Credit Notes
The CreditNote object are an accounts payable transaction used when to represent a gift or refund to a customer. A credit note will contain information on the amount of credit owed, the customer, and the account.The CreditNote object
Properties
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
transaction_dateStringOptional
The credit note's transaction date.
statusEnumOptional
The credit note's status. Possible values include:
SUBMITTED, AUTHORIZED, PAID, or - in cases where there is no clear mapping - the original value passed through.numberStringOptional
The credit note's number.
contactStringOptional
The credit note's contact.
companyStringOptional
The company the credit note belongs to.
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, or - in cases where there is no clear mapping - the original value passed through.remote_created_atStringOptional
When the third party's credit note was created.
remote_updated_atStringOptional
When the third party's credit note was updated.
paymentsArrayRequired
Array of
Payment object IDsremote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted by third party webhooks.
field_mappingsObjectOptional
modified_atStringRequired
This is the datetime that this object was last updated by Merge
remote_dataRemoteData[]Optional
The CreditNote object
JSON
{"id": "8d9fd929-436c-4fd4-a48b-0c61f68d6178","remote_id": "123877","transaction_date": "2020-03-31T00:00:00Z","status": "PAID","number": "CN-29","contact": "c6c7b870-bb4d-489a-921e-2f0ee4192ff9","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","total_amount": 50,"remaining_credit": 20,"line_items": [{"item": "0e3fd929-436c-4fd4-a48b-0c61f68d6178","name": "Basic Monthly","description": "prorated amount for items","quantity": 1,"memo": "privNote","unit_price": "5.0","tax_rate": "8d9fd929-436c-4fd4-a48b-0c61f68d6178","total_line_amount": "5.0","tracking_category": "8d9fd929-436c-4fd4-a48b-0c61f68d6178","tracking_categories": ["8d9fd929-436c-4fd4-a48b-0c61f68d6178","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"account": "8d9fd929-436c-4fd4-a48b-0c61f68d6178","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","remote_id": "121222"}],"tracking_categories": ["b38c59b0-a9d7-4740-b1ee-5436c6751e3d","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"currency": "USD","remote_created_at": "2020-03-31T00:00:00Z","remote_updated_at": "2020-03-31T00:00:00Z","payments": ["b26fd49a-cbae-470a-a8f8-bcbc119e0390"],"remote_was_deleted": true,Show advanced fields}
GET
/credit-notes
Returns a list of CreditNote objects.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
company_idStringOptional
If provided, will only return credit notes for this company.
created_afterStringOptional
If provided, will only return objects created after this datetime.
created_beforeStringOptional
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_afterStringOptional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeStringOptional
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
Which fields should be returned in non-normalized form.
transaction_date_afterStringOptional
If provided, will only return objects created after this datetime.
transaction_date_beforeStringOptional
If provided, will only return objects created before this datetime.
Response
JSON
{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"id": "8d9fd929-436c-4fd4-a48b-0c61f68d6178","remote_id": "123877","transaction_date": "2020-03-31T00:00:00Z","status": "PAID","number": "CN-29","contact": "c6c7b870-bb4d-489a-921e-2f0ee4192ff9","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","total_amount": 50,"remaining_credit": 20,"line_items": [{"item": "0e3fd929-436c-4fd4-a48b-0c61f68d6178","name": "Basic Monthly","description": "prorated amount for items","quantity": 1,"memo": "privNote","unit_price": "5.0","tax_rate": "8d9fd929-436c-4fd4-a48b-0c61f68d6178","total_line_amount": "5.0","tracking_category": "8d9fd929-436c-4fd4-a48b-0c61f68d6178","tracking_categories": ["8d9fd929-436c-4fd4-a48b-0c61f68d6178","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"account": "8d9fd929-436c-4fd4-a48b-0c61f68d6178","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","remote_id": "121222"}],"tracking_categories": ["b38c59b0-a9d7-4740-b1ee-5436c6751e3d","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"currency": "USD","remote_created_at": "2020-03-31T00:00:00Z","remote_updated_at": "2020-03-31T00:00:00Z","payments": ["b26fd49a-cbae-470a-a8f8-bcbc119e0390"],"remote_was_deleted": true,Show advanced fields}]}
Field support by platform
FreshBooks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyEnumremote_dataRemoteData[]pathstringdataobjectremote_idStringstatusEnumtotal_amountNumbertransaction_dateString
Microsoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsCreditNoteLineItem[]itemstringdescriptionstringquantitystringunit_pricestringtotal_line_amountstringtracking_categoriesarrayaccountstringcompanystringremote_idstringcompanyStringcontactStringcurrencyEnumnumberStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumtotal_amountNumbertracking_categoriesArraytransaction_dateString
NetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsCreditNoteLineItem[]itemstringquantitystringunit_pricestringtotal_line_amountstringaccountstringremote_idstringcompanyStringcontactStringcurrencyEnumnumberStringremaining_creditNumberremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumtotal_amountNumbertransaction_dateString
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsCreditNoteLineItem[]itemstringdescriptionstringquantitystringunit_pricestringtotal_line_amountstringtracking_categorystringtracking_categoriesarrayaccountstringremote_idstringcontactStringcurrencyEnumnumberStringremaining_creditNumberremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringtotal_amountNumbertracking_categoriesArraytransaction_dateString
Sage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyEnumremaining_creditNumberremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumtotal_amountNumbertransaction_dateString
Sage Intacct
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsCreditNoteLineItem[]itemstringdescriptionstringtotal_line_amountstringtracking_categoriesarrayaccountstringcompanystringremote_idstringcompanyStringcurrencyEnumnumberStringremaining_creditNumberremote_created_atStringremote_idStringremote_updated_atStringstatusEnumtotal_amountNumbertransaction_dateString
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsCreditNoteLineItem[]itemstringdescriptionstringquantitystringunit_pricestringtotal_line_amountstringtracking_categorystringtracking_categoriesarrayaccountstringremote_idstringcontactStringcurrencyEnumnumberStringremaining_creditNumberremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumtotal_amountNumbertransaction_dateString
Zoho Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsCreditNoteLineItem[]itemstringdescriptionstringquantitystringunit_pricestringtotal_line_amountstringaccountstringremote_idstringcompanyStringcontactStringcurrencyEnumnumberStringremaining_creditNumberremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumtotal_amountNumbertransaction_dateStringHint: Use the /linked-accounts endpoint to pull platform support information.
GET
/credit-notes/{id}
Returns a CreditNote object with the given id.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idStringRequired
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
Which fields should be returned in non-normalized form.
Response
JSON
{"id": "8d9fd929-436c-4fd4-a48b-0c61f68d6178","remote_id": "123877","transaction_date": "2020-03-31T00:00:00Z","status": "PAID","number": "CN-29","contact": "c6c7b870-bb4d-489a-921e-2f0ee4192ff9","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","total_amount": 50,"remaining_credit": 20,"line_items": [{"item": "0e3fd929-436c-4fd4-a48b-0c61f68d6178","name": "Basic Monthly","description": "prorated amount for items","quantity": 1,"memo": "privNote","unit_price": "5.0","tax_rate": "8d9fd929-436c-4fd4-a48b-0c61f68d6178","total_line_amount": "5.0","tracking_category": "8d9fd929-436c-4fd4-a48b-0c61f68d6178","tracking_categories": ["8d9fd929-436c-4fd4-a48b-0c61f68d6178","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"account": "8d9fd929-436c-4fd4-a48b-0c61f68d6178","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","remote_id": "121222"}],"tracking_categories": ["b38c59b0-a9d7-4740-b1ee-5436c6751e3d","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"currency": "USD","remote_created_at": "2020-03-31T00:00:00Z","remote_updated_at": "2020-03-31T00:00:00Z","payments": ["b26fd49a-cbae-470a-a8f8-bcbc119e0390"],"remote_was_deleted": true,Show advanced fields}
Field support by platform
FreshBooks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyEnumremote_dataRemoteData[]pathstringdataobjectremote_idStringstatusEnumtotal_amountNumbertransaction_dateStringMicrosoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsCreditNoteLineItem[]itemstringdescriptionstringquantitystringunit_pricestringtotal_line_amountstringtracking_categoriesarrayaccountstringcompanystringremote_idstringcompanyStringcontactStringcurrencyEnumnumberStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumtotal_amountNumbertracking_categoriesArraytransaction_dateStringNetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsCreditNoteLineItem[]itemstringquantitystringunit_pricestringtotal_line_amountstringaccountstringremote_idstringcompanyStringcontactStringcurrencyEnumnumberStringremaining_creditNumberremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumtotal_amountNumbertransaction_dateStringQuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsCreditNoteLineItem[]itemstringdescriptionstringquantitystringunit_pricestringtotal_line_amountstringtracking_categorystringtracking_categoriesarrayaccountstringremote_idstringcontactStringcurrencyEnumnumberStringremaining_creditNumberremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringtotal_amountNumbertracking_categoriesArraytransaction_dateStringSage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyEnumremaining_creditNumberremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumtotal_amountNumbertransaction_dateStringSage Intacct
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsCreditNoteLineItem[]itemstringdescriptionstringtotal_line_amountstringtracking_categoriesarrayaccountstringcompanystringremote_idstringcompanyStringcurrencyEnumnumberStringremaining_creditNumberremote_created_atStringremote_idStringremote_updated_atStringstatusEnumtotal_amountNumbertransaction_dateStringXero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsCreditNoteLineItem[]itemstringdescriptionstringquantitystringunit_pricestringtotal_line_amountstringtracking_categorystringtracking_categoriesarrayaccountstringremote_idstringcontactStringcurrencyEnumnumberStringremaining_creditNumberremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumtotal_amountNumbertransaction_dateStringZoho Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsCreditNoteLineItem[]itemstringdescriptionstringquantitystringunit_pricestringtotal_line_amountstringaccountstringremote_idstringcompanyStringcontactStringcurrencyEnumnumberStringremaining_creditNumberremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumtotal_amountNumbertransaction_dateStringHint: Use the /linked-accounts endpoint to pull platform support information.