API ReferenceContract

Preview Invoices

Generate previews of the invoices that will be created from the provided contract.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
contractobjectRequired
Contract to preview invoice creation for
invoiceIndexeslist of integersRequired

Indexes of the invoices to generate from each recurrence (e.g. [0, 1, 2] for the first three invoices). Note that contracts with multiple recurrences will generate more preview invoices, and invalid invoice indexes will be ignored silently. For example, [0, 1, 2] on a contract with 2 recurrences will generate at most 6 invoices, and potentially fewer if some of indexes are out of bounds for a recurrence.

Response

This endpoint returns a list of objects.
approvalPolicylist of objects
approverslist of objects
createdAtdatetime
hasDocumentsboolean
True if the invoice has documents attached.
hasSourceEmailboolean
True if the invoice was created by an incoming email.
idstring
metadatamap from strings to strings
Metadata associated with this invoice.
paymentDestinationConfirmedboolean

True if the payment destination has been confirmed by the vendor. False if the payment destination has been set (for example, a check to an address) but has not been confirmed by the vendor.

statusenum
updatedAtdatetime
amountdouble or null
Total amount of invoice in major units
batchPaymentboolean or null
If true, this invoice will be paid as a batch payment. Batches are automatically determined by Mercoa based on the payment source, destination, and scheduled payment date.
commentslist of objects or null
creatorEntityIdstring or null
The ID of the entity who created this invoice.
creatorUserobject or null
Entity user who created this invoice.
currencyenum or null
Currency code for the amount. Defaults to USD.
deductionDatedatetime or null
Initial date when funds are scheduled to be deducted from payer's account. The actual deduction date may differ from this date, and will be reflected in the processedAt field.
dueDatedatetime or null
Due date of invoice.
failureTypeenum or null
If the invoice failed to be paid, this field will be populated with the type of failure.
Allowed values:
feesobject or null
Fees associated with this invoice.
foreignIdstring or null
The ID used to identify this invoice in your system. This ID must be unique within each creatorEntity in your system, e.g. two invoices with the same creatorEntity may not have the same foreign ID.
invoiceDatedatetime or null
Date the invoice was issued.
invoiceNumberstring or null
lineItemslist of objects or null
netTermsinteger or null
Net terms in days. Must be a positive number.
nextDeductionDatedatetime or null
For invoice templates, this is the date when the next recurring payment will be scheduled.
noteToSelfstring or null
ocrJobIdstring or null
ID of the OCR job that processed this invoice.
payerobject or null
payerIdstring or null
paymentDestinationobject or null
paymentDestinationIdstring or null
paymentDestinationOptionsobject or null
paymentScheduleobject or null

If this is a recurring invoice, this will be the payment schedule for the invoice. If not provided, this will be a one-time invoice.

paymentSourceobject or null
paymentSourceIdstring or null
paymentTimingobject or null
processedAtdatetime or null
Date when the invoice payment was processed.
serviceEndDatedatetime or null
serviceStartDatedatetime or null
settlementDatedatetime or null
Date of funds settlement.
shippingAmountdouble or null
Shipping amount for this invoice.
taxAmountdouble or null
Tax amount for this invoice.
transactionslist of objects or null
Transactions associated with this invoice.
vendorobject or null
vendorCreditIdslist of strings or null
The IDs of the vendor credits that are currently applied to this invoice.
vendorIdstring or null

Errors