API ReferenceInvoiceDocument

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.

Path parameters

invoiceIdstringRequired

Invoice ID or Invoice ForeignID

Headers

AuthorizationstringRequired

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

Response

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

mimeTypestring
typeenum
uristring
idstringOptional

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

Errors