Class: Merge::Accounting::PurchaseOrder

Inherits:

Object

Object
Merge::Accounting::PurchaseOrder

show all

Defined in:: lib/merge_ruby_client/accounting/types/purchase_order.rb

Overview

The PurchaseOrder Object

Description

A PurchaseOrder represents a request to purchase goods or services from a vendor. It outlines the details of the purchase, such as the items or services requested, quantities, prices, and delivery details. A PurchaseOrder is a crucial component of the procurement process, but does not typically result in any impact on the company’s general ledger. The general ledger is typically only affected when the PurchaseOrder is fulfilled as an Accounts Payable Invoice object (also known as a Bill).

Usage Example

Fetch from the LIST PurchaseOrders endpoint and view a company's purchase orders.

Constant Summary collapse

OMIT =

Object.new

Instance Attribute Summary collapse

#accounting_period ⇒ Merge::Accounting::PurchaseOrderAccountingPeriod readonly
The accounting period that the PurchaseOrder was generated in.
#additional_properties ⇒ OpenStruct readonly
Additional properties unmapped to the current class definition.
#company ⇒ Merge::Accounting::PurchaseOrderCompany readonly
The company the purchase order belongs to.
#created_at ⇒ DateTime readonly
The datetime that this object was created by Merge.
#currency ⇒ Merge::Accounting::TransactionCurrencyEnum readonly
The purchase order's currency.
#customer ⇒ String readonly
The contact making the purchase order.
#delivery_address ⇒ Merge::Accounting::PurchaseOrderDeliveryAddress readonly
The purchase order's delivery address.
#delivery_date ⇒ DateTime readonly
The purchase order's delivery date.
#exchange_rate ⇒ String readonly
The purchase order's exchange rate.
#field_mappings ⇒ Hash{String => Object} readonly
#id ⇒ String readonly
#inclusive_of_tax ⇒ Boolean readonly
If the transaction is inclusive or exclusive of tax.
#issue_date ⇒ DateTime readonly
The purchase order's issue date.
#line_items ⇒ Array<Merge::Accounting::PurchaseOrderLineItem> readonly
#memo ⇒ String readonly
A memo attached to the purchase order.
#modified_at ⇒ DateTime readonly
The datetime that this object was modified by Merge.
#payment_term ⇒ Merge::Accounting::PurchaseOrderPaymentTerm readonly
The payment term that applies to this transaction.
#purchase_order_number ⇒ String readonly
The human-readable number of the purchase order.
#remote_created_at ⇒ DateTime readonly
When the third party's purchase order note was created.
#remote_data ⇒ Array<Merge::Accounting::RemoteData> readonly
#remote_fields ⇒ Array<Merge::Accounting::RemoteField> readonly
#remote_id ⇒ String readonly
The third-party API ID of the matching object.
#remote_updated_at ⇒ DateTime readonly
When the third party's purchase order note was updated.
#remote_was_deleted ⇒ Boolean readonly
Indicates whether or not this object has been deleted in the third party platform.
#status ⇒ Merge::Accounting::PurchaseOrderStatusEnum readonly
The purchase order's status.
#total_amount ⇒ Float readonly
The purchase order's total amount.
#tracking_categories ⇒ Array<Merge::Accounting::PurchaseOrderTrackingCategoriesItem> readonly
#vendor ⇒ Merge::Accounting::PurchaseOrderVendor readonly
The party fulfilling the purchase order.

Class Method Summary collapse

.from_json(json_object:) ⇒ Merge::Accounting::PurchaseOrder
Deserialize a JSON object to an instance of PurchaseOrder.
.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(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, status: OMIT, issue_date: OMIT, purchase_order_number: OMIT, delivery_date: OMIT, delivery_address: OMIT, customer: OMIT, vendor: OMIT, memo: OMIT, company: OMIT, total_amount: OMIT, currency: OMIT, exchange_rate: OMIT, payment_term: OMIT, line_items: OMIT, inclusive_of_tax: OMIT, tracking_categories: OMIT, accounting_period: OMIT, remote_created_at: OMIT, remote_updated_at: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, remote_fields: OMIT, additional_properties: nil) ⇒ `Merge::Accounting::PurchaseOrder`

Parameters:

