Class: Merge::Accounting::CreditNoteRequest

Inherits:

Object

Object
Merge::Accounting::CreditNoteRequest

show all

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

Overview

The CreditNote Object

Description

A CreditNote is transaction issued to a customer, indicating a reduction or cancellation of the amount owed by the customer. It is most generally used as an adjustment note used to rectify errors, returns, or overpayments related to a sales transaction. A CreditNote can be applied to Accounts Receivable Invoices to decrease the overall amount of the Invoice.

Usage Example

Fetch from the LIST CreditNotes endpoint and view a company's credit notes.

Constant Summary collapse

OMIT =

Object.new

Instance Attribute Summary collapse

#accounting_period ⇒ Merge::Accounting::CreditNoteRequestAccountingPeriod readonly
The accounting period that the CreditNote was generated in.
#additional_properties ⇒ OpenStruct readonly
Additional properties unmapped to the current class definition.
#applied_payments ⇒ Array<Merge::Accounting::CreditNoteRequestAppliedPaymentsItem> readonly
A list of the Payment Applied to Lines common models related to a given Invoice, Credit Note, or Journal Entry.
#applied_to_lines ⇒ Array<Merge::Accounting::CreditNoteApplyLineForCreditNoteRequest> readonly
A list of the CreditNote Applied to Lines common models related to a given Credit Note.
#company ⇒ Merge::Accounting::CreditNoteRequestCompany readonly
The company the credit note belongs to.
#contact ⇒ Merge::Accounting::CreditNoteRequestContact readonly
The credit note's contact.
#currency ⇒ Merge::Accounting::TransactionCurrencyEnum readonly
The credit note's currency.
#exchange_rate ⇒ String readonly
The credit note's exchange rate.
#inclusive_of_tax ⇒ Boolean readonly
If the transaction is inclusive or exclusive of tax.
#integration_params ⇒ Hash{String => Object} readonly
#line_items ⇒ Array<Merge::Accounting::CreditNoteRequestLineItemsItem> readonly
#linked_account_params ⇒ Hash{String => Object} readonly
#number ⇒ String readonly
The credit note's number.
#payments ⇒ Array<Merge::Accounting::CreditNoteRequestPaymentsItem> readonly
Array of Payment object IDs.
#remaining_credit ⇒ Float readonly
The amount of value remaining in the credit note that the customer can use.
#status ⇒ Merge::Accounting::CreditNoteStatusEnum readonly
The credit note's status.
#total_amount ⇒ Float readonly
The credit note's total amount.
#tracking_categories ⇒ Array<Merge::Accounting::CreditNoteRequestTrackingCategoriesItem> readonly
#transaction_date ⇒ DateTime readonly
The credit note's transaction date.

Class Method Summary collapse

.from_json(json_object:) ⇒ Merge::Accounting::CreditNoteRequest
Deserialize a JSON object to an instance of CreditNoteRequest.
.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(transaction_date: OMIT, status: OMIT, number: OMIT, contact: OMIT, company: OMIT, exchange_rate: OMIT, total_amount: OMIT, remaining_credit: OMIT, inclusive_of_tax: OMIT, line_items: OMIT, tracking_categories: OMIT, currency: OMIT, payments: OMIT, applied_payments: OMIT, accounting_period: OMIT, applied_to_lines: OMIT, integration_params: OMIT, linked_account_params: OMIT, additional_properties: nil) ⇒ `Merge::Accounting::CreditNoteRequest`

Parameters:

