Common ModelsInvoices

/invoices/{id}

Returns an Invoice 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_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

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.
typeenum or null
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. * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE
Allowed values:
contactstring or nullformat: "uuid"
The invoice's contact.
numberstring or null
The invoice's number.
issue_datedatetime or null
The invoice's issue date.
due_datedatetime or null
The invoice's due date.
paid_on_datedatetime or null
The invoice's paid date.
memostring or null
The invoice's private note.
companystring or nullformat: "uuid"
The company the invoice belongs to.
employeestring or nullformat: "uuid"
The employee this overall transaction relates to.
currencyenum or null
The invoice's currency. The currency code in ISO 4217 format.
exchange_ratestring or nullformat: "decimal"
The invoice's exchange rate.
payment_termstring or nullformat: "uuid"
The payment term that applies to this transaction.
total_discountdouble or null
The total discounts applied to the total cost.
sub_totaldouble or null
The total amount being paid before taxes.
statusenum or null
The status of the invoice. * `PAID` - PAID * `DRAFT` - DRAFT * `SUBMITTED` - SUBMITTED * `PARTIALLY_PAID` - PARTIALLY_PAID * `OPEN` - OPEN * `VOID` - VOID
total_tax_amountdouble or null
The total amount being paid in taxes.
total_amountdouble or null
The invoice's total amount.
balancedouble or null
The invoice's remaining balance.
remote_updated_atdatetime or null
When the third party's invoice entry was updated.
tracking_categorieslist of strings
accounting_periodstring or nullformat: "uuid"
The accounting period that the Invoice was generated in.
purchase_orderslist of strings
sales_orderslist of strings
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.
line_itemslist of objectsRead-only
applied_credit_noteslist of objects

CreditNoteApplyLines applied to the Invoice.

applied_vendor_creditslist of objects

VendorCreditApplyLines applied to the Invoice.

inclusive_of_taxboolean or null

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

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
remote_fieldslist of objectsRead-only