Invoice

Get attached file from an invoice

Retrieves a file attached to an invoice.

get/Invoice/attachedFileFromInvoice/{idInvoice}/{filename}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/Invoice/attachedFileFromInvoice/{idInvoice}/{filename}
  • Auth: HTTP bearer

Path parameters

filenamestring required

The filename in Payabli. Get this from the zipName field in the DocumentsRef.filelist array returned by /api/Invoice/{idInvoice}. Example: 0_Bill.pdf.

idInvoiceinteger required

Invoice ID

Query parameters

returnObjectboolean

When true, the request returns the file content as a Base64-encoded string.

Response

A successful response returns a binary file when returnObject is false. When returnObject is true, the response contains the file content as a Base64-encoded string in an object. Due to technical limitations, only the object response is documented here.

fContentstring

Content of file, Base64-encoded. Ignored if furl is specified. Max upload size is 30 MB.

filenamestring

The name of the attached file.

ftype'pdf' | 'doc' | 'docx' | 'jpg' | 'jpeg' | 'png' | 'gif' | 'txt'

The MIME type of the file (if content is provided).

furlstring

Optional URL provided to show or download the file remotely.

Changes

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