APIPay Out endpointsBills

Delete bill attachment

Delete a file attached to a bill.

Path parameters

filenamestringRequired

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

1  "DocumentsRef": {
2    "zipfile": "inva_269.zip",
3    "filelist": [
4      {
5        "originalName": "Bill.pdf",
6        "zipName": "0_Bill.pdf",
7        "descriptor": null
8      }
9    ]
10  }
idBillintegerRequired

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

Headers

requestTokenstringRequired

Query parameters

returnObjectbooleanOptionalDefaults to false

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

Response

Success
responseCodeinteger or null

Code for the response. Learn more in API Response Codes.

pageIdentifierstring or null
Auxiliary validation used internally by payment pages and components.
roomIdlong or null

Field not in use on this endpoint. It always returns 0.

isSuccessboolean or null

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

responseTextstring or null

Response text for operation: ‘Success’ or ‘Declined’.

responseDatastring or integer or null

If isSuccess = true, this contains the bill identifier. If isSuccess = false, this contains the reason for the error.

Errors