Credit Notes

The CreditNote object is used to represent a refund or credit of payment.

The CreditNote object

Properties


idString
Required

remote_idString
Optional
The third-party API ID of the matching object.

transaction_dateString
Optional
The credit note's transaction date.

statusEnum
Optional
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.

total_amountNumber
Optional
The credit note's total amount.

remaining_creditNumber
Optional
The credit note's remaining credit.

currencyEnum
Optional
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_atString
Optional
When the third party's credit note was created.

remote_updated_atString
Optional
When the third party's credit note was updated.

paymentsArray
Required
Array of Payment object IDs

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted on the third-party.

The CreditNote object
JSON
{
"id": "8d9fd929-436c-4fd4-a48b-0c61f68d6178",
"remote_id": "123877",
"transaction_date": "2020-03-31T00:00:00Z",
"status": "PAID",
"total_amount": 50,
"remaining_credit": 20,
"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
}

GET

/credit-notes

Returns a list of CreditNote objects.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_deleted_dataBoolean
Optional
Whether to include data that was deleted in the third-party service.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

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",
"total_amount": 50,
"remaining_credit": 20,
"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
}
]
}
Field support by platform

FreshBooks

FreshBooks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


currencyEnum

transaction_dateString

remote_idString

statusEnum

total_amountNumber

Zoho Books

Zoho Books

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


currencyEnum

remaining_creditNumber

transaction_dateString

remote_created_atString

remote_idString

remote_updated_atString

statusEnum

total_amountNumber

Xero

Xero

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


currencyEnum

remaining_creditNumber

transaction_dateString

remote_idString

remote_updated_atString

statusEnum

total_amountNumber

Sage Business Cloud Accounting

Sage Business Cloud Accounting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


currencyEnum

remaining_creditNumber

transaction_dateString

remote_created_atString

remote_idString

remote_updated_atString

statusEnum

total_amountNumber

Quickbooks Online

Quickbooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


currencyEnum

remaining_creditNumber

transaction_dateString

remote_created_atString

remote_idString

remote_updated_atString

total_amountNumber
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/credit-notes/{id}

Returns a CreditNote object with the given id.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{
"id": "8d9fd929-436c-4fd4-a48b-0c61f68d6178",
"remote_id": "123877",
"transaction_date": "2020-03-31T00:00:00Z",
"status": "PAID",
"total_amount": 50,
"remaining_credit": 20,
"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
}
Field support by platform

FreshBooks

FreshBooks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


currencyEnum

transaction_dateString

remote_idString

statusEnum

total_amountNumber

Zoho Books

Zoho Books

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


currencyEnum

remaining_creditNumber

transaction_dateString

remote_created_atString

remote_idString

remote_updated_atString

statusEnum

total_amountNumber

Xero

Xero

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


currencyEnum

remaining_creditNumber

transaction_dateString

remote_idString

remote_updated_atString

statusEnum

total_amountNumber

Sage Business Cloud Accounting

Sage Business Cloud Accounting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


currencyEnum

remaining_creditNumber

transaction_dateString

remote_created_atString

remote_idString

remote_updated_atString

statusEnum

total_amountNumber

Quickbooks Online

Quickbooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


currencyEnum

remaining_creditNumber

transaction_dateString

remote_created_atString

remote_idString

remote_updated_atString

total_amountNumber
Hint: Use the /linked-accounts endpoint to pull platform support information.