Class: Merge::Accounting::Transaction

Inherits:

Object

Object
Merge::Accounting::Transaction

show all

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

Overview

The Transaction Object

Description

The Transaction common model includes records of all types of transactions that do not appear in other common models. The type of transaction can be identified through the type field. More specifically, it will contain all types of transactions outside of:

Credit Notes
Expenses
Invoices
Journal Entries
Payments
Purchase Orders
Vendor Credits

Usage Example

Fetch from the GET Transaction endpoint and view a company's transactions.

Constant Summary collapse

OMIT =

Object.new

Instance Attribute Summary collapse

#account ⇒ Merge::Accounting::TransactionAccount readonly
The transaction's account.
#accounting_period ⇒ Merge::Accounting::TransactionAccountingPeriod readonly
The accounting period that the Transaction was generated in.
#additional_properties ⇒ OpenStruct readonly
Additional properties unmapped to the current class definition.
#company ⇒ String readonly
The company the transaction belongs to.
#contact ⇒ Merge::Accounting::TransactionContact readonly
The contact to whom the transaction relates to.
#created_at ⇒ DateTime readonly
The datetime that this object was created by Merge.
#currency ⇒ Merge::Accounting::TransactionCurrencyEnum readonly
The transaction's currency.
#exchange_rate ⇒ String readonly
The transaction'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.
#line_items ⇒ Array<Merge::Accounting::TransactionLineItem> readonly
#modified_at ⇒ DateTime readonly
The datetime that this object was modified by Merge.
#number ⇒ String readonly
The transaction's number used for identifying purposes.
#remote_data ⇒ Array<Merge::Accounting::RemoteData> readonly
#remote_id ⇒ String readonly
The third-party API ID of the matching object.
#remote_was_deleted ⇒ Boolean readonly
Indicates whether or not this object has been deleted in the third party platform.
#total_amount ⇒ String readonly
The total amount being paid after taxes.
#tracking_categories ⇒ Array<Merge::Accounting::TransactionTrackingCategoriesItem> readonly
#transaction_date ⇒ DateTime readonly
The date upon which the transaction occurred.
#transaction_type ⇒ String readonly
The type of transaction, which can by any transaction object not already included in Merge’s common model.

Class Method Summary collapse

.from_json(json_object:) ⇒ Merge::Accounting::Transaction
Deserialize a JSON object to an instance of Transaction.
.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, transaction_type: OMIT, number: OMIT, transaction_date: OMIT, account: OMIT, contact: OMIT, inclusive_of_tax: OMIT, total_amount: OMIT, currency: OMIT, exchange_rate: OMIT, company: OMIT, tracking_categories: OMIT, line_items: OMIT, remote_was_deleted: OMIT, accounting_period: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ `Merge::Accounting::Transaction`

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.
transaction_type (String) (defaults to: OMIT) —
The type of transaction, which can by any transaction object not already included in Merge’s common model.
number (String) (defaults to: OMIT) —
The transaction's number used for identifying purposes.
transaction_date (DateTime) (defaults to: OMIT) —
The date upon which the transaction occurred.
account (Merge::Accounting::TransactionAccount) (defaults to: OMIT) —
The transaction's account.
contact (Merge::Accounting::TransactionContact) (defaults to: OMIT) —
The contact to whom the transaction relates to.
inclusive_of_tax (Boolean) (defaults to: OMIT) —
If the transaction is inclusive or exclusive of tax. True if inclusive, False if exclusive.
total_amount (String) (defaults to: OMIT) —
The total amount being paid after taxes.
currency (Merge::Accounting::TransactionCurrencyEnum) (defaults to: OMIT) —
The transaction'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 transaction's exchange rate.
company (String) (defaults to: OMIT) —
The company the transaction belongs to.
tracking_categories (Array<Merge::Accounting::TransactionTrackingCategoriesItem>) (defaults to: OMIT)
line_items (Array<Merge::Accounting::TransactionLineItem>) (defaults to: OMIT)
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.
accounting_period (Merge::Accounting::TransactionAccountingPeriod) (defaults to: OMIT) —
The accounting period that the Transaction was generated in.
field_mappings (Hash{String => Object}) (defaults to: OMIT)
remote_data (Array<Merge::Accounting::RemoteData>) (defaults to: OMIT)
additional_properties (OpenStruct) (defaults to: nil) —
Additional properties unmapped to the current class definition

