invoice-template > document

Get Check PDF

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.

get/invoice-template/{invoiceTemplateId}/check/generate

Request

  • Base URL: https://api.mercoa.com
  • URL: https://api.mercoa.com/invoice-template/{invoiceTemplateId}/check/generate
  • Auth: HTTP bearer

Path parameters

invoiceTemplateIdstring required

Invoice Template ID

Response

Link to the PDF file. Will expire after 1 hour.

idstring

ID of the document. If not provided, this is a dynamic document that is generated on the fly.

mimeTypestring required
type'INVOICE' | 'PAYMENT_CONFIRMATION' | 'TEN_NINETY_NINE' | 'W9' | 'CHECK' | 'BANK_STATEMENT' | 'CONTRACT' | 'OTHER' required
uristring required

Changes

No recorded changes to this operation across all 1 revision of this API.