InvoiceDocument

Get Check PDF

GET
Get a PDF of the check for the invoice. If the invoice does not have check as the disbursement method, an error will be returned. If the disbursement option for the check is set to 'MAIL', a void copy of the check will be returned. If the disbursement option for the check is set to 'PRINT', a printable check will be returned. If the invoice is NOT marked as PAID, the check will be a void copy.

Path parameters

invoiceIdstringRequired

Response

This endpoint returns an object
mimeType
string
uri
string
id
stringOptional
ID of the document. If not provided, this is a dynamic document that is generated on the fly.
GET
1curl https://api.mercoa.com/invoice/:invoiceId/check/generate \
2     -H "Authorization: Bearer <token>"
200
Retrieved
1{
2  "mimeType": "string",
3  "uri": "string",
4  "id": "string"
5}
Built with