Sign in
ProformaInvoice

Attach file to proforma invoice V3

This endpoint requires the following scopes: proformaInvoice:update.

Attach a file to a proforma invoice.

post/api/v3/proformaInvoices/{id}/files

Path parameters

idstring required

Request body

titlestring

Title of the file

descriptionstring

Description of the file

keyword'otherFile' | 'coverPage' | 'attachment' | 'eInvoice' | 'receipt' | 'paymentReceipt' required

Document keyword/type

fileNamestring required

Name of the file

fileContentstring required

Base64 encoded file content

Example request

{
  "title": "Supporting document",
  "description": "Additional documentation",
  "keyword": "otherFile",
  "fileName": "document.txt",
  "fileContent": "c2FtcGxlIGNvbnRlbnQ="
}

Response

Attach a file to a proforma invoice.

Example response

{
  "data": {
    "id": 123
  }
}

Changes

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