Class: Merge::Accounting::VendorCreditLine

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/accounting/types/vendor_credit_line.rb

Overview

# The VendorCreditLine Object

### Description
The `VendorCreditLine` object is used to represent a vendor credit's line items.
### Usage Example
Fetch from the `GET VendorCredit` endpoint and view the vendor credit's line
items.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, net_amount: OMIT, tracking_category: OMIT, tracking_categories: OMIT, description: OMIT, account: OMIT, company: OMIT, project: OMIT, contact: OMIT, tax_rate: OMIT, exchange_rate: OMIT, remote_was_deleted: OMIT, additional_properties: nil) ⇒ Merge::Accounting::VendorCreditLine

Parameters:

  • id (String) (defaults to: OMIT)
  • remote_id (String) (defaults to: OMIT) —

    The third-party API ID of the matching object.

  • created_at (DateTime) (defaults to: OMIT) —

    The datetime that this object was created by Merge.

  • modified_at (DateTime) (defaults to: OMIT) —

    The datetime that this object was modified by Merge.

  • net_amount (Float) (defaults to: OMIT) —

    The full value of the credit.

  • tracking_category (String) (defaults to: OMIT) —

    The line’s associated tracking category.

  • tracking_categories (Array<String>) (defaults to: OMIT) —

    The vendor credit line item’s associated tracking categories.

  • description (String) (defaults to: OMIT) —

    The line’s description.

  • account (Merge::Accounting::VendorCreditLineAccount) (defaults to: OMIT) —

    The line’s account.

  • company (String) (defaults to: OMIT) —

    The company the line belongs to.

  • project (Merge::Accounting::VendorCreditLineProject) (defaults to: OMIT)
  • contact (Merge::Accounting::VendorCreditLineContact) (defaults to: OMIT)
  • tax_rate (String) (defaults to: OMIT) —

    The tax rate that applies to this line item.

  • exchange_rate (String) (defaults to: OMIT) —

    The vendor credit line item’s exchange rate.

  • remote_was_deleted (Boolean) (defaults to: OMIT) —

    Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/merge_ruby_client/accounting/types/vendor_credit_line.rb', line 80

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, net_amount: OMIT,
               tracking_category: OMIT, tracking_categories: OMIT, description: OMIT, account: OMIT, company: OMIT, project: OMIT, contact: OMIT, tax_rate: OMIT, exchange_rate: OMIT, remote_was_deleted: OMIT, additional_properties: nil)
  @id = id if id != OMIT
  @remote_id = remote_id if remote_id != OMIT
  @created_at = created_at if created_at != OMIT
  @modified_at = modified_at if modified_at != OMIT
  @net_amount = net_amount if net_amount != OMIT
  @tracking_category = tracking_category if tracking_category != OMIT
  @tracking_categories = tracking_categories if tracking_categories != OMIT
  @description = description if description != OMIT
  @account =  if  != OMIT
  @company = company if company != OMIT
  @project = project if project != OMIT
  @contact = contact if contact != OMIT
  @tax_rate = tax_rate if tax_rate != OMIT
  @exchange_rate = exchange_rate if exchange_rate != OMIT
  @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "id": id,
    "remote_id": remote_id,
    "created_at": created_at,
    "modified_at": modified_at,
    "net_amount": net_amount,
    "tracking_category": tracking_category,
    "tracking_categories": tracking_categories,
    "description": description,
    "account": ,
    "company": company,
    "project": project,
    "contact": contact,
    "tax_rate": tax_rate,
    "exchange_rate": exchange_rate,
    "remote_was_deleted": remote_was_deleted
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#account ⇒ Merge::Accounting::VendorCreditLineAccount (readonly)

Returns The line’s account.

Returns:



36
37
38
 
# File 'lib/merge_ruby_client/accounting/types/vendor_credit_line.rb', line 36

def 
  @account
end

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



53
54
55
 
