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_remote_fieldsbooleanOptional
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
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.
typeenum or nullOptional
Whether the invoice is an accounts receivable or accounts payable. If type is ACCOUNTS_PAYABLE, the invoice is a bill. If type is ACCOUNTS_RECEIVABLE, it is an invoice.
Allowed values:
contactstring or nullOptionalformat: "uuid"
The invoice's contact.
numberstring or nullOptional
The invoice's number.
issue_datedatetime or nullOptional
The invoice's issue date.
due_datedatetime or nullOptional
The invoice's due date.
paid_on_datedatetime or nullOptional
The invoice's paid date.
memostring or nullOptional
The invoice's private note.
companystring or nullOptionalformat: "uuid"
The company the invoice belongs to.
employeestring or nullOptionalformat: "uuid"
The employee this overall transaction relates to.
currencyenum or nullOptional
The invoice's currency. The currency code in ISO 4217 format.
exchange_ratestring or nullOptionalformat: "decimal"
The invoice's exchange rate.
payment_termstring or nullOptionalformat: "uuid"
The payment term that applies to this transaction.
total_discountdouble or nullOptional
The total discounts applied to the total cost.
sub_totaldouble or nullOptional
The total amount being paid before taxes.
statusenum or nullOptional
The status of the invoice.
total_tax_amountdouble or nullOptional
The total amount being paid in taxes.
total_amountdouble or nullOptional
The invoice's total amount.
balancedouble or nullOptional
The invoice's remaining balance.
remote_updated_atdatetime or nullOptional
When the third party's invoice entry was updated.
tracking_categorieslist of stringsOptional
accounting_periodstring or nullOptionalformat: "uuid"
The accounting period that the Invoice was generated in.
purchase_orderslist of stringsOptional
sales_orderslist of stringsOptional
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.
line_itemslist of objectsOptionalRead-only
applied_credit_noteslist of objectsOptional
CreditNoteApplyLines applied to the Invoice.
applied_vendor_creditslist of objectsOptional
VendorCreditApplyLines applied to the Invoice.
inclusive_of_taxboolean or nullOptional
If the transaction is inclusive or exclusive of tax. True if inclusive, False if exclusive.
invoice_urlstring or nullOptionalformat: "uri"<=2000 characters
The 3rd party URL of the invoice.
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
remote_fieldslist of objectsOptionalRead-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
