Credit Notes
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.Properties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
modified_atDateTime (ISO 8601)Required
This is the datetime that this object was last updated by Merge
transaction_dateDateTime (ISO 8601)Optional
The credit note's transaction date.
statusEnumOptional
The credit note's status. Possible values include:
SUBMITTED, AUTHORIZED, PAID. In cases where there is no clear mapping, the original value passed through will be returned.numberStringOptional
The credit note's number.
contactUUIDOptional
The credit note's contact.
companyUUIDOptional
The company the credit note belongs to.
exchange_rateStringOptional
The credit note's exchange rate.
total_amountNumberOptional
The credit note's total amount.
remaining_creditNumberOptional
The amount of value remaining in the credit note that the customer can use.
line_itemsCreditNoteLineItem[]Required
tracking_categoriesArrayRequired
currencyEnumOptional
The credit note's currency. Possible values include:
XUA, 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.remote_created_atDateTime (ISO 8601)Optional
When the third party's credit note was created.
remote_updated_atDateTime (ISO 8601)Optional
When the third party's credit note was updated.
paymentsArrayRequired
Array of
Payment object IDsapplied_paymentsArrayRequired
A list of the Payment Applied to Lines common models related to a given Invoice, Credit Note, or Journal Entry.
remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted in the third party platform.
accounting_periodUUIDOptional
The accounting period that the CreditNote was generated in.
field_mappingsObjectOptional
remote_dataRemoteData[]Optional
GET
/credit-notes
https://api.merge.dev/api/accounting/v1/credit-notes
US
EU
Returns a list of CreditNote objects.
Query & Path Parameters
company_idStringOptional
If provided, will only return credit notes for this company.
created_afterDateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterDateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeIntegerOptional
Number of results to return per page.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
remote_idStringOptional
The API provider's ID for the given object.
show_enum_originsStringOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more
transaction_date_afterDateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
transaction_date_beforeDateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
FreshBooks
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
currencyEnumpaymentsArrayremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtotal_amountNumbertransaction_dateDateTime (ISO 8601)
Microsoft Dynamics 365 Business Central
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
line_itemsCreditNoteLineItem[]remote_idstringitemstringdescriptionstringquantitystringunit_pricestringtotal_line_amountstringtracking_categoriesarrayaccountstringcompanystringcompanyUUIDcontactUUIDcurrencyEnumnumberStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)statusEnumtotal_amountNumbertracking_categoriesArraytransaction_dateDateTime (ISO 8601)
NetSuite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
line_itemsCreditNoteLineItem[]remote_idstringitemstringquantitystringunit_pricestringtotal_line_amountstringaccountstringaccounting_periodUUIDapplied_paymentsArraycompanyUUIDcontactUUIDcurrencyEnumexchange_rateStringnumberStringremaining_creditNumberremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)statusEnumtotal_amountNumbertransaction_dateDateTime (ISO 8601)
QuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
line_itemsCreditNoteLineItem[]remote_idstringitemstringdescriptionstringquantitystringmemostringunit_pricestringtotal_line_amountstringtracking_categoriesarrayaccountstringapplied_paymentsArraycontactUUIDcurrencyEnumexchange_rateStringnumberStringremaining_creditNumberremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)total_amountNumbertracking_categoriesArraytransaction_dateDateTime (ISO 8601)
Sage Business Cloud Accounting
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
currencyEnumremaining_creditNumberremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)statusEnumtotal_amountNumbertransaction_dateDateTime (ISO 8601)
Sage Intacct
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
line_itemsCreditNoteLineItem[]remote_idstringitemstringdescriptionstringtotal_line_amountstringtracking_categoriesarrayaccountstringcompanystringcompanyUUIDcontactUUIDcurrencyEnumexchange_rateStringnumberStringremaining_creditNumberremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)statusEnumtotal_amountNumbertransaction_dateDateTime (ISO 8601)
Xero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
line_itemsCreditNoteLineItem[]remote_idstringitemstringdescriptionstringquantitystringunit_pricestringtotal_line_amountstringtracking_categoriesarrayaccountstringapplied_paymentsArraycontactUUIDcurrencyEnumexchange_rateStringnumberStringpaymentsArrayremaining_creditNumberremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)statusEnumtotal_amountNumbertransaction_dateDateTime (ISO 8601)
Zoho Books
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
line_itemsCreditNoteLineItem[]remote_idstringitemstringdescriptionstringquantitystringunit_pricestringtotal_line_amountstringaccountstringcompanyUUIDcontactUUIDcurrencyEnumexchange_rateStringnumberStringremaining_creditNumberremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)statusEnumtotal_amountNumbertransaction_dateDateTime (ISO 8601)GET
/credit-notes/{id}
https://api.merge.dev/api/accounting/v1/credit-notes/{id}
US
EU
Returns a CreditNote object with the given id.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUIDRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
show_enum_originsStringOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
FreshBooks
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
currencyEnumpaymentsArrayremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumtotal_amountNumbertransaction_dateDateTime (ISO 8601)Microsoft Dynamics 365 Business Central
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
line_itemsCreditNoteLineItem[]remote_idstringitemstringdescriptionstringquantitystringunit_pricestringtotal_line_amountstringtracking_categoriesarrayaccountstringcompanystringcompanyUUIDcontactUUIDcurrencyEnumnumberStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)statusEnumtotal_amountNumbertracking_categoriesArraytransaction_dateDateTime (ISO 8601)NetSuite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
line_itemsCreditNoteLineItem[]remote_idstringitemstringquantitystringunit_pricestringtotal_line_amountstringaccountstringaccounting_periodUUIDapplied_paymentsArraycompanyUUIDcontactUUIDcurrencyEnumexchange_rateStringnumberStringremaining_creditNumberremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)statusEnumtotal_amountNumbertransaction_dateDateTime (ISO 8601)QuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
line_itemsCreditNoteLineItem[]remote_idstringitemstringdescriptionstringquantitystringmemostringunit_pricestringtotal_line_amountstringtracking_categoriesarrayaccountstringapplied_paymentsArraycontactUUIDcurrencyEnumexchange_rateStringnumberStringremaining_creditNumberremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)total_amountNumbertracking_categoriesArraytransaction_dateDateTime (ISO 8601)Sage Business Cloud Accounting
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
currencyEnumremaining_creditNumberremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)statusEnumtotal_amountNumbertransaction_dateDateTime (ISO 8601)Sage Intacct
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
line_itemsCreditNoteLineItem[]remote_idstringitemstringdescriptionstringtotal_line_amountstringtracking_categoriesarrayaccountstringcompanystringcompanyUUIDcontactUUIDcurrencyEnumexchange_rateStringnumberStringremaining_creditNumberremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)statusEnumtotal_amountNumbertransaction_dateDateTime (ISO 8601)Xero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
line_itemsCreditNoteLineItem[]remote_idstringitemstringdescriptionstringquantitystringunit_pricestringtotal_line_amountstringtracking_categoriesarrayaccountstringapplied_paymentsArraycontactUUIDcurrencyEnumexchange_rateStringnumberStringpaymentsArrayremaining_creditNumberremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)statusEnumtotal_amountNumbertransaction_dateDateTime (ISO 8601)Zoho Books
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
line_itemsCreditNoteLineItem[]remote_idstringitemstringdescriptionstringquantitystringunit_pricestringtotal_line_amountstringaccountstringcompanyUUIDcontactUUIDcurrencyEnumexchange_rateStringnumberStringremaining_creditNumberremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)statusEnumtotal_amountNumbertransaction_dateDateTime (ISO 8601)