# File 'lib/merge_ruby_client/accounting/types/vendor_credit_line.rb', line 53

def additional_properties
  @additional_properties
end

#company ⇒ String (readonly)

Returns The company the line belongs to.

Returns:

  • (String) —

    The company the line belongs to.



38
39
40
 
# File 'lib/merge_ruby_client/accounting/types/vendor_credit_line.rb', line 38

def company
  @company
end

#contact ⇒ Merge::Accounting::VendorCreditLineContact (readonly)

Returns:



42
43
44
 
# File 'lib/merge_ruby_client/accounting/types/vendor_credit_line.rb', line 42

def contact
  @contact
end

#created_at ⇒ DateTime (readonly)

Returns The datetime that this object was created by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was created by Merge.



24
25
26
 
# File 'lib/merge_ruby_client/accounting/types/vendor_credit_line.rb', line 24

def created_at
  @created_at
end

#description ⇒ String (readonly)

Returns The line’s description.

Returns:

  • (String) —

    The line’s description.



34
35
36
 
# File 'lib/merge_ruby_client/accounting/types/vendor_credit_line.rb', line 34

def description
  @description
end

#exchange_rate ⇒ String (readonly)

Returns The vendor credit line item’s exchange rate.

Returns:

  • (String) —

    The vendor credit line item’s exchange rate.



46
47
48
 
# File 'lib/merge_ruby_client/accounting/types/vendor_credit_line.rb', line 46

def exchange_rate
  @exchange_rate
end

#id ⇒ String (readonly)

Returns:

  • (String) 


20
21
22
 
# File 'lib/merge_ruby_client/accounting/types/vendor_credit_line.rb', line 20

def id
  @id
end

#modified_at ⇒ DateTime (readonly)

Returns The datetime that this object was modified by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was modified by Merge.



26
27
28
 
# File 'lib/merge_ruby_client/accounting/types/vendor_credit_line.rb', line 26

def modified_at
  @modified_at
end

#net_amount ⇒ Float (readonly)

Returns The full value of the credit.

Returns:

  • (Float) —

    The full value of the credit.



28
29
30
 
# File 'lib/merge_ruby_client/accounting/types/vendor_credit_line.rb', line 28

def net_amount
  @net_amount
end

#project ⇒ Merge::Accounting::VendorCreditLineProject (readonly)

Returns:



40
41
42
 
# File 'lib/merge_ruby_client/accounting/types/vendor_credit_line.rb', line 40

def project
  @project
end

#remote_id ⇒ String (readonly)

Returns The third-party API ID of the matching object.

Returns:

  • (String) —

    The third-party API ID of the matching object.



22
23
24
 
# File 'lib/merge_ruby_client/accounting/types/vendor_credit_line.rb', line 22

def remote_id
  @remote_id
end

#remote_was_deleted ⇒ Boolean (readonly)

Returns Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).

Returns:

  • (Boolean) —

    Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).



51
52
53
 
# File 'lib/merge_ruby_client/accounting/types/vendor_credit_line.rb', line 51

def remote_was_deleted
  @remote_was_deleted
end

#tax_rate ⇒ String (readonly)

Returns The tax rate that applies to this line item.

Returns:

  • (String) —

    The tax rate that applies to this line item.



44
45
46
 
# File 'lib/merge_ruby_client/accounting/types/vendor_credit_line.rb', line 44

def tax_rate
  @tax_rate
end

#tracking_categories ⇒ Array<String> (readonly)

Returns The vendor credit line item’s associated tracking categories.

Returns:

  • (Array<String>) —

    The vendor credit line item’s associated tracking categories.



32
33
34
 
# File 'lib/merge_ruby_client/accounting/types/vendor_credit_line.rb', line 32

def tracking_categories
  @tracking_categories
end

#tracking_category ⇒ String (readonly)

Returns The line’s associated tracking category.

Returns:

  • (String) —

    The line’s associated tracking category.



30
31
32
 
