Class: Merge::Accounting::InvoiceLineItemRequest

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

Overview

# The InvoiceLineItem Object

### Description
The `InvoiceLineItem` object represents an itemized record of goods and/or
services sold to a customer.
### Usage Example
Fetch from the `GET Invoice` endpoint and view the invoice's line items.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(remote_id: OMIT, description: OMIT, unit_price: OMIT, quantity: OMIT, total_amount: OMIT, currency: OMIT, exchange_rate: OMIT, item: OMIT, account: OMIT, tracking_category: OMIT, tracking_categories: OMIT, company: OMIT, integration_params: OMIT, linked_account_params: OMIT, additional_properties: nil) ⇒ Merge::Accounting::InvoiceLineItemRequest

Parameters:

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

    The third-party API ID of the matching object.

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

    The line item’s description.

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

    The line item’s unit price.

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

    The line item’s quantity.

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

    The line item’s total amount.

  • currency (Merge::Accounting::CurrencyEnum) (defaults to: OMIT) —

    The line item’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 line item’s exchange rate.

  • item (Merge::Accounting::InvoiceLineItemRequestItem) (defaults to: OMIT)
  • account (Merge::Accounting::InvoiceLineItemRequestAccount) (defaults to: OMIT)
  • tracking_category (Merge::Accounting::InvoiceLineItemRequestTrackingCategory) (defaults to: OMIT)
  • tracking_categories (Array<Merge::Accounting::InvoiceLineItemRequestTrackingCategoriesItem>) (defaults to: OMIT)
  • company (String) (defaults to: OMIT) —

    The company the line item belongs to.

  • integration_params (Hash{String => Object}) (defaults to: OMIT)
  • linked_account_params (Hash{String => Object}) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
 
# File 'lib/merge_ruby_client/accounting/types/invoice_line_item_request.rb', line 684

def initialize(remote_id: OMIT, description: OMIT, unit_price: OMIT, quantity: OMIT, total_amount: OMIT,
               currency: OMIT, exchange_rate: OMIT, item: OMIT, account: OMIT, tracking_category: OMIT, tracking_categories: OMIT, company: OMIT, integration_params: OMIT, linked_account_params: OMIT, additional_properties: nil)
  @remote_id = remote_id if remote_id != OMIT
  @description = description if description != OMIT
  @unit_price = unit_price if unit_price != OMIT
  @quantity = quantity if quantity != OMIT
  @total_amount = total_amount if total_amount != OMIT
  @currency = currency if currency != OMIT
  @exchange_rate = exchange_rate if exchange_rate != OMIT
  @item = item if item != OMIT
  @account =  if  != OMIT
  @tracking_category = tracking_category if tracking_category != OMIT
  @tracking_categories = tracking_categories if tracking_categories != OMIT
  @company = company if company != OMIT
  @integration_params = integration_params if integration_params != OMIT
  @linked_account_params =  if  != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "remote_id": remote_id,
    "description": description,
    "unit_price": unit_price,
    "quantity": quantity,
    "total_amount": total_amount,
    "currency": currency,
    "exchange_rate": exchange_rate,
    "item": item,
    "account": ,
    "tracking_category": tracking_category,
    "tracking_categories": tracking_categories,
    "company": company,
    "integration_params": integration_params,
    "linked_account_params": 
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

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

Returns:



343
344
345
 
# File 'lib/merge_ruby_client/accounting/types/invoice_line_item_request.rb', line 343

def 
  @account
end

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



355
356
357
 
# File 'lib/merge_ruby_client/accounting/types/invoice_line_item_request.rb', line 355

def additional_properties
  @additional_properties
end

#company ⇒ String (readonly)

Returns The company the line item belongs to.

Returns:

  • (String) —

    The company the line item belongs to.



349
350
351
 
# File 'lib/merge_ruby_client/accounting/types/invoice_line_item_request.rb', line 349

def company
  @company
end

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

Returns The line item’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::CurrencyEnum) —

    The line item’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)



337
338
339
 
# File 'lib/merge_ruby_client/accounting/types/invoice_line_item_request.rb', line 337

def currency
  @currency
end

#description ⇒ String (readonly)

Returns The line item’s description.

Returns:

  • (String) —

    The line item’s description.



23
24
25
 
# File 'lib/merge_ruby_client/accounting/types/invoice_line_item_request.rb', line 23

def description
  @description
end

#exchange_rate ⇒ String (readonly)

Returns The line item’s exchange rate.

Returns:

  • (String) —

    The line item’s exchange rate.



339
340
341
 
# File 'lib/merge_ruby_client/accounting/types/invoice_line_item_request.rb', line 339

def exchange_rate
  @exchange_rate
end

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

Returns:

  • (Hash{String => Object}) 


351
352
353
 
# File 'lib/merge_ruby_client/accounting/types/invoice_line_item_request.rb', line 351

def integration_params
  @integration_params
end

#item ⇒ Merge::Accounting::InvoiceLineItemRequestItem (readonly)

Returns:



341
342
343
 
# File 'lib/merge_ruby_client/accounting/types/invoice_line_item_request.rb', line 341

def item
  @item
end

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

