Skip to main content
Get a price import

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
import_id
string<uuid>
required

Query Parameters

fields
string

Return only these fields, comma-separated; use dots for nested fields, such as counts.created. id is always returned. Fields: id, agreement_id, document_id, origin, worksheets, instructions, default_currency, mode, status, counts, failure, extraction_source_import_id, workflow_run_id, workflow_run_item_id, created_at, updated_at.

Response

The price import.

id
string<uuid>
required
agreement_id
string<uuid>
required
document_id
string<uuid>
required

The document the prices were read from.

origin
enum<string>
required

legacy imports are older imports with no workflow run, row counts or price table.

Available options:
workflow,
legacy
worksheets
string[] | null
required
instructions
string | null
required
default_currency
string | null
required
mode
enum<string>
required

Which existing prices the import replaces: none (add), those from earlier imports of this document (replace_document), or all (replace_all).

Available options:
add,
replace_document,
replace_all
status
enum<string>
required

Failed and cancelled imports add no prices.

Available options:
queued,
running,
completed,
failed,
cancelled
counts
object | null
required

Row outcomes. Null until the import completes.

failure
object | null
required

Why the import failed. Import again to retry.

extraction_source_import_id
string<uuid> | null
required

The earlier import whose rows this import reused instead of reading the same file again. Null when it read the file itself.

workflow_run_id
string<uuid> | null
required
workflow_run_item_id
string<uuid> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required