transaction_date (DateTime) (defaults to: OMIT) —
The credit note's transaction date.
status (Merge::Accounting::CreditNoteStatusEnum) (defaults to: OMIT) —
The credit note's status.
- SUBMITTED - SUBMITTED
- AUTHORIZED - AUTHORIZED
- PAID - PAID
number (String) (defaults to: OMIT) —
The credit note's number.
contact (Merge::Accounting::CreditNoteRequestContact) (defaults to: OMIT) —
The credit note's contact.
company (Merge::Accounting::CreditNoteRequestCompany) (defaults to: OMIT) —
The company the credit note belongs to.
exchange_rate (String) (defaults to: OMIT) —
The credit note's exchange rate.
total_amount (Float) (defaults to: OMIT) —
The credit note's total amount.
remaining_credit (Float) (defaults to: OMIT) —
The amount of value remaining in the credit note that the customer can use.
inclusive_of_tax (Boolean) (defaults to: OMIT) —
If the transaction is inclusive or exclusive of tax. True if inclusive, False if exclusive.
line_items (Array<Merge::Accounting::CreditNoteRequestLineItemsItem>) (defaults to: OMIT)
tracking_categories (Array<Merge::Accounting::CreditNoteRequestTrackingCategoriesItem>) (defaults to: OMIT)
currency (Merge::Accounting::TransactionCurrencyEnum) (defaults to: OMIT) —
The credit note'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)
payments (Array<Merge::Accounting::CreditNoteRequestPaymentsItem>) (defaults to: OMIT) —
Array of Payment object IDs
applied_payments (Array<Merge::Accounting::CreditNoteRequestAppliedPaymentsItem>) (defaults to: OMIT) —
A list of the Payment Applied to Lines common models related to a given Invoice, Credit Note, or Journal Entry.
accounting_period (Merge::Accounting::CreditNoteRequestAccountingPeriod) (defaults to: OMIT) —
The accounting period that the CreditNote was generated in.
applied_to_lines (Array<Merge::Accounting::CreditNoteApplyLineForCreditNoteRequest>) (defaults to: OMIT) —
A list of the CreditNote Applied to Lines common models related to a given Credit Note
integration_params (Hash{String => Object}) (defaults to: OMIT)
linked_account_params (Hash{String => Object}) (defaults to: OMIT)
additional_properties (OpenStruct) (defaults to: nil) —
Additional properties unmapped to the current class definition

# File 'lib/merge_ruby_client/accounting/types/credit_note_request.rb', line 717

def initialize(transaction_date: OMIT, status: OMIT, number: OMIT, contact: OMIT, company: OMIT,
               exchange_rate: OMIT, total_amount: OMIT, remaining_credit: OMIT, inclusive_of_tax: OMIT, line_items: OMIT, tracking_categories: OMIT, currency: OMIT, payments: OMIT, applied_payments: OMIT, accounting_period: OMIT, applied_to_lines: OMIT, integration_params: OMIT, linked_account_params: OMIT, additional_properties: nil)
  @transaction_date = transaction_date if transaction_date != OMIT
  @status = status if status != OMIT
  @number = number if number != OMIT
  @contact = contact if contact != OMIT
  @company = company if company != OMIT
  @exchange_rate = exchange_rate if exchange_rate != OMIT
  @total_amount = total_amount if total_amount != OMIT
  @remaining_credit = remaining_credit if remaining_credit != OMIT
  @inclusive_of_tax = inclusive_of_tax if inclusive_of_tax != OMIT
  @line_items = line_items if line_items != OMIT
  @tracking_categories = tracking_categories if tracking_categories != OMIT
  @currency = currency if currency != OMIT
  @payments = payments if payments != OMIT
  @applied_payments = applied_payments if applied_payments != OMIT
  @accounting_period = accounting_period if accounting_period != OMIT
  @applied_to_lines = applied_to_lines if applied_to_lines != OMIT
  @integration_params = integration_params if integration_params != OMIT
  @linked_account_params = linked_account_params if linked_account_params != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "transaction_date": transaction_date,
    "status": status,
    "number": number,
    "contact": contact,
    "company": company,
    "exchange_rate": exchange_rate,
    "total_amount": total_amount,
    "remaining_credit": remaining_credit,
    "inclusive_of_tax": inclusive_of_tax,
    "line_items": line_items,
    "tracking_categories": tracking_categories,
    "currency": currency,
    "payments": payments,
    "applied_payments": applied_payments,
    "accounting_period": accounting_period,
    "applied_to_lines": applied_to_lines,
    "integration_params": integration_params,
    "linked_account_params": linked_account_params
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

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

