Skip to main content
Get an invoice import

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required

Query Parameters

fields
string

Return only these fields, comma-separated; use dots for nested fields, such as provenance.uploader. id is always returned. Fields: id, status, origin, supersedes_invoice, deleted_at, primary_document, source_count, attachment_count, retryable, provenance, classification_reason, outcome, invoice_id, workflow_run_id, workflow_run_item_id, failure, created_at, updated_at, sources, sources_next_cursor, evidence.

Response

The import.

id
string<uuid>
required
status
enum<string>
required
Available options:
queued,
running,
completed,
failed,
cancelled
origin
enum<string>
required

How the invoice was submitted.

Available options:
upload,
api,
email,
integration
supersedes_invoice
boolean
required

True when this import replaces an existing invoice from the same source.

deleted_at
string<date-time> | null
required
primary_document
object | null
required
source_count
integer
required
Required range: x >= 0
attachment_count
integer
required
Required range: x >= 0
retryable
boolean
required

Whether the import can be retried.

provenance
object
required
classification_reason
string | null
required
outcome
enum<string> | null
required
Available options:
imported,
duplicate,
not_invoice,
null
invoice_id
string<uuid> | null
required
workflow_run_id
string<uuid>
required
workflow_run_item_id
string<uuid>
required
failure
object | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
sources
object[]
required
sources_next_cursor
string | null
required
evidence
object[]
required

The latest result of each extraction step, for diagnostics. More steps may be added.

Maximum array length: 4