Skip to main content
List invoice imports

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.

Query Parameters

fields
string

Return only these fields of each row, 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.

limit
integer
default:50

Maximum number of results per page.

Required range: 1 <= x <= 1000
cursor
string

Opaque next_cursor from the previous page. Keep the same filters and sort; omit for the first page.

Maximum string length: 4096
statuses
string

Comma-separated: queued, running, completed, failed, cancelled. failed lists imports that need attention.

Maximum string length: 4000
outcomes
string

Comma-separated outcome of completed imports: imported, duplicate (the invoice already existed) or not_invoice.

Maximum string length: 4000
origins
string

How the invoice was submitted: upload, api, email or integration.

Maximum string length: 4000
Maximum string length: 255
created_from
string<date-time>
Maximum string length: 27
created_before
string<date-time>
Maximum string length: 27
sort
enum<string>
default:created_at
Available options:
created_at,
updated_at,
primary_file_name
direction
enum<string>
default:desc
Available options:
asc,
desc
deleted
enum<string>
default:false
Available options:
true,
false

Response

A page of import summaries; next_cursor is null at the end.

data
object[]
required
Maximum array length: 1000
next_cursor
string | null
required
total
integer
required
failed_retryable_count
integer
required
has_ingestion
boolean
required

True when the organization has ever submitted invoices, regardless of filters and pagination.