Update
Request
- Base URL: https://api.mercoa.com
- URL: https://api.mercoa.com/invoice/{invoiceId}
- Auth: HTTP bearer
Path parameters
Invoice ID or Invoice ForeignID
Request body
Total amount of invoice in major units. If the entered amount has more decimal places than the currency supports, trailing decimals will be truncated.
Date the invoice was issued.
Initial date when funds are scheduled to be deducted from payer's account.
Date of funds settlement.
Due date of invoice.
Note to self or memo on invoice.
Net terms in days. Must be a positive number.
Metadata associated with this invoice.
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.
Base64-encoded string. Supported file types include PNG, JPG, WEBP, PDF, and all Microsoft Office formats (automatically converted to PDF). Max file size 10MB. If the invoice already has a document, this will add a new document to the invoice.
DEPRECATED. Use document field instead.
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.
The IDs of the vendor credits to be applied to this invoice. Passing this field will un-apply any previously applied vendor credits.
Tax amount for this invoice.
Shipping amount for this invoice.
Set to true if the payment destination has been confirmed by the vendor or if the payment destination should default to the selected payment destination on the vendor portal.
Response
Response with status 200
Total amount of invoice in major units
Date the invoice was issued.
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.
For invoice templates, this is the date when the next recurring payment will be scheduled.
Due date of invoice.
Net terms in days. Must be a positive number.
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.
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.
True if the invoice has documents attached.
True if the invoice was created by an incoming email.
Tax amount for this invoice.
Shipping amount for this invoice.
Metadata associated with this invoice.
The foreign ID of the entity group that created this invoice.
Date when the invoice payment was processed.
Date of funds settlement.
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.
The IDs of the vendor credits that are currently applied to this invoice.
Changes
No recorded changes to this operation across all 1 revision of this API.