Returns The accounting period that the CreditNote was generated in.

Returns:

(Merge::Accounting::CreditNoteRequestAccountingPeriod) —
The accounting period that the CreditNote was generated in.



369
370
371

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

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



378
379
380

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

def additional_properties
  @additional_properties
end

#applied_payments ⇒ `Array<Merge::Accounting::CreditNoteRequestAppliedPaymentsItem>` (readonly)

Returns A list of the Payment Applied to Lines common models related to a given Invoice, Credit Note, or Journal Entry.

Returns:

(Array<Merge::Accounting::CreditNoteRequestAppliedPaymentsItem>) —
A list of the Payment Applied to Lines common models related to a given Invoice, Credit Note, or Journal Entry.



367
368
369

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

def applied_payments
  @applied_payments
end

#applied_to_lines ⇒ `Array<Merge::Accounting::CreditNoteApplyLineForCreditNoteRequest>` (readonly)

Returns A list of the CreditNote Applied to Lines common models related to a given Credit Note.

Returns:

(Array<Merge::Accounting::CreditNoteApplyLineForCreditNoteRequest>) —
A list of the CreditNote Applied to Lines common models related to a given Credit Note



372
373
374

# File 'lib/merge_ruby_client/accounting/types/credit_note_request.rb', line 372

def applied_to_lines
  @applied_to_lines
end

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

Returns The company the credit note belongs to.

Returns:

(Merge::Accounting::CreditNoteRequestCompany) —
The company the credit note belongs to.



41
42
43

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

def company
  @company
end

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

Returns The credit note's contact.

Returns:

(Merge::Accounting::CreditNoteRequestContact) —
The credit note's contact.



39
40
41

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

def contact
  @contact
end

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