# File 'lib/merge_ruby_client/accounting/types/transaction.rb', line 724

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, transaction_type: OMIT,
               number: OMIT, transaction_date: OMIT, account: OMIT, contact: OMIT, inclusive_of_tax: OMIT, total_amount: OMIT, currency: OMIT, exchange_rate: OMIT, company: OMIT, tracking_categories: OMIT, line_items: OMIT, remote_was_deleted: OMIT, accounting_period: OMIT, field_mappings: OMIT, remote_data: 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
  @transaction_type = transaction_type if transaction_type != OMIT
  @number = number if number != OMIT
  @transaction_date = transaction_date if transaction_date != OMIT
  @account = account if account != OMIT
  @contact = contact if contact != OMIT
  @inclusive_of_tax = inclusive_of_tax if inclusive_of_tax != OMIT
  @total_amount = total_amount if total_amount != OMIT
  @currency = currency if currency != OMIT
  @exchange_rate = exchange_rate if exchange_rate != OMIT
  @company = company if company != OMIT
  @tracking_categories = tracking_categories if tracking_categories != OMIT
  @line_items = line_items if line_items != OMIT
  @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT
  @accounting_period = accounting_period if accounting_period != OMIT
  @field_mappings = field_mappings if field_mappings != OMIT
  @remote_data = remote_data if remote_data != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "id": id,
    "remote_id": remote_id,
    "created_at": created_at,
    "modified_at": modified_at,
    "transaction_type": transaction_type,
    "number": number,
    "transaction_date": transaction_date,
    "account": account,
    "contact": contact,
    "inclusive_of_tax": inclusive_of_tax,
    "total_amount": total_amount,
    "currency": currency,
    "exchange_rate": exchange_rate,
    "company": company,
    "tracking_categories": tracking_categories,
    "line_items": line_items,
    "remote_was_deleted": remote_was_deleted,
    "accounting_period": accounting_period,
    "field_mappings": field_mappings,
    "remote_data": remote_data
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#account ⇒ `Merge::Accounting::TransactionAccount` (readonly)

Returns The transaction's account.

Returns:

(Merge::Accounting::TransactionAccount) —
The transaction's account.



48
49
50

# File 'lib/merge_ruby_client/accounting/types/transaction.rb', line 48

def account
  @account
end

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

Returns The accounting period that the Transaction was generated in.

Returns:

(Merge::Accounting::TransactionAccountingPeriod) —
The accounting period that the Transaction was generated in.



378
379
380

# File 'lib/merge_ruby_client/accounting/types/transaction.rb', line 378

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



384
385
386

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

def additional_properties
  @additional_properties
end

#company ⇒ `String` (readonly)

Returns The company the transaction belongs to.

Returns:

(String) —
The company the transaction belongs to.



367
368
369

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

def company
  @company
end

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

Returns The contact to whom the transaction relates to.

Returns:

(Merge::Accounting::TransactionContact) —
The contact to whom the transaction relates to.



50
51
52

# File 'lib/merge_ruby_client/accounting/types/transaction.rb', line 50

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



37
38
39

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

def created_at
  @created_at
end

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

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



363
364
365

# File 'lib/merge_ruby_client/accounting/types/transaction.rb', line 363

def currency
  @currency
end

#exchange_rate ⇒ `String` (readonly)

Returns The transaction's exchange rate.

Returns:

(String) —
The transaction's exchange rate.



365
366
367

# File 'lib/merge_ruby_client/accounting/types/transaction.rb', line 365

def exchange_rate
  @exchange_rate
end

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