id (String) (defaults to: OMIT)
remote_id (String) (defaults to: OMIT) —
The third-party API ID of the matching object.
created_at (DateTime) (defaults to: OMIT) —
The datetime that this object was created by Merge.
modified_at (DateTime) (defaults to: OMIT) —
The datetime that this object was modified by Merge.
status (Merge::Accounting::PurchaseOrderStatusEnum) (defaults to: OMIT) —
The purchase order's status.
- DRAFT - DRAFT
- SUBMITTED - SUBMITTED
- AUTHORIZED - AUTHORIZED
- BILLED - BILLED
- DELETED - DELETED
issue_date (DateTime) (defaults to: OMIT) —
The purchase order's issue date.
purchase_order_number (String) (defaults to: OMIT) —
The human-readable number of the purchase order.
delivery_date (DateTime) (defaults to: OMIT) —
The purchase order's delivery date.
delivery_address (Merge::Accounting::PurchaseOrderDeliveryAddress) (defaults to: OMIT) —
The purchase order's delivery address.
customer (String) (defaults to: OMIT) —
The contact making the purchase order.
vendor (Merge::Accounting::PurchaseOrderVendor) (defaults to: OMIT) —
The party fulfilling the purchase order.
memo (String) (defaults to: OMIT) —
A memo attached to the purchase order.
company (Merge::Accounting::PurchaseOrderCompany) (defaults to: OMIT) —
The company the purchase order belongs to.
total_amount (Float) (defaults to: OMIT) —
The purchase order's total amount.
currency (Merge::Accounting::TransactionCurrencyEnum) (defaults to: OMIT) —
The purchase order'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 purchase order's exchange rate.
payment_term (Merge::Accounting::PurchaseOrderPaymentTerm) (defaults to: OMIT) —
The payment term that applies to this transaction.
line_items (Array<Merge::Accounting::PurchaseOrderLineItem>) (defaults to: OMIT)
inclusive_of_tax (Boolean) (defaults to: OMIT) —
If the transaction is inclusive or exclusive of tax. True if inclusive, False if exclusive.
tracking_categories (Array<Merge::Accounting::PurchaseOrderTrackingCategoriesItem>) (defaults to: OMIT)
accounting_period (Merge::Accounting::PurchaseOrderAccountingPeriod) (defaults to: OMIT) —
The accounting period that the PurchaseOrder was generated in.
remote_created_at (DateTime) (defaults to: OMIT) —
When the third party's purchase order note was created.
remote_updated_at (DateTime) (defaults to: OMIT) —
When the third party's purchase order note was updated.
remote_was_deleted (Boolean) (defaults to: OMIT) —
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
field_mappings (Hash{String => Object}) (defaults to: OMIT)
remote_data (Array<Merge::Accounting::RemoteData>) (defaults to: OMIT)
remote_fields (Array<Merge::Accounting::RemoteField>) (defaults to: OMIT)
additional_properties (OpenStruct) (defaults to: nil) —
Additional properties unmapped to the current class definition

# File 'lib/merge_ruby_client/accounting/types/purchase_order.rb', line 754

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, status: OMIT, issue_date: OMIT,
               purchase_order_number: OMIT, delivery_date: OMIT, delivery_address: OMIT, customer: OMIT, vendor: OMIT, memo: OMIT, company: OMIT, total_amount: OMIT, currency: OMIT, exchange_rate: OMIT, payment_term: OMIT, line_items: OMIT, inclusive_of_tax: OMIT, tracking_categories: OMIT, accounting_period: OMIT, remote_created_at: OMIT, remote_updated_at: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, remote_fields: OMIT, additional_properties: nil)
  @id = id if id != OMIT
  @remote_id = remote_id if remote_id != OMIT
  @created_at = created_at if created_at != OMIT
  @modified_at = modified_at if modified_at != OMIT
  @status = status if status != OMIT
  @issue_date = issue_date if issue_date != OMIT
  @purchase_order_number = purchase_order_number if purchase_order_number != OMIT
  @delivery_date = delivery_date if delivery_date != OMIT
  @delivery_address = delivery_address if delivery_address != OMIT
  @customer = customer if customer != OMIT
  @vendor = vendor if vendor != OMIT
  @memo = memo if memo != OMIT
  @company = company if company != OMIT
  @total_amount = total_amount if total_amount != OMIT
  @currency = currency if currency != OMIT
  @exchange_rate = exchange_rate if exchange_rate != OMIT
  @payment_term = payment_term if payment_term != OMIT
  @line_items = line_items if line_items != OMIT
  @inclusive_of_tax = inclusive_of_tax if inclusive_of_tax != OMIT
  @tracking_categories = tracking_categories if tracking_categories != OMIT
  @accounting_period = accounting_period if accounting_period != OMIT
  @remote_created_at = remote_created_at if remote_created_at != OMIT
  @remote_updated_at = remote_updated_at if remote_updated_at != OMIT
  @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT
  @field_mappings = field_mappings if field_mappings != OMIT
  @remote_data = remote_data if remote_data != OMIT
  @remote_fields = remote_fields if remote_fields != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "id": id,
    "remote_id": remote_id,
    "created_at": created_at,
    "modified_at": modified_at,
    "status": status,
    "issue_date": issue_date,
    "purchase_order_number": purchase_order_number,
    "delivery_date": delivery_date,
    "delivery_address": delivery_address,
    "customer": customer,
    "vendor": vendor,
    "memo": memo,
    "company": company,
    "total_amount": total_amount,
    "currency": currency,
    "exchange_rate": exchange_rate,
    "payment_term": payment_term,
    "line_items": line_items,
    "inclusive_of_tax": inclusive_of_tax,
    "tracking_categories": tracking_categories,
    "accounting_period": accounting_period,
    "remote_created_at": remote_created_at,
    "remote_updated_at": remote_updated_at,
    "remote_was_deleted": remote_was_deleted,
    "field_mappings": field_mappings,
    "remote_data": remote_data,
    "remote_fields": remote_fields
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#accounting_period ⇒ `Merge::Accounting::PurchaseOrderAccountingPeriod` (readonly)