Returns The credit note'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 credit note's currency.
- XUA - ADB Unit of Account
- AFN - Afghan Afghani
- AFA - Afghan Afghani (1927–2002)
- ALL - Albanian Lek
- ALK - Albanian Lek (1946–1965)
- DZD - Algerian Dinar
- ADP - Andorran Peseta
- AOA - Angolan Kwanza
- AOK - Angolan Kwanza (1977–1991)
- AON - Angolan New Kwanza (1990–2000)
- AOR - Angolan Readjusted Kwanza (1995–1999)
- ARA - Argentine Austral
- ARS - Argentine Peso
- ARM - Argentine Peso (1881–1970)
- ARP - Argentine Peso (1983–1985)
- ARL - Argentine Peso Ley (1970–1983)
- AMD - Armenian Dram
- AWG - Aruban Florin
- AUD - Australian Dollar
- ATS - Austrian Schilling
- AZN - Azerbaijani Manat
- AZM - Azerbaijani Manat (1993–2006)
- BSD - Bahamian Dollar
- BHD - Bahraini Dinar
- BDT - Bangladeshi Taka
- BBD - Barbadian Dollar
- BYN - Belarusian Ruble
- BYB - Belarusian Ruble (1994–1999)
- BYR - Belarusian Ruble (2000–2016)
- BEF - Belgian Franc
- BEC - Belgian Franc (convertible)
- BEL - Belgian Franc (financial)
- BZD - Belize Dollar
- BMD - Bermudan Dollar
- BTN - Bhutanese Ngultrum
- BOB - Bolivian Boliviano
- BOL - Bolivian Boliviano (1863–1963)
- BOV - Bolivian Mvdol
- BOP - Bolivian Peso
- BAM - Bosnia-Herzegovina Convertible Mark
- BAD - Bosnia-Herzegovina Dinar (1992–1994)
- BAN - Bosnia-Herzegovina New Dinar (1994–1997)
- BWP - Botswanan Pula
- BRC - Brazilian Cruzado (1986–1989)
- BRZ - Brazilian Cruzeiro (1942–1967)
- BRE - Brazilian Cruzeiro (1990–1993)
- BRR - Brazilian Cruzeiro (1993–1994)
- BRN - Brazilian New Cruzado (1989–1990)
- BRB - Brazilian New Cruzeiro (1967–1986)
- BRL - Brazilian Real
- GBP - British Pound
- BND - Brunei Dollar
- BGL - Bulgarian Hard Lev
- BGN - Bulgarian Lev
- BGO - Bulgarian Lev (1879–1952)
- BGM - Bulgarian Socialist Lev
- BUK - Burmese Kyat
- BIF - Burundian Franc
- XPF - CFP Franc
- KHR - Cambodian Riel
- CAD - Canadian Dollar
- CVE - Cape Verdean Escudo
- KYD - Cayman Islands Dollar
- XAF - Central African CFA Franc
- CLE - Chilean Escudo
- CLP - Chilean Peso
- CLF - Chilean Unit of Account (UF)
- CNX - Chinese People’s Bank Dollar
- CNY - Chinese Yuan
- CNH - Chinese Yuan (offshore)
- COP - Colombian Peso
- COU - Colombian Real Value Unit
- KMF - Comorian Franc
- CDF - Congolese Franc
- CRC - Costa Rican Colón
- HRD - Croatian Dinar
- HRK - Croatian Kuna
- CUC - Cuban Convertible Peso
- CUP - Cuban Peso
- CYP - Cypriot Pound
- CZK - Czech Koruna
- CSK - Czechoslovak Hard Koruna
- DKK - Danish Krone
- DJF - Djiboutian Franc
- DOP - Dominican Peso
- NLG - Dutch Guilder
- XCD - East Caribbean Dollar
- DDM - East German Mark
- ECS - Ecuadorian Sucre
- ECV - Ecuadorian Unit of Constant Value
- EGP - Egyptian Pound
- GQE - Equatorial Guinean Ekwele
- ERN - Eritrean Nakfa
- EEK - Estonian Kroon
- ETB - Ethiopian Birr
- EUR - Euro
- XBA - European Composite Unit
- XEU - European Currency Unit
- XBB - European Monetary Unit
- XBC - European Unit of Account (XBC)
- XBD - European Unit of Account (XBD)
- FKP - Falkland Islands Pound
- FJD - Fijian Dollar
- FIM - Finnish Markka
- FRF - French Franc
- XFO - French Gold Franc
- XFU - French UIC-Franc
- GMD - Gambian Dalasi
- GEK - Georgian Kupon Larit
- GEL - Georgian Lari
- DEM - German Mark
- GHS - Ghanaian Cedi
- GHC - Ghanaian Cedi (1979–2007)
- GIP - Gibraltar Pound
- XAU - Gold
- GRD - Greek Drachma
- GTQ - Guatemalan Quetzal
- GWP - Guinea-Bissau Peso
- GNF - Guinean Franc
- GNS - Guinean Syli
- GYD - Guyanaese Dollar
- HTG - Haitian Gourde
- HNL - Honduran Lempira
- HKD - Hong Kong Dollar
- HUF - Hungarian Forint
- IMP - IMP
- ISK - Icelandic Króna
- ISJ - Icelandic Króna (1918–1981)
- INR - Indian Rupee
- IDR - Indonesian Rupiah
- IRR - Iranian Rial
- IQD - Iraqi Dinar
- IEP - Irish Pound
- ILS - Israeli New Shekel
- ILP - Israeli Pound
- ILR - Israeli Shekel (1980–1985)
- ITL - Italian Lira
- JMD - Jamaican Dollar
- JPY - Japanese Yen
- JOD - Jordanian Dinar
- KZT - Kazakhstani Tenge
- KES - Kenyan Shilling
- KWD - Kuwaiti Dinar
- KGS - Kyrgystani Som
- LAK - Laotian Kip
- LVL - Latvian Lats
- LVR - Latvian Ruble
- LBP - Lebanese Pound
- LSL - Lesotho Loti
- LRD - Liberian Dollar
- LYD - Libyan Dinar
- LTL - Lithuanian Litas
- LTT - Lithuanian Talonas
- LUL - Luxembourg Financial Franc
- LUC - Luxembourgian Convertible Franc
- LUF - Luxembourgian Franc
- MOP - Macanese Pataca
- MKD - Macedonian Denar
- MKN - Macedonian Denar (1992–1993)
- MGA - Malagasy Ariary
- MGF - Malagasy Franc
- MWK - Malawian Kwacha
- MYR - Malaysian Ringgit
- MVR - Maldivian Rufiyaa
- MVP - Maldivian Rupee (1947–1981)
- MLF - Malian Franc
- MTL - Maltese Lira
- MTP - Maltese Pound
- MRU - Mauritanian Ouguiya
- MRO - Mauritanian Ouguiya (1973–2017)
- MUR - Mauritian Rupee
- MXV - Mexican Investment Unit
- MXN - Mexican Peso
- MXP - Mexican Silver Peso (1861–1992)
- MDC - Moldovan Cupon
- MDL - Moldovan Leu
- MCF - Monegasque Franc
- MNT - Mongolian Tugrik
- MAD - Moroccan Dirham
- MAF - Moroccan Franc
- MZE - Mozambican Escudo
- MZN - Mozambican Metical
- MZM - Mozambican Metical (1980–2006)
- MMK - Myanmar Kyat
- NAD - Namibian Dollar
- NPR - Nepalese Rupee
- ANG - Netherlands Antillean Guilder
- TWD - New Taiwan Dollar
- NZD - New Zealand Dollar
- NIO - Nicaraguan Córdoba
- NIC - Nicaraguan Córdoba (1988–1991)
- NGN - Nigerian Naira
- KPW - North Korean Won
- NOK - Norwegian Krone
- OMR - Omani Rial
- PKR - Pakistani Rupee
- XPD - Palladium
- PAB - Panamanian Balboa
- PGK - Papua New Guinean Kina
- PYG - Paraguayan Guarani
- PEI - Peruvian Inti
- PEN - Peruvian Sol
- PES - Peruvian Sol (1863–1965)
- PHP - Philippine Peso
- XPT - Platinum
- PLN - Polish Zloty
- PLZ - Polish Zloty (1950–1995)
- PTE - Portuguese Escudo
- GWE - Portuguese Guinea Escudo
- QAR - Qatari Rial
- XRE - RINET Funds
- RHD - Rhodesian Dollar
- RON - Romanian Leu
- ROL - Romanian Leu (1952–2006)
- RUB - Russian Ruble
- RUR - Russian Ruble (1991–1998)
- RWF - Rwandan Franc
- SVC - Salvadoran Colón
- WST - Samoan Tala
- SAR - Saudi Riyal
- RSD - Serbian Dinar
- CSD - Serbian Dinar (2002–2006)
- SCR - Seychellois Rupee
- SLL - Sierra Leonean Leone
- XAG - Silver
- SGD - Singapore Dollar
- SKK - Slovak Koruna
- SIT - Slovenian Tolar
- SBD - Solomon Islands Dollar
- SOS - Somali Shilling
- ZAR - South African Rand
- ZAL - South African Rand (financial)
- KRH - South Korean Hwan (1953–1962)
- KRW - South Korean Won
- KRO - South Korean Won (1945–1953)
- SSP - South Sudanese Pound
- SUR - Soviet Rouble
- ESP - Spanish Peseta
- ESA - Spanish Peseta (A account)
- ESB - Spanish Peseta (convertible account)
- XDR - Special Drawing Rights
- LKR - Sri Lankan Rupee
- SHP - St. Helena Pound
- XSU - Sucre
- SDD - Sudanese Dinar (1992–2007)
- SDG - Sudanese Pound
- SDP - Sudanese Pound (1957–1998)
- SRD - Surinamese Dollar
- SRG - Surinamese Guilder
- SZL - Swazi Lilangeni
- SEK - Swedish Krona
- CHF - Swiss Franc
- SYP - Syrian Pound
- STN - São Tomé & Príncipe Dobra
- STD - São Tomé & Príncipe Dobra (1977–2017)
- TVD - TVD
- TJR - Tajikistani Ruble
- TJS - Tajikistani Somoni
- TZS - Tanzanian Shilling
- XTS - Testing Currency Code
- THB - Thai Baht
- XXX - The codes assigned for transactions where no currency is involved
- TPE - Timorese Escudo
- TOP - Tongan Paʻanga
- TTD - Trinidad & Tobago Dollar
- TND - Tunisian Dinar
- TRY - Turkish Lira
- TRL - Turkish Lira (1922–2005)
- TMT - Turkmenistani Manat
- TMM - Turkmenistani Manat (1993–2009)
- USD - US Dollar
- USN - US Dollar (Next day)
- USS - US Dollar (Same day)
- UGX - Ugandan Shilling
- UGS - Ugandan Shilling (1966–1987)
- UAH - Ukrainian Hryvnia
- UAK - Ukrainian Karbovanets
- AED - United Arab Emirates Dirham
- UYW - Uruguayan Nominal Wage Index Unit
- UYU - Uruguayan Peso
- UYP - Uruguayan Peso (1975–1993)
- UYI - Uruguayan Peso (Indexed Units)
- UZS - Uzbekistani Som
- VUV - Vanuatu Vatu
- VES - Venezuelan Bolívar
- VEB - Venezuelan Bolívar (1871–2008)
- VEF - Venezuelan Bolívar (2008–2018)
- VND - Vietnamese Dong
- VNN - Vietnamese Dong (1978–1985)
- CHE - WIR Euro
- CHW - WIR Franc
- XOF - West African CFA Franc
- YDD - Yemeni Dinar
- YER - Yemeni Rial
- YUN - Yugoslavian Convertible Dinar (1990–1992)
- YUD - Yugoslavian Hard Dinar (1966–1990)
- YUM - Yugoslavian New Dinar (1994–2002)
- YUR - Yugoslavian Reformed Dinar (1992–1993)
- ZWN - ZWN
- ZRN - Zairean New Zaire (1993–1998)
- ZRZ - Zairean Zaire (1971–1993)
- ZMW - Zambian Kwacha
- ZMK - Zambian Kwacha (1968–2012)
- ZWD - Zimbabwean Dollar (1980–2008)
- ZWR - Zimbabwean Dollar (2008)
- ZWL - Zimbabwean Dollar (2009)



