Skip to main content
Export suppliers or recipients

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

type
enum<string>
required

supplier: issues invoices. recipient: invoices are addressed to it.

Available options:
supplier,
recipient
Required string length: 1 - 200
sort
enum<string>
default:name

spend sorts by the amount of each party's main currency, the first of invoice_totals; amounts in different currencies are compared as they are, unconverted.

Available options:
name,
organization_number,
email,
invoice_count,
spend,
agreement_count
direction
enum<string>
default:asc
Available options:
asc,
desc
has_invoices
boolean
has_agreements
boolean
include_archived_agreements
boolean

Include archived agreements when evaluating has_agreements. Defaults to false.

has_alerts
boolean

Alerts belong to suppliers; no recipient has pending alerts.

company_ids
string<uuid>[]

Only these workspace companies: their recipients, or the suppliers with invoices, agreements, orders or accounting links in them. Counts and spend cover those companies' invoices only.

Required array length: 1 - 1000 elements
invoice_issued_from
string
Pattern: ^\d{4}-\d{2}-\d{2}$
invoice_issued_through
string
Pattern: ^\d{4}-\d{2}-\d{2}$
format
enum<string>
default:csv
Available options:
csv,
xlsx

Response

The export file. Content type follows format.

The response is of type file.