For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Token-based authentication with required prefix “Bearer”
Path parameters
idstringRequiredformat: "uuid"
Headers
X-Account-TokenstringRequired
Token identifying the end user.
Query parameters
expandlist of enumsOptional
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
idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional
The third-party API ID of the matching object.
created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
transaction_datedatetime or nullOptional
The credit note's transaction date.
statusenum or nullOptional
The credit note's status.
numberstring or nullOptional
The credit note's number.
contactstring or nullOptionalformat: "uuid"
The credit note's contact.
companystring or nullOptionalformat: "uuid"
The company the credit note belongs to.
exchange_ratestring or nullOptionalformat: "decimal"
The credit note's exchange rate.
total_amountdouble or nullOptional
The credit note's total amount.
remaining_creditdouble or nullOptional
The amount of value remaining in the credit note that the customer can use.
inclusive_of_taxboolean or nullOptional
If the transaction is inclusive or exclusive of tax. True if inclusive, False if exclusive.
line_itemslist of objectsOptionalRead-only
tracking_categorieslist of stringsOptional
currencyenum or nullOptional
The credit note's currency. The currency code in ISO 4217 format.
remote_created_atdatetime or nullOptional
When the third party's credit note was created.
remote_updated_atdatetime or nullOptional
When the third party's credit note was updated.
paymentslist of stringsOptional
Array of Payment object IDs
applied_paymentslist of stringsOptional
A list of the Payment Applied to Lines common models related to a given Invoice, Credit Note, or Journal Entry.
accounting_periodstring or nullOptionalformat: "uuid"
The accounting period that the CreditNote was generated in.
applied_to_lineslist of objectsOptional
A list of the CreditNote Applied to Lines common models related to a given Credit Note
credit_note_urlstring or nullOptionalformat: "uri"<=2000 characters
The 3rd party URL of the credit note.
remote_was_deletedbooleanOptionalRead-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 nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only
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