362
363
364

# File 'lib/merge_ruby_client/accounting/types/credit_note_request.rb', line 362

def currency
  @currency
end

#exchange_rate ⇒ `String` (readonly)

Returns The credit note's exchange rate.

Returns:

(String) —
The credit note's exchange rate.



43
44
45

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

def exchange_rate
  @exchange_rate
end

#inclusive_of_tax ⇒ `Boolean` (readonly)

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

Returns:

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



50
51
52

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

def inclusive_of_tax
  @inclusive_of_tax
end

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

Returns:

(Hash{String => Object})



374
375
376

# File 'lib/merge_ruby_client/accounting/types/credit_note_request.rb', line 374

def integration_params
  @integration_params
end

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

Returns:

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



52
53
54

# File 'lib/merge_ruby_client/accounting/types/credit_note_request.rb', line 52

def line_items
  @line_items
end

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

Returns:

(Hash{String => Object})



376
377
378

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

def linked_account_params
  @linked_account_params
end

#number ⇒ `String` (readonly)

Returns The credit note's number.

Returns:

(String) —
The credit note's number.



37
38
39

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

def number
  @number
end

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

Returns Array of Payment object IDs.

Returns:

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



364
365
366

# File 'lib/merge_ruby_client/accounting/types/credit_note_request.rb', line 364