Returns The accounting period that the PurchaseOrder was generated in.

Returns:

(Merge::Accounting::PurchaseOrderAccountingPeriod) —
The accounting period that the PurchaseOrder was generated in.



386
387
388

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

def accounting_period
  @accounting_period
end

#additional_properties ⇒ `OpenStruct` (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

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



403
404
405

# File 'lib/merge_ruby_client/accounting/types/purchase_order.rb', line 403

def additional_properties
  @additional_properties
end

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

Returns The company the purchase order belongs to.

Returns:

(Merge::Accounting::PurchaseOrderCompany) —
The company the purchase order belongs to.



63
64
65

# File 'lib/merge_ruby_client/accounting/types/purchase_order.rb', line 63

def company
  @company
end

#created_at ⇒ `DateTime` (readonly)

Returns The datetime that this object was created by Merge.

Returns:

(DateTime) —
The datetime that this object was created by Merge.



38
39
40

# File 'lib/merge_ruby_client/accounting/types/purchase_order.rb', line 38

def created_at
  @created_at
end

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

Returns The purchase order'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 purchase order'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)



373
374
375

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

def currency
  @currency
end

#customer ⇒ `String` (readonly)

Returns The contact making the purchase order.

Returns:

(String) —
The contact making the purchase order.



57
58
59

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

def customer
  @customer
end

#delivery_address ⇒ `Merge::Accounting::PurchaseOrderDeliveryAddress` (readonly)

Returns The purchase order's delivery address.

Returns:

(Merge::Accounting::PurchaseOrderDeliveryAddress) —
The purchase order's delivery address.



55
56
57

# File 'lib/merge_ruby_client/accounting/types/purchase_order.rb', line 55

def delivery_address
  @delivery_address
end

#delivery_date ⇒ `DateTime` (readonly)

Returns The purchase order's delivery date.

Returns:

(DateTime) —
The purchase order's delivery date.



53
54
55

# File 'lib/merge_ruby_client/accounting/types/purchase_order.rb', line 53

def delivery_date
  @delivery_date
end

#exchange_rate ⇒ `String` (readonly)

Returns The purchase order's exchange rate.

Returns:

(String) —
The purchase order's exchange rate.



375
376
377

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

def exchange_rate
  @exchange_rate
end

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

Returns:

(Hash{String => Object})



397
398
399

# File 'lib/merge_ruby_client/accounting/types/purchase_order.rb', line 397

def field_mappings
  @field_mappings
end

#id ⇒ `String` (readonly)

Returns:

(String)



34
35
36

# File 'lib/merge_ruby_client/accounting/types/purchase_order.rb', line 34

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



382
383
384

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

def inclusive_of_tax
  @inclusive_of_tax
end

#issue_date ⇒ `DateTime` (readonly)

Returns The purchase order's issue date.

Returns:

(DateTime) —
The purchase order's issue date.



49
50
51

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

def issue_date
  @issue_date
end

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

Returns:

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



379
380
381

# File 'lib/merge_ruby_client/accounting/types/purchase_order.rb', line 379

def line_items
  @line_items
