Class: Merge::Accounting::InvoiceRequest
- Inherits:
-
Object
- Object
- Merge::Accounting::InvoiceRequest
- Defined in:
- lib/merge_ruby_client/accounting/types/invoice_request.rb
Overview
# The Invoice Object
### Description
The `Invoice` object represents an itemized record of goods and/or services
sold to a customer.
If type = accounts_payable `Invoice` is a bill, if type = accounts_receivable
it's an invoice.
### Usage Example
Fetch from the `LIST Invoices` endpoint and view a company's invoices.
Constant Summary collapse
- OMIT =
Object.new
Instance Attribute Summary collapse
-
#additional_properties ⇒ OpenStruct
readonly
Additional properties unmapped to the current class definition.
-
#balance ⇒ Float
readonly
The invoice’s remaining balance.
-
#company ⇒ Merge::Accounting::InvoiceRequestCompany
readonly
The company the invoice belongs to.
-
#contact ⇒ Merge::Accounting::InvoiceRequestContact
readonly
The invoice’s contact.
-
#currency ⇒ Merge::Accounting::CurrencyEnum
readonly
The invoice’s currency.
-
#due_date ⇒ DateTime
readonly
The invoice’s due date.
-
#exchange_rate ⇒ String
readonly
The invoice’s exchange rate.
- #integration_params ⇒ Hash{String => Object} readonly
-
#issue_date ⇒ DateTime
readonly
The invoice’s issue date.
- #line_items ⇒ Array<Merge::Accounting::InvoiceLineItemRequest> readonly
- #linked_account_params ⇒ Hash{String => Object} readonly
-
#memo ⇒ String
readonly
The invoice’s private note.
-
#number ⇒ String
readonly
The invoice’s number.
-
#paid_on_date ⇒ DateTime
readonly
The invoice’s paid date.
-
#payments ⇒ Array<Merge::Accounting::InvoiceRequestPaymentsItem>
readonly
Array of ‘Payment` object IDs.
- #purchase_orders ⇒ Array<Merge::Accounting::InvoiceRequestPurchaseOrdersItem> readonly
-
#status ⇒ Merge::Accounting::InvoiceStatusEnum
readonly
The status of the invoice.
-
#sub_total ⇒ Float
readonly
The total amount being paid before taxes.
-
#total_amount ⇒ Float
readonly
The invoice’s total amount.
-
#total_discount ⇒ Float
readonly
The total discounts applied to the total cost.
-
#total_tax_amount ⇒ Float
readonly
The total amount being paid in taxes.
- #tracking_categories ⇒ Array<Merge::Accounting::InvoiceRequestTrackingCategoriesItem> readonly
-
#type ⇒ Merge::Accounting::InvoiceTypeEnum
readonly
Whether the invoice is an accounts receivable or accounts payable.
Class Method Summary collapse
-
.from_json(json_object:) ⇒ Merge::Accounting::InvoiceRequest
Deserialize a JSON object to an instance of InvoiceRequest.
-
.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.
Instance Method Summary collapse
- #initialize(type: OMIT, contact: OMIT, number: OMIT, issue_date: OMIT, due_date: OMIT, paid_on_date: OMIT, memo: OMIT, status: OMIT, company: OMIT, currency: OMIT, exchange_rate: OMIT, total_discount: OMIT, sub_total: OMIT, total_tax_amount: OMIT, total_amount: OMIT, balance: OMIT, payments: OMIT, tracking_categories: OMIT, line_items: OMIT, purchase_orders: OMIT, integration_params: OMIT, linked_account_params: OMIT, additional_properties: nil) ⇒ Merge::Accounting::InvoiceRequest constructor
-
#to_json(*_args) ⇒ String
Serialize an instance of InvoiceRequest to a JSON object.
Constructor Details
#initialize(type: OMIT, contact: OMIT, number: OMIT, issue_date: OMIT, due_date: OMIT, paid_on_date: OMIT, memo: OMIT, status: OMIT, company: OMIT, currency: OMIT, exchange_rate: OMIT, total_discount: OMIT, sub_total: OMIT, total_tax_amount: OMIT, total_amount: OMIT, balance: OMIT, payments: OMIT, tracking_categories: OMIT, line_items: OMIT, purchase_orders: OMIT, integration_params: OMIT, linked_account_params: OMIT, additional_properties: nil) ⇒ Merge::Accounting::InvoiceRequest
735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 |
# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 735 def initialize(type: OMIT, contact: OMIT, number: OMIT, issue_date: OMIT, due_date: OMIT, paid_on_date: OMIT, memo: OMIT, status: OMIT, company: OMIT, currency: OMIT, exchange_rate: OMIT, total_discount: OMIT, sub_total: OMIT, total_tax_amount: OMIT, total_amount: OMIT, balance: OMIT, payments: OMIT, tracking_categories: OMIT, line_items: OMIT, purchase_orders: OMIT, integration_params: OMIT, linked_account_params: OMIT, additional_properties: nil) @type = type if type != OMIT @contact = contact if contact != OMIT @number = number if number != OMIT @issue_date = issue_date if issue_date != OMIT @due_date = due_date if due_date != OMIT @paid_on_date = paid_on_date if paid_on_date != OMIT @memo = memo if memo != OMIT @status = status if status != OMIT @company = company if company != OMIT @currency = currency if currency != OMIT @exchange_rate = exchange_rate if exchange_rate != OMIT @total_discount = total_discount if total_discount != OMIT @sub_total = sub_total if sub_total != OMIT @total_tax_amount = total_tax_amount if total_tax_amount != OMIT @total_amount = total_amount if total_amount != OMIT @balance = balance if balance != OMIT @payments = payments if payments != OMIT @tracking_categories = tracking_categories if tracking_categories != OMIT @line_items = line_items if line_items != OMIT @purchase_orders = purchase_orders if purchase_orders != OMIT @integration_params = integration_params if integration_params != OMIT @linked_account_params = linked_account_params if linked_account_params != OMIT @additional_properties = additional_properties @_field_set = { "type": type, "contact": contact, "number": number, "issue_date": issue_date, "due_date": due_date, "paid_on_date": paid_on_date, "memo": memo, "status": status, "company": company, "currency": currency, "exchange_rate": exchange_rate, "total_discount": total_discount, "sub_total": sub_total, "total_tax_amount": total_tax_amount, "total_amount": total_amount, "balance": balance, "payments": payments, "tracking_categories": tracking_categories, "line_items": line_items, "purchase_orders": purchase_orders, "integration_params": integration_params, "linked_account_params": linked_account_params }.reject do |_k, v| v == OMIT end end |
Instance Attribute Details
#additional_properties ⇒ OpenStruct (readonly)
Returns Additional properties unmapped to the current class definition.
388 389 390 |
# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 388 def additional_properties @additional_properties end |
#balance ⇒ Float (readonly)
Returns The invoice’s remaining balance.
374 375 376 |
# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 374 def balance @balance end |
#company ⇒ Merge::Accounting::InvoiceRequestCompany (readonly)
Returns The company the invoice belongs to.
54 55 56 |
# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 54 def company @company end |
#contact ⇒ Merge::Accounting::InvoiceRequestContact (readonly)
Returns The invoice’s contact.
34 35 36 |
# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 34 def contact @contact end |
#currency ⇒ Merge::Accounting::CurrencyEnum (readonly)
Returns 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).
362 363 364 |
# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 362 def currency @currency end |
#due_date ⇒ DateTime (readonly)
Returns The invoice’s due date.
40 41 42 |
# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 40 def due_date @due_date end |
#exchange_rate ⇒ String (readonly)
Returns The invoice’s exchange rate.
364 365 366 |
# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 364 def exchange_rate @exchange_rate end |
#integration_params ⇒ Hash{String => Object} (readonly)
384 385 386 |
# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 384 def integration_params @integration_params end |
#issue_date ⇒ DateTime (readonly)
Returns The invoice’s issue date.
38 39 40 |
# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 38 def issue_date @issue_date end |
#line_items ⇒ Array<Merge::Accounting::InvoiceLineItemRequest> (readonly)
380 381 382 |
# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 380 def line_items @line_items end |
#linked_account_params ⇒ Hash{String => Object} (readonly)
386 387 388 |
# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 386 def linked_account_params @linked_account_params end |
#memo ⇒ String (readonly)
Returns The invoice’s private note.
44 45 46 |
# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 44 def memo @memo end |
#number ⇒ String (readonly)
Returns The invoice’s number.
36 37 38 |
# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 36 def number @number end |
#paid_on_date ⇒ DateTime (readonly)
Returns The invoice’s paid date.
42 43 44 |
# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 42 def paid_on_date @paid_on_date end |
#payments ⇒ Array<Merge::Accounting::InvoiceRequestPaymentsItem> (readonly)
Returns Array of ‘Payment` object IDs.
376 377 378 |
# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 376 def payments @payments end |
#purchase_orders ⇒ Array<Merge::Accounting::InvoiceRequestPurchaseOrdersItem> (readonly)
382 383 384 |
# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 382 def purchase_orders @purchase_orders end |
#status ⇒ Merge::Accounting::InvoiceStatusEnum (readonly)
Returns The status of the invoice.
-
‘PAID` - PAID
-
‘DRAFT` - DRAFT
-
‘SUBMITTED` - SUBMITTED
-
‘PARTIALLY_PAID` - PARTIALLY_PAID
-
‘OPEN` - OPEN
-
‘VOID` - VOID.
52 53 54 |
# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 52 def status @status end |
#sub_total ⇒ Float (readonly)
Returns The total amount being paid before taxes.
368 369 370 |
# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 368 def sub_total @sub_total end |
#total_amount ⇒ Float (readonly)
Returns The invoice’s total amount.
372 373 374 |
# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 372 def total_amount @total_amount end |
#total_discount ⇒ Float (readonly)
Returns The total discounts applied to the total cost.
366 367 368 |
# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 366 def total_discount @total_discount end |
#total_tax_amount ⇒ Float (readonly)
Returns The total amount being paid in taxes.
370 371 372 |
# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 370 def total_tax_amount @total_tax_amount end |
#tracking_categories ⇒ Array<Merge::Accounting::InvoiceRequestTrackingCategoriesItem> (readonly)
378 379 380 |
# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 378 def tracking_categories @tracking_categories end |
#type ⇒ Merge::Accounting::InvoiceTypeEnum (readonly)
Returns 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.
32 33 34 |
# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 32 def type @type end |
Class Method Details
.from_json(json_object:) ⇒ Merge::Accounting::InvoiceRequest
Deserialize a JSON object to an instance of InvoiceRequest
792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 |
# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 792 def self.from_json(json_object:) struct = JSON.parse(json_object, object_class: OpenStruct) parsed_json = JSON.parse(json_object) type = parsed_json["type"] if parsed_json["contact"].nil? contact = nil else contact = parsed_json["contact"].to_json contact = Merge::Accounting::InvoiceRequestContact.from_json(json_object: contact) end number = parsed_json["number"] issue_date = (DateTime.parse(parsed_json["issue_date"]) unless parsed_json["issue_date"].nil?) due_date = (DateTime.parse(parsed_json["due_date"]) unless parsed_json["due_date"].nil?) paid_on_date = (DateTime.parse(parsed_json["paid_on_date"]) unless parsed_json["paid_on_date"].nil?) memo = parsed_json["memo"] status = parsed_json["status"] if parsed_json["company"].nil? company = nil else company = parsed_json["company"].to_json company = Merge::Accounting::InvoiceRequestCompany.from_json(json_object: company) end currency = parsed_json["currency"] exchange_rate = parsed_json["exchange_rate"] total_discount = parsed_json["total_discount"] sub_total = parsed_json["sub_total"] total_tax_amount = parsed_json["total_tax_amount"] total_amount = parsed_json["total_amount"] balance = parsed_json["balance"] payments = parsed_json["payments"]&.map do |item| item = item.to_json Merge::Accounting::InvoiceRequestPaymentsItem.from_json(json_object: item) end tracking_categories = parsed_json["tracking_categories"]&.map do |item| item = item.to_json Merge::Accounting::InvoiceRequestTrackingCategoriesItem.from_json(json_object: item) end line_items = parsed_json["line_items"]&.map do |item| item = item.to_json Merge::Accounting::InvoiceLineItemRequest.from_json(json_object: item) end purchase_orders = parsed_json["purchase_orders"]&.map do |item| item = item.to_json Merge::Accounting::InvoiceRequestPurchaseOrdersItem.from_json(json_object: item) end integration_params = parsed_json["integration_params"] linked_account_params = parsed_json["linked_account_params"] new( type: type, contact: contact, number: number, issue_date: issue_date, due_date: due_date, paid_on_date: paid_on_date, memo: memo, status: status, company: company, currency: currency, exchange_rate: exchange_rate, total_discount: total_discount, sub_total: sub_total, total_tax_amount: total_tax_amount, total_amount: total_amount, balance: balance, payments: payments, tracking_categories: tracking_categories, line_items: line_items, purchase_orders: purchase_orders, integration_params: integration_params, linked_account_params: linked_account_params, 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.
879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 |
# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 879 def self.validate_raw(obj:) obj.type&.is_a?(Merge::Accounting::InvoiceTypeEnum) != false || raise("Passed value for field obj.type is not the expected type, validation failed.") obj.contact.nil? || Merge::Accounting::InvoiceRequestContact.validate_raw(obj: obj.contact) obj.number&.is_a?(String) != false || raise("Passed value for field obj.number is not the expected type, validation failed.") obj.issue_date&.is_a?(DateTime) != false || raise("Passed value for field obj.issue_date is not the expected type, validation failed.") obj.due_date&.is_a?(DateTime) != false || raise("Passed value for field obj.due_date is not the expected type, validation failed.") obj.paid_on_date&.is_a?(DateTime) != false || raise("Passed value for field obj.paid_on_date is not the expected type, validation failed.") obj.memo&.is_a?(String) != false || raise("Passed value for field obj.memo is not the expected type, validation failed.") obj.status&.is_a?(Merge::Accounting::InvoiceStatusEnum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.") obj.company.nil? || Merge::Accounting::InvoiceRequestCompany.validate_raw(obj: obj.company) obj.currency&.is_a?(Merge::Accounting::CurrencyEnum) != false || raise("Passed value for field obj.currency 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.total_discount&.is_a?(Float) != false || raise("Passed value for field obj.total_discount is not the expected type, validation failed.") obj.sub_total&.is_a?(Float) != false || raise("Passed value for field obj.sub_total is not the expected type, validation failed.") obj.total_tax_amount&.is_a?(Float) != false || raise("Passed value for field obj.total_tax_amount is not the expected type, validation failed.") obj.total_amount&.is_a?(Float) != false || raise("Passed value for field obj.total_amount is not the expected type, validation failed.") obj.balance&.is_a?(Float) != false || raise("Passed value for field obj.balance is not the expected type, validation failed.") obj.payments&.is_a?(Array) != false || raise("Passed value for field obj.payments 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.line_items&.is_a?(Array) != false || raise("Passed value for field obj.line_items is not the expected type, validation failed.") obj.purchase_orders&.is_a?(Array) != false || raise("Passed value for field obj.purchase_orders is not the expected type, validation failed.") obj.integration_params&.is_a?(Hash) != false || raise("Passed value for field obj.integration_params is not the expected type, validation failed.") obj.linked_account_params&.is_a?(Hash) != false || raise("Passed value for field obj.linked_account_params is not the expected type, validation failed.") end |
Instance Method Details
#to_json(*_args) ⇒ String
Serialize an instance of InvoiceRequest to a JSON object
869 870 871 |
# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 869 def to_json(*_args) @_field_set&.to_json end |