Returns:

(Hash{String => Object})



380
381
382

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

def field_mappings
  @field_mappings
end

#id ⇒ `String` (readonly)

Returns:

(String)



33
34
35

# File 'lib/merge_ruby_client/accounting/types/transaction.rb', line 33

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.



53
54
55

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

def inclusive_of_tax
  @inclusive_of_tax
end

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

Returns:

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



371
372
373

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

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



39
40
41

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

def modified_at
  @modified_at
end

#number ⇒ `String` (readonly)

Returns The transaction's number used for identifying purposes.

Returns:

(String) —
The transaction's number used for identifying purposes.



44
45
46

# File 'lib/merge_ruby_client/accounting/types/transaction.rb', line 44

def number
  @number
end

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

Returns:

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



382
383
384

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

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



35
36
37

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

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



376
377
378

# File 'lib/merge_ruby_client/accounting/types/transaction.rb', line 376

def remote_was_deleted
  @remote_was_deleted
end

#total_amount ⇒ `String` (readonly)

Returns The total amount being paid after taxes.

Returns:

(String) —
The total amount being paid after taxes.



55
56
57

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

def total_amount
  @total_amount
end

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

Returns:

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



369
370
371

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

def tracking_categories
  @tracking_categories
end

#transaction_date ⇒ `DateTime` (readonly)

Returns The date upon which the transaction occurred.

Returns:

(DateTime) —
The date upon which the transaction occurred.



46
47
48

# File 'lib/merge_ruby_client/accounting/types/transaction.rb', line 46

def transaction_date
  @transaction_date
end

#transaction_type ⇒ `String` (readonly)

Returns The type of transaction, which can by any transaction object not already included in Merge’s common model.

Returns:

(String) —
The type of transaction, which can by any transaction object not already included in Merge’s common model.



42
43
44

# File 'lib/merge_ruby_client/accounting/types/transaction.rb', line 42

def transaction_type
  @transaction_type
end

Class Method Details

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

Deserialize a JSON object to an instance of Transaction

Parameters:

json_object (String)

Returns:

(Merge::Accounting::Transaction)