end

#memo ⇒ `String` (readonly)

Returns A memo attached to the purchase order.

Returns:

(String) —
A memo attached to the purchase order.



61
62
63

# File 'lib/merge_ruby_client/accounting/types/purchase_order.rb', line 61

def memo
  @memo
end

#modified_at ⇒ `DateTime` (readonly)

Returns The datetime that this object was modified by Merge.

Returns:

(DateTime) —
The datetime that this object was modified by Merge.



40
41
42

# File 'lib/merge_ruby_client/accounting/types/purchase_order.rb', line 40

def modified_at
  @modified_at
end

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

Returns The payment term that applies to this transaction.

Returns:

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



377
378
379

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

def payment_term
  @payment_term
end

#purchase_order_number ⇒ `String` (readonly)

Returns The human-readable number of the purchase order.

Returns:

(String) —
The human-readable number of the purchase order.



51
52
53

# File 'lib/merge_ruby_client/accounting/types/purchase_order.rb', line 51

def purchase_order_number
  @purchase_order_number
end

#remote_created_at ⇒ `DateTime` (readonly)

Returns When the third party's purchase order note was created.

Returns:

(DateTime) —
When the third party's purchase order note was created.



388
389
390

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

def remote_created_at
  @remote_created_at
end

#remote_data ⇒ `Array<Merge::Accounting::RemoteData>` (readonly)

Returns:

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



399
400
401

# File 'lib/merge_ruby_client/accounting/types/purchase_order.rb', line 399

def remote_data
  @remote_data
end

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

Returns:

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



401
402
403

# File 'lib/merge_ruby_client/accounting/types/purchase_order.rb', line 401

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



36
37
38

# File 'lib/merge_ruby_client/accounting/types/purchase_order.rb', line 36

def remote_id
  @remote_id
end

#remote_updated_at ⇒ `DateTime` (readonly)

Returns When the third party's purchase order note was updated.

Returns:

(DateTime) —
When the third party's purchase order note was updated.



390
391
392

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

def remote_updated_at
  @remote_updated_at
end

#remote_was_deleted ⇒ `Boolean` (readonly)

Returns Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

Returns:

(Boolean) —
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.



395
396
397

# File 'lib/merge_ruby_client/accounting/types/purchase_order.rb', line 395

def remote_was_deleted
  @remote_was_deleted
end

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

Returns The purchase order's status.

DRAFT - DRAFT
SUBMITTED - SUBMITTED
AUTHORIZED - AUTHORIZED
BILLED - BILLED
DELETED - DELETED.

Returns:

(Merge::Accounting::PurchaseOrderStatusEnum) —
The purchase order's status.
- DRAFT - DRAFT
- SUBMITTED - SUBMITTED
- AUTHORIZED - AUTHORIZED
- BILLED - BILLED
- DELETED - DELETED



47
48
49

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

def status
  @status
end

#total_amount ⇒ `Float` (readonly)

Returns The purchase order's total amount.

Returns:

(Float) —
The purchase order's total amount.



65
66
67

# File 'lib/merge_ruby_client/accounting/types/purchase_order.rb', line 65

def total_amount
  @total_amount
end

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

Returns:

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



384
385
386

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

def tracking_categories
  @tracking_categories
end

#vendor ⇒ `Merge::Accounting::PurchaseOrderVendor` (readonly)

Returns The party fulfilling the purchase order.

Returns:

(Merge::Accounting::PurchaseOrderVendor) —
The party fulfilling the purchase order.



59
60
61

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

def vendor
  @vendor
end

Class Method Details

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

Deserialize a JSON object to an instance of PurchaseOrder

Parameters:

json_object (String)

Returns:

(Merge::Accounting::PurchaseOrder)

