Skip to main content
Find invoices by supplier, number, date or status

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 supplier.id. id is always returned. Fields: id, url, invoice_number, title, category, issued_date, due_date, created_at, updated_at, deleted_at, supplier, recipient, amounts, review, workflows, alerts, relationships.

mine
enum<string>

Only records matched by the filters of teams you belong to. Teams combine with OR; other filters combine with AND. Cannot be combined with team_ids.

Available options:
true,
false
team_ids
string

Only records matched by the filters of these teams: at most 50, comma-separated in a query string or an array in a JSON body. Teams combine with OR. Unknown teams return 404.

Case-insensitive match on invoice number, title, or supplier or recipient name (as printed on the invoice or as currently named). Eight or more digits, spaces ignored, also match a printed organization number. Fewer than three characters match the start of the invoice number.

Required string length: 1 - 200
invoice_number
string

Case-insensitive match on invoice number. Fewer than three characters match its start.

Required string length: 1 - 200
supplier_ids
string

Supplier IDs, comma-separated (maximum 50). Use null for invoices without a supplier.

recipient_ids
string

Recipient IDs, comma-separated (maximum 50). Use null for invoices without a recipient.

categories
string

Categories, comma-separated: invoice, credit_note, self_billed_invoice.

currency_codes
string

Currency codes, comma-separated (maximum 50). Use null for unknown currency, for example NOK,EUR,null.

join_operator
enum<string>
default:and

and requires every column filter to match; or requires at least one. Search, agreement_ids, deleted and team filters always apply.

Available options:
and,
or
supplier_operator
enum<string>
default:is

How supplier_ids applies: is matches any listed value; is_not excludes all listed values.

Available options:
is,
is_not
recipient_operator
enum<string>
default:is

How recipient_ids applies: is matches any listed value; is_not excludes all listed values.

Available options:
is,
is_not
category_operator
enum<string>
default:is

How categories applies: is matches any listed value; is_not excludes all listed values.

Available options:
is,
is_not
currency_operator
enum<string>
default:is

How currency_codes applies: is matches any listed value; is_not excludes all listed values.

Available options:
is,
is_not
confidence_operator
enum<string>
default:is

How confidence_levels applies: is matches any listed value; is_not excludes all listed values.

Available options:
is,
is_not
check_status_operator
enum<string>
default:is

How check_statuses applies: is matches any listed value; is_not excludes all listed values.

Available options:
is,
is_not
alert_status_operator
enum<string>
default:is

How alert_statuses applies: is matches any listed value; is_not excludes all listed values.

Available options:
is,
is_not
display_status_operator
enum<string>
default:is

How display_statuses applies: is matches any listed value; is_not excludes all listed values.

Available options:
is,
is_not
alert_statuses
string

Alert status, comma-separated: credited (covered by credit notes), checking (a check is running), has_issues (open alerts), clean (checked, no open alerts), not_checked.

display_statuses
string

Like alert_statuses, but splits credited into resolved_by_credit_note (alerts were found first) and pre_empted_by_credit_note (no alerts were found). Comma-separated: not_checked, checking, has_issues, clean, resolved_by_credit_note, pre_empted_by_credit_note.

confidence_levels
string

Extraction confidence, comma-separated: high, mid, low or unknown.

check_statuses
string

Check status, comma-separated: completed (every matched agreement checked), incomplete (some checks missing, failed or outdated), checking, not_checked, or not_checkable (credit notes, invoices with a matched credit note, invoices without a document).

has_recorded_match
enum<string>

true selects invoices linked to a credit note, and credit notes linked to an invoice; false selects those without.

Available options:
true,
false
alert_scope
enum<string>
default:invoice

invoice covers all of the invoice's checks and alerts; selected_agreements covers only the agreements in agreement_ids (required).

Available options:
invoice,
selected_agreements
issued_from
string

Earliest issue date (YYYY-MM-DD), inclusive.

Pattern: ^\d{4}-\d{2}-\d{2}$
issued_through
string

Latest issue date (YYYY-MM-DD), inclusive.

Pattern: ^\d{4}-\d{2}-\d{2}$
due_from
string

Earliest due date (YYYY-MM-DD), inclusive.

Pattern: ^\d{4}-\d{2}-\d{2}$
due_through
string

Latest due date (YYYY-MM-DD), inclusive.

Pattern: ^\d{4}-\d{2}-\d{2}$
financially_valid
enum<string>

Whether the amounts add up (see amounts.valid).

Available options:
true,
false
extraction_confirmed
enum<string>

Whether a person has confirmed the extracted data.

Available options:
true,
false

Whether review is recommended (see review.recommended).

Available options:
true,
false
agreement_ids
string

Agreement IDs, comma-separated (maximum 50). Selects invoices matched to any of them.

has_agreement_match
enum<string>

Whether the invoice is matched to at least one agreement.

Available options:
true,
false
has_open_alerts
enum<string>

Whether the invoice has open (pending or claimed) alerts.

Available options:
true,
false
deleted
enum<string>
default:false

true lists only soft-deleted invoices. Defaults to false.

Available options:
true,
false
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
sort
enum<string>
default:created_at

Sort field. supplier and recipient sort by current name; total_amount uses the total including VAT. Empty values sort last.

Available options:
created_at,
issued_date,
due_date,
total_amount,
invoice_number,
supplier,
recipient
direction
enum<string>
default:desc

Sort direction. Empty values always sort last.

Available options:
asc,
desc

Response

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

data
object[]
required
Maximum array length: 1000
next_cursor
string | null
required