Send the PDF of an invoice to be scanned and processed further based on the given PDF.
Send only the PDF of an invoice to be put in the system
This endpoint submits a raw PDF of a purchase invoice for scanning and further automatic processing.
A developer calls this endpoint when only the invoice document itself is available, for example when an invoice arrives by email, and the invoice's structured data (amounts, lines, ledger accounts) still needs to be extracted by Bloxs rather than supplied directly.
The PDF is queued for processing by the "Scan en herken" process (scan and recognise), rather than being turned into an invoice immediately. As a result, the invoice becomes available afterwards as a concept purchase invoice within the application.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
subject | string | Yes | Subject or short description associated with the submitted PDF. Maximum length 512 characters. |
file | object | Yes | The PDF file to be processed. See fields below. |
file.fileName | string | Yes | Name of the file, including extension. Minimum length 1, maximum length 512 characters. |
file.mimeType | string | Yes | MIME type of the file, for example application/pdf. Minimum length 1, maximum length 100 characters. |
file.base64 | string | Yes | Base64-encoded content of the PDF file. Minimum length 1. |
relatedIdentifiers | array of strings | No | Collection of identifiers used to relate the submitted PDF to existing entities, so the resulting invoice can be linked automatically once processing completes. |
Response Fields
A successful request returns a 202 Accepted status with no response body. The PDF has been queued for scanning, the resulting concept purchase invoice is not returned directly in this response.
null
The PDF file data has validation issues