# File 'lib/merge_ruby_client/accounting/types/purchase_order.rb', line 821

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = parsed_json["id"]
  remote_id = parsed_json["remote_id"]
  created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
  modified_at = (DateTime.parse(parsed_json["modified_at"]) unless parsed_json["modified_at"].nil?)
  status = parsed_json["status"]
  issue_date = (DateTime.parse(parsed_json["issue_date"]) unless parsed_json["issue_date"].nil?)
  purchase_order_number = parsed_json["purchase_order_number"]
  delivery_date = (DateTime.parse(parsed_json["delivery_date"]) unless parsed_json["delivery_date"].nil?)
  if parsed_json["delivery_address"].nil?
    delivery_address = nil
  else
    delivery_address = parsed_json["delivery_address"].to_json
    delivery_address = Merge::Accounting::PurchaseOrderDeliveryAddress.from_json(json_object: delivery_address)
  end
  customer = parsed_json["customer"]
  if parsed_json["vendor"].nil?
    vendor = nil
  else
    vendor = parsed_json["vendor"].to_json
    vendor = Merge::Accounting::PurchaseOrderVendor.from_json(json_object: vendor)
  end
  memo = parsed_json["memo"]
  if parsed_json["company"].nil?
    company = nil
  else
    company = parsed_json["company"].to_json
    company = Merge::Accounting::PurchaseOrderCompany.from_json(json_object: company)
  end
  total_amount = parsed_json["total_amount"]
  currency = parsed_json["currency"]
  exchange_rate = parsed_json["exchange_rate"]
  if parsed_json["payment_term"].nil?
    payment_term = nil
  else
    payment_term = parsed_json["payment_term"].to_json
    payment_term = Merge::Accounting::PurchaseOrderPaymentTerm.from_json(json_object: payment_term)
  end
  line_items = parsed_json["line_items"]&.map do |item|
    item = item.to_json
    Merge::Accounting::PurchaseOrderLineItem.from_json(json_object: item)
  end
  inclusive_of_tax = parsed_json["inclusive_of_tax"]
  tracking_categories = parsed_json["tracking_categories"]&.map do |item|
    item = item.to_json
    Merge::Accounting::PurchaseOrderTrackingCategoriesItem.from_json(json_object: item)
  end
  if parsed_json["accounting_period"].nil?
    accounting_period = nil
  else
    accounting_period = parsed_json["accounting_period"].to_json
    accounting_period = Merge::Accounting::PurchaseOrderAccountingPeriod.from_json(json_object: accounting_period)
  end
  remote_created_at = unless parsed_json["remote_created_at"].nil?
                        DateTime.parse(parsed_json["remote_created_at"])
                      end
  remote_updated_at = unless parsed_json["remote_updated_at"].nil?
                        DateTime.parse(parsed_json["remote_updated_at"])
                      end
  remote_was_deleted = parsed_json["remote_was_deleted"]
  field_mappings = parsed_json["field_mappings"]
  remote_data = parsed_json["remote_data"]&.map do |item|
    item = item.to_json
    Merge::Accounting::RemoteData.from_json(json_object: item)
  end
  remote_fields = parsed_json["remote_fields"]&.map do |item|
    item = item.to_json
    Merge::Accounting::RemoteField.from_json(json_object: item)
  end
  new(
    id: id,
    remote_id: remote_id,
    created_at: created_at,
    modified_at: modified_at,
    status: status,
    issue_date: issue_date,
    purchase_order_number: purchase_order_number,
    delivery_date: delivery_date,
    delivery_address: delivery_address,
    customer: customer,
    vendor: vendor,
    memo: memo,
    company: company,
    total_amount: total_amount,
    currency: currency,
    exchange_rate: exchange_rate,
    payment_term: payment_term,
    line_items: line_items,
    inclusive_of_tax: inclusive_of_tax,
    tracking_categories: tracking_categories,
    accounting_period: accounting_period,
    remote_created_at: remote_created_at,
    remote_updated_at: remote_updated_at,
    remote_was_deleted: remote_was_deleted,
    field_mappings: field_mappings,
    remote_data: remote_data,
    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/purchase_order.rb', line 937

def self.validate_raw(obj:)
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.remote_id&.is_a?(String) != false || raise("Passed value for field obj.remote_id is not the expected type, validation failed.")
  obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
  obj.modified_at&.is_a?(DateTime) != false || raise("Passed value for field obj.modified_at is not the expected type, validation failed.")
  obj.status&.is_a?(Merge::Accounting::PurchaseOrderStatusEnum) != false || raise("Passed value for field obj.status 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.purchase_order_number&.is_a?(String) != false || raise("Passed value for field obj.purchase_order_number is not the expected type, validation failed.")
  obj.delivery_date&.is_a?(DateTime) != false || raise("Passed value for field obj.delivery_date is not the expected type, validation failed.")
  obj.delivery_address.nil? || Merge::Accounting::PurchaseOrderDeliveryAddress.validate_raw(obj: obj.delivery_address)
  obj.customer&.is_a?(String) != false || raise("Passed value for field obj.customer is not the expected type, validation failed.")
  obj.vendor.nil? || Merge::Accounting::PurchaseOrderVendor.validate_raw(obj: obj.vendor)
  obj.memo&.is_a?(String) != false || raise("Passed value for field obj.memo is not the expected type, validation failed.")
  obj.company.nil? || Merge::Accounting::PurchaseOrderCompany.validate_raw(obj: obj.company)
  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::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.payment_term.nil? || Merge::Accounting::PurchaseOrderPaymentTerm.validate_raw(obj: obj.payment_term)
  obj.line_items&.is_a?(Array) != false || raise("Passed value for field obj.line_items 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.tracking_categories&.is_a?(Array) != false || raise("Passed value for field obj.tracking_categories is not the expected type, validation failed.")
  obj.accounting_period.nil? || Merge::Accounting::PurchaseOrderAccountingPeriod.validate_raw(obj: obj.accounting_period)
  obj.remote_created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.remote_created_at is not the expected type, validation failed.")
  obj.remote_updated_at&.is_a?(DateTime) != false || raise("Passed value for field obj.remote_updated_at is not the expected type, validation failed.")
  obj.remote_was_deleted&.is_a?(Boolean) != false || raise("Passed value for field obj.remote_was_deleted is not the expected type, validation failed.")
  obj.field_mappings&.is_a?(Hash) != false || raise("Passed value for field obj.field_mappings is not the expected type, validation failed.")
  obj.remote_data&.is_a?(Array) != false || raise("Passed value for field obj.remote_data 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 PurchaseOrder to a JSON object

Returns:

(String)



927
928
929

# File 'lib/merge_ruby_client/accounting/types/purchase_order.rb', line 927

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

Class: Merge::Accounting::PurchaseOrder

Overview

The PurchaseOrder Object

Description

Usage Example

Constant Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

Instance Attribute Details

#accounting_period ⇒ Merge::Accounting::PurchaseOrderAccountingPeriod (readonly)

#additional_properties ⇒ OpenStruct (readonly)

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

#created_at ⇒ DateTime (readonly)

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

#customer ⇒ String (readonly)

#delivery_address ⇒ Merge::Accounting::PurchaseOrderDeliveryAddress (readonly)

#delivery_date ⇒ DateTime (readonly)

#exchange_rate ⇒ String (readonly)

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

#id ⇒ String (readonly)

#inclusive_of_tax ⇒ Boolean (readonly)

#issue_date ⇒ DateTime (readonly)

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

#memo ⇒ String (readonly)

#modified_at ⇒ DateTime (readonly)

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

#purchase_order_number ⇒ String (readonly)

#remote_created_at ⇒ DateTime (readonly)

#remote_data ⇒ Array<Merge::Accounting::RemoteData> (readonly)

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

#remote_id ⇒ String (readonly)

#remote_updated_at ⇒ DateTime (readonly)

#remote_was_deleted ⇒ Boolean (readonly)

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

#total_amount ⇒ Float (readonly)

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

#vendor ⇒ Merge::Accounting::PurchaseOrderVendor (readonly)

Class Method Details

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

.validate_raw(obj:) ⇒ Void

Instance Method Details

#to_json(*_args) ⇒ String

#accounting_period ⇒ `Merge::Accounting::PurchaseOrderAccountingPeriod` (readonly)

#additional_properties ⇒ `OpenStruct` (readonly)

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

#created_at ⇒ `DateTime` (readonly)

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

#customer ⇒ `String` (readonly)

#delivery_address ⇒ `Merge::Accounting::PurchaseOrderDeliveryAddress` (readonly)

#delivery_date ⇒ `DateTime` (readonly)

#exchange_rate ⇒ `String` (readonly)

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

#id ⇒ `String` (readonly)

#inclusive_of_tax ⇒ `Boolean` (readonly)

#issue_date ⇒ `DateTime` (readonly)

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

#memo ⇒ `String` (readonly)

#modified_at ⇒ `DateTime` (readonly)

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

#purchase_order_number ⇒ `String` (readonly)

#remote_created_at ⇒ `DateTime` (readonly)

#remote_data ⇒ `Array<Merge::Accounting::RemoteData>` (readonly)

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

#remote_id ⇒ `String` (readonly)

#remote_updated_at ⇒ `DateTime` (readonly)

#remote_was_deleted ⇒ `Boolean` (readonly)

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

#total_amount ⇒ `Float` (readonly)

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

#vendor ⇒ `Merge::Accounting::PurchaseOrderVendor` (readonly)

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

.validate_raw(obj:) ⇒ `Void`

#to_json(*_args) ⇒ `String`