Skip to main content
Export agreement prices as CSV

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

Matches a substring of any text field or the currency, an exact validity date (YYYY-MM-DD), or a number as an amount, rate, percentage or position.

Required string length: 1 - 200
ids
string

Only these price items, for example the price_item_ids of an alert.

price_import_id
string<uuid>

Only prices this price import created.

filters
string

A JSON array of filters. Every filter must match. Each is { field, operator, value }: text fields support equals, not_equals, contains and in (case-insensitive); numbers and dates also greater_than and less_than; is_empty and is_not_empty take no value; in takes a list. Rates and fractions are decimal fractions, dates YYYY-MM-DD.

Maximum string length: 10000
Example:

"[{\"field\":\"currency_code\",\"operator\":\"equals\",\"value\":\"NOK\"}]"

sort
enum<string>
default:position

The field to order by; position by default.

Available options:
position,
description,
product_code,
product_group,
unit,
currency_code,
price_type,
amount,
rate,
rate_basis,
discount_rate,
surcharge_rate,
vat_rate,
applicability,
calculation_rules,
valid_from,
valid_until,
created_at,
updated_at
direction
enum<string>
default:asc

Empty values sort last in either direction.

Available options:
asc,
desc

Response

The CSV file.

The response is of type file.