Class: Merge::Accounting::InvoiceRequest

Inherits:

Object

Object
Merge::Accounting::InvoiceRequest

show all

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 or bought from a vendor. Represents a Bill when the Invoice type is ACCOUNTS_PAYABLE. References an Invoice when the Invoice type is ACCOUNTS_RECEIVABLE.

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::TransactionCurrencyEnum readonly
The invoice's currency.
#due_date ⇒ DateTime readonly
The invoice's due date.
#employee ⇒ Merge::Accounting::InvoiceRequestEmployee readonly
The employee this overall transaction relates to.
#exchange_rate ⇒ String readonly
The invoice's exchange rate.
#inclusive_of_tax ⇒ Boolean readonly
If the transaction is inclusive or exclusive of tax.
#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.
#payment_term ⇒ Merge::Accounting::InvoiceRequestPaymentTerm readonly
The payment term that applies to this transaction.
#payments ⇒ Array<Merge::Accounting::InvoiceRequestPaymentsItem> readonly
Array of Payment object IDs.
#purchase_orders ⇒ Array<Merge::Accounting::InvoiceRequestPurchaseOrdersItem> readonly
#remote_fields ⇒ Array<Merge::Accounting::RemoteFieldRequest> 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

Constructor Details

#initialize(type: OMIT, contact: OMIT, number: OMIT, issue_date: OMIT, due_date: OMIT, paid_on_date: OMIT, employee: OMIT, memo: OMIT, status: OMIT, company: OMIT, currency: OMIT, exchange_rate: OMIT, total_discount: OMIT, sub_total: OMIT, payment_term: OMIT, total_tax_amount: OMIT, inclusive_of_tax: OMIT, total_amount: OMIT, balance: OMIT, payments: OMIT, tracking_categories: OMIT, line_items: OMIT, purchase_orders: OMIT, integration_params: OMIT, linked_account_params: OMIT, remote_fields: OMIT, additional_properties: nil) ⇒ `Merge::Accounting::InvoiceRequest`

Parameters:

type (Merge::Accounting::InvoiceTypeEnum) (defaults to: OMIT) —
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
contact (Merge::Accounting::InvoiceRequestContact) (defaults to: OMIT) —
The invoice's contact.
number (String) (defaults to: OMIT) —
The invoice's number.
issue_date (DateTime) (defaults to: OMIT) —
The invoice's issue date.
due_date (DateTime) (defaults to: OMIT) —
The invoice's due date.
paid_on_date (DateTime) (defaults to: OMIT) —
The invoice's paid date.
employee (Merge::Accounting::InvoiceRequestEmployee) (defaults to: OMIT) —
The employee this overall transaction relates to.
memo (String) (defaults to: OMIT) —
The invoice's private note.
status (Merge::Accounting::InvoiceStatusEnum) (defaults to: OMIT) —
The status of the invoice.
- PAID - PAID
- DRAFT - DRAFT
- SUBMITTED - SUBMITTED
- PARTIALLY_PAID - PARTIALLY_PAID
- OPEN - OPEN
- VOID - VOID
company (Merge::Accounting::InvoiceRequestCompany) (defaults to: OMIT) —
The company the invoice belongs to.
currency (Merge::Accounting::TransactionCurrencyEnum) (defaults to: OMIT) —
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)
exchange_rate (String) (defaults to: OMIT) —
The invoice's exchange rate.
total_discount (Float) (defaults to: OMIT) —
The total discounts applied to the total cost.
sub_total (Float) (defaults to: OMIT) —
The total amount being paid before taxes.
payment_term (Merge::Accounting::InvoiceRequestPaymentTerm) (defaults to: OMIT) —
The payment term that applies to this transaction.
total_tax_amount (Float) (defaults to: OMIT) —
The total amount being paid in taxes.
inclusive_of_tax (Boolean) (defaults to: OMIT) —
If the transaction is inclusive or exclusive of tax. True if inclusive, False if exclusive.
total_amount (Float) (defaults to: OMIT) —
The invoice's total amount.
balance (Float) (defaults to: OMIT) —
The invoice's remaining balance.
payments (Array<Merge::Accounting::InvoiceRequestPaymentsItem>) (defaults to: OMIT) —
Array of Payment object IDs.
tracking_categories (Array<Merge::Accounting::InvoiceRequestTrackingCategoriesItem>) (defaults to: OMIT)
line_items (Array<Merge::Accounting::InvoiceLineItemRequest>) (defaults to: OMIT)
purchase_orders (Array<Merge::Accounting::InvoiceRequestPurchaseOrdersItem>) (defaults to: OMIT)
integration_params (Hash{String => Object}) (defaults to: OMIT)
linked_account_params (Hash{String => Object}) (defaults to: OMIT)
remote_fields (Array<Merge::Accounting::RemoteFieldRequest>) (defaults to: OMIT)
additional_properties (OpenStruct) (defaults to: nil) —
Additional properties unmapped to the current class definition

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 752

