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.id
UUIDremote_id
Stringcreated_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)transaction_date
DateTime (ISO 8601)status
EnumSUBMITTED
, AUTHORIZED
, PAID
. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.number
Stringcontact
UUIDcompany
UUIDexchange_rate
Stringtotal_amount
Numberremaining_credit
Numberinclusive_of_tax
BooleanTrue
if inclusive, False
if exclusive.line_items
CreditNoteLineItem[]tracking_categories
Arraycurrency
EnumXUA
, AFN
, AFA
, ALL
, ALK
, DZD
, ADP
, AOA
, AOK
, AON
, AOR
, ARA
, ARS
, ARM
, ARP
, ARL
, AMD
, AWG
, AUD
, ATS
, AZN
, AZM
, BSD
, BHD
, BDT
, BBD
, BYN
, BYB
, BYR
, BEF
, BEC
, BEL
, BZD
, BMD
, BTN
, BOB
, BOL
, BOV
, BOP
, BAM
, BAD
, BAN
, BWP
, BRC
, BRZ
, BRE
, BRR
, BRN
, BRB
, BRL
, GBP
, BND
, BGL
, BGN
, BGO
, BGM
, BUK
, BIF
, XPF
, KHR
, CAD
, CVE
, KYD
, XAF
, CLE
, CLP
, CLF
, CNX
, CNY
, CNH
, COP
, COU
, KMF
, CDF
, CRC
, HRD
, HRK
, CUC
, CUP
, CYP
, CZK
, CSK
, DKK
, DJF
, DOP
, NLG
, XCD
, DDM
, ECS
, ECV
, EGP
, GQE
, ERN
, EEK
, ETB
, EUR
, XBA
, XEU
, XBB
, XBC
, XBD
, FKP
, FJD
, FIM
, FRF
, XFO
, XFU
, GMD
, GEK
, GEL
, DEM
, GHS
, GHC
, GIP
, XAU
, GRD
, GTQ
, GWP
, GNF
, GNS
, GYD
, HTG
, HNL
, HKD
, HUF
, IMP
, ISK
, ISJ
, INR
, IDR
, IRR
, IQD
, IEP
, ILS
, ILP
, ILR
, ITL
, JMD
, JPY
, JOD
, KZT
, KES
, KWD
, KGS
, LAK
, LVL
, LVR
, LBP
, LSL
, LRD
, LYD
, LTL
, LTT
, LUL
, LUC
, LUF
, MOP
, MKD
, MKN
, MGA
, MGF
, MWK
, MYR
, MVR
, MVP
, MLF
, MTL
, MTP
, MRU
, MRO
, MUR
, MXV
, MXN
, MXP
, MDC
, MDL
, MCF
, MNT
, MAD
, MAF
, MZE
, MZN
, MZM
, MMK
, NAD
, NPR
, ANG
, TWD
, NZD
, NIO
, NIC
, NGN
, KPW
, NOK
, OMR
, PKR
, XPD
, PAB
, PGK
, PYG
, PEI
, PEN
, PES
, PHP
, XPT
, PLN
, PLZ
, PTE
, GWE
, QAR
, XRE
, RHD
, RON
, ROL
, RUB
, RUR
, RWF
, SVC
, WST
, SAR
, RSD
, CSD
, SCR
, SLL
, XAG
, SGD
, SKK
, SIT
, SBD
, SOS
, ZAR
, ZAL
, KRH
, KRW
, KRO
, SSP
, SUR
, ESP
, ESA
, ESB
, XDR
, LKR
, SHP
, XSU
, SDD
, SDG
, SDP
, SRD
, SRG
, SZL
, SEK
, CHF
, SYP
, STN
, STD
, TVD
, TJR
, TJS
, TZS
, XTS
, THB
, XXX
, TPE
, TOP
, TTD
, TND
, TRY
, TRL
, TMT
, TMM
, USD
, USN
, USS
, UGX
, UGS
, UAH
, UAK
, AED
, UYW
, UYU
, UYP
, UYI
, UZS
, VUV
, VES
, VEB
, VEF
, VND
, VNN
, CHE
, CHW
, XOF
, YDD
, YER
, YUN
, YUD
, YUM
, YUR
, ZWN
, ZRN
, ZRZ
, ZMW
, ZMK
, ZWD
, ZWR
, ZWL
. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.remote_created_at
DateTime (ISO 8601)remote_updated_at
DateTime (ISO 8601)payments
ArrayPayment
object IDsapplied_payments
Arrayremote_was_deleted
Booleanaccounting_period
UUIDapplied_to_lines
CreditNoteApplyLineForCreditNote[]CreditNoteApplyLine
is attached to the CreditNote model.remote_id
Stringcreated_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)invoice
UUIDapplied_date
DateTime (ISO 8601)applied_amount
Stringremote_was_deleted
Booleanfield_mappings
Objectremote_data
RemoteData[]https://api.merge.dev/api/accounting/v1/credit-notes
Returns a list of CreditNote
objects.
company_id
Stringcreated_after
DateTime (ISO 8601)created_before
DateTime (ISO 8601)cursor
Stringexpand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleaninclude_shell_data
Booleanmodified_after
DateTime (ISO 8601)modified_before
DateTime (ISO 8601)page_size
Integerremote_fields
Stringremote_id
Stringshow_enum_origins
Stringtransaction_date_after
DateTime (ISO 8601)transaction_date_before
DateTime (ISO 8601)Supported Response Fields
currency
Enumpayments
Arrayremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
Enumtotal_amount
Numbertransaction_date
DateTime (ISO 8601)Supported Response Fields
line_items
CreditNoteLineItem[]remote_id
stringitem
stringdescription
stringquantity
stringunit_price
stringtotal_line_amount
stringtracking_categories
arrayaccount
stringcompany
stringcompany
UUIDcontact
UUIDcurrency
Enumnumber
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtotal_amount
Numbertracking_categories
Arraytransaction_date
DateTime (ISO 8601)Supported Response Fields
line_items
CreditNoteLineItem[]remote_id
stringitem
stringquantity
stringunit_price
stringtax_rate
stringtotal_line_amount
stringtracking_categories
arrayaccount
stringaccounting_period
UUIDapplied_payments
Arraycompany
UUIDcontact
UUIDcurrency
Enumexchange_rate
Stringinclusive_of_tax
Booleannumber
Stringremaining_credit
Numberremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtotal_amount
Numbertracking_categories
Arraytransaction_date
DateTime (ISO 8601)Supported Response Fields
line_items
CreditNoteLineItem[]remote_id
stringitem
stringdescription
stringquantity
stringmemo
stringunit_price
stringtotal_line_amount
stringtracking_categories
arrayaccount
stringapplied_payments
Arraycontact
UUIDcurrency
Enumexchange_rate
Stringnumber
Stringremaining_credit
Numberremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)total_amount
Numbertracking_categories
Arraytransaction_date
DateTime (ISO 8601)Supported Response Fields
currency
Enumremaining_credit
Numberremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtotal_amount
Numbertransaction_date
DateTime (ISO 8601)Supported Response Fields
line_items
CreditNoteLineItem[]remote_id
stringitem
stringdescription
stringtax_rate
stringtotal_line_amount
stringtracking_categories
arrayaccount
stringcompany
stringcompany
UUIDcontact
UUIDcurrency
Enumexchange_rate
Stringnumber
Stringremaining_credit
Numberremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtotal_amount
Numbertransaction_date
DateTime (ISO 8601)Supported Response Fields
line_items
CreditNoteLineItem[]remote_id
stringitem
stringdescription
stringquantity
stringunit_price
stringtax_rate
stringtotal_line_amount
stringtracking_categories
arrayaccount
stringapplied_payments
Arrayapplied_to_lines
CreditNoteApplyLineForCreditNote[]remote_id
stringcreated_at
stringmodified_at
stringinvoice
stringapplied_date
stringapplied_amount
stringremote_was_deleted
booleancontact
UUIDcurrency
Enumexchange_rate
Stringinclusive_of_tax
Booleannumber
Stringpayments
Arrayremaining_credit
Numberremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtotal_amount
Numbertransaction_date
DateTime (ISO 8601)Supported Response Fields
line_items
CreditNoteLineItem[]remote_id
stringitem
stringdescription
stringquantity
stringunit_price
stringtotal_line_amount
stringaccount
stringcompany
UUIDcontact
UUIDcurrency
Enumexchange_rate
Stringnumber
Stringremaining_credit
Numberremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtotal_amount
Numbertransaction_date
DateTime (ISO 8601)https://api.merge.dev/api/accounting/v1/credit-notes
Creates a CreditNote
object with the given values.
is_debug_mode
Booleanrun_async
Booleanmodel
Objecttransaction_date
DateTime (ISO 8601)status
EnumSUBMITTED
, AUTHORIZED
, PAID
.number
Stringcontact
UUIDid
field in the Contact object.company
UUIDid
field in the CompanyInfo object.exchange_rate
Stringtotal_amount
Numberremaining_credit
Numberinclusive_of_tax
BooleanTrue
if inclusive, False
if exclusive.line_items
Arraytracking_categories
Arraycurrency
EnumXUA
, AFN
, AFA
, ALL
, ALK
, DZD
, ADP
, AOA
, AOK
, AON
, AOR
, ARA
, ARS
, ARM
, ARP
, ARL
, AMD
, AWG
, AUD
, ATS
, AZN
, AZM
, BSD
, BHD
, BDT
, BBD
, BYN
, BYB
, BYR
, BEF
, BEC
, BEL
, BZD
, BMD
, BTN
, BOB
, BOL
, BOV
, BOP
, BAM
, BAD
, BAN
, BWP
, BRC
, BRZ
, BRE
, BRR
, BRN
, BRB
, BRL
, GBP
, BND
, BGL
, BGN
, BGO
, BGM
, BUK
, BIF
, XPF
, KHR
, CAD
, CVE
, KYD
, XAF
, CLE
, CLP
, CLF
, CNX
, CNY
, CNH
, COP
, COU
, KMF
, CDF
, CRC
, HRD
, HRK
, CUC
, CUP
, CYP
, CZK
, CSK
, DKK
, DJF
, DOP
, NLG
, XCD
, DDM
, ECS
, ECV
, EGP
, GQE
, ERN
, EEK
, ETB
, EUR
, XBA
, XEU
, XBB
, XBC
, XBD
, FKP
, FJD
, FIM
, FRF
, XFO
, XFU
, GMD
, GEK
, GEL
, DEM
, GHS
, GHC
, GIP
, XAU
, GRD
, GTQ
, GWP
, GNF
, GNS
, GYD
, HTG
, HNL
, HKD
, HUF
, IMP
, ISK
, ISJ
, INR
, IDR
, IRR
, IQD
, IEP
, ILS
, ILP
, ILR
, ITL
, JMD
, JPY
, JOD
, KZT
, KES
, KWD
, KGS
, LAK
, LVL
, LVR
, LBP
, LSL
, LRD
, LYD
, LTL
, LTT
, LUL
, LUC
, LUF
, MOP
, MKD
, MKN
, MGA
, MGF
, MWK
, MYR
, MVR
, MVP
, MLF
, MTL
, MTP
, MRU
, MRO
, MUR
, MXV
, MXN
, MXP
, MDC
, MDL
, MCF
, MNT
, MAD
, MAF
, MZE
, MZN
, MZM
, MMK
, NAD
, NPR
, ANG
, TWD
, NZD
, NIO
, NIC
, NGN
, KPW
, NOK
, OMR
, PKR
, XPD
, PAB
, PGK
, PYG
, PEI
, PEN
, PES
, PHP
, XPT
, PLN
, PLZ
, PTE
, GWE
, QAR
, XRE
, RHD
, RON
, ROL
, RUB
, RUR
, RWF
, SVC
, WST
, SAR
, RSD
, CSD
, SCR
, SLL
, XAG
, SGD
, SKK
, SIT
, SBD
, SOS
, ZAR
, ZAL
, KRH
, KRW
, KRO
, SSP
, SUR
, ESP
, ESA
, ESB
, XDR
, LKR
, SHP
, XSU
, SDD
, SDG
, SDP
, SRD
, SRG
, SZL
, SEK
, CHF
, SYP
, STN
, STD
, TVD
, TJR
, TJS
, TZS
, XTS
, THB
, XXX
, TPE
, TOP
, TTD
, TND
, TRY
, TRL
, TMT
, TMM
, USD
, USN
, USS
, UGX
, UGS
, UAH
, UAK
, AED
, UYW
, UYU
, UYP
, UYI
, UZS
, VUV
, VES
, VEB
, VEF
, VND
, VNN
, CHE
, CHW
, XOF
, YDD
, YER
, YUN
, YUD
, YUM
, YUR
, ZWN
, ZRN
, ZRZ
, ZMW
, ZMK
, ZWD
, ZWR
, ZWL
.payments
ArrayPayment
object IDsapplied_payments
Arrayaccounting_period
UUIDid
field in the AccountingPeriod object.applied_to_lines
Arrayintegration_params
Objectlinked_account_params
ObjectSupported POST Model Parameters
applied_to_lines
CreditNoteApplyLineForCreditNote[]remote_id
stringcreated_at
stringmodified_at
stringinvoice
stringapplied_date
stringapplied_amount
stringremote_was_deleted
booleancontact
UUIDcurrency
Enumexchange_rate
Stringinclusive_of_tax
Booleanline_items
CreditNoteLineItem[]id
stringremote_id
stringcreated_at
stringmodified_at
stringitem
stringname
stringdescription
stringquantity
stringmemo
stringunit_price
stringtax_rate
stringtotal_line_amount
stringtracking_category
stringtracking_categories
arrayaccount
stringcompany
stringremote_was_deleted
booleannumber
Stringremaining_credit
Numberremote_created_at
DateTime (ISO 8601)remote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtotal_amount
Numbertransaction_date
DateTime (ISO 8601)https://api.merge.dev/api/accounting/v1/credit-notes/{id}
Returns a CreditNote
object with the given id
.
expand
Stringid
UUIDinclude_remote_data
Booleanremote_fields
Stringshow_enum_origins
StringSupported Response Fields
currency
Enumpayments
Arrayremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
Enumtotal_amount
Numbertransaction_date
DateTime (ISO 8601)Supported Response Fields
line_items
CreditNoteLineItem[]remote_id
stringitem
stringdescription
stringquantity
stringunit_price
stringtotal_line_amount
stringtracking_categories
arrayaccount
stringcompany
stringcompany
UUIDcontact
UUIDcurrency
Enumnumber
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtotal_amount
Numbertracking_categories
Arraytransaction_date
DateTime (ISO 8601)Supported Response Fields
line_items
CreditNoteLineItem[]remote_id
stringitem
stringquantity
stringunit_price
stringtax_rate
stringtotal_line_amount
stringtracking_categories
arrayaccount
stringaccounting_period
UUIDapplied_payments
Arraycompany
UUIDcontact
UUIDcurrency
Enumexchange_rate
Stringinclusive_of_tax
Booleannumber
Stringremaining_credit
Numberremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtotal_amount
Numbertracking_categories
Arraytransaction_date
DateTime (ISO 8601)Supported Response Fields
line_items
CreditNoteLineItem[]remote_id
stringitem
stringdescription
stringquantity
stringmemo
stringunit_price
stringtotal_line_amount
stringtracking_categories
arrayaccount
stringapplied_payments
Arraycontact
UUIDcurrency
Enumexchange_rate
Stringnumber
Stringremaining_credit
Numberremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)total_amount
Numbertracking_categories
Arraytransaction_date
DateTime (ISO 8601)Supported Response Fields
currency
Enumremaining_credit
Numberremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtotal_amount
Numbertransaction_date
DateTime (ISO 8601)Supported Response Fields
line_items
CreditNoteLineItem[]remote_id
stringitem
stringdescription
stringtax_rate
stringtotal_line_amount
stringtracking_categories
arrayaccount
stringcompany
stringcompany
UUIDcontact
UUIDcurrency
Enumexchange_rate
Stringnumber
Stringremaining_credit
Numberremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtotal_amount
Numbertransaction_date
DateTime (ISO 8601)Supported Response Fields
line_items
CreditNoteLineItem[]remote_id
stringitem
stringdescription
stringquantity
stringunit_price
stringtax_rate
stringtotal_line_amount
stringtracking_categories
arrayaccount
stringapplied_payments
Arrayapplied_to_lines
CreditNoteApplyLineForCreditNote[]remote_id
stringcreated_at
stringmodified_at
stringinvoice
stringapplied_date
stringapplied_amount
stringremote_was_deleted
booleancontact
UUIDcurrency
Enumexchange_rate
Stringinclusive_of_tax
Booleannumber
Stringpayments
Arrayremaining_credit
Numberremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtotal_amount
Numbertransaction_date
DateTime (ISO 8601)Supported Response Fields
line_items
CreditNoteLineItem[]remote_id
stringitem
stringdescription
stringquantity
stringunit_price
stringtotal_line_amount
stringaccount
stringcompany
UUIDcontact
UUIDcurrency
Enumexchange_rate
Stringnumber
Stringremaining_credit
Numberremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtotal_amount
Numbertransaction_date
DateTime (ISO 8601)https://api.merge.dev/api/accounting/v1/credit-notes/meta/post
Returns metadata for CreditNote
POSTs.
Supported POST Model Parameters
applied_to_lines
CreditNoteApplyLineForCreditNote[]remote_id
stringcreated_at
stringmodified_at
stringinvoice
stringapplied_date
stringapplied_amount
stringremote_was_deleted
booleancontact
UUIDcurrency
Enumexchange_rate
Stringinclusive_of_tax
Booleanline_items
CreditNoteLineItem[]id
stringremote_id
stringcreated_at
stringmodified_at
stringitem
stringname
stringdescription
stringquantity
stringmemo
stringunit_price
stringtax_rate
stringtotal_line_amount
stringtracking_category
stringtracking_categories
arrayaccount
stringcompany
stringremote_was_deleted
booleannumber
Stringremaining_credit
Numberremote_created_at
DateTime (ISO 8601)remote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumtotal_amount
Numbertransaction_date
DateTime (ISO 8601)