Skip to main content
Get an agreement document relationship

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

Query Parameters

fields
string

Return only these fields, comma-separated; use dots for nested fields, such as document.id. Fields: agreement_id, ingestion_status, document, role, price_imported, active_price_import, imported_price_count, has_historical_price_import, position, suggestion, preparation, created_at, updated_at.

Response

The resource.

agreement_id
string<uuid>
required
ingestion_status
enum<string>
required
Available options:
pending,
accepted,
rejected,
cancelled,
failed
document
object
required
role
enum<string>
required
Available options:
terms,
price_list,
uncategorized,
excluded
price_imported
boolean
required

True when prices have been imported from this document.

active_price_import
object | null
required

The price import from this document that is in progress, if any. Cancel it through its workflow run.

imported_price_count
integer
required

Prices on this agreement imported from this document.

has_historical_price_import
boolean
required

True when some prices from this document are not tracked per import: they are not counted in imported_price_count or deleted with delete_imported_prices.

position
integer | null
required
suggestion
object | null
required
preparation
object
required
created_at
string<date-time>
required
updated_at
string<date-time>
required