Skip to main content
GET
Get an invoice document

Authorizations

Authorization
string
header
required

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

Path Parameters

document_uuid
string
required

UUID of the invoice document in this request.

Pattern: ^[^/]+$
uuid
string<uuid>
required

UUID of the invoice in this request.

Response

Read shape of an invoice document.

created_at
string<date-time>
required
read-only

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

download_url
string<uri> | null
required
read-only

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

filename
string | null
required
read-only

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

id
string<uuid>
required
read-only

Stable identifier of the invoice document.

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
updated_at
string<date-time>
required
read-only

Time at which the document was last updated.