Create

POST

Request

This endpoint expects an object.
amountdoubleOptional

Total amount of invoice in major units. If the entered amount has more decimal places than the currency supports, trailing decimals will be truncated.

approverslist of objectsOptional

Set approvers for this invoice.

batchPaymentbooleanOptional

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.

creatorEntityIdstringOptional

ID of the entity who created this invoice template.

creatorUserIdstringOptional

User ID or Foreign ID of entity user who created this invoice.

currencyenumOptional

Currency code for the amount. Defaults to USD.

deductionDatedatetimeOptional

Initial date when funds are scheduled to be deducted from payer’s account.

documentstringOptional

Base64 encoded image or PDF of invoice document. PNG, JPG, WEBP, and PDF are supported. 10MB max. If the invoice already has a document, this will add a new document to the invoice.

dueDatedatetimeOptional

Due date of invoice.

feesobjectOptional

If using a custom payment method, you can override the default fees for this invoice. If not provided, the default fees for the custom payment method will be used.

invoiceDatedatetimeOptional

Date the invoice was issued.

invoiceNumberstringOptional
lineItemslist of objectsOptional
metadatamap from strings to stringsOptional

Metadata associated with this invoice.

noteToSelfstringOptional

Note to self or memo on invoice.

payerIdstringOptional

ID or foreign ID of the payer of this invoice.

paymentDestinationIdstringOptional

ID of payment destination for this invoice. If not provided, will attempt to use the default payment destination for the vendor when creating an invoice if a default payment destination exists for the vendor.

paymentDestinationOptionsobjectOptional

Options for the payment destination. Depending on the payment destination, this may include things such as check delivery method.

paymentScheduleobjectOptional

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.

paymentSourceIdstringOptional

ID of payment source for this invoice. If not provided, will attempt to use the default payment source for the payer when creating an invoice if a default payment source exists for the payer.

serviceEndDatedatetimeOptional
serviceStartDatedatetimeOptional
statusenumOptional
vendorIdstringOptional

ID or foreign ID of the vendor of this invoice.

Response

This endpoint returns an object.
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
amountdoubleOptional

Total amount of invoice in major units

batchPaymentbooleanOptional

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 objectsOptional
creatorEntityIdstringOptional

The ID of the entity who created this invoice.

creatorUserobjectOptional

Entity user who created this invoice.

currencyenumOptional

Currency code for the amount. Defaults to USD.

deductionDatedatetimeOptional

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.

dueDatedatetimeOptional

Due date of invoice.

feesobjectOptional

Fees associated with this invoice.

invoiceDatedatetimeOptional

Date the invoice was issued.

invoiceNumberstringOptional
lineItemslist of objectsOptional
nextDeductionDatedatetimeOptional

For invoice templates, this is the date when the next recurring payment will be scheduled.

noteToSelfstringOptional
payerobjectOptional
payerIdstringOptional
paymentDestinationobjectOptional
paymentDestinationIdstringOptional
paymentDestinationOptionsobjectOptional
paymentScheduleobjectOptional

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.

paymentSourceobjectOptional
paymentSourceIdstringOptional
serviceEndDatedatetimeOptional
serviceStartDatedatetimeOptional
vendorobjectOptional
vendorIdstringOptional