# File 'lib/merge_ruby_client/accounting/types/transaction.rb', line 777

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?)
  transaction_type = parsed_json["transaction_type"]
  number = parsed_json["number"]
  transaction_date = (DateTime.parse(parsed_json["transaction_date"]) unless parsed_json["transaction_date"].nil?)
  if parsed_json["account"].nil?
    account = nil
  else
    account = parsed_json["account"].to_json
    account = Merge::Accounting::TransactionAccount.from_json(json_object: account)
  end
  if parsed_json["contact"].nil?
    contact = nil
  else
    contact = parsed_json["contact"].to_json
    contact = Merge::Accounting::TransactionContact.from_json(json_object: contact)
  end
  inclusive_of_tax = parsed_json["inclusive_of_tax"]
  total_amount = parsed_json["total_amount"]
  currency = parsed_json["currency"]
  exchange_rate = parsed_json["exchange_rate"]
  company = parsed_json["company"]
  tracking_categories = parsed_json["tracking_categories"]&.map do |item|
    item = item.to_json
    Merge::Accounting::TransactionTrackingCategoriesItem.from_json(json_object: item)
  end
  line_items = parsed_json["line_items"]&.map do |item|
    item = item.to_json
    Merge::Accounting::TransactionLineItem.from_json(json_object: item)
  end
  remote_was_deleted = parsed_json["remote_was_deleted"]
  if parsed_json["accounting_period"].nil?
    accounting_period = nil
  else
    accounting_period = parsed_json["accounting_period"].to_json
    accounting_period = Merge::Accounting::TransactionAccountingPeriod.from_json(json_object: accounting_period)
  end
  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
  new(
    id: id,
    remote_id: remote_id,
    created_at: created_at,
    modified_at: modified_at,
    transaction_type: transaction_type,
    number: number,
    transaction_date: transaction_date,
    account: account,
    contact: contact,
    inclusive_of_tax: inclusive_of_tax,
    total_amount: total_amount,
    currency: currency,
    exchange_rate: exchange_rate,
    company: company,
    tracking_categories: tracking_categories,
    line_items: line_items,
    remote_was_deleted: remote_was_deleted,
    accounting_period: accounting_period,
    field_mappings: field_mappings,
    remote_data: remote_data,
    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/transaction.rb', line 862

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.transaction_type&.is_a?(String) != false || raise("Passed value for field obj.transaction_type is not the expected type, validation failed.")
  obj.number&.is_a?(String) != false || raise("Passed value for field obj.number is not the expected type, validation failed.")
  obj.transaction_date&.is_a?(DateTime) != false || raise("Passed value for field obj.transaction_date is not the expected type, validation failed.")
  obj.account.nil? || Merge::Accounting::TransactionAccount.validate_raw(obj: obj.account)
  obj.contact.nil? || Merge::Accounting::TransactionContact.validate_raw(obj: obj.contact)
  obj.inclusive_of_tax&.is_a?(Boolean) != false || raise("Passed value for field obj.inclusive_of_tax is not the expected type, validation failed.")
  obj.total_amount&.is_a?(String) != 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.company&.is_a?(String) != false || raise("Passed value for field obj.company is not the expected type, validation failed.")
  obj.tracking_categories&.is_a?(Array) != false || raise("Passed value for field obj.tracking_categories is not the expected type, validation failed.")
  obj.line_items&.is_a?(Array) != false || raise("Passed value for field obj.line_items is not the expected type, validation failed.")
  obj.remote_was_deleted&.is_a?(Boolean) != false || raise("Passed value for field obj.remote_was_deleted is not the expected type, validation failed.")
  obj.accounting_period.nil? || Merge::Accounting::TransactionAccountingPeriod.validate_raw(obj: obj.accounting_period)
  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.")
end

Instance Method Details

#to_json(*_args) ⇒ `String`

Serialize an instance of Transaction to a JSON object

Returns:

(String)



852
853
854

# File 'lib/merge_ruby_client/accounting/types/transaction.rb', line 852

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

Class: Merge::Accounting::Transaction

Overview

The Transaction Object

Description

Usage Example

Constant Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

Instance Attribute Details

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

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

#additional_properties ⇒ OpenStruct (readonly)

#company ⇒ String (readonly)

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

#created_at ⇒ DateTime (readonly)

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

#exchange_rate ⇒ String (readonly)

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

#id ⇒ String (readonly)

#inclusive_of_tax ⇒ Boolean (readonly)

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

#modified_at ⇒ DateTime (readonly)

#number ⇒ String (readonly)

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

#remote_id ⇒ String (readonly)

#remote_was_deleted ⇒ Boolean (readonly)

#total_amount ⇒ String (readonly)

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

#transaction_date ⇒ DateTime (readonly)

#transaction_type ⇒ String (readonly)

Class Method Details

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

.validate_raw(obj:) ⇒ Void

Instance Method Details

#to_json(*_args) ⇒ String

#account ⇒ `Merge::Accounting::TransactionAccount` (readonly)

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

#additional_properties ⇒ `OpenStruct` (readonly)

#company ⇒ `String` (readonly)

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

#created_at ⇒ `DateTime` (readonly)

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

#exchange_rate ⇒ `String` (readonly)

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

#id ⇒ `String` (readonly)

#inclusive_of_tax ⇒ `Boolean` (readonly)

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

#modified_at ⇒ `DateTime` (readonly)

#number ⇒ `String` (readonly)

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

#remote_id ⇒ `String` (readonly)

#remote_was_deleted ⇒ `Boolean` (readonly)

#total_amount ⇒ `String` (readonly)

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

#transaction_date ⇒ `DateTime` (readonly)

#transaction_type ⇒ `String` (readonly)

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

.validate_raw(obj:) ⇒ `Void`

#to_json(*_args) ⇒ `String`