def payments
  @payments
end

#remaining_credit ⇒ `Float` (readonly)

Returns The amount of value remaining in the credit note that the customer can use.

Returns:

(Float) —
The amount of value remaining in the credit note that the customer can use.



47
48
49

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

def remaining_credit
  @remaining_credit
end

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

Returns The credit note's status.

SUBMITTED - SUBMITTED
AUTHORIZED - AUTHORIZED
PAID - PAID.

Returns:

(Merge::Accounting::CreditNoteStatusEnum) —
The credit note's status.
- SUBMITTED - SUBMITTED
- AUTHORIZED - AUTHORIZED
- PAID - PAID



35
36
37

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

def status
  @status
end

#total_amount ⇒ `Float` (readonly)

Returns The credit note's total amount.

Returns:

(Float) —
The credit note's total amount.



45
46
47

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

def total_amount
  @total_amount
end

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

Returns:

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



54
55
56

# File 'lib/merge_ruby_client/accounting/types/credit_note_request.rb', line 54

def tracking_categories
  @tracking_categories
end

#transaction_date ⇒ `DateTime` (readonly)

Returns The credit note's transaction date.

Returns:

(DateTime) —
The credit note's transaction date.



30
31
32

# File 'lib/merge_ruby_client/accounting/types/credit_note_request.rb', line 30

