Class: MergeAccountingClient::Invoice

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_accounting_client/models/invoice.rb

Overview

# The Invoice Object ### Description The ‘Invoice` object represents an itemized record of goods and/or services sold to a customer. ### Usage Example Fetch from the `LIST Invoices` endpoint and view a company’s invoices.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Invoice

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 207

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MergeAccountingClient::Invoice` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `MergeAccountingClient::Invoice`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.key?(:'contact')
    self.contact = attributes[:'contact']
  end

  if attributes.key?(:'number')
    self.number = attributes[:'number']
  end

  if attributes.key?(:'issue_date')
    self.issue_date = attributes[:'issue_date']
  end

  if attributes.key?(:'due_date')
    self.due_date = attributes[:'due_date']
  end

  if attributes.key?(:'paid_on_date')
    self.paid_on_date = attributes[:'paid_on_date']
  end

  if attributes.key?(:'memo')
    self.memo = attributes[:'memo']
  end

  if attributes.key?(:'company')
    self.company = attributes[:'company']
  end

  if attributes.key?(:'currency')
    self.currency = attributes[:'currency']
  end

  if attributes.key?(:'exchange_rate')
    self.exchange_rate = attributes[:'exchange_rate']
  end

  if attributes.key?(:'total_discount')
    self.total_discount = attributes[:'total_discount']
  end

  if attributes.key?(:'sub_total')
    self.sub_total = attributes[:'sub_total']
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.key?(:'total_tax_amount')
    self.total_tax_amount = attributes[:'total_tax_amount']
  end

  if attributes.key?(:'total_amount')
    self.total_amount = attributes[:'total_amount']
  end

  if attributes.key?(:'balance')
    self.balance = attributes[:'balance']
  end

  if attributes.key?(:'remote_updated_at')
    self.remote_updated_at = attributes[:'remote_updated_at']
  end

  if attributes.key?(:'tracking_categories')
    if (value = attributes[:'tracking_categories']).is_a?(Array)
      self.tracking_categories = value
    end
  end

  if attributes.key?(:'payments')
    if (value = attributes[:'payments']).is_a?(Array)
      self.payments = value
    end
  end

  if attributes.key?(:'applied_payments')
    if (value = attributes[:'applied_payments']).is_a?(Array)
      self.applied_payments = value
    end
  end

  if attributes.key?(:'line_items')
    if (value = attributes[:'line_items']).is_a?(Array)
      self.line_items = value
    end
  end

  if attributes.key?(:'remote_was_deleted')
    self.remote_was_deleted = attributes[:'remote_was_deleted']
  end

  if attributes.key?(:'accounting_period')
    self.accounting_period = attributes[:'accounting_period']
  end

  if attributes.key?(:'purchase_orders')
    if (value = attributes[:'purchase_orders']).is_a?(Array)
      self.purchase_orders = value
    end
  end

  if attributes.key?(:'remote_id')
    self.remote_id = attributes[:'remote_id']
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.key?(:'modified_at')
    self.modified_at = attributes[:'modified_at']
  end

  if attributes.key?(:'field_mappings')
    if (value = attributes[:'field_mappings']).is_a?(Hash)
      self.field_mappings = value
    end
  end

  if attributes.key?(:'remote_data')
    if (value = attributes[:'remote_data']).is_a?(Array)
      self.remote_data = value
    end
  end
end

Instance Attribute Details

#accounting_period ⇒ Object

The accounting period that the Invoice was generated in.



85
86
87
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 85

def accounting_period
  @accounting_period
end

#applied_payments ⇒ Object

A list of the Payment Applied to Lines common models related to a given Invoice, Credit Note, or Journal Entry.



78
79
80
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 78

def applied_payments
  @applied_payments
end

#balance ⇒ Object

The invoice’s remaining balance.



67
68
69
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 67

def balance
  @balance
end

#company ⇒ Object

The company the invoice belongs to.



43
44
45
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 43

def company
  @company
end

#contact ⇒ Object

The invoice’s contact.



25
26
27
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 25

def contact
  @contact
end

#created_at ⇒ Object

Returns the value of attribute created_at.



92
93
94
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 92

def created_at
  @created_at
end

#currency ⇒ Object

The invoice’s currency. * ‘XUA` - ADB Unit of Account * `AFN` - Afghan Afghani * `AFA` - Afghan Afghani (1927–2002) * `ALL` - Albanian Lek * `ALK` - Albanian Lek (1946–1965) * `DZD` - Algerian Dinar * `ADP` - Andorran Peseta * `AOA` - Angolan Kwanza * `AOK` - Angolan Kwanza (1977–1991) * `AON` - Angolan New Kwanza (1990–2000) * `AOR` - Angolan Readjusted Kwanza (1995–1999) * `ARA` - Argentine Austral * `ARS` - Argentine Peso * `ARM` - Argentine Peso (1881–1970) * `ARP` - Argentine Peso (1983–1985) * `ARL` - Argentine Peso Ley (1970–1983) * `AMD` - Armenian Dram * `AWG` - Aruban Florin * `AUD` - Australian Dollar * `ATS` - Austrian Schilling * `AZN` - Azerbaijani Manat * `AZM` - Azerbaijani Manat (1993–2006) * `BSD` - Bahamian Dollar * `BHD` - Bahraini Dinar * `BDT` - Bangladeshi Taka * `BBD` - Barbadian Dollar * `BYN` - Belarusian Ruble * `BYB` - Belarusian Ruble (1994–1999) * `BYR` - Belarusian Ruble (2000–2016) * `BEF` - Belgian Franc * `BEC` - Belgian Franc (convertible) * `BEL` - Belgian Franc (financial) * `BZD` - Belize Dollar * `BMD` - Bermudan Dollar * `BTN` - Bhutanese Ngultrum * `BOB` - Bolivian Boliviano * `BOL` - Bolivian Boliviano (1863–1963) * `BOV` - Bolivian Mvdol * `BOP` - Bolivian Peso * `BAM` - Bosnia-Herzegovina Convertible Mark * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) * `BWP` - Botswanan Pula * `BRC` - Brazilian Cruzado (1986–1989) * `BRZ` - Brazilian Cruzeiro (1942–1967) * `BRE` - Brazilian Cruzeiro (1990–1993) * `BRR` - Brazilian Cruzeiro (1993–1994) * `BRN` - Brazilian New Cruzado (1989–1990) * `BRB` - Brazilian New Cruzeiro (1967–1986) * `BRL` - Brazilian Real * `GBP` - British Pound * `BND` - Brunei Dollar * `BGL` - Bulgarian Hard Lev * `BGN` - Bulgarian Lev * `BGO` - Bulgarian Lev (1879–1952) * `BGM` - Bulgarian Socialist Lev * `BUK` - Burmese Kyat * `BIF` - Burundian Franc * `XPF` - CFP Franc * `KHR` - Cambodian Riel * `CAD` - Canadian Dollar * `CVE` - Cape Verdean Escudo * `KYD` - Cayman Islands Dollar * `XAF` - Central African CFA Franc * `CLE` - Chilean Escudo * `CLP` - Chilean Peso * `CLF` - Chilean Unit of Account (UF) * `CNX` - Chinese People’s Bank Dollar * `CNY` - Chinese Yuan * `CNH` - Chinese Yuan (offshore) * `COP` - Colombian Peso * `COU` - Colombian Real Value Unit * `KMF` - Comorian Franc * `CDF` - Congolese Franc * `CRC` - Costa Rican Colón * `HRD` - Croatian Dinar * `HRK` - Croatian Kuna * `CUC` - Cuban Convertible Peso * `CUP` - Cuban Peso * `CYP` - Cypriot Pound * `CZK` - Czech Koruna * `CSK` - Czechoslovak Hard Koruna * `DKK` - Danish Krone * `DJF` - Djiboutian Franc * `DOP` - Dominican Peso * `NLG` - Dutch Guilder * `XCD` - East Caribbean Dollar * `DDM` - East German Mark * `ECS` - Ecuadorian Sucre * `ECV` - Ecuadorian Unit of Constant Value * `EGP` - Egyptian Pound * `GQE` - Equatorial Guinean Ekwele * `ERN` - Eritrean Nakfa * `EEK` - Estonian Kroon * `ETB` - Ethiopian Birr * `EUR` - Euro * `XBA` - European Composite Unit * `XEU` - European Currency Unit * `XBB` - European Monetary Unit * `XBC` - European Unit of Account (XBC) * `XBD` - European Unit of Account (XBD) * `FKP` - Falkland Islands Pound * `FJD` - Fijian Dollar * `FIM` - Finnish Markka * `FRF` - French Franc * `XFO` - French Gold Franc * `XFU` - French UIC-Franc * `GMD` - Gambian Dalasi * `GEK` - Georgian Kupon Larit * `GEL` - Georgian Lari * `DEM` - German Mark * `GHS` - Ghanaian Cedi * `GHC` - Ghanaian Cedi (1979–2007) * `GIP` - Gibraltar Pound * `XAU` - Gold * `GRD` - Greek Drachma * `GTQ` - Guatemalan Quetzal * `GWP` - Guinea-Bissau Peso * `GNF` - Guinean Franc * `GNS` - Guinean Syli * `GYD` - Guyanaese Dollar * `HTG` - Haitian Gourde * `HNL` - Honduran Lempira * `HKD` - Hong Kong Dollar * `HUF` - Hungarian Forint * `IMP` - IMP * `ISK` - Icelandic Króna * `ISJ` - Icelandic Króna (1918–1981) * `INR` - Indian Rupee * `IDR` - Indonesian Rupiah * `IRR` - Iranian Rial * `IQD` - Iraqi Dinar * `IEP` - Irish Pound * `ILS` - Israeli New Shekel * `ILP` - Israeli Pound * `ILR` - Israeli Shekel (1980–1985) * `ITL` - Italian Lira * `JMD` - Jamaican Dollar * `JPY` - Japanese Yen * `JOD` - Jordanian Dinar * `KZT` - Kazakhstani Tenge * `KES` - Kenyan Shilling * `KWD` - Kuwaiti Dinar * `KGS` - Kyrgystani Som * `LAK` - Laotian Kip * `LVL` - Latvian Lats * `LVR` - Latvian Ruble * `LBP` - Lebanese Pound * `LSL` - Lesotho Loti * `LRD` - Liberian Dollar * `LYD` - Libyan Dinar * `LTL` - Lithuanian Litas * `LTT` - Lithuanian Talonas * `LUL` - Luxembourg Financial Franc * `LUC` - Luxembourgian Convertible Franc * `LUF` - Luxembourgian Franc * `MOP` - Macanese Pataca * `MKD` - Macedonian Denar * `MKN` - Macedonian Denar (1992–1993) * `MGA` - Malagasy Ariary * `MGF` - Malagasy Franc * `MWK` - Malawian Kwacha * `MYR` - Malaysian Ringgit * `MVR` - Maldivian Rufiyaa * `MVP` - Maldivian Rupee (1947–1981) * `MLF` - Malian Franc * `MTL` - Maltese Lira * `MTP` - Maltese Pound * `MRU` - Mauritanian Ouguiya * `MRO` - Mauritanian Ouguiya (1973–2017) * `MUR` - Mauritian Rupee * `MXV` - Mexican Investment Unit * `MXN` - Mexican Peso * `MXP` - Mexican Silver Peso (1861–1992) * `MDC` - Moldovan Cupon * `MDL` - Moldovan Leu * `MCF` - Monegasque Franc * `MNT` - Mongolian Tugrik * `MAD` - Moroccan Dirham * `MAF` - Moroccan Franc * `MZE` - Mozambican Escudo * `MZN` - Mozambican Metical * `MZM` - Mozambican Metical (1980–2006) * `MMK` - Myanmar Kyat * `NAD` - Namibian Dollar * `NPR` - Nepalese Rupee * `ANG` - Netherlands Antillean Guilder * `TWD` - New Taiwan Dollar * `NZD` - New Zealand Dollar * `NIO` - Nicaraguan Córdoba * `NIC` - Nicaraguan Córdoba (1988–1991) * `NGN` - Nigerian Naira * `KPW` - North Korean Won * `NOK` - Norwegian Krone * `OMR` - Omani Rial * `PKR` - Pakistani Rupee * `XPD` - Palladium * `PAB` - Panamanian Balboa * `PGK` - Papua New Guinean Kina * `PYG` - Paraguayan Guarani * `PEI` - Peruvian Inti * `PEN` - Peruvian Sol * `PES` - Peruvian Sol (1863–1965) * `PHP` - Philippine Peso * `XPT` - Platinum * `PLN` - Polish Zloty * `PLZ` - Polish Zloty (1950–1995) * `PTE` - Portuguese Escudo * `GWE` - Portuguese Guinea Escudo * `QAR` - Qatari Rial * `XRE` - RINET Funds * `RHD` - Rhodesian Dollar * `RON` - Romanian Leu * `ROL` - Romanian Leu (1952–2006) * `RUB` - Russian Ruble * `RUR` - Russian Ruble (1991–1998) * `RWF` - Rwandan Franc * `SVC` - Salvadoran Colón * `WST` - Samoan Tala * `SAR` - Saudi Riyal * `RSD` - Serbian Dinar * `CSD` - Serbian Dinar (2002–2006) * `SCR` - Seychellois Rupee * `SLL` - Sierra Leonean Leone * `XAG` - Silver * `SGD` - Singapore Dollar * `SKK` - Slovak Koruna * `SIT` - Slovenian Tolar * `SBD` - Solomon Islands Dollar * `SOS` - Somali Shilling * `ZAR` - South African Rand * `ZAL` - South African Rand (financial) * `KRH` - South Korean Hwan (1953–1962) * `KRW` - South Korean Won * `KRO` - South Korean Won (1945–1953) * `SSP` - South Sudanese Pound * `SUR` - Soviet Rouble * `ESP` - Spanish Peseta * `ESA` - Spanish Peseta (A account) * `ESB` - Spanish Peseta (convertible account) * `XDR` - Special Drawing Rights * `LKR` - Sri Lankan Rupee * `SHP` - St. Helena Pound * `XSU` - Sucre * `SDD` - Sudanese Dinar (1992–2007) * `SDG` - Sudanese Pound * `SDP` - Sudanese Pound (1957–1998) * `SRD` - Surinamese Dollar * `SRG` - Surinamese Guilder * `SZL` - Swazi Lilangeni * `SEK` - Swedish Krona * `CHF` - Swiss Franc * `SYP` - Syrian Pound * `STN` - São Tomé & Príncipe Dobra * `STD` - São Tomé & Príncipe Dobra (1977–2017) * `TVD` - TVD * `TJR` - Tajikistani Ruble * `TJS` - Tajikistani Somoni * `TZS` - Tanzanian Shilling * `XTS` - Testing Currency Code * `THB` - Thai Baht * `XXX` - The codes assigned for transactions where no currency is involved * `TPE` - Timorese Escudo * `TOP` - Tongan Paʻanga * `TTD` - Trinidad & Tobago Dollar * `TND` - Tunisian Dinar * `TRY` - Turkish Lira * `TRL` - Turkish Lira (1922–2005) * `TMT` - Turkmenistani Manat * `TMM` - Turkmenistani Manat (1993–2009) * `USD` - US Dollar * `USN` - US Dollar (Next day) * `USS` - US Dollar (Same day) * `UGX` - Ugandan Shilling * `UGS` - Ugandan Shilling (1966–1987) * `UAH` - Ukrainian Hryvnia * `UAK` - Ukrainian Karbovanets * `AED` - United Arab Emirates Dirham * `UYW` - Uruguayan Nominal Wage Index Unit * `UYU` - Uruguayan Peso * `UYP` - Uruguayan Peso (1975–1993) * `UYI` - Uruguayan Peso (Indexed Units) * `UZS` - Uzbekistani Som * `VUV` - Vanuatu Vatu * `VES` - Venezuelan Bolívar * `VEB` - Venezuelan Bolívar (1871–2008) * `VEF` - Venezuelan Bolívar (2008–2018) * `VND` - Vietnamese Dong * `VNN` - Vietnamese Dong (1978–1985) * `CHE` - WIR Euro * `CHW` - WIR Franc * `XOF` - West African CFA Franc * `YDD` - Yemeni Dinar * `YER` - Yemeni Rial * `YUN` - Yugoslavian Convertible Dinar (1990–1992) * `YUD` - Yugoslavian Hard Dinar (1966–1990) * `YUM` - Yugoslavian New Dinar (1994–2002) * `YUR` - Yugoslavian Reformed Dinar (1992–1993) * `ZWN` - ZWN * `ZRN` - Zairean New Zaire (1993–1998) * `ZRZ` - Zairean Zaire (1971–1993) * `ZMW` - Zambian Kwacha * `ZMK` - Zambian Kwacha (1968–2012) * `ZWD` - Zimbabwean Dollar (1980–2008) * `ZWR` - Zimbabwean Dollar (2008) * `ZWL` - Zimbabwean Dollar (2009)



