merge_ruby_client 0.0.1

data/lib/merge_ruby_client/accounting/types/credit_note.rb

@@ -0,0 +1,856 @@
+# frozen_string_literal: true
+
+require "date"
+require_relative "credit_note_status_enum"
+require_relative "credit_note_contact"
+require_relative "credit_note_company"
+require_relative "credit_note_line_item"
+require_relative "credit_note_tracking_categories_item"
+require_relative "currency_enum"
+require_relative "credit_note_payments_item"
+require_relative "credit_note_applied_payments_item"
+require_relative "credit_note_accounting_period"
+require_relative "remote_data"
+require "json"
+
+module Merge
+  module Accounting
+    # # 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.
+    class CreditNote
+      attr_reader :id, :remote_id, :transaction_date, :status, :number, :contact, :company, :exchange_rate,
+                  :total_amount, :remaining_credit, :line_items, :tracking_categories, :currency, :remote_created_at, :remote_updated_at, :payments, :applied_payments, :remote_was_deleted, :accounting_period, :created_at, :modified_at, :field_mappings, :remote_data, :additional_properties
+
+      # @param id [String]
+      # @param remote_id [String] The third-party API ID of the matching object.
+      # @param transaction_date [DateTime] The credit note's transaction date.
+      # @param status [CREDIT_NOTE_STATUS_ENUM] The credit note's status.
+      #   - `SUBMITTED` - SUBMITTED
+      #   - `AUTHORIZED` - AUTHORIZED
+      #   - `PAID` - PAID
+      # @param number [String] The credit note's number.
+      # @param contact [Accounting::CreditNoteContact] The credit note's contact.
+      # @param company [Accounting::CreditNoteCompany] The company the credit note belongs to.
+      # @param exchange_rate [String] The credit note's exchange rate.
+      # @param total_amount [Float] The credit note's total amount.
+      # @param remaining_credit [Float] The amount of value remaining in the credit note that the customer can use.
+      # @param line_items [Array<Accounting::CreditNoteLineItem>]
+      # @param tracking_categories [Array<Accounting::CreditNoteTrackingCategoriesItem>]
+      # @param currency [CURRENCY_ENUM] 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)
+      # @param remote_created_at [DateTime] When the third party's credit note was created.
+      # @param remote_updated_at [DateTime] When the third party's credit note was updated.
+      # @param payments [Array<Accounting::CreditNotePaymentsItem>] Array of `Payment` object IDs
+      # @param applied_payments [Array<Accounting::CreditNoteAppliedPaymentsItem>] A list of the Payment Applied to Lines common models related to a given Invoice, Credit Note, or Journal Entry.
+      # @param remote_was_deleted [Boolean] Indicates whether or not this object has been deleted in the third party platform.
+      # @param accounting_period [Accounting::CreditNoteAccountingPeriod] The accounting period that the CreditNote was generated in.
+      # @param created_at [DateTime]
+      # @param modified_at [DateTime] This is the datetime that this object was last updated by Merge
+      # @param field_mappings [Hash{String => String}]
+      # @param remote_data [Array<Accounting::RemoteData>]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Accounting::CreditNote]
+      def initialize(id: nil, remote_id: nil, transaction_date: nil, status: nil, number: nil, contact: nil,
+                     company: nil, exchange_rate: nil, total_amount: nil, remaining_credit: nil, line_items: nil, tracking_categories: nil, currency: nil, remote_created_at: nil, remote_updated_at: nil, payments: nil, applied_payments: nil, remote_was_deleted: nil, accounting_period: nil, created_at: nil, modified_at: nil, field_mappings: nil, remote_data: nil, additional_properties: nil)
+        # @type [String]
+        @id = id
+        # @type [String] The third-party API ID of the matching object.
+        @remote_id = remote_id
+        # @type [DateTime] The credit note's transaction date.
+        @transaction_date = transaction_date
+        # @type [CREDIT_NOTE_STATUS_ENUM] The credit note's status.
+        #   - `SUBMITTED` - SUBMITTED
+        #   - `AUTHORIZED` - AUTHORIZED
+        #   - `PAID` - PAID
+        @status = status
+        # @type [String] The credit note's number.
+        @number = number
+        # @type [Accounting::CreditNoteContact] The credit note's contact.
+        @contact = contact
+        # @type [Accounting::CreditNoteCompany] The company the credit note belongs to.
+        @company = company
+        # @type [String] The credit note's exchange rate.
+        @exchange_rate = exchange_rate
+        # @type [Float] The credit note's total amount.
+        @total_amount = total_amount
+        # @type [Float] The amount of value remaining in the credit note that the customer can use.
+        @remaining_credit = remaining_credit
+        # @type [Array<Accounting::CreditNoteLineItem>]
+        @line_items = line_items
+        # @type [Array<Accounting::CreditNoteTrackingCategoriesItem>]
+        @tracking_categories = tracking_categories
+        # @type [CURRENCY_ENUM] 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)
+        @currency = currency
+        # @type [DateTime] When the third party's credit note was created.
+        @remote_created_at = remote_created_at
+        # @type [DateTime] When the third party's credit note was updated.
+        @remote_updated_at = remote_updated_at
+        # @type [Array<Accounting::CreditNotePaymentsItem>] Array of `Payment` object IDs
+        @payments = payments
+        # @type [Array<Accounting::CreditNoteAppliedPaymentsItem>] A list of the Payment Applied to Lines common models related to a given Invoice, Credit Note, or Journal Entry.
+        @applied_payments = applied_payments
+        # @type [Boolean] Indicates whether or not this object has been deleted in the third party platform.
+        @remote_was_deleted = remote_was_deleted
+        # @type [Accounting::CreditNoteAccountingPeriod] The accounting period that the CreditNote was generated in.
+        @accounting_period = accounting_period
+        # @type [DateTime]
+        @created_at = created_at
+        # @type [DateTime] This is the datetime that this object was last updated by Merge
+        @modified_at = modified_at
+        # @type [Hash{String => String}]
+        @field_mappings = field_mappings
+        # @type [Array<Accounting::RemoteData>]
+        @remote_data = remote_data
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of CreditNote
+      #
+      # @param json_object [JSON]
+      # @return [Accounting::CreditNote]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        id = struct.id
+        remote_id = struct.remote_id
+        transaction_date = (DateTime.parse(parsed_json["transaction_date"]) unless parsed_json["transaction_date"].nil?)
+        status = Accounting::CREDIT_NOTE_STATUS_ENUM.key(parsed_json["status"]) || parsed_json["status"]
+        number = struct.number
+        if parsed_json["contact"].nil?
+          contact = nil
+        else
+          contact = parsed_json["contact"].to_json
+          contact = Accounting::CreditNoteContact.from_json(json_object: contact)
+        end
+        if parsed_json["company"].nil?
+          company = nil
+        else
+          company = parsed_json["company"].to_json
+          company = Accounting::CreditNoteCompany.from_json(json_object: company)
+        end
+        exchange_rate = struct.exchange_rate
+        total_amount = struct.total_amount
+        remaining_credit = struct.remaining_credit
+        line_items = parsed_json["line_items"]&.map do |v|
+          v = v.to_json
+          Accounting::CreditNoteLineItem.from_json(json_object: v)
+        end
+        tracking_categories = parsed_json["tracking_categories"]&.map do |v|
+          v = v.to_json
+          Accounting::CreditNoteTrackingCategoriesItem.from_json(json_object: v)
+        end
+        currency = Accounting::CURRENCY_ENUM.key(parsed_json["currency"]) || parsed_json["currency"]
+        remote_created_at = unless parsed_json["remote_created_at"].nil?
+                              DateTime.parse(parsed_json["remote_created_at"])
+                            end
+        remote_updated_at = unless parsed_json["remote_updated_at"].nil?
+                              DateTime.parse(parsed_json["remote_updated_at"])
+                            end
+        payments = parsed_json["payments"]&.map do |v|
+          v = v.to_json
+          Accounting::CreditNotePaymentsItem.from_json(json_object: v)
+        end
+        applied_payments = parsed_json["applied_payments"]&.map do |v|
+          v = v.to_json
+          Accounting::CreditNoteAppliedPaymentsItem.from_json(json_object: v)
+        end
+        remote_was_deleted = struct.remote_was_deleted
+        if parsed_json["accounting_period"].nil?
+          accounting_period = nil
+        else
+          accounting_period = parsed_json["accounting_period"].to_json
+          accounting_period = Accounting::CreditNoteAccountingPeriod.from_json(json_object: accounting_period)
+        end
+        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?)
+        field_mappings = struct.field_mappings
+        remote_data = parsed_json["remote_data"]&.map do |v|
+          v = v.to_json
+          Accounting::RemoteData.from_json(json_object: v)
+        end
+        new(id: id, remote_id: remote_id, transaction_date: transaction_date, status: status, number: number,
+            contact: contact, company: company, exchange_rate: exchange_rate, total_amount: total_amount, remaining_credit: remaining_credit, line_items: line_items, tracking_categories: tracking_categories, currency: currency, remote_created_at: remote_created_at, remote_updated_at: remote_updated_at, payments: payments, applied_payments: applied_payments, remote_was_deleted: remote_was_deleted, accounting_period: accounting_period, created_at: created_at, modified_at: modified_at, field_mappings: field_mappings, remote_data: remote_data, additional_properties: struct)
+      end
+
+      # Serialize an instance of CreditNote to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        {
+          "id": @id,
+          "remote_id": @remote_id,
+          "transaction_date": @transaction_date,
+          "status": Accounting::CREDIT_NOTE_STATUS_ENUM[@status] || @status,
+          "number": @number,
+          "contact": @contact,
+          "company": @company,
+          "exchange_rate": @exchange_rate,
+          "total_amount": @total_amount,
+          "remaining_credit": @remaining_credit,
+          "line_items": @line_items,
+          "tracking_categories": @tracking_categories,
+          "currency": Accounting::CURRENCY_ENUM[@currency] || @currency,
+          "remote_created_at": @remote_created_at,
+          "remote_updated_at": @remote_updated_at,
+          "payments": @payments,
+          "applied_payments": @applied_payments,
+          "remote_was_deleted": @remote_was_deleted,
+          "accounting_period": @accounting_period,
+          "created_at": @created_at,
+          "modified_at": @modified_at,
+          "field_mappings": @field_mappings,
+          "remote_data": @remote_data
+        }.to_json
+      end
+
+      # 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.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      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.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?(Accounting::CREDIT_NOTE_STATUS_ENUM) != 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? || Accounting::CreditNoteContact.validate_raw(obj: obj.contact)
+        obj.company.nil? || Accounting::CreditNoteCompany.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.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?(Accounting::CURRENCY_ENUM) != false || raise("Passed value for field obj.currency is not the expected type, validation failed.")
+        obj.remote_created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.remote_created_at is not the expected type, validation failed.")
+        obj.remote_updated_at&.is_a?(DateTime) != false || raise("Passed value for field obj.remote_updated_at is not the expected type, validation failed.")
+        obj.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.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? || Accounting::CreditNoteAccountingPeriod.validate_raw(obj: obj.accounting_period)
+        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.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
+    end
+  end
+end