def transaction_date
  @transaction_date
end

Class Method Details

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

Deserialize a JSON object to an instance of CreditNoteRequest

Parameters:

json_object (String)

Returns:

(Merge::Accounting::CreditNoteRequest)

# File 'lib/merge_ruby_client/accounting/types/credit_note_request.rb', line 766

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  transaction_date = (DateTime.parse(parsed_json["transaction_date"]) unless parsed_json["transaction_date"].nil?)
  status = parsed_json["status"]
  number = parsed_json["number"]
  if parsed_json["contact"].nil?
    contact = nil
  else
    contact = parsed_json["contact"].to_json
    contact = Merge::Accounting::CreditNoteRequestContact.from_json(json_object: contact)
  end
  if parsed_json["company"].nil?
    company = nil
  else
    company = parsed_json["company"].to_json
    company = Merge::Accounting::CreditNoteRequestCompany.from_json(json_object: company)
  end
  exchange_rate = parsed_json["exchange_rate"]
  total_amount = parsed_json["total_amount"]
  remaining_credit = parsed_json["remaining_credit"]
  inclusive_of_tax = parsed_json["inclusive_of_tax"]
  line_items = parsed_json["line_items"]&.map do |item|
    item = item.to_json
    Merge::Accounting::CreditNoteRequestLineItemsItem.from_json(json_object: item)
  end
  tracking_categories = parsed_json["tracking_categories"]&.map do |item|
    item = item.to_json
    Merge::Accounting::CreditNoteRequestTrackingCategoriesItem.from_json(json_object: item)
  end
  currency = parsed_json["currency"]
  payments = parsed_json["payments"]&.map do |item|
    item = item.to_json
    Merge::Accounting::CreditNoteRequestPaymentsItem.from_json(json_object: item)
  end
  applied_payments = parsed_json["applied_payments"]&.map do |item|
    item = item.to_json
    Merge::Accounting::CreditNoteRequestAppliedPaymentsItem.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::CreditNoteRequestAccountingPeriod.from_json(json_object: accounting_period)
  end
  applied_to_lines = parsed_json["applied_to_lines"]&.map do |item|
    item = item.to_json
    Merge::Accounting::CreditNoteApplyLineForCreditNoteRequest.from_json(json_object: item)
  end
  integration_params = parsed_json["integration_params"]
  linked_account_params = parsed_json["linked_account_params"]
  new(
    transaction_date: transaction_date,
    status: status,
    number: number,
    contact: contact,
    company: company,
    exchange_rate: exchange_rate,
    total_amount: total_amount,
    remaining_credit: remaining_credit,
    inclusive_of_tax: inclusive_of_tax,
    line_items: line_items,
    tracking_categories: tracking_categories,
    currency: currency,
    payments: payments,
    applied_payments: applied_payments,
    accounting_period: accounting_period,
    applied_to_lines: applied_to_lines,
    integration_params: integration_params,
    linked_account_params: linked_account_params,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ `Void`

Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.

Parameters:

obj (Object)

Returns:

(Void)

# File 'lib/merge_ruby_client/accounting/types/credit_note_request.rb', line 853

def self.validate_raw(obj:)
  obj.transaction_date&.is_a?(DateTime) != false || raise("Passed value for field obj.transaction_date is not the expected type, validation failed.")
  obj.status&.is_a?(Merge::Accounting::CreditNoteStatusEnum) != false || raise("Passed value for field obj.status 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.contact.nil? || Merge::Accounting::CreditNoteRequestContact.validate_raw(obj: obj.contact)
  obj.company.nil? || Merge::Accounting::CreditNoteRequestCompany.validate_raw(obj: obj.company)
  obj.exchange_rate&.is_a?(String) != false || raise("Passed value for field obj.exchange_rate is not the expected type, validation failed.")
  obj.total_amount&.is_a?(Float) != false || raise("Passed value for field obj.total_amount is not the expected type, validation failed.")
  obj.remaining_credit&.is_a?(Float) != false || raise("Passed value for field obj.remaining_credit 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.line_items&.is_a?(Array) != false || raise("Passed value for field obj.line_items 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.currency&.is_a?(Merge::Accounting::TransactionCurrencyEnum) != false || raise("Passed value for field obj.currency is not the expected type, validation failed.")
  obj.payments&.is_a?(Array) != false || raise("Passed value for field obj.payments is not the expected type, validation failed.")
  obj.applied_payments&.is_a?(Array) != false || raise("Passed value for field obj.applied_payments is not the expected type, validation failed.")
  obj.accounting_period.nil? || Merge::Accounting::CreditNoteRequestAccountingPeriod.validate_raw(obj: obj.accounting_period)
  obj.applied_to_lines&.is_a?(Array) != false || raise("Passed value for field obj.applied_to_lines is not the expected type, validation failed.")
  obj.integration_params&.is_a?(Hash) != false || raise("Passed value for field obj.integration_params is not the expected type, validation failed.")
  obj.linked_account_params&.is_a?(Hash) != false || raise("Passed value for field obj.linked_account_params is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ `String`

Serialize an instance of CreditNoteRequest to a JSON object

Returns:

(String)



843
844
845

# File 'lib/merge_ruby_client/accounting/types/credit_note_request.rb', line 843

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

Class: Merge::Accounting::CreditNoteRequest

Overview

The CreditNote 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::CreditNoteRequestAccountingPeriod (readonly)

#additional_properties ⇒ OpenStruct (readonly)

#applied_payments ⇒ Array<Merge::Accounting::CreditNoteRequestAppliedPaymentsItem> (readonly)

#applied_to_lines ⇒ Array<Merge::Accounting::CreditNoteApplyLineForCreditNoteRequest> (readonly)

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

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

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

#exchange_rate ⇒ String (readonly)

#inclusive_of_tax ⇒ Boolean (readonly)

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

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

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

#number ⇒ String (readonly)

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

#remaining_credit ⇒ Float (readonly)

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

#total_amount ⇒ Float (readonly)

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

#transaction_date ⇒ DateTime (readonly)

Class Method Details

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

.validate_raw(obj:) ⇒ Void

Instance Method Details

#to_json(*_args) ⇒ String

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

#additional_properties ⇒ `OpenStruct` (readonly)

#applied_payments ⇒ `Array<Merge::Accounting::CreditNoteRequestAppliedPaymentsItem>` (readonly)

#applied_to_lines ⇒ `Array<Merge::Accounting::CreditNoteApplyLineForCreditNoteRequest>` (readonly)

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

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

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

#exchange_rate ⇒ `String` (readonly)

#inclusive_of_tax ⇒ `Boolean` (readonly)

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

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

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

#number ⇒ `String` (readonly)

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

#remaining_credit ⇒ `Float` (readonly)

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

#total_amount ⇒ `Float` (readonly)

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

#transaction_date ⇒ `DateTime` (readonly)

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

.validate_raw(obj:) ⇒ `Void`

#to_json(*_args) ⇒ `String`