API referencePay In endpointsInvoices

Get invoice attachment

Retrieves a file attached to an invoice.

Path parameters

filenamestringRequired

The filename in Payabli. Filename is zipName in the response to a request to /api/Invoice/{idInvoice}. Here, the filename is `0_Bill.pdf“.

  "DocumentsRef": {
    "zipfile": "inva_269.zip",
    "filelist": [
      {
        "originalName": "Bill.pdf",
        "zipName": "0_Bill.pdf",
        "descriptor": null
      }
    ]
  }
idInvoiceintegerRequired
Invoice ID

Headers

requestTokenstringRequired

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 or null

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

filenamestring or null
The name of the attached file.
ftypeenum or null

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

furlstring or null
Optional url provided to show or download the file remotely

Errors