Skip to main content
Import prices from Documents

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.

idempotency-key
string

Optional protection for safely retrying a request after a timeout or lost response. Choose a unique value (for example, a UUID) for each action and reuse it with the same input when retrying. Omit it for a normal request.

Required string length: 1 - 200
Pattern: ^[\x21-\x7e]+$

Path Parameters

id
string<uuid>
required

Body

application/json
entries
object[]
required

1–200 distinct documents linked to this agreement, each with its own settings.

Required array length: 1 - 200 elements
mode
enum<string>
default:add

add keeps existing prices; replace_document replaces the prices earlier imports of each document created; replace_all replaces every price on the agreement, once. Nothing is deleted unless an import finds valid prices.

Available options:
add,
replace_document,
replace_all
extract_again
boolean
default:false

Read the file again instead of reusing the rows from an earlier import of the same file and settings.

Response

Every file reused an existing import, or the Idempotency-Key was used before; nothing new started.

workflow_run_id
string<uuid> | null
required
entries
object[]
required