Skip to main content
Get a price import

Authorizations

Authorization
string
header
required

Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.

Headers

X-Organization-Id
string

Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.

Path Parameters

id
string<uuid>
required
import_id
string<uuid>
required

Response

The price import.

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

The Document the prices were extracted from.

worksheets
string[] | null
required
instructions
string | null
required
default_currency
string | null
required
status
enum<string>
required

completed means the new prices are appended and the price table is written, in one transaction. Failed and cancelled imports append nothing.

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

Row outcomes, set when the import completes; null before and on failure.

failure
object | null
required

extraction_incomplete, extraction_failed, agreement_busy or agreement_deleted. dispatch_failed or admission_expired: processing never started. execution_incomplete: processing ended without a result. Import again in every case.

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