46
47
48
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 46

def currency
  @currency
end

#due_date ⇒ Object

The invoice’s due date.



34
35
36
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 34

def due_date
  @due_date
end

#exchange_rate ⇒ Object

The invoice’s exchange rate.



49
50
51
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 49

def exchange_rate
  @exchange_rate
end

#field_mappings ⇒ Object

Returns the value of attribute field_mappings.



97
98
99
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 97

def field_mappings
  @field_mappings
end

#id ⇒ Object

Returns the value of attribute id.



19
20
21
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 19

def id
  @id
end

#issue_date ⇒ Object

The invoice’s issue date.



31
32
33
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 31

def issue_date
  @issue_date
end

#line_items ⇒ Object

Returns the value of attribute line_items.



80
81
82
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 80

def line_items
  @line_items
end

#memo ⇒ Object

The invoice’s private note.



40
41
42
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 40

def memo
  @memo
end

#modified_at ⇒ Object

This is the datetime that this object was last updated by Merge



95
96
97
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 95

def modified_at
  @modified_at
end

#number ⇒ Object

The invoice’s number.



28
29
30
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 28

def number
  @number
end

The invoice’s paid date.



37
38
39
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 37

def paid_on_date
  @paid_on_date
end

#payments ⇒ Object

Array of ‘Payment` object IDs.



75
76
77
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 75

def payments
  @payments
end

#purchase_orders ⇒ Object

Returns the value of attribute purchase_orders.



87
88
89
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 87

def purchase_orders
  @purchase_orders
end

#remote_data ⇒ Object

Returns the value of attribute remote_data.



99
100
101
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 99

def remote_data
  @remote_data
end

#remote_id ⇒ Object

The third-party API ID of the matching object.



90
91
92
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 90

def remote_id
  @remote_id
end

#remote_updated_at ⇒ Object

When the third party’s invoice entry was updated.



70
71
72
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 70

def remote_updated_at
  @remote_updated_at
end

#remote_was_deleted ⇒ Object

Returns the value of attribute remote_was_deleted.



82
83
84
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 82

def remote_was_deleted
  @remote_was_deleted
end

#status ⇒ Object

The status of the invoice. * ‘PAID` - PAID * `DRAFT` - DRAFT * `SUBMITTED` - SUBMITTED * `PARTIALLY_PAID` - PARTIALLY_PAID * `OPEN` - OPEN * `VOID` - VOID



