Skip to main content
POST
Attach the invoice PDF
Draft documentation — API not yet rolled out. This endpoint describes the preview contract and may change before release. Sandbox access is provided separately. See access and limitations.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

uuid
string<uuid>
required

UUID of the invoice in this request.

Body

Exactly one of file (multipart) or base64. PDF only.

A document is only ever the bytes the client itself transmits. url is rejected as an unknown field rather than silently ignored, and the error never echoes the value back -- a presigned source URL carries credentials in its query string.

base64
string
required

Base64-encoded complete PDF; a data: prefix is accepted. Provide exactly one of base64 or file. Maximum decoded document size: 10 MiB (10,485,760 bytes); maximum PDF length: 100 pages. Each invoice holds one PDF; uploading again replaces it while the invoice is held. Oversized files are rejected during upload; processing failures appear as status failed.

Required string length: 1 - 15029589
file
file

Invoice PDF supplied as multipart form-data. Provide exactly one of file or base64. Maximum file size: 10 MiB (10,485,760 bytes); maximum PDF length: 100 pages. Each invoice holds one PDF; uploading again replaces it while the invoice is held. Oversized files are rejected during upload; processing failures appear as status failed.

filename
string

Optional filename override. Defaults to the uploaded file's name for multipart or document.pdf for base64.

Required string length: 1 - 255

Response

Read shape of an invoice document.

id
string<uuid>
required
read-only
filename
string | null
required
read-only

Stored document filename, or null when no filename is available.

mime_type
string | null
required
read-only

Document media type (application/pdf for an accepted PDF), or null when unavailable.

size
integer | null
required
read-only

Document size in bytes. Null before ready, and may remain null if the size of a legacy document cannot be retrieved.

status
enum<string>
required

Document ingestion state: pending while processing, ready after acceptance, rejected when content is rejected, or failed when ingestion/scanning cannot complete. Replace a rejected or failed document while the invoice is held to try again.

Available options:
pending,
ready,
rejected,
failed
download_url
string<uri> | null
required
read-only

Authenticated API URL for downloading the invoice PDF; null unless the document is ready.

created_at
string<date-time>
required
read-only

Creation time of the stable document resource; unchanged when its contents are replaced.

updated_at
string<date-time>
required
read-only