Returns:

  • (Hash{String => Object}) 


353
354
355
 
# File 'lib/merge_ruby_client/accounting/types/invoice_line_item_request.rb', line 353

def 
  @linked_account_params
end

#quantity ⇒ Float (readonly)

Returns The line item’s quantity.

Returns:

  • (Float) —

    The line item’s quantity.



27
28
29
 
# File 'lib/merge_ruby_client/accounting/types/invoice_line_item_request.rb', line 27

def quantity
  @quantity
end

#remote_id ⇒ String (readonly)

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

Returns:

  • (String) —

    The third-party API ID of the matching object.



21
22
23
 
# File 'lib/merge_ruby_client/accounting/types/invoice_line_item_request.rb', line 21

def remote_id
  @remote_id
end

#total_amount ⇒ Float (readonly)

Returns The line item’s total amount.

Returns:

  • (Float) —

    The line item’s total amount.



29
30
31
 
# File 'lib/merge_ruby_client/accounting/types/invoice_line_item_request.rb', line 29

def total_amount
  @total_amount
end

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

Returns:



347
348
349
 
# File 'lib/merge_ruby_client/accounting/types/invoice_line_item_request.rb', line 347

def tracking_categories
  @tracking_categories
end

#tracking_category ⇒ Merge::Accounting::InvoiceLineItemRequestTrackingCategory (readonly)

Returns:



345
346
347
 
# File 'lib/merge_ruby_client/accounting/types/invoice_line_item_request.rb', line 345

def tracking_category
  @tracking_category
end

#unit_price ⇒ Float (readonly)

Returns The line item’s unit price.

Returns:

  • (Float) —

    The line item’s unit price.



25
26
27
 
# File 'lib/merge_ruby_client/accounting/types/invoice_line_item_request.rb', line 25

def unit_price
  @unit_price
end

Class Method Details

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

Deserialize a JSON object to an instance of InvoiceLineItemRequest

Parameters:

  • json_object (String)

Returns:



725
726
727
728
729
730
731
732
733
734
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
 
# File 'lib/merge_ruby_client/accounting/types/invoice_line_item_request.rb', line 725

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  remote_id = parsed_json["remote_id"]
  description = parsed_json["description"]
  unit_price = parsed_json["unit_price"]
  quantity = parsed_json["quantity"]
  total_amount = parsed_json["total_amount"]
  currency = parsed_json["currency"]
  exchange_rate = parsed_json["exchange_rate"]
  if parsed_json["item"].nil?
    item = nil
  else
    item = parsed_json["item"].to_json
    item = Merge::Accounting::InvoiceLineItemRequestItem.from_json(json_object: item)
  end
  if parsed_json["account"].nil?
     = nil
  else
     = parsed_json["account"].to_json
     = Merge::Accounting::InvoiceLineItemRequestAccount.from_json(json_object: )
  end
  if parsed_json["tracking_category"].nil?
    tracking_category = nil
  else
    tracking_category = parsed_json["tracking_category"].to_json
    tracking_category = Merge::Accounting::InvoiceLineItemRequestTrackingCategory.from_json(json_object: tracking_category)
  end
  tracking_categories = parsed_json["tracking_categories"]&.map do |item|
    item = item.to_json
    Merge::Accounting::InvoiceLineItemRequestTrackingCategoriesItem.from_json(json_object: item)
  end
  company = parsed_json["company"]
  integration_params = parsed_json["integration_params"]
   = parsed_json["linked_account_params"]
  new(
    remote_id: remote_id,
    description: description,
    unit_price: unit_price,
    quantity: quantity,
    total_amount: total_amount,
    currency: currency,
    exchange_rate: exchange_rate,
    item: item,
    account: ,
    tracking_category: tracking_category,
    tracking_categories: tracking_categories,
    company: company,
    integration_params: integration_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.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
 
# File 'lib/merge_ruby_client/accounting/types/invoice_line_item_request.rb', line 792

def self.validate_raw(obj:)
  obj.remote_id&.is_a?(String) != false || raise("Passed value for field obj.remote_id is not the expected type, validation failed.")
  obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
  obj.unit_price&.is_a?(Float) != false || raise("Passed value for field obj.unit_price is not the expected type, validation failed.")
  obj.quantity&.is_a?(Float) != false || raise("Passed value for field obj.quantity 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.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.item.nil? || Merge::Accounting::InvoiceLineItemRequestItem.validate_raw(obj: obj.item)
  obj..nil? || Merge::Accounting::InvoiceLineItemRequestAccount.validate_raw(obj: obj.)
  obj.tracking_category.nil? || Merge::Accounting::InvoiceLineItemRequestTrackingCategory.validate_raw(obj: obj.tracking_category)
  obj.tracking_categories&.is_a?(Array) != false || raise("Passed value for field obj.tracking_categories is not the expected type, validation failed.")
  obj.company&.is_a?(String) != false || raise("Passed value for field obj.company 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.&.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 InvoiceLineItemRequest to a JSON object

Returns:

  • (String) 


782
783
784
 
# File 'lib/merge_ruby_client/accounting/types/invoice_line_item_request.rb', line 782

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