58
59
60
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 58

def status
  @status
end

#sub_total ⇒ Object

The total amount being paid before taxes.



55
56
57
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 55

def sub_total
  @sub_total
end

#total_amount ⇒ Object

The invoice’s total amount.



64
65
66
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 64

def total_amount
  @total_amount
end

#total_discount ⇒ Object

The total discounts applied to the total cost.



52
53
54
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 52

def total_discount
  @total_discount
end

#total_tax_amount ⇒ Object

The total amount being paid in taxes.



61
62
63
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 61

def total_tax_amount
  @total_tax_amount
end

#tracking_categories ⇒ Object

Returns the value of attribute tracking_categories.



72
73
74
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 72

def tracking_categories
  @tracking_categories
end

#type ⇒ Object

Whether the invoice is an accounts receivable or accounts payable. If ‘type` is `accounts_payable`, the invoice is a bill. If `type` is `accounts_receivable`, it is an invoice. * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE



22
23
24
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 22

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



138
139
140
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 138

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 102

def self.attribute_map
  {
    :'id' => :'id',
    :'type' => :'type',
    :'contact' => :'contact',
    :'number' => :'number',
    :'issue_date' => :'issue_date',
    :'due_date' => :'due_date',
    :'paid_on_date' => :'paid_on_date',
    :'memo' => :'memo',
    :'company' => :'company',
    :'currency' => :'currency',
    :'exchange_rate' => :'exchange_rate',
    :'total_discount' => :'total_discount',
    :'sub_total' => :'sub_total',
    :'status' => :'status',
    :'total_tax_amount' => :'total_tax_amount',
    :'total_amount' => :'total_amount',
    :'balance' => :'balance',
    :'remote_updated_at' => :'remote_updated_at',
    :'tracking_categories' => :'tracking_categories',
    :'payments' => :'payments',
    :'applied_payments' => :'applied_payments',
    :'line_items' => :'line_items',
    :'remote_was_deleted' => :'remote_was_deleted',
    :'accounting_period' => :'accounting_period',
    :'purchase_orders' => :'purchase_orders',
    :'remote_id' => :'remote_id',
    :'created_at' => :'created_at',
    :'modified_at' => :'modified_at',
    :'field_mappings' => :'field_mappings',
    :'remote_data' => :'remote_data'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



437
438
439
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 437

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 179

def self.openapi_nullable
  Set.new([
    :'type',
    :'contact',
    :'number',
    :'issue_date',
    :'due_date',
    :'paid_on_date',
    :'memo',
    :'company',
    :'currency',
    :'exchange_rate',
    :'total_discount',
    :'sub_total',
    :'status',
    :'total_tax_amount',
    :'total_amount',
    :'balance',
    :'remote_updated_at',
    :'accounting_period',
    :'remote_id',
    :'field_mappings',
    :'remote_data'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
175
176
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 143

def self.openapi_types
  {
    :'id' => :'String',
    :'type' => :'InvoiceTypeEnum',
    :'contact' => :'String',
    :'number' => :'String',
    :'issue_date' => :'Time',
    :'due_date' => :'Time',
    :'paid_on_date' => :'Time',
    :'memo' => :'String',
    :'company' => :'String',
    :'currency' => :'CurrencyEnum',
    :'exchange_rate' => :'String',
    :'total_discount' => :'Float',
    :'sub_total' => :'Float',
    :'status' => :'InvoiceStatusEnum',
    :'total_tax_amount' => :'Float',
    :'total_amount' => :'Float',
    :'balance' => :'Float',
    :'remote_updated_at' => :'Time',
    :'tracking_categories' => :'Array<String>',
    :'payments' => :'Array<String>',
    :'applied_payments' => :'Array<String>',
    :'line_items' => :'Array<InvoiceLineItem>',
    :'remote_was_deleted' => :'Boolean',
    :'accounting_period' => :'String',
    :'purchase_orders' => :'Array<String>',
    :'remote_id' => :'String',
    :'created_at' => :'Time',
    :'modified_at' => :'Time',
    :'field_mappings' => :'Hash<String, Object>',
    :'remote_data' => :'Array<RemoteData>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 387

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      type == o.type &&
      contact == o.contact &&
      number == o.number &&
      issue_date == o.issue_date &&
      due_date == o.due_date &&
      paid_on_date == o.paid_on_date &&
      memo == o.memo &&
      company == o.company &&
      currency == o.currency &&
      exchange_rate == o.exchange_rate &&
      total_discount == o.total_discount &&
      sub_total == o.sub_total &&
      status == o.status &&
      total_tax_amount == o.total_tax_amount &&
      total_amount == o.total_amount &&
      balance == o.balance &&
      remote_updated_at == o.remote_updated_at &&
      tracking_categories == o.tracking_categories &&
      payments == o.payments &&
      applied_payments == o.applied_payments &&
      line_items == o.line_items &&
      remote_was_deleted == o.remote_was_deleted &&
      accounting_period == o.accounting_period &&
      purchase_orders == o.purchase_orders &&
      remote_id == o.remote_id &&
      created_at == o.created_at &&
      modified_at == o.modified_at &&
      field_mappings == o.field_mappings &&
      remote_data == o.remote_data
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 467

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = MergeAccountingClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



538
539
540
541
542
543
544
545
546
547
548
549
550
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 538

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 444

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


424
425
426
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 424

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



430
431
432
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 430

def hash
  [id, type, contact, number, issue_date, due_date, paid_on_date, memo, company, currency, exchange_rate, total_discount, sub_total, status, total_tax_amount, total_amount, balance, remote_updated_at, tracking_categories, payments, applied_payments, line_items, remote_was_deleted, accounting_period, purchase_orders, remote_id, created_at, modified_at, field_mappings, remote_data].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



357
358
359
360
361
362
363
364
365
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 357

def list_invalid_properties
  invalid_properties = Array.new
  pattern = Regexp.new(/^-?\d{0,32}(?:\.\d{0,16})?$/)
  if !@exchange_rate.nil? && @exchange_rate.to_s !~ pattern
    invalid_properties.push("invalid value for \"exchange_rate\", must conform to the pattern #{pattern}.")
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



514
515
516
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 514

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



520
521
522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 520

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



508
509
510
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 508

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



369
370
371
372
 
# File 'lib/merge_accounting_client/models/invoice.rb', line 369

def valid?
  return false if !@exchange_rate.nil? && @exchange_rate.to_s !~ Regexp.new(/^-?\d{0,32}(?:\.\d{0,16})?$/)
  true
end