def initialize(type: OMIT, contact: OMIT, number: OMIT, issue_date: OMIT, due_date: OMIT, paid_on_date: OMIT,
               employee: OMIT, memo: OMIT, status: OMIT, company: OMIT, currency: OMIT, exchange_rate: OMIT, total_discount: OMIT, sub_total: OMIT, payment_term: OMIT, total_tax_amount: OMIT, inclusive_of_tax: OMIT, total_amount: OMIT, balance: OMIT, payments: OMIT, tracking_categories: OMIT, line_items: OMIT, purchase_orders: OMIT, integration_params: OMIT, linked_account_params: OMIT, remote_fields: 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
  @employee = employee if employee != 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
  @payment_term = payment_term if payment_term != OMIT
  @total_tax_amount = total_tax_amount if total_tax_amount != OMIT
  @inclusive_of_tax = inclusive_of_tax if inclusive_of_tax != 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
  @remote_fields = remote_fields if remote_fields != 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,
    "employee": employee,
    "memo": memo,
    "status": status,
    "company": company,
    "currency": currency,
    "exchange_rate": exchange_rate,
    "total_discount": total_discount,
    "sub_total": sub_total,
    "payment_term": payment_term,
    "total_tax_amount": total_tax_amount,
    "inclusive_of_tax": inclusive_of_tax,
    "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,
    "remote_fields": remote_fields
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ `OpenStruct` (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

(OpenStruct) —
Additional properties unmapped to the current class definition



400
401
402

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 400

def additional_properties
  @additional_properties
end

#balance ⇒ `Float` (readonly)

Returns The invoice's remaining balance.

Returns:

(Float) —
The invoice's remaining balance.



384
385
386

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 384

def balance
  @balance
end

#company ⇒ `Merge::Accounting::InvoiceRequestCompany` (readonly)

Returns The company the invoice belongs to.

Returns:

(Merge::Accounting::InvoiceRequestCompany) —
The company the invoice belongs to.



59
60
61

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 59

def company
  @company
end

#contact ⇒ `Merge::Accounting::InvoiceRequestContact` (readonly)

Returns The invoice's contact.

Returns:

(Merge::Accounting::InvoiceRequestContact) —
The invoice's contact.



37
38
39

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 37

def contact
  @contact
end

#currency ⇒ `Merge::Accounting::TransactionCurrencyEnum` (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).

Returns:

(Merge::Accounting::TransactionCurrencyEnum) —
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)



367
368
369

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 367

def currency
  @currency
end

#due_date ⇒ `DateTime` (readonly)

Returns The invoice's due date.

Returns:

(DateTime) —
The invoice's due date.



43
44
45

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 43

def due_date
  @due_date
end

#employee ⇒ `Merge::Accounting::InvoiceRequestEmployee` (readonly)

Returns The employee this overall transaction relates to.

Returns:

(Merge::Accounting::InvoiceRequestEmployee) —
The employee this overall transaction relates to.



47
48
49

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 47

def employee
  @employee
end

#exchange_rate ⇒ `String` (readonly)

Returns The invoice's exchange rate.

Returns:

(String) —
The invoice's exchange rate.



369
370
371

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 369

def exchange_rate
  @exchange_rate
end

#inclusive_of_tax ⇒ `Boolean` (readonly)

Returns If the transaction is inclusive or exclusive of tax. True if inclusive, False if exclusive.

Returns:

(Boolean) —
If the transaction is inclusive or exclusive of tax. True if inclusive, False if exclusive.



380
381
382

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 380

def inclusive_of_tax
  @inclusive_of_tax
end

#integration_params ⇒ `Hash{String => Object}` (readonly)

Returns:

(Hash{String => Object})



394
395
396

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 394

def integration_params
  @integration_params
end

#issue_date ⇒ `DateTime` (readonly)

Returns The invoice's issue date.

Returns:

(DateTime) —
The invoice's issue date.



41
42
43

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 41

def issue_date
  @issue_date
end

#line_items ⇒ `Array<Merge::Accounting::InvoiceLineItemRequest>` (readonly)

Returns:

(Array<Merge::Accounting::InvoiceLineItemRequest>)



390
391
392

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 390

def line_items
  @line_items
end

#linked_account_params ⇒ `Hash{String => Object}` (readonly)

Returns:

(Hash{String => Object})



396
397
398

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 396

def linked_account_params
  @linked_account_params
end

#memo ⇒ `String` (readonly)

Returns The invoice's private note.

Returns:

(String) —
The invoice's private note.



49
50
51

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 49

def memo
  @memo
end

#number ⇒ `String` (readonly)

Returns The invoice's number.

Returns:

(String) —
The invoice's number.



39
40
41

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 39

def number
  @number
end

#paid_on_date ⇒ `DateTime` (readonly)

Returns The invoice's paid date.

Returns:

(DateTime) —
The invoice's paid date.



45
46
47

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 45

def paid_on_date
  @paid_on_date
end

#payment_term ⇒ `Merge::Accounting::InvoiceRequestPaymentTerm` (readonly)

Returns The payment term that applies to this transaction.

Returns:

(Merge::Accounting::InvoiceRequestPaymentTerm) —
The payment term that applies to this transaction.



375
376
377

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 375

def payment_term
  @payment_term
end

#payments ⇒ `Array<Merge::Accounting::InvoiceRequestPaymentsItem>` (readonly)

Returns Array of Payment object IDs.

Returns:

(Array<Merge::Accounting::InvoiceRequestPaymentsItem>) —
Array of Payment object IDs.



386
387
388

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 386

def payments
  @payments
end

#purchase_orders ⇒ `Array<Merge::Accounting::InvoiceRequestPurchaseOrdersItem>` (readonly)

Returns:

(Array<Merge::Accounting::InvoiceRequestPurchaseOrdersItem>)



392
393
394

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 392

def purchase_orders
  @purchase_orders
end

#remote_fields ⇒ `Array<Merge::Accounting::RemoteFieldRequest>` (readonly)

Returns:

(Array<Merge::Accounting::RemoteFieldRequest>)



398
399
400

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 398

def remote_fields
  @remote_fields
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.

Returns:

(Merge::Accounting::InvoiceStatusEnum) —
The status of the invoice.
- PAID - PAID
- DRAFT - DRAFT
- SUBMITTED - SUBMITTED
- PARTIALLY_PAID - PARTIALLY_PAID
- OPEN - OPEN
- VOID - VOID



57
58
59

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 57

def status
  @status
end

#sub_total ⇒ `Float` (readonly)

Returns The total amount being paid before taxes.

Returns:

(Float) —
The total amount being paid before taxes.



373
374
375

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 373

def sub_total
  @sub_total
end

#total_amount ⇒ `Float` (readonly)

Returns The invoice's total amount.

Returns:

(Float) —
The invoice's total amount.



382
383
384

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 382

def total_amount
  @total_amount
end

#total_discount ⇒ `Float` (readonly)

Returns The total discounts applied to the total cost.

Returns:

(Float) —
The total discounts applied to the total cost.



371
372
373

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 371

def total_discount
  @total_discount
end

#total_tax_amount ⇒ `Float` (readonly)

Returns The total amount being paid in taxes.

Returns:

(Float) —
The total amount being paid in taxes.



377
378
379

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 377

def total_tax_amount
  @total_tax_amount
end

#tracking_categories ⇒ `Array<Merge::Accounting::InvoiceRequestTrackingCategoriesItem>` (readonly)

Returns:

(Array<Merge::Accounting::InvoiceRequestTrackingCategoriesItem>)



388
389
390

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 388

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.

Returns:

(Merge::Accounting::InvoiceTypeEnum) —
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



35
36
37

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 35

def type
  @type
end

Class Method Details

.from_json(json_object:) ⇒ `Merge::Accounting::InvoiceRequest`

Deserialize a JSON object to an instance of InvoiceRequest

Parameters:

json_object (String)

Returns:

(Merge::Accounting::InvoiceRequest)

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 817

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?)
  if parsed_json["employee"].nil?
    employee = nil
  else
    employee = parsed_json["employee"].to_json
    employee = Merge::Accounting::InvoiceRequestEmployee.from_json(json_object: employee)
  end
  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"]
  if parsed_json["payment_term"].nil?
    payment_term = nil
  else
    payment_term = parsed_json["payment_term"].to_json
    payment_term = Merge::Accounting::InvoiceRequestPaymentTerm.from_json(json_object: payment_term)
  end
  total_tax_amount = parsed_json["total_tax_amount"]
  inclusive_of_tax = parsed_json["inclusive_of_tax"]
  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"]
  remote_fields = parsed_json["remote_fields"]&.map do |item|
    item = item.to_json
    Merge::Accounting::RemoteFieldRequest.from_json(json_object: item)
  end
  new(
    type: type,
    contact: contact,
    number: number,
    issue_date: issue_date,
    due_date: due_date,
    paid_on_date: paid_on_date,
    employee: employee,
    memo: memo,
    status: status,
    company: company,
    currency: currency,
    exchange_rate: exchange_rate,
    total_discount: total_discount,
    sub_total: sub_total,
    payment_term: payment_term,
    total_tax_amount: total_tax_amount,
    inclusive_of_tax: inclusive_of_tax,
    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,
    remote_fields: remote_fields,
    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)

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 925

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.employee.nil? || Merge::Accounting::InvoiceRequestEmployee.validate_raw(obj: obj.employee)
  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::TransactionCurrencyEnum) != 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.payment_term.nil? || Merge::Accounting::InvoiceRequestPaymentTerm.validate_raw(obj: obj.payment_term)
  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.inclusive_of_tax&.is_a?(Boolean) != false || raise("Passed value for field obj.inclusive_of_tax 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.")
  obj.remote_fields&.is_a?(Array) != false || raise("Passed value for field obj.remote_fields is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ `String`

Serialize an instance of InvoiceRequest to a JSON object

Returns:

(String)



915
916
917

# File 'lib/merge_ruby_client/accounting/types/invoice_request.rb', line 915

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

Class: Merge::Accounting::InvoiceRequest

Overview

The Invoice Object

Description

Usage Example

Constant Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

#balance ⇒ Float (readonly)

#company ⇒ Merge::Accounting::InvoiceRequestCompany (readonly)

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

#currency ⇒ Merge::Accounting::TransactionCurrencyEnum (readonly)

#due_date ⇒ DateTime (readonly)

#employee ⇒ Merge::Accounting::InvoiceRequestEmployee (readonly)

#exchange_rate ⇒ String (readonly)

#inclusive_of_tax ⇒ Boolean (readonly)

#integration_params ⇒ Hash{String => Object} (readonly)

#issue_date ⇒ DateTime (readonly)

#line_items ⇒ Array<Merge::Accounting::InvoiceLineItemRequest> (readonly)

#linked_account_params ⇒ Hash{String => Object} (readonly)

#memo ⇒ String (readonly)

#number ⇒ String (readonly)

#paid_on_date ⇒ DateTime (readonly)

#payment_term ⇒ Merge::Accounting::InvoiceRequestPaymentTerm (readonly)

#payments ⇒ Array<Merge::Accounting::InvoiceRequestPaymentsItem> (readonly)

#purchase_orders ⇒ Array<Merge::Accounting::InvoiceRequestPurchaseOrdersItem> (readonly)

#remote_fields ⇒ Array<Merge::Accounting::RemoteFieldRequest> (readonly)

#status ⇒ Merge::Accounting::InvoiceStatusEnum (readonly)

#sub_total ⇒ Float (readonly)

#total_amount ⇒ Float (readonly)

#total_discount ⇒ Float (readonly)

#total_tax_amount ⇒ Float (readonly)

#tracking_categories ⇒ Array<Merge::Accounting::InvoiceRequestTrackingCategoriesItem> (readonly)

#type ⇒ Merge::Accounting::InvoiceTypeEnum (readonly)

Class Method Details

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

.validate_raw(obj:) ⇒ Void

Instance Method Details

#to_json(*_args) ⇒ String

#additional_properties ⇒ `OpenStruct` (readonly)

#balance ⇒ `Float` (readonly)

#company ⇒ `Merge::Accounting::InvoiceRequestCompany` (readonly)

#contact ⇒ `Merge::Accounting::InvoiceRequestContact` (readonly)

#currency ⇒ `Merge::Accounting::TransactionCurrencyEnum` (readonly)

#due_date ⇒ `DateTime` (readonly)

#employee ⇒ `Merge::Accounting::InvoiceRequestEmployee` (readonly)

#exchange_rate ⇒ `String` (readonly)

#inclusive_of_tax ⇒ `Boolean` (readonly)

#integration_params ⇒ `Hash{String => Object}` (readonly)

#issue_date ⇒ `DateTime` (readonly)

#line_items ⇒ `Array<Merge::Accounting::InvoiceLineItemRequest>` (readonly)

#linked_account_params ⇒ `Hash{String => Object}` (readonly)

#memo ⇒ `String` (readonly)

#number ⇒ `String` (readonly)

#paid_on_date ⇒ `DateTime` (readonly)

#payment_term ⇒ `Merge::Accounting::InvoiceRequestPaymentTerm` (readonly)

#payments ⇒ `Array<Merge::Accounting::InvoiceRequestPaymentsItem>` (readonly)

#purchase_orders ⇒ `Array<Merge::Accounting::InvoiceRequestPurchaseOrdersItem>` (readonly)

#remote_fields ⇒ `Array<Merge::Accounting::RemoteFieldRequest>` (readonly)

#status ⇒ `Merge::Accounting::InvoiceStatusEnum` (readonly)

#sub_total ⇒ `Float` (readonly)

#total_amount ⇒ `Float` (readonly)

#total_discount ⇒ `Float` (readonly)

#total_tax_amount ⇒ `Float` (readonly)

#tracking_categories ⇒ `Array<Merge::Accounting::InvoiceRequestTrackingCategoriesItem>` (readonly)

#type ⇒ `Merge::Accounting::InvoiceTypeEnum` (readonly)

.from_json(json_object:) ⇒ `Merge::Accounting::InvoiceRequest`

.validate_raw(obj:) ⇒ `Void`

#to_json(*_args) ⇒ `String`