Common ModelsCredit Notes

/credit-notes/{id}

Returns a CreditNote object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

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

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

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

Allowed values:
show_enum_originsenumOptional
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](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
Allowed values:

Response

idstringRead-onlyformat: "uuid"
remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only
The datetime that this object was created by Merge.
modified_atdatetimeRead-only
The datetime that this object was modified by Merge.
transaction_datedatetime or null
The credit note's transaction date.
statusenum or null
The credit note's status. * `SUBMITTED` - SUBMITTED * `AUTHORIZED` - AUTHORIZED * `PAID` - PAID
Allowed values:
numberstring or null
The credit note's number.
contactstring or nullformat: "uuid"
The credit note's contact.
companystring or nullformat: "uuid"
The company the credit note belongs to.
exchange_ratestring or nullformat: "decimal"
The credit note's exchange rate.
total_amountdouble or null
The credit note's total amount.
remaining_creditdouble or null
The amount of value remaining in the credit note that the customer can use.
inclusive_of_taxboolean or null

If the transaction is inclusive or exclusive of tax. True if inclusive, False if exclusive.

line_itemslist of objectsRead-only
tracking_categorieslist of strings
currencyenum or null
The credit note's currency. The currency code in ISO 4217 format.
remote_created_atdatetime or null
When the third party's credit note was created.
remote_updated_atdatetime or null
When the third party's credit note was updated.
paymentslist of strings

Array of Payment object IDs

applied_paymentslist of strings
A list of the Payment Applied to Lines common models related to a given Invoice, Credit Note, or Journal Entry.
accounting_periodstring or nullformat: "uuid"
The accounting period that the CreditNote was generated in.
applied_to_lineslist of objects
A list of the CreditNote Applied to Lines common models related to a given Credit Note
remote_was_deletedbooleanRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullRead-only
remote_datalist of objects or nullRead-only

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information