# File 'lib/merge_ruby_client/accounting/types/vendor_credit_line.rb', line 30

def tracking_category
  @tracking_category
end

Class Method Details

.from_json(json_object:) ⇒ Merge::Accounting::VendorCreditLine

Deserialize a JSON object to an instance of VendorCreditLine

Parameters:

  • json_object (String)

Returns:



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/merge_ruby_client/accounting/types/vendor_credit_line.rb', line 123

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = parsed_json["id"]
  remote_id = parsed_json["remote_id"]
  created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
  modified_at = (DateTime.parse(parsed_json["modified_at"]) unless parsed_json["modified_at"].nil?)
  net_amount = parsed_json["net_amount"]
  tracking_category = parsed_json["tracking_category"]
  tracking_categories = parsed_json["tracking_categories"]
  description = parsed_json["description"]
  if parsed_json["account"].nil?
     = nil
  else
     = parsed_json["account"].to_json
     = Merge::Accounting::VendorCreditLineAccount.from_json(json_object: )
  end
  company = parsed_json["company"]
  if parsed_json["project"].nil?
    project = nil
  else
    project = parsed_json["project"].to_json
    project = Merge::Accounting::VendorCreditLineProject.from_json(json_object: project)
  end
  if parsed_json["contact"].nil?
    contact = nil
  else
    contact = parsed_json["contact"].to_json
    contact = Merge::Accounting::VendorCreditLineContact.from_json(json_object: contact)
  end
  tax_rate = parsed_json["tax_rate"]
  exchange_rate = parsed_json["exchange_rate"]
  remote_was_deleted = parsed_json["remote_was_deleted"]
  new(
    id: id,
    remote_id: remote_id,
    created_at: created_at,
    modified_at: modified_at,
    net_amount: net_amount,
    tracking_category: tracking_category,
    tracking_categories: tracking_categories,
    description: description,
    account: ,
    company: company,
    project: project,
    contact: contact,
    tax_rate: tax_rate,
    exchange_rate: exchange_rate,
    remote_was_deleted: remote_was_deleted,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/merge_ruby_client/accounting/types/vendor_credit_line.rb', line 189

def self.validate_raw(obj:)
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.remote_id&.is_a?(String) != false || raise("Passed value for field obj.remote_id is not the expected type, validation failed.")
  obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
  obj.modified_at&.is_a?(DateTime) != false || raise("Passed value for field obj.modified_at is not the expected type, validation failed.")
  obj.net_amount&.is_a?(Float) != false || raise("Passed value for field obj.net_amount is not the expected type, validation failed.")
  obj.tracking_category&.is_a?(String) != false || raise("Passed value for field obj.tracking_category is not the expected type, validation failed.")
  obj.tracking_categories&.is_a?(Array) != false || raise("Passed value for field obj.tracking_categories is not the expected type, validation failed.")
  obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
  obj..nil? || Merge::Accounting::VendorCreditLineAccount.validate_raw(obj: obj.)
  obj.company&.is_a?(String) != false || raise("Passed value for field obj.company is not the expected type, validation failed.")
  obj.project.nil? || Merge::Accounting::VendorCreditLineProject.validate_raw(obj: obj.project)
  obj.contact.nil? || Merge::Accounting::VendorCreditLineContact.validate_raw(obj: obj.contact)
  obj.tax_rate&.is_a?(String) != false || raise("Passed value for field obj.tax_rate is not the expected type, validation failed.")
  obj.exchange_rate&.is_a?(String) != false || raise("Passed value for field obj.exchange_rate is not the expected type, validation failed.")
  obj.remote_was_deleted&.is_a?(Boolean) != false || raise("Passed value for field obj.remote_was_deleted is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of VendorCreditLine to a JSON object

Returns:

  • (String) 


179
180
181
 
# File 'lib/merge_ruby_client/accounting/types/vendor_credit_line.rb', line 179

def to_json(*_args)
  @_field_set&.to_json
end