APIPay Out endpointsBills

Get bill attachment

View as MarkdownOpen in Claude

Retrieves a file attached to a bill, either as a binary file or as a Base64-encoded string.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

filenamestringRequired

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

idBillintegerRequired

Payabli ID for the bill. Get this ID by querying /api/Query/bills/ for the entrypoint or the organization.

Query parameters

returnObjectbooleanOptionalDefaults to false

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.
ftypeenum

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

furlstring
Optional URL provided to show or download the file remotely.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error