Endpoint reference

This reference is generated from the same validated OpenAPI artifact used by the backend and Postman collection. Only listed operations are part of the external beta contract. The web application's internal routes are not supported integration endpoints.

All requests require approved workspace beta access and a workspace service-account key. Financial values can be null or absent when the key lacks the corresponding visibility scopes. Directory responses omit embedded project histories; retrieve assigned projects through the project endpoints.

239 operations. Required fields are marked with *. Computed JSON values may vary with permissions; examples do not grant additional access.

GET /api/v1/workspaces/{workspace_id}/calendar-exceptions/

Required scopes and service-account permissions: events:read, schedules:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Reusable security logic for any Workspace-scoped resource.

Parameters

Name	Location	Details
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	CalendarException[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/calendar-exceptions/

Required scopes and service-account permissions: events:write, schedules:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Reusable security logic for any Workspace-scoped resource.

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`date` *	date
`is_working`	boolean	False = non-working; True = working override
`note`	string
`project`	uuid

Responses

201 — Success

Field	Type	Details
`date` *	date
`id` *	uuid
`is_working`	boolean	False = non-working; True = working override
`note`	string
`project`	uuid
`workspace` *	uuid

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/calendar-exceptions/{id}/

Required scopes and service-account permissions: events:write, schedules:manage. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Reusable security logic for any Workspace-scoped resource.

Parameters

Name	Location	Details
`id` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/calendar-exceptions/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`date` *	date
`id` *	uuid
`is_working`	boolean	False = non-working; True = working override
`note`	string
`project`	uuid
`workspace` *	uuid

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/calendar-exceptions/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`date`	date
`is_working`	boolean	False = non-working; True = working override
`note`	string
`project`	uuid

Responses

200 — Success

Field	Type	Details
`date` *	date
`id` *	uuid
`is_working`	boolean	False = non-working; True = working override
`note`	string
`project`	uuid
`workspace` *	uuid

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/customers/

Required scopes and service-account permissions: customers:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Reusable security logic for any Workspace-scoped resource.

Parameters

Name	Location	Details
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	CustomerList[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/customers/

Required scopes and service-account permissions: customers:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Reusable security logic for any Workspace-scoped resource.

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`avatar_color`	string
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`billing_address`	AddressRequest
`company`	string	Optional company name for the customer.
`contact_email`	email	Primary contact email for this customer entity.
`contacts_payload`	ContactRequest[]
`customer_type`	string	* `residential` - Residential * `commercial` - Commercial Options: residential, commercial
`name` *	string	Name of the customer (individual or company).
`notes`	string
`payment_terms_days`	integer	Default number of days until an invoice is due for this customer.
`phone_number`	string
`relationship_stage`	string	Prospect until a job is won; active once they have live or completed work. * `prospect` - Prospect * `active` - Active client * `past` - Past client Options: prospect, active, past
`tax_id`	string	Tax ID or VAT Number.

Responses

201 — Success

Field	Type	Details
`avatar_color`	string
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`billing_address`	Address
`company`	string	Optional company name for the customer.
`contact_email`	email	Primary contact email for this customer entity.
`contacts` *	Contact[]
`customer_type`	string	* `residential` - Residential * `commercial` - Commercial Options: residential, commercial
`id` *	uuid
`name` *	string	Name of the customer (individual or company).
`notes`	string
`payment_terms_days`	integer	Default number of days until an invoice is due for this customer.
`phone_number`	string
`relationship_stage`	string	Prospect until a job is won; active once they have live or completed work. * `prospect` - Prospect * `active` - Active client * `past` - Past client Options: prospect, active, past
`tax_id`	string	Tax ID or VAT Number.
`workspace` *	uuid

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/customers/{customer_pk}/contacts/

Parameters

Name	Location	Details
`customer_pk` *	path	uuid
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	Contact[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/customers/{customer_pk}/contacts/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`customer_pk` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`avatar_color`	string
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`email`	email
`is_primary_contact`	boolean
`name` *	string
`notes`	string
`phone_number`	string
`role`	string

Responses

201 — Success

Field	Type	Details
`avatar_color`	string
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`email`	email
`id` *	uuid
`is_primary_contact`	boolean
`linked_user` *	LinkedUserAvatar
`name` *	string
`notes`	string
`phone_number`	string
`role`	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/customers/{customer_pk}/contacts/{contact_pk}/

Required scopes and service-account permissions: customers:manage, customers:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Reusable security logic for any Workspace-scoped resource.

Parameters

Name	Location	Details
`contact_pk` *	path	uuid
`customer_pk` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/customers/{customer_pk}/contacts/{contact_pk}/

Parameters

Name	Location	Details
`contact_pk` *	path	uuid
`customer_pk` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`avatar_color`	string
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`email`	email
`id` *	uuid
`is_primary_contact`	boolean
`linked_user` *	LinkedUserAvatar
`name` *	string
`notes`	string
`phone_number`	string
`role`	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/customers/{customer_pk}/contacts/{contact_pk}/

Parameters

Name	Location	Details
`contact_pk` *	path	uuid
`customer_pk` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`avatar_color`	string
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`email`	email
`is_primary_contact`	boolean
`name`	string
`notes`	string
`phone_number`	string
`role`	string

Responses

200 — Success

Field	Type	Details
`avatar_color`	string
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`email`	email
`id` *	uuid
`is_primary_contact`	boolean
`linked_user` *	LinkedUserAvatar
`name` *	string
`notes`	string
`phone_number`	string
`role`	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/customers/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/customers/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`avatar_color`	string
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`billing_address`	Address
`company`	string	Optional company name for the customer.
`contact_email`	email	Primary contact email for this customer entity.
`contacts` *	Contact[]
`customer_type`	string	* `residential` - Residential * `commercial` - Commercial Options: residential, commercial
`id` *	uuid
`name` *	string	Name of the customer (individual or company).
`notes`	string
`payment_terms_days`	integer	Default number of days until an invoice is due for this customer.
`phone_number`	string
`relationship_stage`	string	Prospect until a job is won; active once they have live or completed work. * `prospect` - Prospect * `active` - Active client * `past` - Past client Options: prospect, active, past
`tax_id`	string	Tax ID or VAT Number.
`workspace` *	uuid

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/customers/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`avatar_color`	string
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`billing_address`	AddressRequest
`company`	string	Optional company name for the customer.
`contact_email`	email	Primary contact email for this customer entity.
`contacts_payload`	ContactRequest[]
`customer_type`	string	* `residential` - Residential * `commercial` - Commercial Options: residential, commercial
`name`	string	Name of the customer (individual or company).
`notes`	string
`payment_terms_days`	integer	Default number of days until an invoice is due for this customer.
`phone_number`	string
`relationship_stage`	string	Prospect until a job is won; active once they have live or completed work. * `prospect` - Prospect * `active` - Active client * `past` - Past client Options: prospect, active, past
`tax_id`	string	Tax ID or VAT Number.

Responses

200 — Success

Field	Type	Details
`avatar_color`	string
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`billing_address`	Address
`company`	string	Optional company name for the customer.
`contact_email`	email	Primary contact email for this customer entity.
`contacts` *	Contact[]
`customer_type`	string	* `residential` - Residential * `commercial` - Commercial Options: residential, commercial
`id` *	uuid
`name` *	string	Name of the customer (individual or company).
`notes`	string
`payment_terms_days`	integer	Default number of days until an invoice is due for this customer.
`phone_number`	string
`relationship_stage`	string	Prospect until a job is won; active once they have live or completed work. * `prospect` - Prospect * `active` - Active client * `past` - Past client Options: prospect, active, past
`tax_id`	string	Tax ID or VAT Number.
`workspace` *	uuid

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/activities/

Required scopes and service-account permissions: libraries:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Base for all library endpoints. Mixin enforces Auth, Membership, and Billing.

Parameters

Name	Location	Details
`ordering`	query	Which field to use when ordering the results.
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`search`	query	A search term.
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	Activity[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/libraries/activities/

Required scopes and service-account permissions: libraries:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Base for all library endpoints. Mixin enforces Auth, Membership, and Billing.

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`code`	string
`default_waste_pct`	decimal
`description`	string
`group`	integer
`is_active`	boolean
`last_reviewed_at`	date
`name` *	string
`notes_internal`	string
`parent`	integer
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived
`set` *	integer
`sort`	integer
`work_items`	JSON	Computed JSON value; may be null when access is restricted.
`work_items_input`	ActivityWorkItemInlineRequest[]

Responses

201 — Success

Field	Type	Details
`code`	string
`default_waste_pct`	decimal
`description`	string
`group`	integer
`group_name`	string
`id` *	integer
`is_active`	boolean
`last_reviewed_at`	date
`name` *	string
`notes_internal`	string
`parent`	integer
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived
`set` *	integer
`set_name` *	string
`sort`	integer
`updated_at` *	date-time
`work_item_count` *	integer
`work_items`	JSON	Computed JSON value; may be null when access is restricted.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/libraries/activities/{id}/

Required scopes and service-account permissions: libraries:manage, libraries:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Base for all library endpoints. Mixin enforces Auth, Membership, and Billing.

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/activities/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`code`	string
`default_waste_pct`	decimal
`description`	string
`group`	integer
`group_name`	string
`id` *	integer
`is_active`	boolean
`last_reviewed_at`	date
`name` *	string
`notes_internal`	string
`parent`	integer
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived
`set` *	integer
`set_name` *	string
`sort`	integer
`updated_at` *	date-time
`work_item_count` *	integer
`work_items`	JSON	Computed JSON value; may be null when access is restricted.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/libraries/activities/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`code`	string
`default_waste_pct`	decimal
`description`	string
`group`	integer
`is_active`	boolean
`last_reviewed_at`	date
`name`	string
`notes_internal`	string
`parent`	integer
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived
`set`	integer
`sort`	integer
`work_items`	JSON	Computed JSON value; may be null when access is restricted.
`work_items_input`	ActivityWorkItemInlineRequest[]

Responses

200 — Success

Field	Type	Details
`code`	string
`default_waste_pct`	decimal
`description`	string
`group`	integer
`group_name`	string
`id` *	integer
`is_active`	boolean
`last_reviewed_at`	date
`name` *	string
`notes_internal`	string
`parent`	integer
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived
`set` *	integer
`set_name` *	string
`sort`	integer
`updated_at` *	date-time
`work_item_count` *	integer
`work_items`	JSON	Computed JSON value; may be null when access is restricted.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/activity-groups/

Parameters

Name	Location	Details
`ordering`	query	Which field to use when ordering the results.
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`search`	query	A search term.
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	ActivityGroup[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/libraries/activity-groups/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`name` *	string

Responses

201 — Success

Field	Type	Details
`id` *	integer
`name` *	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/libraries/activity-groups/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/activity-groups/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`id` *	integer
`name` *	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/libraries/activity-groups/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`name`	string

Responses

200 — Success

Field	Type	Details
`id` *	integer
`name` *	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/activity-sets/

Parameters

Name	Location	Details
`ordering`	query	Which field to use when ordering the results.
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`search`	query	A search term.
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	ActivitySet[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/libraries/activity-sets/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`code`	string
`default_waste_pct`	decimal
`description`	string
`last_reviewed_at`	date
`name` *	string
`notes_internal`	string
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived

Responses

201 — Success

Field	Type	Details
`code`	string
`default_waste_pct`	decimal
`description`	string
`id` *	integer
`last_reviewed_at`	date
`name` *	string
`notes_internal`	string
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/libraries/activity-sets/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/activity-sets/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`code`	string
`default_waste_pct`	decimal
`description`	string
`id` *	integer
`last_reviewed_at`	date
`name` *	string
`notes_internal`	string
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/libraries/activity-sets/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`code`	string
`default_waste_pct`	decimal
`description`	string
`last_reviewed_at`	date
`name`	string
`notes_internal`	string
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived

Responses

200 — Success

Field	Type	Details
`code`	string
`default_waste_pct`	decimal
`description`	string
`id` *	integer
`last_reviewed_at`	date
`name` *	string
`notes_internal`	string
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/budget-groups/

Parameters

Name	Location	Details
`ordering`	query	Which field to use when ordering the results.
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`search`	query	A search term.
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	BudgetGroup[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/libraries/budget-groups/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`code`	string
`is_active`	boolean
`job`	uuid	Optional job-specific group; null = workspace-global.
`name` *	string

Responses

201 — Success

Field	Type	Details
`code`	string
`id` *	uuid
`is_active`	boolean
`job`	uuid	Optional job-specific group; null = workspace-global.
`name` *	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/libraries/budget-groups/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/budget-groups/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`code`	string
`id` *	uuid
`is_active`	boolean
`job`	uuid	Optional job-specific group; null = workspace-global.
`name` *	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/libraries/budget-groups/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`code`	string
`is_active`	boolean
`job`	uuid	Optional job-specific group; null = workspace-global.
`name`	string

Responses

200 — Success

Field	Type	Details
`code`	string
`id` *	uuid
`is_active`	boolean
`job`	uuid	Optional job-specific group; null = workspace-global.
`name` *	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/cost-codes/

Parameters

Name	Location	Details
`ordering`	query	Which field to use when ordering the results.
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`search`	query	A search term.
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	CostCode[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/libraries/cost-codes/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`code`	string
`cost_types`	CostCodeTypeLinkRequest[]
`default_rate`	decimal
`default_unit`	string
`external_code`	string
`is_active`	boolean
`name` *	string

Responses

201 — Success

Field	Type	Details
`code`	string
`cost_types`	CostCodeTypeLink[]
`default_rate`	decimal
`default_unit`	string
`external_code`	string
`id` *	integer
`is_active`	boolean
`is_system` *	boolean
`name` *	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/libraries/cost-codes/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/cost-codes/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`code`	string
`cost_types`	CostCodeTypeLink[]
`default_rate`	decimal
`default_unit`	string
`external_code`	string
`id` *	integer
`is_active`	boolean
`is_system` *	boolean
`name` *	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/libraries/cost-codes/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`code`	string
`cost_types`	CostCodeTypeLinkRequest[]
`default_rate`	decimal
`default_unit`	string
`external_code`	string
`is_active`	boolean
`name`	string

Responses

200 — Success

Field	Type	Details
`code`	string
`cost_types`	CostCodeTypeLink[]
`default_rate`	decimal
`default_unit`	string
`external_code`	string
`id` *	integer
`is_active`	boolean
`is_system` *	boolean
`name` *	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/cost-types/

Parameters

Name	Location	Details
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	CostType[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/libraries/cost-types/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`is_active`	boolean
`name` *	string
`sort_order`	integer

Responses

201 — Success

Field	Type	Details
`id` *	integer
`is_active`	boolean
`is_core` *	boolean
`key` *	string
`name` *	string
`sort_order`	integer

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/libraries/cost-types/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/cost-types/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`id` *	integer
`is_active`	boolean
`is_core` *	boolean
`key` *	string
`name` *	string
`sort_order`	integer

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/libraries/cost-types/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`is_active`	boolean
`name`	string
`sort_order`	integer

Responses

200 — Success

Field	Type	Details
`id` *	integer
`is_active`	boolean
`is_core` *	boolean
`key` *	string
`name` *	string
`sort_order`	integer

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/locations/

Parameters

Name	Location	Details
`ordering`	query	Which field to use when ordering the results.
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`search`	query	A search term.
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	Location[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/libraries/locations/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`code`	string
`description`	string
`is_active`	boolean
`name` *	string
`parent`	integer
`sort_order`	integer

Responses

201 — Success

Field	Type	Details
`code`	string
`created_at` *	date-time
`description`	string
`id` *	integer
`is_active`	boolean
`name` *	string
`parent`	integer
`parent_name`	string
`sort_order`	integer
`updated_at` *	date-time

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/libraries/locations/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/locations/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`code`	string
`created_at` *	date-time
`description`	string
`id` *	integer
`is_active`	boolean
`name` *	string
`parent`	integer
`parent_name`	string
`sort_order`	integer
`updated_at` *	date-time

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/libraries/locations/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`code`	string
`description`	string
`is_active`	boolean
`name`	string
`parent`	integer
`sort_order`	integer

Responses

200 — Success

Field	Type	Details
`code`	string
`created_at` *	date-time
`description`	string
`id` *	integer
`is_active`	boolean
`name` *	string
`parent`	integer
`parent_name`	string
`sort_order`	integer
`updated_at` *	date-time

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/resource-groups/

Parameters

Name	Location	Details
`ordering`	query	Which field to use when ordering the results.
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`search`	query	A search term.
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	ResourceGroup[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/libraries/resource-groups/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`name` *	string

Responses

201 — Success

Field	Type	Details
`id` *	integer
`name` *	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/libraries/resource-groups/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/resource-groups/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`id` *	integer
`name` *	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/libraries/resource-groups/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`name`	string

Responses

200 — Success

Field	Type	Details
`id` *	integer
`name` *	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/resource-notes/

Parameters

Name	Location	Details
`ordering`	query	Which field to use when ordering the results.
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`search`	query	A search term.
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	ResourceNote[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/libraries/resource-notes/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`author_name`	JSON	Computed JSON value; may be null when access is restricted.
`body` *	string
`resource` *	integer

Responses

201 — Success

Field	Type	Details
`author_name`	JSON	Computed JSON value; may be null when access is restricted.
`body` *	string
`created_at` *	date-time
`id` *	integer
`resource` *	integer

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/libraries/resource-notes/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/resource-notes/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`author_name`	JSON	Computed JSON value; may be null when access is restricted.
`body` *	string
`created_at` *	date-time
`id` *	integer
`resource` *	integer

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/libraries/resource-notes/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`author_name`	JSON	Computed JSON value; may be null when access is restricted.
`body`	string
`resource`	integer

Responses

200 — Success

Field	Type	Details
`author_name`	JSON	Computed JSON value; may be null when access is restricted.
`body` *	string
`created_at` *	date-time
`id` *	integer
`resource` *	integer

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/resource-prices/

Parameters

Name	Location	Details
`ordering`	query	Which field to use when ordering the results.
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`search`	query	A search term.
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	ResourcePrice[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/libraries/resource-prices/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`is_default`	boolean	Use this supplier price by default when the resource is added to an estimate.
`notes`	string
`partner`	uuid
`price_type`	string	* `general` - General * `partner` - Partner Options: general, partner
`rate` *	decimal
`resource` *	integer
`supplier_code`	string
`supplier_description`	string
`updated_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`valid_from`	date
`valid_to`	date

Responses

201 — Success

Field	Type	Details
`id` *	integer
`is_default`	boolean	Use this supplier price by default when the resource is added to an estimate.
`notes`	string
`partner`	uuid
`partner_name`	string
`price_type`	string	* `general` - General * `partner` - Partner Options: general, partner
`rate`	decimal
`resource` *	integer
`resource_name` *	string
`supplier_code`	string
`supplier_description`	string
`supplier_listing` *	integer
`updated_at` *	date-time
`updated_by` *	uuid
`updated_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`valid_from`	date
`valid_to`	date
`workspace` *	uuid

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/libraries/resource-prices/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/resource-prices/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`id` *	integer
`is_default`	boolean	Use this supplier price by default when the resource is added to an estimate.
`notes`	string
`partner`	uuid
`partner_name`	string
`price_type`	string	* `general` - General * `partner` - Partner Options: general, partner
`rate`	decimal
`resource` *	integer
`resource_name` *	string
`supplier_code`	string
`supplier_description`	string
`supplier_listing` *	integer
`updated_at` *	date-time
`updated_by` *	uuid
`updated_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`valid_from`	date
`valid_to`	date
`workspace` *	uuid

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/libraries/resource-prices/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`is_default`	boolean	Use this supplier price by default when the resource is added to an estimate.
`notes`	string
`partner`	uuid
`price_type`	string	* `general` - General * `partner` - Partner Options: general, partner
`rate`	decimal
`resource`	integer
`supplier_code`	string
`supplier_description`	string
`updated_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`valid_from`	date
`valid_to`	date

Responses

200 — Success

Field	Type	Details
`id` *	integer
`is_default`	boolean	Use this supplier price by default when the resource is added to an estimate.
`notes`	string
`partner`	uuid
`partner_name`	string
`price_type`	string	* `general` - General * `partner` - Partner Options: general, partner
`rate`	decimal
`resource` *	integer
`resource_name` *	string
`supplier_code`	string
`supplier_description`	string
`supplier_listing` *	integer
`updated_at` *	date-time
`updated_by` *	uuid
`updated_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`valid_from`	date
`valid_to`	date
`workspace` *	uuid

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/resource-supplier-listings/

Parameters

Name	Location	Details
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	ResourceSupplierListing[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/libraries/resource-supplier-listings/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`is_default`	boolean
`partner` *	uuid
`product_url`	uri
`resource` *	integer
`supplier_code`	string
`supplier_description`	string

Responses

201 — Success

Field	Type	Details
`created_at` *	date-time
`id` *	integer
`is_default`	boolean
`partner` *	uuid
`partner_name` *	string
`product_url`	uri
`resource` *	integer
`resource_name` *	string
`supplier_code`	string
`supplier_description`	string
`updated_at` *	date-time
`workspace` *	uuid

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/libraries/resource-supplier-listings/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/resource-supplier-listings/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`created_at` *	date-time
`id` *	integer
`is_default`	boolean
`partner` *	uuid
`partner_name` *	string
`product_url`	uri
`resource` *	integer
`resource_name` *	string
`supplier_code`	string
`supplier_description`	string
`updated_at` *	date-time
`workspace` *	uuid

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/libraries/resource-supplier-listings/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`is_default`	boolean
`partner`	uuid
`product_url`	uri
`resource`	integer
`supplier_code`	string
`supplier_description`	string

Responses

200 — Success

Field	Type	Details
`created_at` *	date-time
`id` *	integer
`is_default`	boolean
`partner` *	uuid
`partner_name` *	string
`product_url`	uri
`resource` *	integer
`resource_name` *	string
`supplier_code`	string
`supplier_description`	string
`updated_at` *	date-time
`workspace` *	uuid

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/resources/

Parameters

Name	Location	Details
`ordering`	query	Which field to use when ordering the results.
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`search`	query	A search term.
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	Resource[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/libraries/resources/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`base_cost_input`	string
`budget_group`	uuid	Commercial reporting group; falls back to resource group when null.
`code`	string
`cost_code`	integer
`cost_code_category`	JSON	Computed JSON value; may be null when access is restricted.
`default_supplier`	JSON	Computed JSON value; may be null when access is restricted.
`default_supplier_price`	JSON	Computed JSON value; may be null when access is restricted.
`default_unit`	uuid
`default_waste_pct`	decimal
`description`	string
`external_url`	uri
`extras_cost_input`	string
`general_price`	JSON	Computed JSON value; may be null when access is restricted.
`group` *	integer
`initial_supplier`	uuid
`initial_supplier_code`	string
`initial_supplier_description`	string
`initial_supplier_name`	string
`initial_supplier_price`	decimal
`initial_supplier_price_valid_from`	date
`initial_supplier_product_url`	uri
`is_active`	boolean
`job`	uuid	Set for Source B (job resource / BOQ list).
`labour_cost_input`	string
`last_reviewed_at`	date
`lead_in_days`	integer
`materials_cost_input`	string
`name` *	string
`notes_internal`	string
`rate_valid_from`	JSON	Computed JSON value; may be null when access is restricted.
`resource_type`	string	* `material` - Material * `labour` - Labour * `plant` - Plant * `subcontract` - Subcontract Options: material, labour, plant, subcontract
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived
`safety_url`	uri
`source_type`	string	* `WORKSPACE_A` - Workspace library * `JOB_B` - Job resource list * `USER_C` - Personal user library Options: WORKSPACE_A, JOB_B, USER_C
`supplier_listing_count`	JSON	Computed JSON value; may be null when access is restricted.
`supplier_price_count`	JSON	Computed JSON value; may be null when access is restricted.
`unit_of_measure`	string
`waste_percent`	decimal

Responses

201 — Success

Field	Type	Details
`base_cost`	decimal
`budget_group`	uuid	Commercial reporting group; falls back to resource group when null.
`budget_group_name`	string
`code`	string
`cost_code`	integer
`cost_code_category`	JSON	Computed JSON value; may be null when access is restricted.
`cost_code_code`	string
`cost_code_name`	string
`created_at` *	date-time
`default_supplier`	JSON	Computed JSON value; may be null when access is restricted.
`default_supplier_price`	JSON	Computed JSON value; may be null when access is restricted.
`default_unit`	uuid
`default_waste_pct`	decimal
`description`	string
`effective_rate` *	object
`external_url`	uri
`extras_cost`	decimal
`general_price`	JSON	Computed JSON value; may be null when access is restricted.
`group` *	integer
`group_name`	string
`id` *	integer
`is_active`	boolean
`job`	uuid	Set for Source B (job resource / BOQ list).
`labour_cost`	decimal
`last_reviewed_at`	date
`lead_in_days`	integer
`materials_cost`	decimal
`name` *	string
`notes_internal`	string
`owner_user` *	uuid
`rate_valid_from`	JSON	Computed JSON value; may be null when access is restricted.
`resource_type`	string	* `material` - Material * `labour` - Labour * `plant` - Plant * `subcontract` - Subcontract Options: material, labour, plant, subcontract
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived
`safety_url`	uri
`source_type`	string	* `WORKSPACE_A` - Workspace library * `JOB_B` - Job resource list * `USER_C` - Personal user library Options: WORKSPACE_A, JOB_B, USER_C
`supplier_listing_count`	JSON	Computed JSON value; may be null when access is restricted.
`supplier_listings` *	ResourceSupplierListing[]
`supplier_price_count`	JSON	Computed JSON value; may be null when access is restricted.
`unit_of_measure`	string
`updated_at` *	date-time
`waste_percent`	decimal

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/libraries/resources/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/resources/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`base_cost`	decimal
`budget_group`	uuid	Commercial reporting group; falls back to resource group when null.
`budget_group_name`	string
`code`	string
`cost_code`	integer
`cost_code_category`	JSON	Computed JSON value; may be null when access is restricted.
`cost_code_code`	string
`cost_code_name`	string
`created_at` *	date-time
`default_supplier`	JSON	Computed JSON value; may be null when access is restricted.
`default_supplier_price`	JSON	Computed JSON value; may be null when access is restricted.
`default_unit`	uuid
`default_waste_pct`	decimal
`description`	string
`effective_rate` *	object
`external_url`	uri
`extras_cost`	decimal
`general_price`	JSON	Computed JSON value; may be null when access is restricted.
`group` *	integer
`group_name`	string
`id` *	integer
`is_active`	boolean
`job`	uuid	Set for Source B (job resource / BOQ list).
`labour_cost`	decimal
`last_reviewed_at`	date
`lead_in_days`	integer
`materials_cost`	decimal
`name` *	string
`notes_internal`	string
`owner_user` *	uuid
`rate_valid_from`	JSON	Computed JSON value; may be null when access is restricted.
`resource_type`	string	* `material` - Material * `labour` - Labour * `plant` - Plant * `subcontract` - Subcontract Options: material, labour, plant, subcontract
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived
`safety_url`	uri
`source_type`	string	* `WORKSPACE_A` - Workspace library * `JOB_B` - Job resource list * `USER_C` - Personal user library Options: WORKSPACE_A, JOB_B, USER_C
`supplier_listing_count`	JSON	Computed JSON value; may be null when access is restricted.
`supplier_listings` *	ResourceSupplierListing[]
`supplier_price_count`	JSON	Computed JSON value; may be null when access is restricted.
`unit_of_measure`	string
`updated_at` *	date-time
`waste_percent`	decimal

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/libraries/resources/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`base_cost_input`	string
`budget_group`	uuid	Commercial reporting group; falls back to resource group when null.
`code`	string
`cost_code`	integer
`cost_code_category`	JSON	Computed JSON value; may be null when access is restricted.
`default_supplier`	JSON	Computed JSON value; may be null when access is restricted.
`default_supplier_price`	JSON	Computed JSON value; may be null when access is restricted.
`default_unit`	uuid
`default_waste_pct`	decimal
`description`	string
`external_url`	uri
`extras_cost_input`	string
`general_price`	JSON	Computed JSON value; may be null when access is restricted.
`group`	integer
`initial_supplier`	uuid
`initial_supplier_code`	string
`initial_supplier_description`	string
`initial_supplier_name`	string
`initial_supplier_price`	decimal
`initial_supplier_price_valid_from`	date
`initial_supplier_product_url`	uri
`is_active`	boolean
`job`	uuid	Set for Source B (job resource / BOQ list).
`labour_cost_input`	string
`last_reviewed_at`	date
`lead_in_days`	integer
`materials_cost_input`	string
`name`	string
`notes_internal`	string
`rate_valid_from`	JSON	Computed JSON value; may be null when access is restricted.
`resource_type`	string	* `material` - Material * `labour` - Labour * `plant` - Plant * `subcontract` - Subcontract Options: material, labour, plant, subcontract
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived
`safety_url`	uri
`source_type`	string	* `WORKSPACE_A` - Workspace library * `JOB_B` - Job resource list * `USER_C` - Personal user library Options: WORKSPACE_A, JOB_B, USER_C
`supplier_listing_count`	JSON	Computed JSON value; may be null when access is restricted.
`supplier_price_count`	JSON	Computed JSON value; may be null when access is restricted.
`unit_of_measure`	string
`waste_percent`	decimal

Responses

200 — Success

Field	Type	Details
`base_cost`	decimal
`budget_group`	uuid	Commercial reporting group; falls back to resource group when null.
`budget_group_name`	string
`code`	string
`cost_code`	integer
`cost_code_category`	JSON	Computed JSON value; may be null when access is restricted.
`cost_code_code`	string
`cost_code_name`	string
`created_at` *	date-time
`default_supplier`	JSON	Computed JSON value; may be null when access is restricted.
`default_supplier_price`	JSON	Computed JSON value; may be null when access is restricted.
`default_unit`	uuid
`default_waste_pct`	decimal
`description`	string
`effective_rate` *	object
`external_url`	uri
`extras_cost`	decimal
`general_price`	JSON	Computed JSON value; may be null when access is restricted.
`group` *	integer
`group_name`	string
`id` *	integer
`is_active`	boolean
`job`	uuid	Set for Source B (job resource / BOQ list).
`labour_cost`	decimal
`last_reviewed_at`	date
`lead_in_days`	integer
`materials_cost`	decimal
`name` *	string
`notes_internal`	string
`owner_user` *	uuid
`rate_valid_from`	JSON	Computed JSON value; may be null when access is restricted.
`resource_type`	string	* `material` - Material * `labour` - Labour * `plant` - Plant * `subcontract` - Subcontract Options: material, labour, plant, subcontract
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived
`safety_url`	uri
`source_type`	string	* `WORKSPACE_A` - Workspace library * `JOB_B` - Job resource list * `USER_C` - Personal user library Options: WORKSPACE_A, JOB_B, USER_C
`supplier_listing_count`	JSON	Computed JSON value; may be null when access is restricted.
`supplier_listings` *	ResourceSupplierListing[]
`supplier_price_count`	JSON	Computed JSON value; may be null when access is restricted.
`unit_of_measure`	string
`updated_at` *	date-time
`waste_percent`	decimal

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/units/

Required scopes and service-account permissions: libraries:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Active units for this workspace, with ids the order foreign key can store.

Parameters

Name	Location	Details
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	Unit[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/work-item-groups/

Parameters

Name	Location	Details
`ordering`	query	Which field to use when ordering the results.
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`search`	query	A search term.
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	WorkItemGroup[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/libraries/work-item-groups/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`name` *	string

Responses

201 — Success

Field	Type	Details
`id` *	integer
`name` *	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/libraries/work-item-groups/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/work-item-groups/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`id` *	integer
`name` *	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/libraries/work-item-groups/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`name`	string

Responses

200 — Success

Field	Type	Details
`id` *	integer
`name` *	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/work-item-lines/

Required scopes and service-account permissions: libraries:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Block estimate API when the workspace module is disabled.

Parameters

Name	Location	Details
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	LibWorkItemLine[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/libraries/work-item-lines/

Required scopes and service-account permissions: libraries:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Block estimate API when the workspace module is disabled.

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`boq_path`	JSON	Computed JSON value; may be null when access is restricted.
`classification_system`	string	* `NRM` - NRM * `BCIS` - BCIS * `CUSTOM` - Custom Options: NRM, BCIS, CUSTOM
`line_desc` *	string
`line_ref`	string
`line_type`	uuid
`parent`	uuid
`parent_level`	JSON	Computed JSON value; may be null when access is restricted.
`work_items`	JSON	Computed JSON value; may be null when access is restricted.

Responses

201 — Success

Field	Type	Details
`boq_path`	JSON	Computed JSON value; may be null when access is restricted.
`classification_system`	string	* `NRM` - NRM * `BCIS` - BCIS * `CUSTOM` - Custom Options: NRM, BCIS, CUSTOM
`hierarchy_level` *	integer
`id` *	uuid
`lft` *	integer
`line_desc` *	string
`line_ref`	string
`line_type`	uuid
`parent`	uuid
`parent_level`	JSON	Computed JSON value; may be null when access is restricted.
`rgt` *	integer
`type_name` *	string
`work_item_count` *	integer
`work_items`	JSON	Computed JSON value; may be null when access is restricted.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/libraries/work-item-lines/{id}/

Required scopes and service-account permissions: libraries:manage, libraries:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Block estimate API when the workspace module is disabled.

Parameters

Name	Location	Details
`id` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/work-item-lines/{id}/

Required scopes and service-account permissions: libraries:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Block estimate API when the workspace module is disabled.

Parameters

Name	Location	Details
`id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`boq_path`	JSON	Computed JSON value; may be null when access is restricted.
`classification_system`	string	* `NRM` - NRM * `BCIS` - BCIS * `CUSTOM` - Custom Options: NRM, BCIS, CUSTOM
`hierarchy_level` *	integer
`id` *	uuid
`lft` *	integer
`line_desc` *	string
`line_ref`	string
`line_type`	uuid
`parent`	uuid
`parent_level`	JSON	Computed JSON value; may be null when access is restricted.
`rgt` *	integer
`type_name` *	string
`work_item_count` *	integer
`work_items`	JSON	Computed JSON value; may be null when access is restricted.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/libraries/work-item-lines/{id}/

Required scopes and service-account permissions: libraries:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Block estimate API when the workspace module is disabled.

Parameters

Name	Location	Details
`id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`boq_path`	JSON	Computed JSON value; may be null when access is restricted.
`classification_system`	string	* `NRM` - NRM * `BCIS` - BCIS * `CUSTOM` - Custom Options: NRM, BCIS, CUSTOM
`line_desc`	string
`line_ref`	string
`line_type`	uuid
`parent`	uuid
`parent_level`	JSON	Computed JSON value; may be null when access is restricted.
`work_items`	JSON	Computed JSON value; may be null when access is restricted.

Responses

200 — Success

Field	Type	Details
`boq_path`	JSON	Computed JSON value; may be null when access is restricted.
`classification_system`	string	* `NRM` - NRM * `BCIS` - BCIS * `CUSTOM` - Custom Options: NRM, BCIS, CUSTOM
`hierarchy_level` *	integer
`id` *	uuid
`lft` *	integer
`line_desc` *	string
`line_ref`	string
`line_type`	uuid
`parent`	uuid
`parent_level`	JSON	Computed JSON value; may be null when access is restricted.
`rgt` *	integer
`type_name` *	string
`work_item_count` *	integer
`work_items`	JSON	Computed JSON value; may be null when access is restricted.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/work-items/

Parameters

Name	Location	Details
`ordering`	query	Which field to use when ordering the results.
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`search`	query	A search term.
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	WorkItem[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/libraries/work-items/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`boq_path`	JSON	Computed JSON value; may be null when access is restricted.
`code`	string
`default_waste_pct`	decimal
`description`	string
`group` *	integer
`is_active`	boolean
`is_unit_price`	boolean
`items`	WorkItemItemRequest[]
`last_reviewed_at`	date
`lib_line`	uuid
`name` *	string
`notes_internal`	string
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived
`unit_of_measure`	string

Responses

201 — Success

Field	Type	Details
`boq_path`	JSON	Computed JSON value; may be null when access is restricted.
`code`	string
`created_at` *	date-time
`default_waste_pct`	decimal
`description`	string
`group` *	integer
`group_name`	string
`id` *	integer
`is_active`	boolean
`is_unit_price`	boolean
`items`	WorkItemItem[]
`last_reviewed_at`	date
`lib_line`	uuid
`name` *	string
`notes_internal`	string
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived
`unit_of_measure`	string
`updated_at` *	date-time

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/libraries/work-items/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/libraries/work-items/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`boq_path`	JSON	Computed JSON value; may be null when access is restricted.
`code`	string
`created_at` *	date-time
`default_waste_pct`	decimal
`description`	string
`group` *	integer
`group_name`	string
`id` *	integer
`is_active`	boolean
`is_unit_price`	boolean
`items`	WorkItemItem[]
`last_reviewed_at`	date
`lib_line`	uuid
`name` *	string
`notes_internal`	string
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived
`unit_of_measure`	string
`updated_at` *	date-time

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/libraries/work-items/{id}/

Parameters

Name	Location	Details
`id` *	path	integer
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`boq_path`	JSON	Computed JSON value; may be null when access is restricted.
`code`	string
`default_waste_pct`	decimal
`description`	string
`group`	integer
`is_active`	boolean
`is_unit_price`	boolean
`items`	WorkItemItemRequest[]
`last_reviewed_at`	date
`lib_line`	uuid
`name`	string
`notes_internal`	string
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived
`unit_of_measure`	string

Responses

200 — Success

Field	Type	Details
`boq_path`	JSON	Computed JSON value; may be null when access is restricted.
`code`	string
`created_at` *	date-time
`default_waste_pct`	decimal
`description`	string
`group` *	integer
`group_name`	string
`id` *	integer
`is_active`	boolean
`is_unit_price`	boolean
`items`	WorkItemItem[]
`last_reviewed_at`	date
`lib_line`	uuid
`name` *	string
`notes_internal`	string
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived
`unit_of_measure`	string
`updated_at` *	date-time

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/partners/

Required scopes and service-account permissions: partners:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Reusable security logic for any Workspace-scoped resource.

Parameters

Name	Location	Details
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	PartnerList[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/partners/

Required scopes and service-account permissions: partners:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Reusable security logic for any Workspace-scoped resource.

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`address`	AddressRequest
`avatar_color`	string
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`backup_withholding_required`	boolean	US: payer should review backup withholding before payment.
`category` *	string	* `professional` - Professional Services * `trade` - Trades * `supplier` - Suppliers Options: professional, trade, supplier
`contacts_payload`	PartnerContactRequest[]
`email`	email
`is_1099_eligible`	boolean	US: vendor may require 1099 reporting.
`is_cis_registered`	boolean	UK: subcontractor is CIS-registered and needs verification on file.
`name` *	string	The partner's name or company name.
`notes`	string
`phone_number`	string
`specialty_names`	string[]
`tax_id`	string	VAT number, EIN, UTR, or other tax identifier.
`us_tax_classification`	string	US W-9 tax classification. Full tax IDs are not required here. * `` - Not recorded * `individual` - Individual / sole proprietor * `c_corp` - C corporation * `s_corp` - S corporation * `partnership` - Partnership * `trust_estate` - Trust / estate * `llc` - LLC * `other` - Other Options: , individual, c_corp, s_corp, partnership, trust_estate, llc, other
`us_tin_last_four`	string	US W-9 TIN/EIN last four only.
`us_tin_type`	string	US W-9 identifier type, stored without the full identifier. * `` - Not recorded * `ein` - EIN * `ssn` - SSN * `itin` - ITIN Options: , ein, ssn, itin
`w9_received_at`	date	Date a W-9 was received or confirmed.

Responses

201 — Success

Field	Type	Details
`address`	Address
`avatar_color`	string
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`backup_withholding_required`	boolean	US: payer should review backup withholding before payment.
`category` *	string	* `professional` - Professional Services * `trade` - Trades * `supplier` - Suppliers Options: professional, trade, supplier
`contacts` *	PartnerContact[]
`email`	email
`id` *	uuid
`is_1099_eligible`	boolean	US: vendor may require 1099 reporting.
`is_cis_registered`	boolean	UK: subcontractor is CIS-registered and needs verification on file.
`name` *	string	The partner's name or company name.
`notes`	string
`phone_number`	string
`specialties` *	PartnerSpecialty[]
`tax_id`	string	VAT number, EIN, UTR, or other tax identifier.
`us_tax_classification`	string	US W-9 tax classification. Full tax IDs are not required here. * `` - Not recorded * `individual` - Individual / sole proprietor * `c_corp` - C corporation * `s_corp` - S corporation * `partnership` - Partnership * `trust_estate` - Trust / estate * `llc` - LLC * `other` - Other Options: , individual, c_corp, s_corp, partnership, trust_estate, llc, other
`us_tin_last_four`	string	US W-9 TIN/EIN last four only.
`us_tin_type`	string	US W-9 identifier type, stored without the full identifier. * `` - Not recorded * `ein` - EIN * `ssn` - SSN * `itin` - ITIN Options: , ein, ssn, itin
`w9_received_at`	date	Date a W-9 was received or confirmed.
`workspace` *	uuid

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/partners/{id}/

Required scopes and service-account permissions: partners:manage, partners:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Reusable security logic for any Workspace-scoped resource.

Parameters

Name	Location	Details
`id` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/partners/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`address`	Address
`avatar_color`	string
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`backup_withholding_required`	boolean	US: payer should review backup withholding before payment.
`category` *	string	* `professional` - Professional Services * `trade` - Trades * `supplier` - Suppliers Options: professional, trade, supplier
`contacts` *	PartnerContact[]
`email`	email
`id` *	uuid
`is_1099_eligible`	boolean	US: vendor may require 1099 reporting.
`is_cis_registered`	boolean	UK: subcontractor is CIS-registered and needs verification on file.
`name` *	string	The partner's name or company name.
`notes`	string
`phone_number`	string
`specialties` *	PartnerSpecialty[]
`tax_id`	string	VAT number, EIN, UTR, or other tax identifier.
`us_tax_classification`	string	US W-9 tax classification. Full tax IDs are not required here. * `` - Not recorded * `individual` - Individual / sole proprietor * `c_corp` - C corporation * `s_corp` - S corporation * `partnership` - Partnership * `trust_estate` - Trust / estate * `llc` - LLC * `other` - Other Options: , individual, c_corp, s_corp, partnership, trust_estate, llc, other
`us_tin_last_four`	string	US W-9 TIN/EIN last four only.
`us_tin_type`	string	US W-9 identifier type, stored without the full identifier. * `` - Not recorded * `ein` - EIN * `ssn` - SSN * `itin` - ITIN Options: , ein, ssn, itin
`w9_received_at`	date	Date a W-9 was received or confirmed.
`workspace` *	uuid

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/partners/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`address`	AddressRequest
`avatar_color`	string
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`backup_withholding_required`	boolean	US: payer should review backup withholding before payment.
`category`	string	* `professional` - Professional Services * `trade` - Trades * `supplier` - Suppliers Options: professional, trade, supplier
`contacts_payload`	PartnerContactRequest[]
`email`	email
`is_1099_eligible`	boolean	US: vendor may require 1099 reporting.
`is_cis_registered`	boolean	UK: subcontractor is CIS-registered and needs verification on file.
`name`	string	The partner's name or company name.
`notes`	string
`phone_number`	string
`specialty_names`	string[]
`tax_id`	string	VAT number, EIN, UTR, or other tax identifier.
`us_tax_classification`	string	US W-9 tax classification. Full tax IDs are not required here. * `` - Not recorded * `individual` - Individual / sole proprietor * `c_corp` - C corporation * `s_corp` - S corporation * `partnership` - Partnership * `trust_estate` - Trust / estate * `llc` - LLC * `other` - Other Options: , individual, c_corp, s_corp, partnership, trust_estate, llc, other
`us_tin_last_four`	string	US W-9 TIN/EIN last four only.
`us_tin_type`	string	US W-9 identifier type, stored without the full identifier. * `` - Not recorded * `ein` - EIN * `ssn` - SSN * `itin` - ITIN Options: , ein, ssn, itin
`w9_received_at`	date	Date a W-9 was received or confirmed.

Responses

200 — Success

Field	Type	Details
`address`	Address
`avatar_color`	string
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`backup_withholding_required`	boolean	US: payer should review backup withholding before payment.
`category` *	string	* `professional` - Professional Services * `trade` - Trades * `supplier` - Suppliers Options: professional, trade, supplier
`contacts` *	PartnerContact[]
`email`	email
`id` *	uuid
`is_1099_eligible`	boolean	US: vendor may require 1099 reporting.
`is_cis_registered`	boolean	UK: subcontractor is CIS-registered and needs verification on file.
`name` *	string	The partner's name or company name.
`notes`	string
`phone_number`	string
`specialties` *	PartnerSpecialty[]
`tax_id`	string	VAT number, EIN, UTR, or other tax identifier.
`us_tax_classification`	string	US W-9 tax classification. Full tax IDs are not required here. * `` - Not recorded * `individual` - Individual / sole proprietor * `c_corp` - C corporation * `s_corp` - S corporation * `partnership` - Partnership * `trust_estate` - Trust / estate * `llc` - LLC * `other` - Other Options: , individual, c_corp, s_corp, partnership, trust_estate, llc, other
`us_tin_last_four`	string	US W-9 TIN/EIN last four only.
`us_tin_type`	string	US W-9 identifier type, stored without the full identifier. * `` - Not recorded * `ein` - EIN * `ssn` - SSN * `itin` - ITIN Options: , ein, ssn, itin
`w9_received_at`	date	Date a W-9 was received or confirmed.
`workspace` *	uuid

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/

Required scopes and service-account permissions: projects:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Reusable security logic for any Workspace-scoped resource.

Parameters

Name	Location	Details
`archived`	query	false (default), true, or only.
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`search`	query	Search project name and number.
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	Project[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/

Required scopes and service-account permissions: projects:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Reusable security logic for any Workspace-scoped resource.

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`allow_store_collection`	boolean	Override workspace store-collection toggle when set.
`archived_at`	date-time	Timestamp when the project was archived.
`budget`	decimal	Current agreed revenue budget visible to the client.
`commercial_summary`	JSON	Computed JSON value; may be null when access is restricted.
`cost_budget`	decimal	The internal cost budget, visible only to the builder's team.
`custom_status_id`	uuid
`customer_id`	uuid
`description`	string	Detailed description of the project.
`effective_estimating_enabled`	JSON	Computed JSON value; may be null when access is restricted.
`effective_variation_workflow`	JSON	Computed JSON value; may be null when access is restricted.
`enable_delivery_sign_off`	boolean	Override workspace delivery sign-off when set.
`enable_location_tagging`	boolean	Allow plot/location codes on purchase order lines.
`end_date_actual`	date
`end_date_planned`	date
`estimated_value`	decimal	Estimated value before a formal quote is issued.
`estimating_enabled`	boolean	Override workspace estimating_enabled when set.
`follow_up_date`	date
`initial_revenue_budget`	decimal	Snapshot of revenue at award (initial position), separate from current agreed budget.
`is_archived`	boolean
`is_location_unoccupied`	boolean	Will the work location be unoccupied during the project?
`local_restrictions`	string	Note any permit parking, delivery constraints, or noise restrictions.
`lost_reason`	string	Reason recorded when a job is marked lost or a quote is rejected.
`mandated_approver`	uuid	When set, all POs for this job require this approver.
`matching_mode`	string	two_way \| three_way; blank inherits workspace default.
`name` *	string	Name of the project.
`next_visit_on`	JSON	Computed JSON value; may be null when access is restricted.
`notice_to_start_days`	integer	The required notice period in days before work can begin.
`open_task_count`	JSON	Computed JSON value; may be null when access is restricted.
`permit_authority`	uuid	Local building control, city planning, or permit office.
`permit_authority_id`	uuid
`pipeline_source`	string	How this job was sourced (sales pipeline).
`plot_count`	JSON	Computed JSON value; may be null when access is restricted.
`po_import_allow_boq`	boolean	Override workspace PO import-from-BOQ when set.
`po_import_allow_estimate`	boolean	Override workspace PO import-from-estimate when set.
`po_import_allow_imported`	boolean	Override workspace PO import-from-imported-resources when set.
`po_import_allow_library`	boolean	Override workspace PO import-from-library when set.
`po_import_allow_quote`	boolean	Override workspace PO import-from-quote when set.
`project_number`	string	Optional internal project number or code.
`project_type`	string	* `new_build` - New Build * `conversion` - Significant Conversion * `renovation` - Renovation * `extension` - Extension * `maintenance` - Maintenance Options: new_build, conversion, renovation, extension, maintenance,
`site_address`	AddressRequest
`site_working_hours`	string	e.g. Mon-Fri 8am-6pm, Sat 8am-1pm
`start_date_actual`	date
`start_date_planned`	date
`status_set_id`	uuid
`timesheet_identity_check_excluded`	boolean	Clock in and out on this job without a biometric or photo check.
`variation_workflow`	string	Override workspace default_variation_workflow when set. * `simple` - Simple * `comprehensive` - Comprehensive Options: simple, comprehensive, ,
`warranty_provider`	uuid
`warranty_provider_id`	uuid
`zoning_or_planning_ref`	string	Approved planning permission or zoning reference.

Responses

201 — Success

Field	Type	Details
`allow_store_collection`	boolean	Override workspace store-collection toggle when set.
`archived_at`	date-time	Timestamp when the project was archived.
`brief_snapshot_id` *	uuid
`budget`	decimal	Current agreed revenue budget visible to the client.
`commercial`	ProjectCommercial
`commercial_summary`	JSON	Computed JSON value; may be null when access is restricted.
`cost_budget`	decimal	The internal cost budget, visible only to the builder's team.
`created_at` *	date-time
`custom_status` *	CustomProjectStatus
`customer` *	CustomerSimple
`description`	string	Detailed description of the project.
`effective_estimating_enabled`	JSON	Computed JSON value; may be null when access is restricted.
`effective_variation_workflow`	JSON	Computed JSON value; may be null when access is restricted.
`enable_delivery_sign_off`	boolean	Override workspace delivery sign-off when set.
`enable_location_tagging`	boolean	Allow plot/location codes on purchase order lines.
`end_date_actual`	date
`end_date_planned`	date
`estimated_value`	decimal	Estimated value before a formal quote is issued.
`estimating_enabled`	boolean	Override workspace estimating_enabled when set.
`follow_up_date`	date
`forecast_revenue_budget`	decimal	Last persisted final-account forecast total (net, same basis as ledger/variations).
`id` *	uuid
`initial_revenue_budget`	decimal	Snapshot of revenue at award (initial position), separate from current agreed budget.
`is_archived`	boolean
`is_location_unoccupied`	boolean	Will the work location be unoccupied during the project?
`job_cost_snapshot`	JSON
`local_restrictions`	string	Note any permit parking, delivery constraints, or noise restrictions.
`lost_reason`	string	Reason recorded when a job is marked lost or a quote is rejected.
`mandated_approver`	uuid	When set, all POs for this job require this approver.
`matching_mode`	string	two_way \| three_way; blank inherits workspace default.
`name` *	string	Name of the project.
`next_visit_on`	JSON	Computed JSON value; may be null when access is restricted.
`notice_to_start_days`	integer	The required notice period in days before work can begin.
`open_task_count`	JSON	Computed JSON value; may be null when access is restricted.
`permit_authority`	uuid	Local building control, city planning, or permit office.
`permit_authority_name`	string
`pipeline_source`	string	How this job was sourced (sales pipeline).
`plot_count`	JSON	Computed JSON value; may be null when access is restricted.
`po_import_allow_boq`	boolean	Override workspace PO import-from-BOQ when set.
`po_import_allow_estimate`	boolean	Override workspace PO import-from-estimate when set.
`po_import_allow_imported`	boolean	Override workspace PO import-from-imported-resources when set.
`po_import_allow_library`	boolean	Override workspace PO import-from-library when set.
`po_import_allow_quote`	boolean	Override workspace PO import-from-quote when set.
`project_number`	string	Optional internal project number or code.
`project_type`	string	* `new_build` - New Build * `conversion` - Significant Conversion * `renovation` - Renovation * `extension` - Extension * `maintenance` - Maintenance Options: new_build, conversion, renovation, extension, maintenance,
`site_address`	Address
`site_working_hours`	string	e.g. Mon-Fri 8am-6pm, Sat 8am-1pm
`start_date_actual`	date
`start_date_planned`	date
`status` *	string	Core system status of the project, derived from the custom status. * `planning` - Planning * `active` - Active * `on_hold` - On Hold * `completed` - Completed * `canceled` - Canceled Options: planning, active, on_hold, completed, canceled
`status_set_id`	uuid
`timesheet_identity_check_excluded`	boolean	Clock in and out on this job without a biometric or photo check.
`uk_details`	ProjectUKDetails
`us_details`	ProjectUSDetails
`variation_workflow`	string	Override workspace default_variation_workflow when set. * `simple` - Simple * `comprehensive` - Comprehensive Options: simple, comprehensive, ,
`warranty_provider`	uuid
`warranty_provider_name`	string
`workspace_currency` *	string
`zoning_or_planning_ref`	string	Approved planning permission or zoning reference.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/projects/{id}/

Required scopes and service-account permissions: projects:manage. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. FLEXIBLE SECURITY: For Project-scoped resources (Tasks, Events, Files). Allows both internal Workspace members AND external Project Guests (Clients).

Parameters

Name	Location	Details
`id` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{id}/

Required scopes and service-account permissions: projects:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. FLEXIBLE SECURITY: For Project-scoped resources (Tasks, Events, Files). Allows both internal Workspace members AND external Project Guests (Clients).

Parameters

Name	Location	Details
`id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`allow_store_collection`	boolean	Override workspace store-collection toggle when set.
`archived_at`	date-time	Timestamp when the project was archived.
`brief_snapshot_id` *	uuid
`budget`	decimal	Current agreed revenue budget visible to the client.
`commercial`	ProjectCommercial
`commercial_summary`	JSON	Computed JSON value; may be null when access is restricted.
`cost_budget`	decimal	The internal cost budget, visible only to the builder's team.
`created_at` *	date-time
`custom_status` *	CustomProjectStatus
`customer` *	CustomerSimple
`description`	string	Detailed description of the project.
`effective_estimating_enabled`	JSON	Computed JSON value; may be null when access is restricted.
`effective_variation_workflow`	JSON	Computed JSON value; may be null when access is restricted.
`enable_delivery_sign_off`	boolean	Override workspace delivery sign-off when set.
`enable_location_tagging`	boolean	Allow plot/location codes on purchase order lines.
`end_date_actual`	date
`end_date_planned`	date
`estimated_value`	decimal	Estimated value before a formal quote is issued.
`estimating_enabled`	boolean	Override workspace estimating_enabled when set.
`follow_up_date`	date
`forecast_revenue_budget`	decimal	Last persisted final-account forecast total (net, same basis as ledger/variations).
`id` *	uuid
`initial_revenue_budget`	decimal	Snapshot of revenue at award (initial position), separate from current agreed budget.
`is_archived`	boolean
`is_location_unoccupied`	boolean	Will the work location be unoccupied during the project?
`job_cost_snapshot`	JSON
`local_restrictions`	string	Note any permit parking, delivery constraints, or noise restrictions.
`lost_reason`	string	Reason recorded when a job is marked lost or a quote is rejected.
`mandated_approver`	uuid	When set, all POs for this job require this approver.
`matching_mode`	string	two_way \| three_way; blank inherits workspace default.
`name` *	string	Name of the project.
`next_visit_on`	JSON	Computed JSON value; may be null when access is restricted.
`notice_to_start_days`	integer	The required notice period in days before work can begin.
`open_task_count`	JSON	Computed JSON value; may be null when access is restricted.
`permit_authority`	uuid	Local building control, city planning, or permit office.
`permit_authority_name`	string
`pipeline_source`	string	How this job was sourced (sales pipeline).
`plot_count`	JSON	Computed JSON value; may be null when access is restricted.
`po_import_allow_boq`	boolean	Override workspace PO import-from-BOQ when set.
`po_import_allow_estimate`	boolean	Override workspace PO import-from-estimate when set.
`po_import_allow_imported`	boolean	Override workspace PO import-from-imported-resources when set.
`po_import_allow_library`	boolean	Override workspace PO import-from-library when set.
`po_import_allow_quote`	boolean	Override workspace PO import-from-quote when set.
`project_number`	string	Optional internal project number or code.
`project_type`	string	* `new_build` - New Build * `conversion` - Significant Conversion * `renovation` - Renovation * `extension` - Extension * `maintenance` - Maintenance Options: new_build, conversion, renovation, extension, maintenance,
`site_address`	Address
`site_working_hours`	string	e.g. Mon-Fri 8am-6pm, Sat 8am-1pm
`start_date_actual`	date
`start_date_planned`	date
`status` *	string	Core system status of the project, derived from the custom status. * `planning` - Planning * `active` - Active * `on_hold` - On Hold * `completed` - Completed * `canceled` - Canceled Options: planning, active, on_hold, completed, canceled
`status_set_id`	uuid
`timesheet_identity_check_excluded`	boolean	Clock in and out on this job without a biometric or photo check.
`uk_details`	ProjectUKDetails
`us_details`	ProjectUSDetails
`variation_workflow`	string	Override workspace default_variation_workflow when set. * `simple` - Simple * `comprehensive` - Comprehensive Options: simple, comprehensive, ,
`warranty_provider`	uuid
`warranty_provider_name`	string
`workspace_currency` *	string
`zoning_or_planning_ref`	string	Approved planning permission or zoning reference.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/projects/{id}/

Required scopes and service-account permissions: projects:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. FLEXIBLE SECURITY: For Project-scoped resources (Tasks, Events, Files). Allows both internal Workspace members AND external Project Guests (Clients).

Parameters

Name	Location	Details
`id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`allow_store_collection`	boolean	Override workspace store-collection toggle when set.
`archived_at`	date-time	Timestamp when the project was archived.
`budget`	decimal	Current agreed revenue budget visible to the client.
`commercial_summary`	JSON	Computed JSON value; may be null when access is restricted.
`cost_budget`	decimal	The internal cost budget, visible only to the builder's team.
`custom_status_id`	uuid
`customer_id`	uuid
`description`	string	Detailed description of the project.
`effective_estimating_enabled`	JSON	Computed JSON value; may be null when access is restricted.
`effective_variation_workflow`	JSON	Computed JSON value; may be null when access is restricted.
`enable_delivery_sign_off`	boolean	Override workspace delivery sign-off when set.
`enable_location_tagging`	boolean	Allow plot/location codes on purchase order lines.
`end_date_actual`	date
`end_date_planned`	date
`estimated_value`	decimal	Estimated value before a formal quote is issued.
`estimating_enabled`	boolean	Override workspace estimating_enabled when set.
`follow_up_date`	date
`initial_revenue_budget`	decimal	Snapshot of revenue at award (initial position), separate from current agreed budget.
`is_archived`	boolean
`is_location_unoccupied`	boolean	Will the work location be unoccupied during the project?
`local_restrictions`	string	Note any permit parking, delivery constraints, or noise restrictions.
`lost_reason`	string	Reason recorded when a job is marked lost or a quote is rejected.
`mandated_approver`	uuid	When set, all POs for this job require this approver.
`matching_mode`	string	two_way \| three_way; blank inherits workspace default.
`name`	string	Name of the project.
`next_visit_on`	JSON	Computed JSON value; may be null when access is restricted.
`notice_to_start_days`	integer	The required notice period in days before work can begin.
`open_task_count`	JSON	Computed JSON value; may be null when access is restricted.
`permit_authority`	uuid	Local building control, city planning, or permit office.
`permit_authority_id`	uuid
`pipeline_source`	string	How this job was sourced (sales pipeline).
`plot_count`	JSON	Computed JSON value; may be null when access is restricted.
`po_import_allow_boq`	boolean	Override workspace PO import-from-BOQ when set.
`po_import_allow_estimate`	boolean	Override workspace PO import-from-estimate when set.
`po_import_allow_imported`	boolean	Override workspace PO import-from-imported-resources when set.
`po_import_allow_library`	boolean	Override workspace PO import-from-library when set.
`po_import_allow_quote`	boolean	Override workspace PO import-from-quote when set.
`project_number`	string	Optional internal project number or code.
`project_type`	string	* `new_build` - New Build * `conversion` - Significant Conversion * `renovation` - Renovation * `extension` - Extension * `maintenance` - Maintenance Options: new_build, conversion, renovation, extension, maintenance,
`site_address`	AddressRequest
`site_working_hours`	string	e.g. Mon-Fri 8am-6pm, Sat 8am-1pm
`start_date_actual`	date
`start_date_planned`	date
`status_set_id`	uuid
`timesheet_identity_check_excluded`	boolean	Clock in and out on this job without a biometric or photo check.
`variation_workflow`	string	Override workspace default_variation_workflow when set. * `simple` - Simple * `comprehensive` - Comprehensive Options: simple, comprehensive, ,
`warranty_provider`	uuid
`warranty_provider_id`	uuid
`zoning_or_planning_ref`	string	Approved planning permission or zoning reference.

Responses

200 — Success

Field	Type	Details
`allow_store_collection`	boolean	Override workspace store-collection toggle when set.
`archived_at`	date-time	Timestamp when the project was archived.
`brief_snapshot_id` *	uuid
`budget`	decimal	Current agreed revenue budget visible to the client.
`commercial`	ProjectCommercial
`commercial_summary`	JSON	Computed JSON value; may be null when access is restricted.
`cost_budget`	decimal	The internal cost budget, visible only to the builder's team.
`created_at` *	date-time
`custom_status` *	CustomProjectStatus
`customer` *	CustomerSimple
`description`	string	Detailed description of the project.
`effective_estimating_enabled`	JSON	Computed JSON value; may be null when access is restricted.
`effective_variation_workflow`	JSON	Computed JSON value; may be null when access is restricted.
`enable_delivery_sign_off`	boolean	Override workspace delivery sign-off when set.
`enable_location_tagging`	boolean	Allow plot/location codes on purchase order lines.
`end_date_actual`	date
`end_date_planned`	date
`estimated_value`	decimal	Estimated value before a formal quote is issued.
`estimating_enabled`	boolean	Override workspace estimating_enabled when set.
`follow_up_date`	date
`forecast_revenue_budget`	decimal	Last persisted final-account forecast total (net, same basis as ledger/variations).
`id` *	uuid
`initial_revenue_budget`	decimal	Snapshot of revenue at award (initial position), separate from current agreed budget.
`is_archived`	boolean
`is_location_unoccupied`	boolean	Will the work location be unoccupied during the project?
`job_cost_snapshot`	JSON
`local_restrictions`	string	Note any permit parking, delivery constraints, or noise restrictions.
`lost_reason`	string	Reason recorded when a job is marked lost or a quote is rejected.
`mandated_approver`	uuid	When set, all POs for this job require this approver.
`matching_mode`	string	two_way \| three_way; blank inherits workspace default.
`name` *	string	Name of the project.
`next_visit_on`	JSON	Computed JSON value; may be null when access is restricted.
`notice_to_start_days`	integer	The required notice period in days before work can begin.
`open_task_count`	JSON	Computed JSON value; may be null when access is restricted.
`permit_authority`	uuid	Local building control, city planning, or permit office.
`permit_authority_name`	string
`pipeline_source`	string	How this job was sourced (sales pipeline).
`plot_count`	JSON	Computed JSON value; may be null when access is restricted.
`po_import_allow_boq`	boolean	Override workspace PO import-from-BOQ when set.
`po_import_allow_estimate`	boolean	Override workspace PO import-from-estimate when set.
`po_import_allow_imported`	boolean	Override workspace PO import-from-imported-resources when set.
`po_import_allow_library`	boolean	Override workspace PO import-from-library when set.
`po_import_allow_quote`	boolean	Override workspace PO import-from-quote when set.
`project_number`	string	Optional internal project number or code.
`project_type`	string	* `new_build` - New Build * `conversion` - Significant Conversion * `renovation` - Renovation * `extension` - Extension * `maintenance` - Maintenance Options: new_build, conversion, renovation, extension, maintenance,
`site_address`	Address
`site_working_hours`	string	e.g. Mon-Fri 8am-6pm, Sat 8am-1pm
`start_date_actual`	date
`start_date_planned`	date
`status` *	string	Core system status of the project, derived from the custom status. * `planning` - Planning * `active` - Active * `on_hold` - On Hold * `completed` - Completed * `canceled` - Canceled Options: planning, active, on_hold, completed, canceled
`status_set_id`	uuid
`timesheet_identity_check_excluded`	boolean	Clock in and out on this job without a biometric or photo check.
`uk_details`	ProjectUKDetails
`us_details`	ProjectUSDetails
`variation_workflow`	string	Override workspace default_variation_workflow when set. * `simple` - Simple * `comprehensive` - Comprehensive Options: simple, comprehensive, ,
`warranty_provider`	uuid
`warranty_provider_name`	string
`workspace_currency` *	string
`zoning_or_planning_ref`	string	Approved planning permission or zoning reference.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/entries/

Required scopes and service-account permissions: entries:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. FLEXIBLE SECURITY: For Project-scoped resources (Tasks, Events, Files). Allows both internal Workspace members AND external Project Guests (Clients).

Parameters

Name	Location	Details
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	Entry[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/entries/

Required scopes and service-account permissions: entries:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. FLEXIBLE SECURITY: For Project-scoped resources (Tasks, Events, Files). Allows both internal Workspace members AND external Project Guests (Clients).

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`attached_file_ids`	uuid[]
`audience_type`	string	* `builder_internal` - Builder staff * `builder_team` - Builder side * `builder_client` - Builder and client teams * `client_team` - Client team * `everyone` - Everyone on this job * `selected_people` - Selected people Options: builder_internal, builder_team, builder_client, client_team, everyone, selected_people
`content` *	string	The main text content or a description of the event.
`is_private`	boolean	If True, this entry is only visible to workspace members.
`notify_mode`	string	* `everyone` - Everyone * `none` - No one * `custom` - Custom Options: everyone, none, custom
`parent_entry`	uuid
`recipient_ids`	uuid[]
`selected_user_ids`	JSON

Responses

201 — Success

Field	Type	Details
`attached_files` *	FileDetail[]
`audience_type`	string	* `builder_internal` - Builder staff * `builder_team` - Builder side * `builder_client` - Builder and client teams * `client_team` - Client team * `everyone` - Everyone on this job * `selected_people` - Selected people Options: builder_internal, builder_team, builder_client, client_team, everyone, selected_people
`author` *	UserPublic
`can_manage_entry`	JSON	Computed JSON value; may be null when access is restricted.
`can_retract_entry`	JSON	Computed JSON value; may be null when access is restricted.
`can_view_original`	JSON	Computed JSON value; may be null when access is restricted.
`change_request`	JSON	Computed JSON value; may be null when access is restricted.
`content_original`	JSON	Computed JSON value; may be null when access is restricted.
`content_type`	integer
`content_visible`	JSON	Computed JSON value; may be null when access is restricted.
`converted_change_request`	JSON	Computed JSON value; may be null when access is restricted.
`converted_task`	JSON	Computed JSON value; may be null when access is restricted.
`created_at` *	date-time
`deliveries` *	EntryDelivery[]
`email_last_attempt_at`	date-time
`email_last_error`	string
`email_send_status`	string
`enquiry`	uuid	Pipeline enquiry this activity originated from.
`entry_type`	string	* `message` - User Message * `file_upload` - File Upload * `site_diary` - Site Diary * `actionable_item` - Actionable Item * `system_event` - System Event Options: message, file_upload, site_diary, actionable_item, system_event
`entry_type_display` *	string
`event_key`	string	Stable machine key for system-generated activity events.
`event_meta`	JSON	Structured, redacted metadata for audit/export details.
`external_sender_email`	email	Email of an external recipient when author is null.
`external_sender_via`	string	How the external sender responded (shared link or email reply). * `` - - * `portal` - Portal * `email` - Email Options: , portal, email
`id` *	uuid
`is_private`	boolean	If True, this entry is only visible to workspace members.
`is_tombstoned` *	boolean
`linked_object_kind` *	string
`linked_object_label` *	string
`linked_object_was_deleted` *	boolean
`made_public_at`	date-time	Timestamp for when a private note was made public.
`notified_users`	JSON	Computed JSON value; may be null when access is restricted.
`notify_mode`	string	Who should be notified about this entry. * `everyone` - Everyone * `none` - No one * `custom` - Custom Options: everyone, none, custom
`object_id`	uuid
`parent_entry`	uuid
`project`	uuid
`project_name`	string
`quote`	JSON	Computed JSON value; may be null when access is restricted.
`replies`	JSON	Computed JSON value; may be null when access is restricted.
`retracted_at`	date-time
`retracted_by` *	UserPublic
`selected_user_ids`	JSON
`site_diary`	JSON	Computed JSON value; may be null when access is restricted.
`status`	string	* `active` - Active * `retracted` - Retracted Options: active, retracted
`status_display` *	string
`tombstone_reason` *	string
`updated_at` *	date-time
`workspace` *	uuid	Direct scope for pre-project enquiry activity and workspace search.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/projects/{project_id}/entries/{id}/

Required scopes and service-account permissions: entries:manage, entries:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. FLEXIBLE SECURITY: For Project-scoped resources (Tasks, Events, Files). Allows both internal Workspace members AND external Project Guests (Clients).

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/entries/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`attached_files` *	FileDetail[]
`audience_type`	string	* `builder_internal` - Builder staff * `builder_team` - Builder side * `builder_client` - Builder and client teams * `client_team` - Client team * `everyone` - Everyone on this job * `selected_people` - Selected people Options: builder_internal, builder_team, builder_client, client_team, everyone, selected_people
`author` *	UserPublic
`can_manage_entry`	JSON	Computed JSON value; may be null when access is restricted.
`can_retract_entry`	JSON	Computed JSON value; may be null when access is restricted.
`can_view_original`	JSON	Computed JSON value; may be null when access is restricted.
`change_request`	JSON	Computed JSON value; may be null when access is restricted.
`content_original`	JSON	Computed JSON value; may be null when access is restricted.
`content_type`	integer
`content_visible`	JSON	Computed JSON value; may be null when access is restricted.
`converted_change_request`	JSON	Computed JSON value; may be null when access is restricted.
`converted_task`	JSON	Computed JSON value; may be null when access is restricted.
`created_at` *	date-time
`deliveries` *	EntryDelivery[]
`email_last_attempt_at`	date-time
`email_last_error`	string
`email_send_status`	string
`enquiry`	uuid	Pipeline enquiry this activity originated from.
`entry_type`	string	* `message` - User Message * `file_upload` - File Upload * `site_diary` - Site Diary * `actionable_item` - Actionable Item * `system_event` - System Event Options: message, file_upload, site_diary, actionable_item, system_event
`entry_type_display` *	string
`event_key`	string	Stable machine key for system-generated activity events.
`event_meta`	JSON	Structured, redacted metadata for audit/export details.
`external_sender_email`	email	Email of an external recipient when author is null.
`external_sender_via`	string	How the external sender responded (shared link or email reply). * `` - - * `portal` - Portal * `email` - Email Options: , portal, email
`id` *	uuid
`is_private`	boolean	If True, this entry is only visible to workspace members.
`is_tombstoned` *	boolean
`linked_object_kind` *	string
`linked_object_label` *	string
`linked_object_was_deleted` *	boolean
`made_public_at`	date-time	Timestamp for when a private note was made public.
`notified_users`	JSON	Computed JSON value; may be null when access is restricted.
`notify_mode`	string	Who should be notified about this entry. * `everyone` - Everyone * `none` - No one * `custom` - Custom Options: everyone, none, custom
`object_id`	uuid
`parent_entry`	uuid
`project`	uuid
`project_name`	string
`quote`	JSON	Computed JSON value; may be null when access is restricted.
`replies`	JSON	Computed JSON value; may be null when access is restricted.
`retracted_at`	date-time
`retracted_by` *	UserPublic
`selected_user_ids`	JSON
`site_diary`	JSON	Computed JSON value; may be null when access is restricted.
`status`	string	* `active` - Active * `retracted` - Retracted Options: active, retracted
`status_display` *	string
`tombstone_reason` *	string
`updated_at` *	date-time
`workspace` *	uuid	Direct scope for pre-project enquiry activity and workspace search.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/projects/{project_id}/entries/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`audience_type`	string	* `builder_internal` - Builder staff * `builder_team` - Builder side * `builder_client` - Builder and client teams * `client_team` - Client team * `everyone` - Everyone on this job * `selected_people` - Selected people Options: builder_internal, builder_team, builder_client, client_team, everyone, selected_people
`can_manage_entry`	JSON	Computed JSON value; may be null when access is restricted.
`can_retract_entry`	JSON	Computed JSON value; may be null when access is restricted.
`can_view_original`	JSON	Computed JSON value; may be null when access is restricted.
`change_request`	JSON	Computed JSON value; may be null when access is restricted.
`content_original`	JSON	Computed JSON value; may be null when access is restricted.
`content_type`	integer
`content_visible`	JSON	Computed JSON value; may be null when access is restricted.
`converted_change_request`	JSON	Computed JSON value; may be null when access is restricted.
`converted_task`	JSON	Computed JSON value; may be null when access is restricted.
`email_last_attempt_at`	date-time
`email_last_error`	string
`email_send_status`	string
`enquiry`	uuid	Pipeline enquiry this activity originated from.
`entry_type`	string	* `message` - User Message * `file_upload` - File Upload * `site_diary` - Site Diary * `actionable_item` - Actionable Item * `system_event` - System Event Options: message, file_upload, site_diary, actionable_item, system_event
`event_key`	string	Stable machine key for system-generated activity events.
`event_meta`	JSON	Structured, redacted metadata for audit/export details.
`external_sender_email`	email	Email of an external recipient when author is null.
`external_sender_via`	string	How the external sender responded (shared link or email reply). * `` - - * `portal` - Portal * `email` - Email Options: , portal, email
`is_private`	boolean	If True, this entry is only visible to workspace members.
`made_public_at`	date-time	Timestamp for when a private note was made public.
`notified_users`	JSON	Computed JSON value; may be null when access is restricted.
`notify_mode`	string	Who should be notified about this entry. * `everyone` - Everyone * `none` - No one * `custom` - Custom Options: everyone, none, custom
`object_id`	uuid
`parent_entry`	uuid
`project`	uuid
`quote`	JSON	Computed JSON value; may be null when access is restricted.
`replies`	JSON	Computed JSON value; may be null when access is restricted.
`retracted_at`	date-time
`selected_user_ids`	JSON
`site_diary`	JSON	Computed JSON value; may be null when access is restricted.
`status`	string	* `active` - Active * `retracted` - Retracted Options: active, retracted
`workspace`	uuid	Direct scope for pre-project enquiry activity and workspace search.

Responses

200 — Success

Field	Type	Details
`attached_files` *	FileDetail[]
`audience_type`	string	* `builder_internal` - Builder staff * `builder_team` - Builder side * `builder_client` - Builder and client teams * `client_team` - Client team * `everyone` - Everyone on this job * `selected_people` - Selected people Options: builder_internal, builder_team, builder_client, client_team, everyone, selected_people
`author` *	UserPublic
`can_manage_entry`	JSON	Computed JSON value; may be null when access is restricted.
`can_retract_entry`	JSON	Computed JSON value; may be null when access is restricted.
`can_view_original`	JSON	Computed JSON value; may be null when access is restricted.
`change_request`	JSON	Computed JSON value; may be null when access is restricted.
`content_original`	JSON	Computed JSON value; may be null when access is restricted.
`content_type`	integer
`content_visible`	JSON	Computed JSON value; may be null when access is restricted.
`converted_change_request`	JSON	Computed JSON value; may be null when access is restricted.
`converted_task`	JSON	Computed JSON value; may be null when access is restricted.
`created_at` *	date-time
`deliveries` *	EntryDelivery[]
`email_last_attempt_at`	date-time
`email_last_error`	string
`email_send_status`	string
`enquiry`	uuid	Pipeline enquiry this activity originated from.
`entry_type`	string	* `message` - User Message * `file_upload` - File Upload * `site_diary` - Site Diary * `actionable_item` - Actionable Item * `system_event` - System Event Options: message, file_upload, site_diary, actionable_item, system_event
`entry_type_display` *	string
`event_key`	string	Stable machine key for system-generated activity events.
`event_meta`	JSON	Structured, redacted metadata for audit/export details.
`external_sender_email`	email	Email of an external recipient when author is null.
`external_sender_via`	string	How the external sender responded (shared link or email reply). * `` - - * `portal` - Portal * `email` - Email Options: , portal, email
`id` *	uuid
`is_private`	boolean	If True, this entry is only visible to workspace members.
`is_tombstoned` *	boolean
`linked_object_kind` *	string
`linked_object_label` *	string
`linked_object_was_deleted` *	boolean
`made_public_at`	date-time	Timestamp for when a private note was made public.
`notified_users`	JSON	Computed JSON value; may be null when access is restricted.
`notify_mode`	string	Who should be notified about this entry. * `everyone` - Everyone * `none` - No one * `custom` - Custom Options: everyone, none, custom
`object_id`	uuid
`parent_entry`	uuid
`project`	uuid
`project_name`	string
`quote`	JSON	Computed JSON value; may be null when access is restricted.
`replies`	JSON	Computed JSON value; may be null when access is restricted.
`retracted_at`	date-time
`retracted_by` *	UserPublic
`selected_user_ids`	JSON
`site_diary`	JSON	Computed JSON value; may be null when access is restricted.
`status`	string	* `active` - Active * `retracted` - Retracted Options: active, retracted
`status_display` *	string
`tombstone_reason` *	string
`updated_at` *	date-time
`workspace` *	uuid	Direct scope for pre-project enquiry activity and workspace search.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/events/

Required scopes and service-account permissions: events:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. FLEXIBLE SECURITY: For Project-scoped resources (Tasks, Events, Files). Allows both internal Workspace members AND external Project Guests (Clients).

Parameters

Name	Location	Details
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	Event[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/events/

Required scopes and service-account permissions: events:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. FLEXIBLE SECURITY: For Project-scoped resources (Tasks, Events, Files). Allows both internal Workspace members AND external Project Guests (Clients).

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`all_day`	boolean
`attendees`	AttendeeRequest[]
`conference_url`	uri
`description`	string
`end` *	date-time
`external_uid`	string
`is_private`	boolean
`is_private_read`	JSON	Computed JSON value; may be null when access is restricted.
`organizer_email`	email
`recurrence_rrule`	string
`reminder_minutes`	integer
`start` *	date-time
`timezone`	string
`title` *	string
`url`	uri
`visibility`	string	* `project` - Project * `private` - Private * `workspace` - Workspace Options: project, private, workspace

Responses

201 — Success

Field	Type	Details
`all_day`	boolean
`attendees`	Attendee[]
`conference_url`	uri
`created_at` *	date-time
`created_by` *	uuid
`description`	string
`end` *	date-time
`external_uid`	string
`id` *	uuid
`is_private_read`	JSON	Computed JSON value; may be null when access is restricted.
`organizer_email`	email
`project` *	uuid
`recurrence_rrule`	string
`reminder_minutes`	integer
`start` *	date-time
`timezone`	string
`title` *	string
`updated_at` *	date-time
`url`	uri
`visibility`	string	* `project` - Project * `private` - Private * `workspace` - Workspace Options: project, private, workspace
`workspace` *	uuid

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/projects/{project_id}/events/{id}/

Required scopes and service-account permissions: events:manage, events:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. FLEXIBLE SECURITY: For Project-scoped resources (Tasks, Events, Files). Allows both internal Workspace members AND external Project Guests (Clients).

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/events/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`all_day`	boolean
`attendees`	Attendee[]
`conference_url`	uri
`created_at` *	date-time
`created_by` *	uuid
`description`	string
`end` *	date-time
`external_uid`	string
`id` *	uuid
`is_private_read`	JSON	Computed JSON value; may be null when access is restricted.
`organizer_email`	email
`project` *	uuid
`recurrence_rrule`	string
`reminder_minutes`	integer
`start` *	date-time
`timezone`	string
`title` *	string
`updated_at` *	date-time
`url`	uri
`visibility`	string	* `project` - Project * `private` - Private * `workspace` - Workspace Options: project, private, workspace
`workspace` *	uuid

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/projects/{project_id}/events/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`all_day`	boolean
`attendees`	AttendeeRequest[]
`conference_url`	uri
`description`	string
`end`	date-time
`external_uid`	string
`is_private`	boolean
`is_private_read`	JSON	Computed JSON value; may be null when access is restricted.
`organizer_email`	email
`recurrence_rrule`	string
`reminder_minutes`	integer
`start`	date-time
`timezone`	string
`title`	string
`url`	uri
`visibility`	string	* `project` - Project * `private` - Private * `workspace` - Workspace Options: project, private, workspace

Responses

200 — Success

Field	Type	Details
`all_day`	boolean
`attendees`	Attendee[]
`conference_url`	uri
`created_at` *	date-time
`created_by` *	uuid
`description`	string
`end` *	date-time
`external_uid`	string
`id` *	uuid
`is_private_read`	JSON	Computed JSON value; may be null when access is restricted.
`organizer_email`	email
`project` *	uuid
`recurrence_rrule`	string
`reminder_minutes`	integer
`start` *	date-time
`timezone`	string
`title` *	string
`updated_at` *	date-time
`url`	uri
`visibility`	string	* `project` - Project * `private` - Private * `workspace` - Workspace Options: project, private, workspace
`workspace` *	uuid

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/expenses/

Required scopes and service-account permissions: expenses:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Enforce a workspace capability in addition to RBAC.

Parameters

Name	Location	Details
`ordering`	query	Which field to use when ordering the results.
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`partner`	query	Supplier UUID.
`project_id` *	path	uuid
`search`	query	A search term.
`status`	query	Expense status.
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	Expense[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/expenses/

Required scopes and service-account permissions: expenses:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Enforce a workspace capability in addition to RBAC.

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`approval`	JSON	Computed JSON value; may be null when access is restricted.
`attached_receipts`	uuid[]
`attached_receipts_detail`	JSON	Computed JSON value; may be null when access is restricted.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`balance_due`	string or number or object
`cis_deduction_rate`	decimal
`cis_materials_amount`	decimal
`claimant`	uuid	The person who paid out of pocket and needs to be reimbursed.
`claimant_name`	string
`description`	string
`document_type`	string	* `bill` - Bill * `credit_note` - Credit note Options: bill, credit_note
`due_date`	date
`effective_retention_held`	JSON	Computed JSON value; may be null when access is restricted.
`exchange_rate`	decimal	Rate used to convert Original -> Workspace.
`gross_amount`	string or number or object
`is_converted`	JSON	Computed JSON value; may be null when access is restricted.
`is_reimbursable`	boolean	True if paid by employee (needs reimbursement). False if paid by company.
`issue_date` *	date
`line_items`	ExpenseLineItemRequest[]
`match_summary`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_amount`	string or number or object
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string	Internal notes or comments about this expense.
`original_currency`	string	ISO code of the original receipt currency.
`parent_expense_id`	uuid
`parsing_notes`	string	Context or warnings from the AI extraction.
`partner_id`	uuid
`purchase_order_id`	uuid
`record_type`	string	* `supplier_bill` - Supplier bill * `expense` - Everyday expense / receipt * `reimbursement` - Employee reimbursement Options: supplier_bill, expense, reimbursement
`reference`	string
`requested_approver`	uuid	The specific manager requested to approve this spend.
`retention_held`	string or number or object
`retention_percentage`	decimal
`retention_released`	string or number or object
`status`	string	* `draft` - Draft * `submitted` - Submitted * `approved` - Approved * `rejected` - Rejected * `partially_paid` - Partially Paid * `paid` - Paid * `overdue` - Overdue Options: draft, submitted, approved, rejected, partially_paid, paid, overdue
`supplier_invoice_number`	string
`tax_amount`	string or number or object
`tax_exempt`	boolean
`tax_treatment`	string	* `standard` - Standard * `reverse_charge` - Domestic reverse charge * `zero` - Zero rated * `reduced` - Reduced rated * `exempt` - Exempt * `use_tax` - Use tax Options: standard, reverse_charge, zero, reduced, exempt, use_tax
`total_paid`	string or number or object
`use_tax_amount`	decimal
`vendor_name` *	string	Vendor/supplier name.

Responses

201 — Success

Field	Type	Details
`approval`	JSON	Computed JSON value; may be null when access is restricted.
`attached_receipts`	uuid[]
`attached_receipts_detail`	JSON	Computed JSON value; may be null when access is restricted.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`balance_due`	object
`cis_deduction_amount`	decimal
`cis_deduction_rate`	decimal
`cis_materials_amount`	decimal
`claimant`	uuid	The person who paid out of pocket and needs to be reimbursed.
`claimant_name`	string
`created_by` *	uuid
`description`	string
`document_type`	string	* `bill` - Bill * `credit_note` - Credit note Options: bill, credit_note
`due_date`	date
`effective_retention_held`	JSON	Computed JSON value; may be null when access is restricted.
`exchange_rate`	decimal	Rate used to convert Original -> Workspace.
`gross_amount`	object
`id` *	uuid
`is_converted`	JSON	Computed JSON value; may be null when access is restricted.
`is_reimbursable`	boolean	True if paid by employee (needs reimbursement). False if paid by company.
`issue_date` *	date
`latest_return_note` *	string
`lien_waiver_action_at` *	date-time
`lien_waiver_action_by` *	uuid
`lien_waiver_action_note` *	string
`lien_waiver_status` *	string	* `not_required` - Not required * `required` - Required * `received` - Received * `waived` - Requirement waived Options: not_required, required, received, waived
`lien_waivers` *	ExpenseLienWaiver[]
`line_items`	ExpenseLineItem[]
`match_exception_approved_at` *	date-time
`match_exception_approved_by` *	uuid
`match_notes` *	string
`match_status` *	string	* `unmatched` - Unmatched * `matched` - Matched * `exception` - Match exception * `exception_approved` - Exception approved Options: unmatched, matched, exception, exception_approved
`match_summary`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_amount`	object
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string	Internal notes or comments about this expense.
`original_currency`	string	ISO code of the original receipt currency.
`parent_expense_id`	uuid
`parsing_notes`	string	Context or warnings from the AI extraction.
`partner` *	ExpensePartner
`partner_id`	uuid
`payments`	ExpensePayment[]
`project` *	uuid
`purchase_order_id`	uuid
`purchase_order_number`	string
`record_type`	string	* `supplier_bill` - Supplier bill * `expense` - Everyday expense / receipt * `reimbursement` - Employee reimbursement Options: supplier_bill, expense, reimbursement
`reference`	string
`requested_approver`	uuid	The specific manager requested to approve this spend.
`retention_held`	object
`retention_percentage`	decimal
`retention_released`	object
`retention_releases` *	ExpenseRetentionRelease[]
`status`	string	* `draft` - Draft * `submitted` - Submitted * `approved` - Approved * `rejected` - Rejected * `partially_paid` - Partially Paid * `paid` - Paid * `overdue` - Overdue Options: draft, submitted, approved, rejected, partially_paid, paid, overdue
`supplier_invoice_number`	string
`tax_amount`	object
`tax_exempt`	boolean
`tax_treatment`	string	* `standard` - Standard * `reverse_charge` - Domestic reverse charge * `zero` - Zero rated * `reduced` - Reduced rated * `exempt` - Exempt * `use_tax` - Use tax Options: standard, reverse_charge, zero, reduced, exempt, use_tax
`total_paid`	object
`use_tax_amount`	decimal
`vendor_name` *	string	Vendor/supplier name.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/projects/{project_id}/expenses/{id}/

Required scopes and service-account permissions: expenses:manage, expenses:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Enforce a workspace capability in addition to RBAC.

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/expenses/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`approval`	JSON	Computed JSON value; may be null when access is restricted.
`attached_receipts`	uuid[]
`attached_receipts_detail`	JSON	Computed JSON value; may be null when access is restricted.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`balance_due`	object
`cis_deduction_amount`	decimal
`cis_deduction_rate`	decimal
`cis_materials_amount`	decimal
`claimant`	uuid	The person who paid out of pocket and needs to be reimbursed.
`claimant_name`	string
`created_by` *	uuid
`description`	string
`document_type`	string	* `bill` - Bill * `credit_note` - Credit note Options: bill, credit_note
`due_date`	date
`effective_retention_held`	JSON	Computed JSON value; may be null when access is restricted.
`exchange_rate`	decimal	Rate used to convert Original -> Workspace.
`gross_amount`	object
`id` *	uuid
`is_converted`	JSON	Computed JSON value; may be null when access is restricted.
`is_reimbursable`	boolean	True if paid by employee (needs reimbursement). False if paid by company.
`issue_date` *	date
`latest_return_note` *	string
`lien_waiver_action_at` *	date-time
`lien_waiver_action_by` *	uuid
`lien_waiver_action_note` *	string
`lien_waiver_status` *	string	* `not_required` - Not required * `required` - Required * `received` - Received * `waived` - Requirement waived Options: not_required, required, received, waived
`lien_waivers` *	ExpenseLienWaiver[]
`line_items`	ExpenseLineItem[]
`match_exception_approved_at` *	date-time
`match_exception_approved_by` *	uuid
`match_notes` *	string
`match_status` *	string	* `unmatched` - Unmatched * `matched` - Matched * `exception` - Match exception * `exception_approved` - Exception approved Options: unmatched, matched, exception, exception_approved
`match_summary`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_amount`	object
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string	Internal notes or comments about this expense.
`original_currency`	string	ISO code of the original receipt currency.
`parent_expense_id`	uuid
`parsing_notes`	string	Context or warnings from the AI extraction.
`partner` *	ExpensePartner
`partner_id`	uuid
`payments`	ExpensePayment[]
`project` *	uuid
`purchase_order_id`	uuid
`purchase_order_number`	string
`record_type`	string	* `supplier_bill` - Supplier bill * `expense` - Everyday expense / receipt * `reimbursement` - Employee reimbursement Options: supplier_bill, expense, reimbursement
`reference`	string
`requested_approver`	uuid	The specific manager requested to approve this spend.
`retention_held`	object
`retention_percentage`	decimal
`retention_released`	object
`retention_releases` *	ExpenseRetentionRelease[]
`status`	string	* `draft` - Draft * `submitted` - Submitted * `approved` - Approved * `rejected` - Rejected * `partially_paid` - Partially Paid * `paid` - Paid * `overdue` - Overdue Options: draft, submitted, approved, rejected, partially_paid, paid, overdue
`supplier_invoice_number`	string
`tax_amount`	object
`tax_exempt`	boolean
`tax_treatment`	string	* `standard` - Standard * `reverse_charge` - Domestic reverse charge * `zero` - Zero rated * `reduced` - Reduced rated * `exempt` - Exempt * `use_tax` - Use tax Options: standard, reverse_charge, zero, reduced, exempt, use_tax
`total_paid`	object
`use_tax_amount`	decimal
`vendor_name` *	string	Vendor/supplier name.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/projects/{project_id}/expenses/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`approval`	JSON	Computed JSON value; may be null when access is restricted.
`attached_receipts`	uuid[]
`attached_receipts_detail`	JSON	Computed JSON value; may be null when access is restricted.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`balance_due`	string or number or object
`cis_deduction_rate`	decimal
`cis_materials_amount`	decimal
`claimant`	uuid	The person who paid out of pocket and needs to be reimbursed.
`claimant_name`	string
`description`	string
`document_type`	string	* `bill` - Bill * `credit_note` - Credit note Options: bill, credit_note
`due_date`	date
`effective_retention_held`	JSON	Computed JSON value; may be null when access is restricted.
`exchange_rate`	decimal	Rate used to convert Original -> Workspace.
`gross_amount`	string or number or object
`is_converted`	JSON	Computed JSON value; may be null when access is restricted.
`is_reimbursable`	boolean	True if paid by employee (needs reimbursement). False if paid by company.
`issue_date`	date
`line_items`	ExpenseLineItemRequest[]
`match_summary`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_amount`	string or number or object
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string	Internal notes or comments about this expense.
`original_currency`	string	ISO code of the original receipt currency.
`parent_expense_id`	uuid
`parsing_notes`	string	Context or warnings from the AI extraction.
`partner_id`	uuid
`purchase_order_id`	uuid
`record_type`	string	* `supplier_bill` - Supplier bill * `expense` - Everyday expense / receipt * `reimbursement` - Employee reimbursement Options: supplier_bill, expense, reimbursement
`reference`	string
`requested_approver`	uuid	The specific manager requested to approve this spend.
`retention_held`	string or number or object
`retention_percentage`	decimal
`retention_released`	string or number or object
`status`	string	* `draft` - Draft * `submitted` - Submitted * `approved` - Approved * `rejected` - Rejected * `partially_paid` - Partially Paid * `paid` - Paid * `overdue` - Overdue Options: draft, submitted, approved, rejected, partially_paid, paid, overdue
`supplier_invoice_number`	string
`tax_amount`	string or number or object
`tax_exempt`	boolean
`tax_treatment`	string	* `standard` - Standard * `reverse_charge` - Domestic reverse charge * `zero` - Zero rated * `reduced` - Reduced rated * `exempt` - Exempt * `use_tax` - Use tax Options: standard, reverse_charge, zero, reduced, exempt, use_tax
`total_paid`	string or number or object
`use_tax_amount`	decimal
`vendor_name`	string	Vendor/supplier name.

Responses

200 — Success

Field	Type	Details
`approval`	JSON	Computed JSON value; may be null when access is restricted.
`attached_receipts`	uuid[]
`attached_receipts_detail`	JSON	Computed JSON value; may be null when access is restricted.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`balance_due`	object
`cis_deduction_amount`	decimal
`cis_deduction_rate`	decimal
`cis_materials_amount`	decimal
`claimant`	uuid	The person who paid out of pocket and needs to be reimbursed.
`claimant_name`	string
`created_by` *	uuid
`description`	string
`document_type`	string	* `bill` - Bill * `credit_note` - Credit note Options: bill, credit_note
`due_date`	date
`effective_retention_held`	JSON	Computed JSON value; may be null when access is restricted.
`exchange_rate`	decimal	Rate used to convert Original -> Workspace.
`gross_amount`	object
`id` *	uuid
`is_converted`	JSON	Computed JSON value; may be null when access is restricted.
`is_reimbursable`	boolean	True if paid by employee (needs reimbursement). False if paid by company.
`issue_date` *	date
`latest_return_note` *	string
`lien_waiver_action_at` *	date-time
`lien_waiver_action_by` *	uuid
`lien_waiver_action_note` *	string
`lien_waiver_status` *	string	* `not_required` - Not required * `required` - Required * `received` - Received * `waived` - Requirement waived Options: not_required, required, received, waived
`lien_waivers` *	ExpenseLienWaiver[]
`line_items`	ExpenseLineItem[]
`match_exception_approved_at` *	date-time
`match_exception_approved_by` *	uuid
`match_notes` *	string
`match_status` *	string	* `unmatched` - Unmatched * `matched` - Matched * `exception` - Match exception * `exception_approved` - Exception approved Options: unmatched, matched, exception, exception_approved
`match_summary`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_amount`	object
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string	Internal notes or comments about this expense.
`original_currency`	string	ISO code of the original receipt currency.
`parent_expense_id`	uuid
`parsing_notes`	string	Context or warnings from the AI extraction.
`partner` *	ExpensePartner
`partner_id`	uuid
`payments`	ExpensePayment[]
`project` *	uuid
`purchase_order_id`	uuid
`purchase_order_number`	string
`record_type`	string	* `supplier_bill` - Supplier bill * `expense` - Everyday expense / receipt * `reimbursement` - Employee reimbursement Options: supplier_bill, expense, reimbursement
`reference`	string
`requested_approver`	uuid	The specific manager requested to approve this spend.
`retention_held`	object
`retention_percentage`	decimal
`retention_released`	object
`retention_releases` *	ExpenseRetentionRelease[]
`status`	string	* `draft` - Draft * `submitted` - Submitted * `approved` - Approved * `rejected` - Rejected * `partially_paid` - Partially Paid * `paid` - Paid * `overdue` - Overdue Options: draft, submitted, approved, rejected, partially_paid, paid, overdue
`supplier_invoice_number`	string
`tax_amount`	object
`tax_exempt`	boolean
`tax_treatment`	string	* `standard` - Standard * `reverse_charge` - Domestic reverse charge * `zero` - Zero rated * `reduced` - Reduced rated * `exempt` - Exempt * `use_tax` - Use tax Options: standard, reverse_charge, zero, reduced, exempt, use_tax
`total_paid`	object
`use_tax_amount`	decimal
`vendor_name` *	string	Vendor/supplier name.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/expenses/{id}/approve/

Required scopes and service-account permissions: expenses:approve, expenses:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Enforce a workspace capability in addition to RBAC.

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`note`	string

Responses

200 — Success

Field	Type	Details
`approval`	JSON	Computed JSON value; may be null when access is restricted.
`attached_receipts`	uuid[]
`attached_receipts_detail`	JSON	Computed JSON value; may be null when access is restricted.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`balance_due`	object
`cis_deduction_amount`	decimal
`cis_deduction_rate`	decimal
`cis_materials_amount`	decimal
`claimant`	uuid	The person who paid out of pocket and needs to be reimbursed.
`claimant_name`	string
`created_by` *	uuid
`description`	string
`document_type`	string	* `bill` - Bill * `credit_note` - Credit note Options: bill, credit_note
`due_date`	date
`effective_retention_held`	JSON	Computed JSON value; may be null when access is restricted.
`exchange_rate`	decimal	Rate used to convert Original -> Workspace.
`gross_amount`	object
`id` *	uuid
`is_converted`	JSON	Computed JSON value; may be null when access is restricted.
`is_reimbursable`	boolean	True if paid by employee (needs reimbursement). False if paid by company.
`issue_date` *	date
`latest_return_note` *	string
`lien_waiver_action_at` *	date-time
`lien_waiver_action_by` *	uuid
`lien_waiver_action_note` *	string
`lien_waiver_status` *	string	* `not_required` - Not required * `required` - Required * `received` - Received * `waived` - Requirement waived Options: not_required, required, received, waived
`lien_waivers` *	ExpenseLienWaiver[]
`line_items`	ExpenseLineItem[]
`match_exception_approved_at` *	date-time
`match_exception_approved_by` *	uuid
`match_notes` *	string
`match_status` *	string	* `unmatched` - Unmatched * `matched` - Matched * `exception` - Match exception * `exception_approved` - Exception approved Options: unmatched, matched, exception, exception_approved
`match_summary`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_amount`	object
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string	Internal notes or comments about this expense.
`original_currency`	string	ISO code of the original receipt currency.
`parent_expense_id`	uuid
`parsing_notes`	string	Context or warnings from the AI extraction.
`partner` *	ExpensePartner
`partner_id`	uuid
`payments`	ExpensePayment[]
`project` *	uuid
`purchase_order_id`	uuid
`purchase_order_number`	string
`record_type`	string	* `supplier_bill` - Supplier bill * `expense` - Everyday expense / receipt * `reimbursement` - Employee reimbursement Options: supplier_bill, expense, reimbursement
`reference`	string
`requested_approver`	uuid	The specific manager requested to approve this spend.
`retention_held`	object
`retention_percentage`	decimal
`retention_released`	object
`retention_releases` *	ExpenseRetentionRelease[]
`status`	string	* `draft` - Draft * `submitted` - Submitted * `approved` - Approved * `rejected` - Rejected * `partially_paid` - Partially Paid * `paid` - Paid * `overdue` - Overdue Options: draft, submitted, approved, rejected, partially_paid, paid, overdue
`supplier_invoice_number`	string
`tax_amount`	object
`tax_exempt`	boolean
`tax_treatment`	string	* `standard` - Standard * `reverse_charge` - Domestic reverse charge * `zero` - Zero rated * `reduced` - Reduced rated * `exempt` - Exempt * `use_tax` - Use tax Options: standard, reverse_charge, zero, reduced, exempt, use_tax
`total_paid`	object
`use_tax_amount`	decimal
`vendor_name` *	string	Vendor/supplier name.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/expenses/{id}/reject/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`note`	string

Responses

200 — Success

Field	Type	Details
`approval`	JSON	Computed JSON value; may be null when access is restricted.
`attached_receipts`	uuid[]
`attached_receipts_detail`	JSON	Computed JSON value; may be null when access is restricted.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`balance_due`	object
`cis_deduction_amount`	decimal
`cis_deduction_rate`	decimal
`cis_materials_amount`	decimal
`claimant`	uuid	The person who paid out of pocket and needs to be reimbursed.
`claimant_name`	string
`created_by` *	uuid
`description`	string
`document_type`	string	* `bill` - Bill * `credit_note` - Credit note Options: bill, credit_note
`due_date`	date
`effective_retention_held`	JSON	Computed JSON value; may be null when access is restricted.
`exchange_rate`	decimal	Rate used to convert Original -> Workspace.
`gross_amount`	object
`id` *	uuid
`is_converted`	JSON	Computed JSON value; may be null when access is restricted.
`is_reimbursable`	boolean	True if paid by employee (needs reimbursement). False if paid by company.
`issue_date` *	date
`latest_return_note` *	string
`lien_waiver_action_at` *	date-time
`lien_waiver_action_by` *	uuid
`lien_waiver_action_note` *	string
`lien_waiver_status` *	string	* `not_required` - Not required * `required` - Required * `received` - Received * `waived` - Requirement waived Options: not_required, required, received, waived
`lien_waivers` *	ExpenseLienWaiver[]
`line_items`	ExpenseLineItem[]
`match_exception_approved_at` *	date-time
`match_exception_approved_by` *	uuid
`match_notes` *	string
`match_status` *	string	* `unmatched` - Unmatched * `matched` - Matched * `exception` - Match exception * `exception_approved` - Exception approved Options: unmatched, matched, exception, exception_approved
`match_summary`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_amount`	object
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string	Internal notes or comments about this expense.
`original_currency`	string	ISO code of the original receipt currency.
`parent_expense_id`	uuid
`parsing_notes`	string	Context or warnings from the AI extraction.
`partner` *	ExpensePartner
`partner_id`	uuid
`payments`	ExpensePayment[]
`project` *	uuid
`purchase_order_id`	uuid
`purchase_order_number`	string
`record_type`	string	* `supplier_bill` - Supplier bill * `expense` - Everyday expense / receipt * `reimbursement` - Employee reimbursement Options: supplier_bill, expense, reimbursement
`reference`	string
`requested_approver`	uuid	The specific manager requested to approve this spend.
`retention_held`	object
`retention_percentage`	decimal
`retention_released`	object
`retention_releases` *	ExpenseRetentionRelease[]
`status`	string	* `draft` - Draft * `submitted` - Submitted * `approved` - Approved * `rejected` - Rejected * `partially_paid` - Partially Paid * `paid` - Paid * `overdue` - Overdue Options: draft, submitted, approved, rejected, partially_paid, paid, overdue
`supplier_invoice_number`	string
`tax_amount`	object
`tax_exempt`	boolean
`tax_treatment`	string	* `standard` - Standard * `reverse_charge` - Domestic reverse charge * `zero` - Zero rated * `reduced` - Reduced rated * `exempt` - Exempt * `use_tax` - Use tax Options: standard, reverse_charge, zero, reduced, exempt, use_tax
`total_paid`	object
`use_tax_amount`	decimal
`vendor_name` *	string	Vendor/supplier name.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/files/

Required scopes and service-account permissions: files:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Upload, list, and manage files for a project.

Parameters

Name	Location	Details
`exclude_source`	query	Comma-separated sources to exclude.
`needs_attention`	query	true to show files requiring attention; requires files:write.
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`project_id` *	path	uuid
`search`	query	Search filename, text, type, tags, and uploader.
`source`	query	Filter by file source.
`tag`	query	Filter by tag name.
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	FileDetail[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/files/presign/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`accuracy_m`	double
`audience_type`	string	* `builder_internal` - Builder staff * `builder_team` - Builder side * `builder_client` - Builder and client teams * `client_team` - Client team * `everyone` - Everyone on this job * `selected_people` - Selected people Options: builder_internal, builder_team, builder_client, client_team, everyone, selected_people
`captured_at`	date-time
`content_type` *	string
`exif_latitude`	double
`exif_longitude`	double
`filename` *	string
`is_private`	boolean
`latitude`	double
`location_source`	string	* `device_gps` - Device GPS * `exif` - Photo EXIF Options: device_gps, exif,
`longitude`	double
`selected_user_ids`	uuid[]
`size_bytes` *	integer
`source`	string	* `general` - General Upload * `timeline` - Timeline Message * `site_diary` - Site Diary * `task` - Task Attachment * `expense` - Expense Receipt * `pickup` - Store Pickup Ticket * `delivery_ticket` - Delivery Docket * `quote` - Quote / Document Assets * `invoice` - Invoice / Document Assets * `partner_compliance` - Partner Compliance * `brief` - Builder Brief Options: general, timeline, site_diary, task, expense, pickup, delivery_ticket, quote, invoice, partner_compliance, brief
`tags`	uuid[]

Responses

200 — Success

Field	Type	Details
`bucket` *	string
`file_id` *	uuid
`key` *	string
`presigned_post` *	object

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/projects/{project_id}/files/{id}/

Required scopes and service-account permissions: files:manage, files:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Upload, list, and manage files for a project.

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/files/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`accuracy_m` *	double
`ai_suggestions`	JSON	Stores raw AI suggestions for name, tags, etc.
`analysis_error`	string
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`audience_type`	string	* `builder_internal` - Builder staff * `builder_team` - Builder side * `builder_client` - Builder and client teams * `client_team` - Client team * `everyone` - Everyone on this job * `selected_people` - Selected people Options: builder_internal, builder_team, builder_client, client_team, everyone, selected_people
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`captured_at` *	date-time
`created_at` *	date-time
`created_by_name`	string
`description`	string	A user-or-AI-generated description of the file's content.
`distance_from_site_m`	JSON	Computed JSON value; may be null when access is restricted.
`exif_latitude` *	double
`exif_longitude` *	double
`file` *	uri
`file_size`	integer	Size of the file in bytes.
`folder`	JSON	Computed JSON value; may be null when access is restricted.
`folder_id`	uuid
`id` *	uuid
`is_private`	boolean	If True, this document is only visible to workspace members.
`latitude` *	double
`location_source` *	string	* `device_gps` - Device GPS * `exif` - Photo EXIF Options: device_gps, exif
`longitude` *	double
`mime_type`	string	MIME type of the file.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`project`	uuid
`selected_user_ids`	JSON
`source`	string	* `general` - General Upload * `timeline` - Timeline Message * `site_diary` - Site Diary * `task` - Task Attachment * `expense` - Expense Receipt * `pickup` - Store Pickup Ticket * `delivery_ticket` - Delivery Docket * `quote` - Quote / Document Assets * `invoice` - Invoice / Document Assets * `partner_compliance` - Partner Compliance * `brief` - Builder Brief Options: general, timeline, site_diary, task, expense, pickup, delivery_ticket, quote, invoice, partner_compliance, brief
`status`	string	* `uploading` - Uploading * `processing` - Processing * `pending_review` - Pending Review * `approved` - Approved * `failed` - Failed Options: uploading, processing, pending_review, approved, failed
`storage_key` *	string
`superseded_by_id`	JSON	Computed JSON value; may be null when access is restricted.
`superseded_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`supersedes_id`	uuid
`tags` *	FileTag[]
`updated_at` *	date-time
`user_defined_name` *	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/projects/{project_id}/files/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`audience_type`	string	* `builder_internal` - Builder staff * `builder_team` - Builder side * `builder_client` - Builder and client teams * `client_team` - Client team * `everyone` - Everyone on this job * `selected_people` - Selected people Options: builder_internal, builder_team, builder_client, client_team, everyone, selected_people
`description`	string	A user-or-AI-generated description of the file's content.
`file`	binary
`folder_id`	uuid
`is_private`	boolean	If True, this document is only visible to workspace members.
`selected_user_ids`	JSON
`source`	string
`status`	string	* `uploading` - Uploading * `processing` - Processing * `pending_review` - Pending Review * `approved` - Approved * `failed` - Failed Options: uploading, processing, pending_review, approved, failed
`superseded_by_id`	JSON	Computed JSON value; may be null when access is restricted.
`superseded_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`supersedes_id`	uuid
`tags`	uuid[]
`user_defined_name`	string

Responses

200 — Success

Field	Type	Details
`audience_type`	string	* `builder_internal` - Builder staff * `builder_team` - Builder side * `builder_client` - Builder and client teams * `client_team` - Client team * `everyone` - Everyone on this job * `selected_people` - Selected people Options: builder_internal, builder_team, builder_client, client_team, everyone, selected_people
`created_at` *	date-time
`description`	string	A user-or-AI-generated description of the file's content.
`file`	uri
`folder_id`	uuid
`id` *	uuid
`is_private`	boolean	If True, this document is only visible to workspace members.
`selected_user_ids`	JSON
`status`	string	* `uploading` - Uploading * `processing` - Processing * `pending_review` - Pending Review * `approved` - Approved * `failed` - Failed Options: uploading, processing, pending_review, approved, failed
`superseded_by_id`	JSON	Computed JSON value; may be null when access is restricted.
`superseded_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`supersedes_id`	uuid
`tags`	uuid[]
`user_defined_name`	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/files/{id}/download-url/

Required scopes and service-account permissions: files:download, files:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Generate a short-lived S3 presigned URL for downloading/viewing a file.

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`url` *	uri

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/files/{id}/finalize/

Required scopes and service-account permissions: files:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Finalisation returns 202 Accepted; read the file detail to monitor processing status. Finalize a presigned upload: - HEAD the object - set file size/mime/status - increment workspace storage used + file count - trigger billing sync so storage buckets auto-increment

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`etag`	string

Responses

202 — Success

Field	Type	Details
`accuracy_m` *	double
`ai_suggestions`	JSON	Stores raw AI suggestions for name, tags, etc.
`analysis_error`	string
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`audience_type`	string	* `builder_internal` - Builder staff * `builder_team` - Builder side * `builder_client` - Builder and client teams * `client_team` - Client team * `everyone` - Everyone on this job * `selected_people` - Selected people Options: builder_internal, builder_team, builder_client, client_team, everyone, selected_people
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`captured_at` *	date-time
`created_at` *	date-time
`created_by_name`	string
`description`	string	A user-or-AI-generated description of the file's content.
`distance_from_site_m`	JSON	Computed JSON value; may be null when access is restricted.
`exif_latitude` *	double
`exif_longitude` *	double
`file` *	uri
`file_size`	integer	Size of the file in bytes.
`folder`	JSON	Computed JSON value; may be null when access is restricted.
`folder_id`	uuid
`id` *	uuid
`is_private`	boolean	If True, this document is only visible to workspace members.
`latitude` *	double
`location_source` *	string	* `device_gps` - Device GPS * `exif` - Photo EXIF Options: device_gps, exif
`longitude` *	double
`mime_type`	string	MIME type of the file.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`project`	uuid
`selected_user_ids`	JSON
`source`	string	* `general` - General Upload * `timeline` - Timeline Message * `site_diary` - Site Diary * `task` - Task Attachment * `expense` - Expense Receipt * `pickup` - Store Pickup Ticket * `delivery_ticket` - Delivery Docket * `quote` - Quote / Document Assets * `invoice` - Invoice / Document Assets * `partner_compliance` - Partner Compliance * `brief` - Builder Brief Options: general, timeline, site_diary, task, expense, pickup, delivery_ticket, quote, invoice, partner_compliance, brief
`status`	string	* `uploading` - Uploading * `processing` - Processing * `pending_review` - Pending Review * `approved` - Approved * `failed` - Failed Options: uploading, processing, pending_review, approved, failed
`storage_key` *	string
`superseded_by_id`	JSON	Computed JSON value; may be null when access is restricted.
`superseded_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`supersedes_id`	uuid
`tags` *	FileTag[]
`updated_at` *	date-time
`user_defined_name` *	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/final-account/assumptions/

Required scopes and service-account permissions: final_account:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Enforce a workspace capability in addition to RBAC.

Parameters

Name	Location	Details
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	FinalAccountAssumption[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/final-account/assumptions/

Required scopes and service-account permissions: final_account:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Enforce a workspace capability in addition to RBAC.

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`forecast_revenue_net`	decimal
`records` *	FinalAccountAssumptionRequest[]

Responses

200 — Success

Field	Type	Details
`assumption_percent`	integer
`change_request` *	uuid
`id` *	uuid
`included`	boolean
`project` *	uuid
`updated_at` *	date-time

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/financial-summary/

Required scopes and service-account permissions: project_finance:view_budgets, project_finance:view_cashflow, project_finance:view_commitments, project_finance:view_forecasts, project_finance:view_margins, projects:read, timesheets:view_hours, timesheets:view_labour_costs. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Reusable security logic for any Workspace-scoped resource.

Parameters

Name	Location	Details
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`accrued_cost` *	double
`actual_cost` *	double
`approved_actuals` *	double
`approved_expenses` *	double
`billed_margin` *	double
`budget_message` *	string
`budget_source` *	string
`budget_variance` *	double
`budget_variance_pct` *	double
`cash_in` *	double
`cash_out` *	double
`cash_paid` *	double
`cash_received` *	double
`client_credit_balance` *	double
`committed_cost` *	double
`committed_po_value` *	double
`contract_margin` *	double
`contract_margin_pct` *	double
`contract_sum` *	double
`cost_at_completion` *	double
`cost_movement` *	object
`forecast_cost` *	double
`forecast_margin` *	double
`forecast_margin_pct` *	double
`forecast_variance` *	double
`invoiced` *	double
`owed_by_client` *	double
`owed_to_suppliers` *	double
`pending_bills` *	double
`pending_payables` *	double
`planned_cost` *	double
`projected_profit` *	double
`remaining_commitment` *	double
`supplier_retention_held` *	double
`timesheet_cost` *	double
`timesheet_hours` *	double
`timesheet_labour` *	JSON
`total_exposure` *	double
`unordered_budget_residual` *	double

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/invoices/

Required scopes and service-account permissions: invoices:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Reusable security logic for any Workspace-scoped resource.

Parameters

Name	Location	Details
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	InvoiceDetail[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/invoices/

Required scopes and service-account permissions: invoices:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Reusable security logic for any Workspace-scoped resource.

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`amount_paid`	JSON	Computed JSON value; may be null when access is restricted.
`apply_cis`	boolean
`apply_drc`	boolean	If True, applies Domestic Reverse Charge (VAT = 0).
`apply_retention`	boolean
`apply_tax`	boolean	Whether VAT/tax is applied and shown on this invoice.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`balance_due`	JSON	Computed JSON value; may be null when access is restricted.
`bank_details`	string
`bill_to_address_id`	uuid
`cis_deduction_amount`	JSON	Computed JSON value; may be null when access is restricted.
`cis_rate`	decimal
`created_by`	uuid
`document_type`	string	* `invoice` - Invoice * `credit_note` - Credit Note * `retention_release` - Retention Release Options: invoice, credit_note, retention_release
`due_date` *	date
`effective_for_address`	JSON	Computed JSON value; may be null when access is restricted.
`effective_for_name`	JSON	Computed JSON value; may be null when access is restricted.
`effective_from_address`	JSON	Computed JSON value; may be null when access is restricted.
`effective_from_name`	JSON	Computed JSON value; may be null when access is restricted.
`effective_from_tax_id`	JSON	Computed JSON value; may be null when access is restricted.
`effective_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`effective_terms`	JSON	Computed JSON value; may be null when access is restricted.
`email_message`	string	Optional message to include in the email when sending/issuing. Not shown on the invoice PDF.
`header_config`	JSON
`internal_notes`	string
`is_application`	JSON	Computed JSON value; may be null when access is restricted.
`issue_date` *	date
`line_items` *	InvoiceLineItemRequest[]
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_payable`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string
`parent_invoice`	uuid
`previously_certified`	JSON	Computed JSON value; may be null when access is restricted.
`project` *	uuid
`reference`	string
`retention_amount`	JSON	Computed JSON value; may be null when access is restricted.
`retention_rate`	decimal
`source_attributions`	JSON	Computed JSON value; may be null when access is restricted.
`source_quote`	uuid
`subtotal`	JSON	Computed JSON value; may be null when access is restricted.
`tax_amount`	JSON	Computed JSON value; may be null when access is restricted.
`tax_rate`	decimal	Override tax rate. If null, uses workspace default.
`terms_override`	string	Optional invoice-specific terms; if blank uses workspace default_terms_and_conditions.
`title`	string
`total`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_country_iso2`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_tax_label`	JSON	Computed JSON value; may be null when access is restricted.

Responses

201 — Success

Field	Type	Details
`allocations` *	PaymentAllocation[]
`amount_paid`	JSON	Computed JSON value; may be null when access is restricted.
`apply_cis`	boolean
`apply_drc`	boolean	If True, applies Domestic Reverse Charge (VAT = 0).
`apply_retention`	boolean
`apply_tax`	boolean	Whether VAT/tax is applied and shown on this invoice.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`balance_due`	JSON	Computed JSON value; may be null when access is restricted.
`bank_details`	string
`bill_to_address` *	Address
`cis_deduction_amount`	JSON	Computed JSON value; may be null when access is restricted.
`cis_rate`	decimal
`created_at` *	date-time
`created_by`	uuid
`customer_name`	string
`document_type`	string	* `invoice` - Invoice * `credit_note` - Credit Note * `retention_release` - Retention Release Options: invoice, credit_note, retention_release
`due_date` *	date
`effective_for_address`	JSON	Computed JSON value; may be null when access is restricted.
`effective_for_name`	JSON	Computed JSON value; may be null when access is restricted.
`effective_from_address`	JSON	Computed JSON value; may be null when access is restricted.
`effective_from_name`	JSON	Computed JSON value; may be null when access is restricted.
`effective_from_tax_id`	JSON	Computed JSON value; may be null when access is restricted.
`effective_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`effective_terms`	JSON	Computed JSON value; may be null when access is restricted.
`email_message`	string	Optional message to include in the email when sending/issuing. Not shown on the invoice PDF.
`header_config`	JSON
`id` *	uuid
`internal_notes`	string
`invoice_number` *	string	Workspace-unique invoice number (e.g., INV-0001).
`is_application`	JSON	Computed JSON value; may be null when access is restricted.
`issue_date` *	date
`line_items` *	InvoiceLineItem[]
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_payable`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string
`parent_invoice`	uuid
`previously_certified`	JSON	Computed JSON value; may be null when access is restricted.
`project` *	uuid
`project_name` *	string
`project_site_address` *	Address
`reference`	string
`retention_amount`	JSON	Computed JSON value; may be null when access is restricted.
`retention_rate`	decimal
`sections` *	InvoiceSection[]
`source_attributions`	JSON	Computed JSON value; may be null when access is restricted.
`source_document_type`	string
`source_quote`	uuid
`source_quote_number`	string
`source_quote_title`	string
`source_variation_number`	integer
`status` *	string	* `draft` - Draft * `issued` - Issued (Awaiting Payment) * `paid` - Paid * `partially_paid` - Partially Paid * `void` - Void Options: draft, issued, paid, partially_paid, void
`subtotal`	JSON	Computed JSON value; may be null when access is restricted.
`tax_amount`	JSON	Computed JSON value; may be null when access is restricted.
`tax_rate`	decimal	Override tax rate. If null, uses workspace default.
`terms_override`	string	Optional invoice-specific terms; if blank uses workspace default_terms_and_conditions.
`title`	string
`total`	JSON	Computed JSON value; may be null when access is restricted.
`updated_at` *	date-time
`workspace_bank_account_name` *	string
`workspace_bank_account_number` *	string
`workspace_bank_name` *	string
`workspace_bank_sort_code` *	string
`workspace_business_address` *	Address
`workspace_company_name` *	string
`workspace_country_iso2`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_default_payment_terms_days` *	integer
`workspace_default_tax_rate` *	decimal
`workspace_default_terms_and_conditions` *	string
`workspace_include_terms_in_invoices` *	boolean
`workspace_logo` *	uri
`workspace_name` *	string
`workspace_tax_id` *	string
`workspace_tax_label`	JSON	Computed JSON value; may be null when access is restricted.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/projects/{project_id}/invoices/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/invoices/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`allocations` *	PaymentAllocation[]
`amount_paid`	JSON	Computed JSON value; may be null when access is restricted.
`apply_cis`	boolean
`apply_drc`	boolean	If True, applies Domestic Reverse Charge (VAT = 0).
`apply_retention`	boolean
`apply_tax`	boolean	Whether VAT/tax is applied and shown on this invoice.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`balance_due`	JSON	Computed JSON value; may be null when access is restricted.
`bank_details`	string
`bill_to_address` *	Address
`cis_deduction_amount`	JSON	Computed JSON value; may be null when access is restricted.
`cis_rate`	decimal
`created_at` *	date-time
`created_by`	uuid
`customer_name`	string
`document_type`	string	* `invoice` - Invoice * `credit_note` - Credit Note * `retention_release` - Retention Release Options: invoice, credit_note, retention_release
`due_date` *	date
`effective_for_address`	JSON	Computed JSON value; may be null when access is restricted.
`effective_for_name`	JSON	Computed JSON value; may be null when access is restricted.
`effective_from_address`	JSON	Computed JSON value; may be null when access is restricted.
`effective_from_name`	JSON	Computed JSON value; may be null when access is restricted.
`effective_from_tax_id`	JSON	Computed JSON value; may be null when access is restricted.
`effective_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`effective_terms`	JSON	Computed JSON value; may be null when access is restricted.
`email_message`	string	Optional message to include in the email when sending/issuing. Not shown on the invoice PDF.
`header_config`	JSON
`id` *	uuid
`internal_notes`	string
`invoice_number` *	string	Workspace-unique invoice number (e.g., INV-0001).
`is_application`	JSON	Computed JSON value; may be null when access is restricted.
`issue_date` *	date
`line_items` *	InvoiceLineItem[]
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_payable`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string
`parent_invoice`	uuid
`previously_certified`	JSON	Computed JSON value; may be null when access is restricted.
`project` *	uuid
`project_name` *	string
`project_site_address` *	Address
`reference`	string
`retention_amount`	JSON	Computed JSON value; may be null when access is restricted.
`retention_rate`	decimal
`sections` *	InvoiceSection[]
`source_attributions`	JSON	Computed JSON value; may be null when access is restricted.
`source_document_type`	string
`source_quote`	uuid
`source_quote_number`	string
`source_quote_title`	string
`source_variation_number`	integer
`status` *	string	* `draft` - Draft * `issued` - Issued (Awaiting Payment) * `paid` - Paid * `partially_paid` - Partially Paid * `void` - Void Options: draft, issued, paid, partially_paid, void
`subtotal`	JSON	Computed JSON value; may be null when access is restricted.
`tax_amount`	JSON	Computed JSON value; may be null when access is restricted.
`tax_rate`	decimal	Override tax rate. If null, uses workspace default.
`terms_override`	string	Optional invoice-specific terms; if blank uses workspace default_terms_and_conditions.
`title`	string
`total`	JSON	Computed JSON value; may be null when access is restricted.
`updated_at` *	date-time
`workspace_bank_account_name` *	string
`workspace_bank_account_number` *	string
`workspace_bank_name` *	string
`workspace_bank_sort_code` *	string
`workspace_business_address` *	Address
`workspace_company_name` *	string
`workspace_country_iso2`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_default_payment_terms_days` *	integer
`workspace_default_tax_rate` *	decimal
`workspace_default_terms_and_conditions` *	string
`workspace_include_terms_in_invoices` *	boolean
`workspace_logo` *	uri
`workspace_name` *	string
`workspace_tax_id` *	string
`workspace_tax_label`	JSON	Computed JSON value; may be null when access is restricted.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/projects/{project_id}/invoices/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`amount_paid`	JSON	Computed JSON value; may be null when access is restricted.
`apply_cis`	boolean
`apply_drc`	boolean	If True, applies Domestic Reverse Charge (VAT = 0).
`apply_retention`	boolean
`apply_tax`	boolean	Whether VAT/tax is applied and shown on this invoice.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`balance_due`	JSON	Computed JSON value; may be null when access is restricted.
`bank_details`	string
`bill_to_address_id`	uuid
`cis_deduction_amount`	JSON	Computed JSON value; may be null when access is restricted.
`cis_rate`	decimal
`created_by`	uuid
`document_type`	string	* `invoice` - Invoice * `credit_note` - Credit Note * `retention_release` - Retention Release Options: invoice, credit_note, retention_release
`due_date`	date
`effective_for_address`	JSON	Computed JSON value; may be null when access is restricted.
`effective_for_name`	JSON	Computed JSON value; may be null when access is restricted.
`effective_from_address`	JSON	Computed JSON value; may be null when access is restricted.
`effective_from_name`	JSON	Computed JSON value; may be null when access is restricted.
`effective_from_tax_id`	JSON	Computed JSON value; may be null when access is restricted.
`effective_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`effective_terms`	JSON	Computed JSON value; may be null when access is restricted.
`email_message`	string	Optional message to include in the email when sending/issuing. Not shown on the invoice PDF.
`header_config`	JSON
`internal_notes`	string
`is_application`	JSON	Computed JSON value; may be null when access is restricted.
`issue_date`	date
`line_items`	InvoiceLineItemRequest[]
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_payable`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string
`parent_invoice`	uuid
`previously_certified`	JSON	Computed JSON value; may be null when access is restricted.
`project`	uuid
`reference`	string
`retention_amount`	JSON	Computed JSON value; may be null when access is restricted.
`retention_rate`	decimal
`source_attributions`	JSON	Computed JSON value; may be null when access is restricted.
`source_quote`	uuid
`subtotal`	JSON	Computed JSON value; may be null when access is restricted.
`tax_amount`	JSON	Computed JSON value; may be null when access is restricted.
`tax_rate`	decimal	Override tax rate. If null, uses workspace default.
`terms_override`	string	Optional invoice-specific terms; if blank uses workspace default_terms_and_conditions.
`title`	string
`total`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_country_iso2`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_tax_label`	JSON	Computed JSON value; may be null when access is restricted.

Responses

200 — Success

Field	Type	Details
`allocations` *	PaymentAllocation[]
`amount_paid`	JSON	Computed JSON value; may be null when access is restricted.
`apply_cis`	boolean
`apply_drc`	boolean	If True, applies Domestic Reverse Charge (VAT = 0).
`apply_retention`	boolean
`apply_tax`	boolean	Whether VAT/tax is applied and shown on this invoice.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`balance_due`	JSON	Computed JSON value; may be null when access is restricted.
`bank_details`	string
`bill_to_address` *	Address
`cis_deduction_amount`	JSON	Computed JSON value; may be null when access is restricted.
`cis_rate`	decimal
`created_at` *	date-time
`created_by`	uuid
`customer_name`	string
`document_type`	string	* `invoice` - Invoice * `credit_note` - Credit Note * `retention_release` - Retention Release Options: invoice, credit_note, retention_release
`due_date` *	date
`effective_for_address`	JSON	Computed JSON value; may be null when access is restricted.
`effective_for_name`	JSON	Computed JSON value; may be null when access is restricted.
`effective_from_address`	JSON	Computed JSON value; may be null when access is restricted.
`effective_from_name`	JSON	Computed JSON value; may be null when access is restricted.
`effective_from_tax_id`	JSON	Computed JSON value; may be null when access is restricted.
`effective_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`effective_terms`	JSON	Computed JSON value; may be null when access is restricted.
`email_message`	string	Optional message to include in the email when sending/issuing. Not shown on the invoice PDF.
`header_config`	JSON
`id` *	uuid
`internal_notes`	string
`invoice_number` *	string	Workspace-unique invoice number (e.g., INV-0001).
`is_application`	JSON	Computed JSON value; may be null when access is restricted.
`issue_date` *	date
`line_items` *	InvoiceLineItem[]
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_payable`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string
`parent_invoice`	uuid
`previously_certified`	JSON	Computed JSON value; may be null when access is restricted.
`project` *	uuid
`project_name` *	string
`project_site_address` *	Address
`reference`	string
`retention_amount`	JSON	Computed JSON value; may be null when access is restricted.
`retention_rate`	decimal
`sections` *	InvoiceSection[]
`source_attributions`	JSON	Computed JSON value; may be null when access is restricted.
`source_document_type`	string
`source_quote`	uuid
`source_quote_number`	string
`source_quote_title`	string
`source_variation_number`	integer
`status` *	string	* `draft` - Draft * `issued` - Issued (Awaiting Payment) * `paid` - Paid * `partially_paid` - Partially Paid * `void` - Void Options: draft, issued, paid, partially_paid, void
`subtotal`	JSON	Computed JSON value; may be null when access is restricted.
`tax_amount`	JSON	Computed JSON value; may be null when access is restricted.
`tax_rate`	decimal	Override tax rate. If null, uses workspace default.
`terms_override`	string	Optional invoice-specific terms; if blank uses workspace default_terms_and_conditions.
`title`	string
`total`	JSON	Computed JSON value; may be null when access is restricted.
`updated_at` *	date-time
`workspace_bank_account_name` *	string
`workspace_bank_account_number` *	string
`workspace_bank_name` *	string
`workspace_bank_sort_code` *	string
`workspace_business_address` *	Address
`workspace_company_name` *	string
`workspace_country_iso2`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_default_payment_terms_days` *	integer
`workspace_default_tax_rate` *	decimal
`workspace_default_terms_and_conditions` *	string
`workspace_include_terms_in_invoices` *	boolean
`workspace_logo` *	uri
`workspace_name` *	string
`workspace_tax_id` *	string
`workspace_tax_label`	JSON	Computed JSON value; may be null when access is restricted.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/invoices/{id}/send/

Required scopes and service-account permissions: invoices:send, invoices:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Reusable security logic for any Workspace-scoped resource.

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`copy_to_sender`	boolean
`email_bcc`	email[]
`email_body`	string
`email_cc`	email[]
`email_subject`	string
`email_to`	email[]
`schedule_follow_up`	boolean

Responses

200 — Success

Field	Type	Details
`doc`	object
`emailed_to` *	email[]
`invoice` *	InvoiceDetail	Serializer mixin for module-specific sensitive response fields. ``sensitive_fields_by_permission`` maps an independent permission key to the fields omitted when that key is absent. Nested serializers inherit the root request/project context from DRF.
`resent` *	boolean

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/invoices/{id}/void/

Required scopes and service-account permissions: invoices:manage, invoices:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Dedicated action endpoint for voiding an invoice/credit note. Status transitions must never happen through the generic detail PATCH/PUT endpoint (see InvoiceDetailSerializer commercial-lock validation). This is the only supported way to move a document to void.

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`note`	string

Responses

200 — Success

Field	Type	Details
`allocations` *	PaymentAllocation[]
`amount_paid`	JSON	Computed JSON value; may be null when access is restricted.
`apply_cis`	boolean
`apply_drc`	boolean	If True, applies Domestic Reverse Charge (VAT = 0).
`apply_retention`	boolean
`apply_tax`	boolean	Whether VAT/tax is applied and shown on this invoice.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`balance_due`	JSON	Computed JSON value; may be null when access is restricted.
`bank_details`	string
`bill_to_address` *	Address
`cis_deduction_amount`	JSON	Computed JSON value; may be null when access is restricted.
`cis_rate`	decimal
`created_at` *	date-time
`created_by`	uuid
`customer_name`	string
`document_type`	string	* `invoice` - Invoice * `credit_note` - Credit Note * `retention_release` - Retention Release Options: invoice, credit_note, retention_release
`due_date` *	date
`effective_for_address`	JSON	Computed JSON value; may be null when access is restricted.
`effective_for_name`	JSON	Computed JSON value; may be null when access is restricted.
`effective_from_address`	JSON	Computed JSON value; may be null when access is restricted.
`effective_from_name`	JSON	Computed JSON value; may be null when access is restricted.
`effective_from_tax_id`	JSON	Computed JSON value; may be null when access is restricted.
`effective_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`effective_terms`	JSON	Computed JSON value; may be null when access is restricted.
`email_message`	string	Optional message to include in the email when sending/issuing. Not shown on the invoice PDF.
`header_config`	JSON
`id` *	uuid
`internal_notes`	string
`invoice_number` *	string	Workspace-unique invoice number (e.g., INV-0001).
`is_application`	JSON	Computed JSON value; may be null when access is restricted.
`issue_date` *	date
`line_items` *	InvoiceLineItem[]
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_payable`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string
`parent_invoice`	uuid
`previously_certified`	JSON	Computed JSON value; may be null when access is restricted.
`project` *	uuid
`project_name` *	string
`project_site_address` *	Address
`reference`	string
`retention_amount`	JSON	Computed JSON value; may be null when access is restricted.
`retention_rate`	decimal
`sections` *	InvoiceSection[]
`source_attributions`	JSON	Computed JSON value; may be null when access is restricted.
`source_document_type`	string
`source_quote`	uuid
`source_quote_number`	string
`source_quote_title`	string
`source_variation_number`	integer
`status` *	string	* `draft` - Draft * `issued` - Issued (Awaiting Payment) * `paid` - Paid * `partially_paid` - Partially Paid * `void` - Void Options: draft, issued, paid, partially_paid, void
`subtotal`	JSON	Computed JSON value; may be null when access is restricted.
`tax_amount`	JSON	Computed JSON value; may be null when access is restricted.
`tax_rate`	decimal	Override tax rate. If null, uses workspace default.
`terms_override`	string	Optional invoice-specific terms; if blank uses workspace default_terms_and_conditions.
`title`	string
`total`	JSON	Computed JSON value; may be null when access is restricted.
`updated_at` *	date-time
`workspace_bank_account_name` *	string
`workspace_bank_account_number` *	string
`workspace_bank_name` *	string
`workspace_bank_sort_code` *	string
`workspace_business_address` *	Address
`workspace_company_name` *	string
`workspace_country_iso2`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_default_payment_terms_days` *	integer
`workspace_default_tax_rate` *	decimal
`workspace_default_terms_and_conditions` *	string
`workspace_include_terms_in_invoices` *	boolean
`workspace_logo` *	uri
`workspace_name` *	string
`workspace_tax_id` *	string
`workspace_tax_label`	JSON	Computed JSON value; may be null when access is restricted.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/order-requests/

Required scopes and service-account permissions: material_requests:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Enforce a workspace capability in addition to RBAC.

Parameters

Name	Location	Details
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	RequisitionItem[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/order-requests/

Required scopes and service-account permissions: material_requests:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Enforce a workspace capability in addition to RBAC.

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`batch_summary`	JSON	Computed JSON value; may be null when access is restricted.
`boq_item`	uuid
`cost_code`	integer
`delivery_instructions`	string
`description` *	string
`estimate_location`	uuid	Optional plot this line is tagged to.
`estimated_unit_rate`	decimal
`is_pending_coding`	boolean
`lead_in_warning`	JSON	Computed JSON value; may be null when access is restricted.
`location`	uuid
`note`	string
`order_type`	string	* `material` - Material * `plant` - Plant * `subcontract` - Subcontract * `professional` - Professional services Options: material, plant, subcontract, professional
`priority`	string	* `normal` - Normal * `high` - High Options: normal, high
`progress`	JSON	Computed JSON value; may be null when access is restricted.
`quantity_needed` *	decimal
`requested_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`required_on_site_date` *	date
`resource`	integer
`save_to_personal_library`	boolean
`source`	string	* `workspace_library` - Workspace library * `personal_library` - Personal library * `job_boq` - Job BOQ * `freehand` - Freehand Options: workspace_library, personal_library, job_boq, freehand
`source_estimate_resource`	uuid
`source_estimate_work_item`	uuid
`suggested_partner`	uuid
`unit` *	uuid
`unit_of_measure`	string

Responses

201 — Success

Field	Type	Details
`batch` *	uuid
`batch_summary`	JSON	Computed JSON value; may be null when access is restricted.
`boq_item`	uuid
`converted_order` *	uuid
`converted_order_line` *	uuid
`cost_code`	integer
`created_at` *	date-time
`delivery_instructions`	string
`description` *	string
`estimate_location`	uuid	Optional plot this line is tagged to.
`estimated_unit_rate`	decimal
`id` *	uuid
`is_pending_coding`	boolean
`lead_in_days`	integer
`lead_in_warning`	JSON	Computed JSON value; may be null when access is restricted.
`location`	uuid
`note`	string
`order_type`	string	* `material` - Material * `plant` - Plant * `subcontract` - Subcontract * `professional` - Professional services Options: material, plant, subcontract, professional
`priority`	string	* `normal` - Normal * `high` - High Options: normal, high
`progress`	JSON	Computed JSON value; may be null when access is restricted.
`project` *	uuid
`project_name` *	string
`quantity_needed`	decimal
`rejection_reason` *	string
`requested_by` *	uuid
`requested_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`required_on_site_date`	date
`resource`	integer
`resource_name`	string
`source`	string	* `workspace_library` - Workspace library * `personal_library` - Personal library * `job_boq` - Job BOQ * `freehand` - Freehand Options: workspace_library, personal_library, job_boq, freehand
`source_estimate_resource`	uuid
`source_estimate_work_item`	uuid
`source_snapshot` *	JSON
`status` *	string	* `needed` - Needed * `requested` - Requested * `converted` - Converted * `rejected` - Rejected Options: needed, requested, converted, rejected
`suggested_partner`	uuid
`unit`	uuid
`unit_of_measure`	string
`updated_at` *	date-time
`version` *	integer

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/projects/{project_id}/order-requests/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/order-requests/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`batch` *	uuid
`batch_summary`	JSON	Computed JSON value; may be null when access is restricted.
`boq_item`	uuid
`converted_order` *	uuid
`converted_order_line` *	uuid
`cost_code`	integer
`created_at` *	date-time
`delivery_instructions`	string
`description` *	string
`estimate_location`	uuid	Optional plot this line is tagged to.
`estimated_unit_rate`	decimal
`id` *	uuid
`is_pending_coding`	boolean
`lead_in_days`	integer
`lead_in_warning`	JSON	Computed JSON value; may be null when access is restricted.
`location`	uuid
`note`	string
`order_type`	string	* `material` - Material * `plant` - Plant * `subcontract` - Subcontract * `professional` - Professional services Options: material, plant, subcontract, professional
`priority`	string	* `normal` - Normal * `high` - High Options: normal, high
`progress`	JSON	Computed JSON value; may be null when access is restricted.
`project` *	uuid
`project_name` *	string
`quantity_needed`	decimal
`rejection_reason` *	string
`requested_by` *	uuid
`requested_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`required_on_site_date`	date
`resource`	integer
`resource_name`	string
`source`	string	* `workspace_library` - Workspace library * `personal_library` - Personal library * `job_boq` - Job BOQ * `freehand` - Freehand Options: workspace_library, personal_library, job_boq, freehand
`source_estimate_resource`	uuid
`source_estimate_work_item`	uuid
`source_snapshot` *	JSON
`status` *	string	* `needed` - Needed * `requested` - Requested * `converted` - Converted * `rejected` - Rejected Options: needed, requested, converted, rejected
`suggested_partner`	uuid
`unit`	uuid
`unit_of_measure`	string
`updated_at` *	date-time
`version` *	integer

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/projects/{project_id}/order-requests/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`batch_summary`	JSON	Computed JSON value; may be null when access is restricted.
`boq_item`	uuid
`cost_code`	integer
`delivery_instructions`	string
`description`	string
`estimate_location`	uuid	Optional plot this line is tagged to.
`estimated_unit_rate`	decimal
`is_pending_coding`	boolean
`lead_in_warning`	JSON	Computed JSON value; may be null when access is restricted.
`location`	uuid
`note`	string
`order_type`	string	* `material` - Material * `plant` - Plant * `subcontract` - Subcontract * `professional` - Professional services Options: material, plant, subcontract, professional
`priority`	string	* `normal` - Normal * `high` - High Options: normal, high
`progress`	JSON	Computed JSON value; may be null when access is restricted.
`quantity_needed`	decimal
`requested_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`required_on_site_date`	date
`resource`	integer
`save_to_personal_library`	boolean
`source`	string	* `workspace_library` - Workspace library * `personal_library` - Personal library * `job_boq` - Job BOQ * `freehand` - Freehand Options: workspace_library, personal_library, job_boq, freehand
`source_estimate_resource`	uuid
`source_estimate_work_item`	uuid
`suggested_partner`	uuid
`unit`	uuid
`unit_of_measure`	string

Responses

200 — Success

Field	Type	Details
`batch` *	uuid
`batch_summary`	JSON	Computed JSON value; may be null when access is restricted.
`boq_item`	uuid
`converted_order` *	uuid
`converted_order_line` *	uuid
`cost_code`	integer
`created_at` *	date-time
`delivery_instructions`	string
`description` *	string
`estimate_location`	uuid	Optional plot this line is tagged to.
`estimated_unit_rate`	decimal
`id` *	uuid
`is_pending_coding`	boolean
`lead_in_days`	integer
`lead_in_warning`	JSON	Computed JSON value; may be null when access is restricted.
`location`	uuid
`note`	string
`order_type`	string	* `material` - Material * `plant` - Plant * `subcontract` - Subcontract * `professional` - Professional services Options: material, plant, subcontract, professional
`priority`	string	* `normal` - Normal * `high` - High Options: normal, high
`progress`	JSON	Computed JSON value; may be null when access is restricted.
`project` *	uuid
`project_name` *	string
`quantity_needed`	decimal
`rejection_reason` *	string
`requested_by` *	uuid
`requested_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`required_on_site_date`	date
`resource`	integer
`resource_name`	string
`source`	string	* `workspace_library` - Workspace library * `personal_library` - Personal library * `job_boq` - Job BOQ * `freehand` - Freehand Options: workspace_library, personal_library, job_boq, freehand
`source_estimate_resource`	uuid
`source_estimate_work_item`	uuid
`source_snapshot` *	JSON
`status` *	string	* `needed` - Needed * `requested` - Requested * `converted` - Converted * `rejected` - Rejected Options: needed, requested, converted, rejected
`suggested_partner`	uuid
`unit`	uuid
`unit_of_measure`	string
`updated_at` *	date-time
`version` *	integer

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/purchase-orders/

Required scopes and service-account permissions: orders:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Block purchase order / procurement API when the workspace module is disabled.

Parameters

Name	Location	Details
`ordering`	query	Which field to use when ordering the results.
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`project_id` *	path	uuid
`search`	query	A search term.
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	PurchaseOrder[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/purchase-orders/

Required scopes and service-account permissions: orders:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Block purchase order / procurement API when the workspace module is disabled.

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`approval`	JSON	Computed JSON value; may be null when access is restricted.
`approved_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`cis_applies`	boolean
`cis_deduction_rate`	decimal
`created_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`delivery_address`	string	Required for material orders using site delivery (the default fulfilment method).
`delivery_instructions`	string
`description`	string
`fulfillment_method`	string	* `site_delivery` - Site delivery * `store_pickup` - Store pickup Options: site_delivery, store_pickup
`gross_amount`	string or number or object
`hire_calendar_override`	JSON
`last_return_note`	JSON	Computed JSON value; may be null when access is restricted.
`lien_waiver_required`	boolean
`line_items`	PurchaseOrderLineItemRequest[]
`needs_approval_for_current_user`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_amount`	string or number or object
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string
`off_hire_date`	date
`off_hire_reference`	string
`on_hire_date`	date
`order_type`	string	* `material` - Material * `plant` - Plant * `subcontract` - Subcontract * `professional` - Professional services * `store_collection` - Store collection Options: material, plant, subcontract, professional, store_collection
`parent_order_id`	uuid
`partner_id`	uuid
`payment_terms`	string
`pickup_paid_out_of_pocket`	boolean	Whether the store collection was paid personally or by company card.
`portal_actions`	JSON	Computed JSON value; may be null when access is restricted.
`requested_approver`	uuid
`required_by_date`	date	Required for material orders using site delivery (the default fulfilment method).
`returns`	JSON	Computed JSON value; may be null when access is restricted.
`source`	string	* `office` - Office * `material_request` - Material request * `pickup` - Pick-up order Options: office, material_request, pickup
`supplier_quote_ref`	string
`tax_amount`	string or number or object
`tax_exempt`	boolean
`tax_treatment`	string	* `standard` - Standard * `reverse_charge` - Domestic reverse charge * `zero` - Zero rated * `reduced` - Reduced rated * `exempt` - Exempt * `use_tax` - Use tax Options: standard, reverse_charge, zero, reduced, exempt, use_tax
`ticket_file_ids`	uuid[]
`ticket_files`	JSON	Computed JSON value; may be null when access is restricted.
`vendor_name` *	string

Responses

201 — Success

Field	Type	Details
`approval`	JSON	Computed JSON value; may be null when access is restricted.
`approved_at` *	date-time
`approved_by` *	uuid
`approved_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`cis_applies`	boolean
`cis_deduction_rate`	decimal
`created_at` *	date-time
`created_by` *	uuid
`created_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`delivery_address`	string	Required for material orders using site delivery (the default fulfilment method).
`delivery_instructions`	string
`description`	string
`fulfillment_method`	string	* `site_delivery` - Site delivery * `store_pickup` - Store pickup Options: site_delivery, store_pickup
`gross_amount`	object
`hire_calendar_override`	JSON
`id` *	uuid
`last_return_note`	JSON	Computed JSON value; may be null when access is restricted.
`lien_waiver_required`	boolean
`line_items`	PurchaseOrderLineItem[]
`needs_approval_for_current_user`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_amount`	object
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string
`off_hire_date`	date
`off_hire_reference`	string
`on_hire_date`	date
`order_number` *	string
`order_type`	string	* `material` - Material * `plant` - Plant * `subcontract` - Subcontract * `professional` - Professional services * `store_collection` - Store collection Options: material, plant, subcontract, professional, store_collection
`parent_order_id`	uuid
`partner` *	PurchaseOrderPartner
`partner_id`	uuid
`payment_terms`	string
`pickup_collected` *	boolean	Goods physically collected (may still await approval).
`pickup_collected_at` *	date-time
`pickup_paid_out_of_pocket`	boolean	Whether the store collection was paid personally or by company card.
`portal_actions`	JSON	Computed JSON value; may be null when access is restricted.
`project` *	uuid
`project_name` *	string
`project_number` *	string
`requested_approver`	uuid
`required_by_date`	date	Required for material orders using site delivery (the default fulfilment method).
`returns`	JSON	Computed JSON value; may be null when access is restricted.
`revision_number` *	integer
`sent_at` *	date-time
`source`	string	* `office` - Office * `material_request` - Material request * `pickup` - Pick-up order Options: office, material_request, pickup
`status` *	string	* `draft` - Draft * `pending_approval` - Pending Approval * `approved` - Approved * `sent` - Sent * `amendment_pending` - Amendment Pending * `partially_received` - Partially Received * `received` - Received * `closed` - Closed * `cancelled` - Cancelled Options: draft, pending_approval, approved, sent, amendment_pending, partially_received, received, closed, cancelled
`submitted_at` *	date-time
`supplier_quote_ref`	string
`tax_amount`	object
`tax_exempt`	boolean
`tax_treatment`	string	* `standard` - Standard * `reverse_charge` - Domestic reverse charge * `zero` - Zero rated * `reduced` - Reduced rated * `exempt` - Exempt * `use_tax` - Use tax Options: standard, reverse_charge, zero, reduced, exempt, use_tax
`ticket_file_ids`	uuid[]
`ticket_files`	JSON	Computed JSON value; may be null when access is restricted.
`updated_at` *	date-time
`vendor_name` *	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/projects/{project_id}/purchase-orders/{id}/

Required scopes and service-account permissions: orders:manage, orders:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Block purchase order / procurement API when the workspace module is disabled.

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/purchase-orders/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`approval`	JSON	Computed JSON value; may be null when access is restricted.
`approved_at` *	date-time
`approved_by` *	uuid
`approved_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`cis_applies`	boolean
`cis_deduction_rate`	decimal
`created_at` *	date-time
`created_by` *	uuid
`created_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`delivery_address`	string	Required for material orders using site delivery (the default fulfilment method).
`delivery_instructions`	string
`description`	string
`fulfillment_method`	string	* `site_delivery` - Site delivery * `store_pickup` - Store pickup Options: site_delivery, store_pickup
`gross_amount`	object
`hire_calendar_override`	JSON
`id` *	uuid
`last_return_note`	JSON	Computed JSON value; may be null when access is restricted.
`lien_waiver_required`	boolean
`line_items`	PurchaseOrderLineItem[]
`needs_approval_for_current_user`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_amount`	object
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string
`off_hire_date`	date
`off_hire_reference`	string
`on_hire_date`	date
`order_number` *	string
`order_type`	string	* `material` - Material * `plant` - Plant * `subcontract` - Subcontract * `professional` - Professional services * `store_collection` - Store collection Options: material, plant, subcontract, professional, store_collection
`parent_order_id`	uuid
`partner` *	PurchaseOrderPartner
`partner_id`	uuid
`payment_terms`	string
`pickup_collected` *	boolean	Goods physically collected (may still await approval).
`pickup_collected_at` *	date-time
`pickup_paid_out_of_pocket`	boolean	Whether the store collection was paid personally or by company card.
`portal_actions`	JSON	Computed JSON value; may be null when access is restricted.
`project` *	uuid
`project_name` *	string
`project_number` *	string
`requested_approver`	uuid
`required_by_date`	date	Required for material orders using site delivery (the default fulfilment method).
`returns`	JSON	Computed JSON value; may be null when access is restricted.
`revision_number` *	integer
`sent_at` *	date-time
`source`	string	* `office` - Office * `material_request` - Material request * `pickup` - Pick-up order Options: office, material_request, pickup
`status` *	string	* `draft` - Draft * `pending_approval` - Pending Approval * `approved` - Approved * `sent` - Sent * `amendment_pending` - Amendment Pending * `partially_received` - Partially Received * `received` - Received * `closed` - Closed * `cancelled` - Cancelled Options: draft, pending_approval, approved, sent, amendment_pending, partially_received, received, closed, cancelled
`submitted_at` *	date-time
`supplier_quote_ref`	string
`tax_amount`	object
`tax_exempt`	boolean
`tax_treatment`	string	* `standard` - Standard * `reverse_charge` - Domestic reverse charge * `zero` - Zero rated * `reduced` - Reduced rated * `exempt` - Exempt * `use_tax` - Use tax Options: standard, reverse_charge, zero, reduced, exempt, use_tax
`ticket_file_ids`	uuid[]
`ticket_files`	JSON	Computed JSON value; may be null when access is restricted.
`updated_at` *	date-time
`vendor_name` *	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/projects/{project_id}/purchase-orders/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`approval`	JSON	Computed JSON value; may be null when access is restricted.
`approved_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`cis_applies`	boolean
`cis_deduction_rate`	decimal
`created_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`delivery_address`	string	Required for material orders using site delivery (the default fulfilment method).
`delivery_instructions`	string
`description`	string
`fulfillment_method`	string	* `site_delivery` - Site delivery * `store_pickup` - Store pickup Options: site_delivery, store_pickup
`gross_amount`	string or number or object
`hire_calendar_override`	JSON
`last_return_note`	JSON	Computed JSON value; may be null when access is restricted.
`lien_waiver_required`	boolean
`line_items`	PurchaseOrderLineItemRequest[]
`needs_approval_for_current_user`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_amount`	string or number or object
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string
`off_hire_date`	date
`off_hire_reference`	string
`on_hire_date`	date
`order_type`	string	* `material` - Material * `plant` - Plant * `subcontract` - Subcontract * `professional` - Professional services * `store_collection` - Store collection Options: material, plant, subcontract, professional, store_collection
`parent_order_id`	uuid
`partner_id`	uuid
`payment_terms`	string
`pickup_paid_out_of_pocket`	boolean	Whether the store collection was paid personally or by company card.
`portal_actions`	JSON	Computed JSON value; may be null when access is restricted.
`requested_approver`	uuid
`required_by_date`	date	Required for material orders using site delivery (the default fulfilment method).
`returns`	JSON	Computed JSON value; may be null when access is restricted.
`source`	string	* `office` - Office * `material_request` - Material request * `pickup` - Pick-up order Options: office, material_request, pickup
`supplier_quote_ref`	string
`tax_amount`	string or number or object
`tax_exempt`	boolean
`tax_treatment`	string	* `standard` - Standard * `reverse_charge` - Domestic reverse charge * `zero` - Zero rated * `reduced` - Reduced rated * `exempt` - Exempt * `use_tax` - Use tax Options: standard, reverse_charge, zero, reduced, exempt, use_tax
`ticket_file_ids`	uuid[]
`ticket_files`	JSON	Computed JSON value; may be null when access is restricted.
`vendor_name`	string

Responses

200 — Success

Field	Type	Details
`approval`	JSON	Computed JSON value; may be null when access is restricted.
`approved_at` *	date-time
`approved_by` *	uuid
`approved_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`cis_applies`	boolean
`cis_deduction_rate`	decimal
`created_at` *	date-time
`created_by` *	uuid
`created_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`delivery_address`	string	Required for material orders using site delivery (the default fulfilment method).
`delivery_instructions`	string
`description`	string
`fulfillment_method`	string	* `site_delivery` - Site delivery * `store_pickup` - Store pickup Options: site_delivery, store_pickup
`gross_amount`	object
`hire_calendar_override`	JSON
`id` *	uuid
`last_return_note`	JSON	Computed JSON value; may be null when access is restricted.
`lien_waiver_required`	boolean
`line_items`	PurchaseOrderLineItem[]
`needs_approval_for_current_user`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_amount`	object
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string
`off_hire_date`	date
`off_hire_reference`	string
`on_hire_date`	date
`order_number` *	string
`order_type`	string	* `material` - Material * `plant` - Plant * `subcontract` - Subcontract * `professional` - Professional services * `store_collection` - Store collection Options: material, plant, subcontract, professional, store_collection
`parent_order_id`	uuid
`partner` *	PurchaseOrderPartner
`partner_id`	uuid
`payment_terms`	string
`pickup_collected` *	boolean	Goods physically collected (may still await approval).
`pickup_collected_at` *	date-time
`pickup_paid_out_of_pocket`	boolean	Whether the store collection was paid personally or by company card.
`portal_actions`	JSON	Computed JSON value; may be null when access is restricted.
`project` *	uuid
`project_name` *	string
`project_number` *	string
`requested_approver`	uuid
`required_by_date`	date	Required for material orders using site delivery (the default fulfilment method).
`returns`	JSON	Computed JSON value; may be null when access is restricted.
`revision_number` *	integer
`sent_at` *	date-time
`source`	string	* `office` - Office * `material_request` - Material request * `pickup` - Pick-up order Options: office, material_request, pickup
`status` *	string	* `draft` - Draft * `pending_approval` - Pending Approval * `approved` - Approved * `sent` - Sent * `amendment_pending` - Amendment Pending * `partially_received` - Partially Received * `received` - Received * `closed` - Closed * `cancelled` - Cancelled Options: draft, pending_approval, approved, sent, amendment_pending, partially_received, received, closed, cancelled
`submitted_at` *	date-time
`supplier_quote_ref`	string
`tax_amount`	object
`tax_exempt`	boolean
`tax_treatment`	string	* `standard` - Standard * `reverse_charge` - Domestic reverse charge * `zero` - Zero rated * `reduced` - Reduced rated * `exempt` - Exempt * `use_tax` - Use tax Options: standard, reverse_charge, zero, reduced, exempt, use_tax
`ticket_file_ids`	uuid[]
`ticket_files`	JSON	Computed JSON value; may be null when access is restricted.
`updated_at` *	date-time
`vendor_name` *	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/purchase-orders/{id}/approve/

Required scopes and service-account permissions: orders:approve, orders:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Block purchase order / procurement API when the workspace module is disabled.

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`note`	string

Responses

200 — Success

Field	Type	Details
`approval`	JSON	Computed JSON value; may be null when access is restricted.
`approved_at` *	date-time
`approved_by` *	uuid
`approved_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`cis_applies`	boolean
`cis_deduction_rate`	decimal
`created_at` *	date-time
`created_by` *	uuid
`created_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`delivery_address`	string	Required for material orders using site delivery (the default fulfilment method).
`delivery_instructions`	string
`description`	string
`fulfillment_method`	string	* `site_delivery` - Site delivery * `store_pickup` - Store pickup Options: site_delivery, store_pickup
`gross_amount`	object
`hire_calendar_override`	JSON
`id` *	uuid
`last_return_note`	JSON	Computed JSON value; may be null when access is restricted.
`lien_waiver_required`	boolean
`line_items`	PurchaseOrderLineItem[]
`needs_approval_for_current_user`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_amount`	object
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string
`off_hire_date`	date
`off_hire_reference`	string
`on_hire_date`	date
`order_number` *	string
`order_type`	string	* `material` - Material * `plant` - Plant * `subcontract` - Subcontract * `professional` - Professional services * `store_collection` - Store collection Options: material, plant, subcontract, professional, store_collection
`parent_order_id`	uuid
`partner` *	PurchaseOrderPartner
`partner_id`	uuid
`payment_terms`	string
`pickup_collected` *	boolean	Goods physically collected (may still await approval).
`pickup_collected_at` *	date-time
`pickup_paid_out_of_pocket`	boolean	Whether the store collection was paid personally or by company card.
`portal_actions`	JSON	Computed JSON value; may be null when access is restricted.
`project` *	uuid
`project_name` *	string
`project_number` *	string
`requested_approver`	uuid
`required_by_date`	date	Required for material orders using site delivery (the default fulfilment method).
`returns`	JSON	Computed JSON value; may be null when access is restricted.
`revision_number` *	integer
`sent_at` *	date-time
`source`	string	* `office` - Office * `material_request` - Material request * `pickup` - Pick-up order Options: office, material_request, pickup
`status` *	string	* `draft` - Draft * `pending_approval` - Pending Approval * `approved` - Approved * `sent` - Sent * `amendment_pending` - Amendment Pending * `partially_received` - Partially Received * `received` - Received * `closed` - Closed * `cancelled` - Cancelled Options: draft, pending_approval, approved, sent, amendment_pending, partially_received, received, closed, cancelled
`submitted_at` *	date-time
`supplier_quote_ref`	string
`tax_amount`	object
`tax_exempt`	boolean
`tax_treatment`	string	* `standard` - Standard * `reverse_charge` - Domestic reverse charge * `zero` - Zero rated * `reduced` - Reduced rated * `exempt` - Exempt * `use_tax` - Use tax Options: standard, reverse_charge, zero, reduced, exempt, use_tax
`ticket_file_ids`	uuid[]
`ticket_files`	JSON	Computed JSON value; may be null when access is restricted.
`updated_at` *	date-time
`vendor_name` *	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/purchase-orders/{id}/cancel/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`note`	string

Responses

200 — Success

Field	Type	Details
`approval`	JSON	Computed JSON value; may be null when access is restricted.
`approved_at` *	date-time
`approved_by` *	uuid
`approved_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`cis_applies`	boolean
`cis_deduction_rate`	decimal
`created_at` *	date-time
`created_by` *	uuid
`created_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`delivery_address`	string	Required for material orders using site delivery (the default fulfilment method).
`delivery_instructions`	string
`description`	string
`fulfillment_method`	string	* `site_delivery` - Site delivery * `store_pickup` - Store pickup Options: site_delivery, store_pickup
`gross_amount`	object
`hire_calendar_override`	JSON
`id` *	uuid
`last_return_note`	JSON	Computed JSON value; may be null when access is restricted.
`lien_waiver_required`	boolean
`line_items`	PurchaseOrderLineItem[]
`needs_approval_for_current_user`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_amount`	object
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string
`off_hire_date`	date
`off_hire_reference`	string
`on_hire_date`	date
`order_number` *	string
`order_type`	string	* `material` - Material * `plant` - Plant * `subcontract` - Subcontract * `professional` - Professional services * `store_collection` - Store collection Options: material, plant, subcontract, professional, store_collection
`parent_order_id`	uuid
`partner` *	PurchaseOrderPartner
`partner_id`	uuid
`payment_terms`	string
`pickup_collected` *	boolean	Goods physically collected (may still await approval).
`pickup_collected_at` *	date-time
`pickup_paid_out_of_pocket`	boolean	Whether the store collection was paid personally or by company card.
`portal_actions`	JSON	Computed JSON value; may be null when access is restricted.
`project` *	uuid
`project_name` *	string
`project_number` *	string
`requested_approver`	uuid
`required_by_date`	date	Required for material orders using site delivery (the default fulfilment method).
`returns`	JSON	Computed JSON value; may be null when access is restricted.
`revision_number` *	integer
`sent_at` *	date-time
`source`	string	* `office` - Office * `material_request` - Material request * `pickup` - Pick-up order Options: office, material_request, pickup
`status` *	string	* `draft` - Draft * `pending_approval` - Pending Approval * `approved` - Approved * `sent` - Sent * `amendment_pending` - Amendment Pending * `partially_received` - Partially Received * `received` - Received * `closed` - Closed * `cancelled` - Cancelled Options: draft, pending_approval, approved, sent, amendment_pending, partially_received, received, closed, cancelled
`submitted_at` *	date-time
`supplier_quote_ref`	string
`tax_amount`	object
`tax_exempt`	boolean
`tax_treatment`	string	* `standard` - Standard * `reverse_charge` - Domestic reverse charge * `zero` - Zero rated * `reduced` - Reduced rated * `exempt` - Exempt * `use_tax` - Use tax Options: standard, reverse_charge, zero, reduced, exempt, use_tax
`ticket_file_ids`	uuid[]
`ticket_files`	JSON	Computed JSON value; may be null when access is restricted.
`updated_at` *	date-time
`vendor_name` *	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/purchase-orders/{id}/reject/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`note`	string

Responses

200 — Success

Field	Type	Details
`approval`	JSON	Computed JSON value; may be null when access is restricted.
`approved_at` *	date-time
`approved_by` *	uuid
`approved_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`cis_applies`	boolean
`cis_deduction_rate`	decimal
`created_at` *	date-time
`created_by` *	uuid
`created_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`delivery_address`	string	Required for material orders using site delivery (the default fulfilment method).
`delivery_instructions`	string
`description`	string
`fulfillment_method`	string	* `site_delivery` - Site delivery * `store_pickup` - Store pickup Options: site_delivery, store_pickup
`gross_amount`	object
`hire_calendar_override`	JSON
`id` *	uuid
`last_return_note`	JSON	Computed JSON value; may be null when access is restricted.
`lien_waiver_required`	boolean
`line_items`	PurchaseOrderLineItem[]
`needs_approval_for_current_user`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_amount`	object
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string
`off_hire_date`	date
`off_hire_reference`	string
`on_hire_date`	date
`order_number` *	string
`order_type`	string	* `material` - Material * `plant` - Plant * `subcontract` - Subcontract * `professional` - Professional services * `store_collection` - Store collection Options: material, plant, subcontract, professional, store_collection
`parent_order_id`	uuid
`partner` *	PurchaseOrderPartner
`partner_id`	uuid
`payment_terms`	string
`pickup_collected` *	boolean	Goods physically collected (may still await approval).
`pickup_collected_at` *	date-time
`pickup_paid_out_of_pocket`	boolean	Whether the store collection was paid personally or by company card.
`portal_actions`	JSON	Computed JSON value; may be null when access is restricted.
`project` *	uuid
`project_name` *	string
`project_number` *	string
`requested_approver`	uuid
`required_by_date`	date	Required for material orders using site delivery (the default fulfilment method).
`returns`	JSON	Computed JSON value; may be null when access is restricted.
`revision_number` *	integer
`sent_at` *	date-time
`source`	string	* `office` - Office * `material_request` - Material request * `pickup` - Pick-up order Options: office, material_request, pickup
`status` *	string	* `draft` - Draft * `pending_approval` - Pending Approval * `approved` - Approved * `sent` - Sent * `amendment_pending` - Amendment Pending * `partially_received` - Partially Received * `received` - Received * `closed` - Closed * `cancelled` - Cancelled Options: draft, pending_approval, approved, sent, amendment_pending, partially_received, received, closed, cancelled
`submitted_at` *	date-time
`supplier_quote_ref`	string
`tax_amount`	object
`tax_exempt`	boolean
`tax_treatment`	string	* `standard` - Standard * `reverse_charge` - Domestic reverse charge * `zero` - Zero rated * `reduced` - Reduced rated * `exempt` - Exempt * `use_tax` - Use tax Options: standard, reverse_charge, zero, reduced, exempt, use_tax
`ticket_file_ids`	uuid[]
`ticket_files`	JSON	Computed JSON value; may be null when access is restricted.
`updated_at` *	date-time
`vendor_name` *	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/purchase-orders/{id}/send/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`requested_approver`	uuid

Responses

200 — Success

Field	Type	Details
`approval`	JSON	Computed JSON value; may be null when access is restricted.
`approved_at` *	date-time
`approved_by` *	uuid
`approved_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`cis_applies`	boolean
`cis_deduction_rate`	decimal
`created_at` *	date-time
`created_by` *	uuid
`created_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`delivery_address`	string	Required for material orders using site delivery (the default fulfilment method).
`delivery_instructions`	string
`description`	string
`fulfillment_method`	string	* `site_delivery` - Site delivery * `store_pickup` - Store pickup Options: site_delivery, store_pickup
`gross_amount`	object
`hire_calendar_override`	JSON
`id` *	uuid
`last_return_note`	JSON	Computed JSON value; may be null when access is restricted.
`lien_waiver_required`	boolean
`line_items`	PurchaseOrderLineItem[]
`needs_approval_for_current_user`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_amount`	object
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string
`off_hire_date`	date
`off_hire_reference`	string
`on_hire_date`	date
`order_number` *	string
`order_type`	string	* `material` - Material * `plant` - Plant * `subcontract` - Subcontract * `professional` - Professional services * `store_collection` - Store collection Options: material, plant, subcontract, professional, store_collection
`parent_order_id`	uuid
`partner` *	PurchaseOrderPartner
`partner_id`	uuid
`payment_terms`	string
`pickup_collected` *	boolean	Goods physically collected (may still await approval).
`pickup_collected_at` *	date-time
`pickup_paid_out_of_pocket`	boolean	Whether the store collection was paid personally or by company card.
`portal_actions`	JSON	Computed JSON value; may be null when access is restricted.
`project` *	uuid
`project_name` *	string
`project_number` *	string
`requested_approver`	uuid
`required_by_date`	date	Required for material orders using site delivery (the default fulfilment method).
`returns`	JSON	Computed JSON value; may be null when access is restricted.
`revision_number` *	integer
`sent_at` *	date-time
`source`	string	* `office` - Office * `material_request` - Material request * `pickup` - Pick-up order Options: office, material_request, pickup
`status` *	string	* `draft` - Draft * `pending_approval` - Pending Approval * `approved` - Approved * `sent` - Sent * `amendment_pending` - Amendment Pending * `partially_received` - Partially Received * `received` - Received * `closed` - Closed * `cancelled` - Cancelled Options: draft, pending_approval, approved, sent, amendment_pending, partially_received, received, closed, cancelled
`submitted_at` *	date-time
`supplier_quote_ref`	string
`tax_amount`	object
`tax_exempt`	boolean
`tax_treatment`	string	* `standard` - Standard * `reverse_charge` - Domestic reverse charge * `zero` - Zero rated * `reduced` - Reduced rated * `exempt` - Exempt * `use_tax` - Use tax Options: standard, reverse_charge, zero, reduced, exempt, use_tax
`ticket_file_ids`	uuid[]
`ticket_files`	JSON	Computed JSON value; may be null when access is restricted.
`updated_at` *	date-time
`vendor_name` *	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/

Required scopes and service-account permissions: projects:read, quotes:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. GET /projects/<project_pk>/quotes/?document_type=quote|estimate|variation&status=... POST /projects/<project_pk>/quotes/ (create new quote/estimate/variation)

Parameters

Name	Location	Details
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	Quote[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/

Required scopes and service-account permissions: projects:write, quotes:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. GET /projects/<project_pk>/quotes/?document_type=quote|estimate|variation&status=... POST /projects/<project_pk>/quotes/ (create new quote/estimate/variation)

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`assumption_items`	JSON	Structured assumption/exclusion items with optional client ack flags.
`assumptions`	string	Assumptions made for this quote.
`attached_files`	uuid[]
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`base_quote`	JSON	Computed JSON value; may be null when access is restricted.
`brief_snapshot_id`	uuid
`document_type`	string	* `quote` - Quotation * `estimate` - Estimate * `variation` - Variation Options: quote, estimate, variation
`estimate_id`	JSON	Computed JSON value; may be null when access is restricted.
`is_main_quote`	boolean	Exactly one quote per project may be marked main; baseline for final account / linked flows.
`last_updated_at`	JSON	Computed JSON value; may be null when access is restricted.
`latest_variation_id`	JSON	Computed JSON value; may be null when access is restricted.
`linked_invoice_count`	JSON	Computed JSON value; may be null when access is restricted.
`linked_quote`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string	Private notes for the builder.
`pricing_mode`	string	* `quick` - Quick quote * `estimate` - Linked estimate * `external` - External contract Options: quick, estimate, external
`primary_estimate`	uuid
`primary_estimate_quote_id`	JSON	Computed JSON value; may be null when access is restricted.
`project_address`	JSON	Computed JSON value; may be null when access is restricted.
`revised_total`	JSON	Computed JSON value; may be null when access is restricted.
`source_change_request_id`	JSON	Computed JSON value; may be null when access is restricted.
`source_change_request_register_number`	JSON	Computed JSON value; may be null when access is restricted.
`source_change_request_title`	JSON	Computed JSON value; may be null when access is restricted.
`subtotal`	JSON	Computed JSON value; may be null when access is restricted.
`tax_amount`	JSON	Computed JSON value; may be null when access is restricted.
`tax_breakdown`	JSON	Computed JSON value; may be null when access is restricted.
`tax_name`	string	The name of the tax applied (VAT, Sales Tax, ...).
`tax_rate`	decimal	The tax rate (e.g., 20.00 for 20%). Null means 'not explicitly set' and falls back to the workspace default; 0 means explicitly tax-exempt.
`template_id`	uuid
`terms_and_conditions`	string	Client-facing terms and conditions.
`title`	string	'Quotation for Kitchen Renovation'
`total`	JSON	Computed JSON value; may be null when access is restricted.
`variation_count`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_business_address`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_currency`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_daywork_defaults`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_market_code`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_tax_label`	JSON	Computed JSON value; may be null when access is restricted.

Responses

201 — Success

Field	Type	Details
`actioned_by_ip_address` *	string	IP address of the user who approved/rejected the request.
`approval_method` *	string	How the request was actioned, e.g., 'in_app', 'email_link'.
`approved_at` *	date-time
`assumption_items`	JSON	Structured assumption/exclusion items with optional client ack flags.
`assumptions`	string	Assumptions made for this quote.
`attached_files`	uuid[]
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`base_quote`	JSON	Computed JSON value; may be null when access is restricted.
`brief_snapshot_id`	uuid
`client_action_note` *	string	Note added by the client when they approved or rejected.
`created_at` *	date-time
`created_by` *	uuid
`customer_name`	string
`delivery_status` *	string
`document_type`	string	* `quote` - Quotation * `estimate` - Estimate * `variation` - Variation Options: quote, estimate, variation
`estimate_approved_at` *	date-time
`estimate_id`	JSON	Computed JSON value; may be null when access is restricted.
`estimate_is_approved` *	boolean
`estimate_last_synced_at` *	date-time
`estimate_source_quote_version` *	integer
`id` *	uuid
`is_main_quote`	boolean	Exactly one quote per project may be marked main; baseline for final account / linked flows.
`last_updated_at`	JSON	Computed JSON value; may be null when access is restricted.
`latest_variation_id`	JSON	Computed JSON value; may be null when access is restricted.
`linked_invoice_count`	JSON	Computed JSON value; may be null when access is restricted.
`linked_quote`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string	Private notes for the builder.
`pricing_mode`	string	* `quick` - Quick quote * `estimate` - Linked estimate * `external` - External contract Options: quick, estimate, external
`primary_estimate`	uuid
`primary_estimate_quote_id`	JSON	Computed JSON value; may be null when access is restricted.
`project` *	uuid
`project_address`	JSON	Computed JSON value; may be null when access is restricted.
`project_id` *	uuid
`project_name` *	string
`quote_number` *	string	Workspace-unique quote number (e.g., QUO-001).
`rejected_at` *	date-time
`revised_total`	JSON	Computed JSON value; may be null when access is restricted.
`sent_at` *	date-time
`source_change_request_id`	JSON	Computed JSON value; may be null when access is restricted.
`source_change_request_register_number`	JSON	Computed JSON value; may be null when access is restricted.
`source_change_request_title`	JSON	Computed JSON value; may be null when access is restricted.
`status` *	string	* `draft` - Draft * `sent` - Sent * `approved` - Approved * `rejected` - Rejected * `superseded` - Superseded * `locked` - Locked (linked to quote) * `archived` - Archived Options: draft, sent, approved, rejected, superseded, locked, archived
`subtotal`	JSON	Computed JSON value; may be null when access is restricted.
`tax_amount`	JSON	Computed JSON value; may be null when access is restricted.
`tax_breakdown`	JSON	Computed JSON value; may be null when access is restricted.
`tax_name`	string	The name of the tax applied (VAT, Sales Tax, ...).
`tax_rate`	decimal	The tax rate (e.g., 20.00 for 20%). Null means 'not explicitly set' and falls back to the workspace default; 0 means explicitly tax-exempt.
`terms_and_conditions`	string	Client-facing terms and conditions.
`title`	string	'Quotation for Kitchen Renovation'
`total`	JSON	Computed JSON value; may be null when access is restricted.
`updated_at` *	date-time
`variation_count`	JSON	Computed JSON value; may be null when access is restricted.
`version` *	integer	Highest version number in QuoteVersion for this series.
`workspace_business_address`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_company_name` *	string
`workspace_currency`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_daywork_defaults`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_default_tax_rate` *	decimal
`workspace_default_terms` *	string
`workspace_language` *	string
`workspace_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_market_code`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_name` *	string
`workspace_tax_id` *	string
`workspace_tax_label`	JSON	Computed JSON value; may be null when access is restricted.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{id}/

Required scopes and service-account permissions: quotes:manage, quotes:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Reusable security logic for any Workspace-scoped resource.

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{id}/

Required scopes and service-account permissions: quotes:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Reusable security logic for any Workspace-scoped resource.

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`actioned_by_ip_address` *	string	IP address of the user who approved/rejected the request.
`approval_method` *	string	How the request was actioned, e.g., 'in_app', 'email_link'.
`approved_at` *	date-time
`assumption_items`	JSON	Structured assumption/exclusion items with optional client ack flags.
`assumptions`	string	Assumptions made for this quote.
`attached_files`	uuid[]
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`base_quote`	JSON	Computed JSON value; may be null when access is restricted.
`brief_snapshot_id`	uuid
`client_action_note` *	string	Note added by the client when they approved or rejected.
`created_at` *	date-time
`created_by` *	uuid
`customer_name`	string
`delivery_status` *	string
`document_type`	string	* `quote` - Quotation * `estimate` - Estimate * `variation` - Variation Options: quote, estimate, variation
`estimate_approved_at` *	date-time
`estimate_id`	JSON	Computed JSON value; may be null when access is restricted.
`estimate_is_approved` *	boolean
`estimate_last_synced_at` *	date-time
`estimate_source_quote_version` *	integer
`id` *	uuid
`is_main_quote`	boolean	Exactly one quote per project may be marked main; baseline for final account / linked flows.
`last_updated_at`	JSON	Computed JSON value; may be null when access is restricted.
`latest_variation_id`	JSON	Computed JSON value; may be null when access is restricted.
`linked_invoice_count`	JSON	Computed JSON value; may be null when access is restricted.
`linked_quote`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string	Private notes for the builder.
`pricing_mode`	string	* `quick` - Quick quote * `estimate` - Linked estimate * `external` - External contract Options: quick, estimate, external
`primary_estimate`	uuid
`primary_estimate_quote_id`	JSON	Computed JSON value; may be null when access is restricted.
`project` *	uuid
`project_address`	JSON	Computed JSON value; may be null when access is restricted.
`project_id` *	uuid
`project_name` *	string
`quote_number` *	string	Workspace-unique quote number (e.g., QUO-001).
`rejected_at` *	date-time
`revised_total`	JSON	Computed JSON value; may be null when access is restricted.
`sent_at` *	date-time
`source_change_request_id`	JSON	Computed JSON value; may be null when access is restricted.
`source_change_request_register_number`	JSON	Computed JSON value; may be null when access is restricted.
`source_change_request_title`	JSON	Computed JSON value; may be null when access is restricted.
`status` *	string	* `draft` - Draft * `sent` - Sent * `approved` - Approved * `rejected` - Rejected * `superseded` - Superseded * `locked` - Locked (linked to quote) * `archived` - Archived Options: draft, sent, approved, rejected, superseded, locked, archived
`subtotal`	JSON	Computed JSON value; may be null when access is restricted.
`tax_amount`	JSON	Computed JSON value; may be null when access is restricted.
`tax_breakdown`	JSON	Computed JSON value; may be null when access is restricted.
`tax_name`	string	The name of the tax applied (VAT, Sales Tax, ...).
`tax_rate`	decimal	The tax rate (e.g., 20.00 for 20%). Null means 'not explicitly set' and falls back to the workspace default; 0 means explicitly tax-exempt.
`terms_and_conditions`	string	Client-facing terms and conditions.
`title`	string	'Quotation for Kitchen Renovation'
`total`	JSON	Computed JSON value; may be null when access is restricted.
`updated_at` *	date-time
`variation_count`	JSON	Computed JSON value; may be null when access is restricted.
`version` *	integer	Highest version number in QuoteVersion for this series.
`workspace_business_address`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_company_name` *	string
`workspace_currency`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_daywork_defaults`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_default_tax_rate` *	decimal
`workspace_default_terms` *	string
`workspace_language` *	string
`workspace_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_market_code`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_name` *	string
`workspace_tax_id` *	string
`workspace_tax_label`	JSON	Computed JSON value; may be null when access is restricted.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{id}/

Required scopes and service-account permissions: quotes:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Reusable security logic for any Workspace-scoped resource.

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`assumption_items`	JSON	Structured assumption/exclusion items with optional client ack flags.
`assumptions`	string	Assumptions made for this quote.
`attached_files`	uuid[]
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`base_quote`	JSON	Computed JSON value; may be null when access is restricted.
`brief_snapshot_id`	uuid
`document_type`	string	* `quote` - Quotation * `estimate` - Estimate * `variation` - Variation Options: quote, estimate, variation
`estimate_id`	JSON	Computed JSON value; may be null when access is restricted.
`is_main_quote`	boolean	Exactly one quote per project may be marked main; baseline for final account / linked flows.
`last_updated_at`	JSON	Computed JSON value; may be null when access is restricted.
`latest_variation_id`	JSON	Computed JSON value; may be null when access is restricted.
`linked_invoice_count`	JSON	Computed JSON value; may be null when access is restricted.
`linked_quote`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string	Private notes for the builder.
`pricing_mode`	string	* `quick` - Quick quote * `estimate` - Linked estimate * `external` - External contract Options: quick, estimate, external
`primary_estimate`	uuid
`primary_estimate_quote_id`	JSON	Computed JSON value; may be null when access is restricted.
`project_address`	JSON	Computed JSON value; may be null when access is restricted.
`revised_total`	JSON	Computed JSON value; may be null when access is restricted.
`source_change_request_id`	JSON	Computed JSON value; may be null when access is restricted.
`source_change_request_register_number`	JSON	Computed JSON value; may be null when access is restricted.
`source_change_request_title`	JSON	Computed JSON value; may be null when access is restricted.
`subtotal`	JSON	Computed JSON value; may be null when access is restricted.
`tax_amount`	JSON	Computed JSON value; may be null when access is restricted.
`tax_breakdown`	JSON	Computed JSON value; may be null when access is restricted.
`tax_name`	string	The name of the tax applied (VAT, Sales Tax, ...).
`tax_rate`	decimal	The tax rate (e.g., 20.00 for 20%). Null means 'not explicitly set' and falls back to the workspace default; 0 means explicitly tax-exempt.
`template_id`	uuid
`terms_and_conditions`	string	Client-facing terms and conditions.
`title`	string	'Quotation for Kitchen Renovation'
`total`	JSON	Computed JSON value; may be null when access is restricted.
`variation_count`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_business_address`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_currency`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_daywork_defaults`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_market_code`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_tax_label`	JSON	Computed JSON value; may be null when access is restricted.

Responses

200 — Success

Field	Type	Details
`actioned_by_ip_address` *	string	IP address of the user who approved/rejected the request.
`approval_method` *	string	How the request was actioned, e.g., 'in_app', 'email_link'.
`approved_at` *	date-time
`assumption_items`	JSON	Structured assumption/exclusion items with optional client ack flags.
`assumptions`	string	Assumptions made for this quote.
`attached_files`	uuid[]
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`base_quote`	JSON	Computed JSON value; may be null when access is restricted.
`brief_snapshot_id`	uuid
`client_action_note` *	string	Note added by the client when they approved or rejected.
`created_at` *	date-time
`created_by` *	uuid
`customer_name`	string
`delivery_status` *	string
`document_type`	string	* `quote` - Quotation * `estimate` - Estimate * `variation` - Variation Options: quote, estimate, variation
`estimate_approved_at` *	date-time
`estimate_id`	JSON	Computed JSON value; may be null when access is restricted.
`estimate_is_approved` *	boolean
`estimate_last_synced_at` *	date-time
`estimate_source_quote_version` *	integer
`id` *	uuid
`is_main_quote`	boolean	Exactly one quote per project may be marked main; baseline for final account / linked flows.
`last_updated_at`	JSON	Computed JSON value; may be null when access is restricted.
`latest_variation_id`	JSON	Computed JSON value; may be null when access is restricted.
`linked_invoice_count`	JSON	Computed JSON value; may be null when access is restricted.
`linked_quote`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string	Private notes for the builder.
`pricing_mode`	string	* `quick` - Quick quote * `estimate` - Linked estimate * `external` - External contract Options: quick, estimate, external
`primary_estimate`	uuid
`primary_estimate_quote_id`	JSON	Computed JSON value; may be null when access is restricted.
`project` *	uuid
`project_address`	JSON	Computed JSON value; may be null when access is restricted.
`project_id` *	uuid
`project_name` *	string
`quote_number` *	string	Workspace-unique quote number (e.g., QUO-001).
`rejected_at` *	date-time
`revised_total`	JSON	Computed JSON value; may be null when access is restricted.
`sent_at` *	date-time
`source_change_request_id`	JSON	Computed JSON value; may be null when access is restricted.
`source_change_request_register_number`	JSON	Computed JSON value; may be null when access is restricted.
`source_change_request_title`	JSON	Computed JSON value; may be null when access is restricted.
`status` *	string	* `draft` - Draft * `sent` - Sent * `approved` - Approved * `rejected` - Rejected * `superseded` - Superseded * `locked` - Locked (linked to quote) * `archived` - Archived Options: draft, sent, approved, rejected, superseded, locked, archived
`subtotal`	JSON	Computed JSON value; may be null when access is restricted.
`tax_amount`	JSON	Computed JSON value; may be null when access is restricted.
`tax_breakdown`	JSON	Computed JSON value; may be null when access is restricted.
`tax_name`	string	The name of the tax applied (VAT, Sales Tax, ...).
`tax_rate`	decimal	The tax rate (e.g., 20.00 for 20%). Null means 'not explicitly set' and falls back to the workspace default; 0 means explicitly tax-exempt.
`terms_and_conditions`	string	Client-facing terms and conditions.
`title`	string	'Quotation for Kitchen Renovation'
`total`	JSON	Computed JSON value; may be null when access is restricted.
`updated_at` *	date-time
`variation_count`	JSON	Computed JSON value; may be null when access is restricted.
`version` *	integer	Highest version number in QuoteVersion for this series.
`workspace_business_address`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_company_name` *	string
`workspace_currency`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_daywork_defaults`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_default_tax_rate` *	decimal
`workspace_default_terms` *	string
`workspace_language` *	string
`workspace_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_market_code`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_name` *	string
`workspace_tax_id` *	string
`workspace_tax_label`	JSON	Computed JSON value; may be null when access is restricted.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{id}/approve/

Required scopes and service-account permissions: quotes:approve, quotes:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Reusable security logic for any Workspace-scoped resource.

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`confirm_contract_setup`	boolean
`note`	string

Responses

200 — Success

Field	Type	Details
`actioned_by_ip_address` *	string	IP address of the user who approved/rejected the request.
`approval_method` *	string	How the request was actioned, e.g., 'in_app', 'email_link'.
`approved_at` *	date-time
`assumption_items`	JSON	Structured assumption/exclusion items with optional client ack flags.
`assumptions`	string	Assumptions made for this quote.
`attached_files`	uuid[]
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`base_quote`	JSON	Computed JSON value; may be null when access is restricted.
`brief_snapshot_id`	uuid
`client_action_note` *	string	Note added by the client when they approved or rejected.
`created_at` *	date-time
`created_by` *	uuid
`customer_name`	string
`delivery_status` *	string
`document_type`	string	* `quote` - Quotation * `estimate` - Estimate * `variation` - Variation Options: quote, estimate, variation
`estimate_approved_at` *	date-time
`estimate_id`	JSON	Computed JSON value; may be null when access is restricted.
`estimate_is_approved` *	boolean
`estimate_last_synced_at` *	date-time
`estimate_source_quote_version` *	integer
`id` *	uuid
`is_main_quote`	boolean	Exactly one quote per project may be marked main; baseline for final account / linked flows.
`last_updated_at`	JSON	Computed JSON value; may be null when access is restricted.
`latest_variation_id`	JSON	Computed JSON value; may be null when access is restricted.
`linked_invoice_count`	JSON	Computed JSON value; may be null when access is restricted.
`linked_quote`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string	Private notes for the builder.
`pricing_mode`	string	* `quick` - Quick quote * `estimate` - Linked estimate * `external` - External contract Options: quick, estimate, external
`primary_estimate`	uuid
`primary_estimate_quote_id`	JSON	Computed JSON value; may be null when access is restricted.
`project` *	uuid
`project_address`	JSON	Computed JSON value; may be null when access is restricted.
`project_id` *	uuid
`project_name` *	string
`quote_number` *	string	Workspace-unique quote number (e.g., QUO-001).
`rejected_at` *	date-time
`revised_total`	JSON	Computed JSON value; may be null when access is restricted.
`sent_at` *	date-time
`source_change_request_id`	JSON	Computed JSON value; may be null when access is restricted.
`source_change_request_register_number`	JSON	Computed JSON value; may be null when access is restricted.
`source_change_request_title`	JSON	Computed JSON value; may be null when access is restricted.
`status` *	string	* `draft` - Draft * `sent` - Sent * `approved` - Approved * `rejected` - Rejected * `superseded` - Superseded * `locked` - Locked (linked to quote) * `archived` - Archived Options: draft, sent, approved, rejected, superseded, locked, archived
`subtotal`	JSON	Computed JSON value; may be null when access is restricted.
`tax_amount`	JSON	Computed JSON value; may be null when access is restricted.
`tax_breakdown`	JSON	Computed JSON value; may be null when access is restricted.
`tax_name`	string	The name of the tax applied (VAT, Sales Tax, ...).
`tax_rate`	decimal	The tax rate (e.g., 20.00 for 20%). Null means 'not explicitly set' and falls back to the workspace default; 0 means explicitly tax-exempt.
`terms_and_conditions`	string	Client-facing terms and conditions.
`title`	string	'Quotation for Kitchen Renovation'
`total`	JSON	Computed JSON value; may be null when access is restricted.
`updated_at` *	date-time
`variation_count`	JSON	Computed JSON value; may be null when access is restricted.
`version` *	integer	Highest version number in QuoteVersion for this series.
`workspace_business_address`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_company_name` *	string
`workspace_currency`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_daywork_defaults`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_default_tax_rate` *	decimal
`workspace_default_terms` *	string
`workspace_language` *	string
`workspace_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_market_code`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_name` *	string
`workspace_tax_id` *	string
`workspace_tax_label`	JSON	Computed JSON value; may be null when access is restricted.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{id}/estimate/

Required scopes and service-account permissions: estimates:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Block estimate API when the workspace module is disabled.

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`adjudication_mode`	string	* `CONTRACTING` - Contracting * `HOUSEBUILDER` - Housebuilder Options: CONTRACTING, HOUSEBUILDER
`as_of_date`	date
`auth_status` *	string	* `DRAFT` - Draft * `PENDING_REVIEW` - Pending review * `AUTHORIZED` - Authorized * `REJECTED` - Rejected Options: DRAFT, PENDING_REVIEW, AUTHORIZED, REJECTED
`contingency_amount`	decimal
`created_at` *	date-time
`id` *	uuid
`is_active`	boolean
`is_primary`	boolean
`markup_labour_percent`	decimal
`markup_material_percent`	decimal
`markup_other_percent`	decimal
`markup_plant_percent`	decimal
`markup_subcontract_percent`	decimal
`notes_internal`	string
`ohp_defaults`	JSON
`partner_id`	uuid
`profit_spread_mode`	string	* `SUMMARY_LUMP_SUM` - Summary lump sum * `SPREAD_IN_RATES` - Spread in rates Options: SUMMARY_LUMP_SUM, SPREAD_IN_RATES
`programme_weeks`	integer
`project` *	uuid
`quote` *	uuid
`requested_approver` *	uuid
`submitted_by` *	uuid
`target_gdv`	decimal
`total_gifa_sq_ft`	decimal
`total_gifa_sq_m`	decimal
`updated_at` *	date-time
`version_name`	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{id}/estimate/

Required scopes and service-account permissions: estimates:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Block estimate API when the workspace module is disabled.

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`adjudication_mode`	string	* `CONTRACTING` - Contracting * `HOUSEBUILDER` - Housebuilder Options: CONTRACTING, HOUSEBUILDER
`as_of_date`	date
`contingency_amount`	decimal
`is_active`	boolean
`is_primary`	boolean
`markup_labour_percent`	decimal
`markup_material_percent`	decimal
`markup_other_percent`	decimal
`markup_plant_percent`	decimal
`markup_subcontract_percent`	decimal
`notes_internal`	string
`ohp_defaults`	JSON
`partner_id`	uuid
`profit_spread_mode`	string	* `SUMMARY_LUMP_SUM` - Summary lump sum * `SPREAD_IN_RATES` - Spread in rates Options: SUMMARY_LUMP_SUM, SPREAD_IN_RATES
`programme_weeks`	integer
`target_gdv`	decimal
`total_gifa_sq_ft`	decimal
`total_gifa_sq_m`	decimal
`version_name`	string

Responses

200 — Success

Field	Type	Details
`adjudication_mode`	string	* `CONTRACTING` - Contracting * `HOUSEBUILDER` - Housebuilder Options: CONTRACTING, HOUSEBUILDER
`as_of_date`	date
`auth_status` *	string	* `DRAFT` - Draft * `PENDING_REVIEW` - Pending review * `AUTHORIZED` - Authorized * `REJECTED` - Rejected Options: DRAFT, PENDING_REVIEW, AUTHORIZED, REJECTED
`contingency_amount`	decimal
`created_at` *	date-time
`id` *	uuid
`is_active`	boolean
`is_primary`	boolean
`markup_labour_percent`	decimal
`markup_material_percent`	decimal
`markup_other_percent`	decimal
`markup_plant_percent`	decimal
`markup_subcontract_percent`	decimal
`notes_internal`	string
`ohp_defaults`	JSON
`partner_id`	uuid
`profit_spread_mode`	string	* `SUMMARY_LUMP_SUM` - Summary lump sum * `SPREAD_IN_RATES` - Spread in rates Options: SUMMARY_LUMP_SUM, SPREAD_IN_RATES
`programme_weeks`	integer
`project` *	uuid
`quote` *	uuid
`requested_approver` *	uuid
`submitted_by` *	uuid
`target_gdv`	decimal
`total_gifa_sq_ft`	decimal
`total_gifa_sq_m`	decimal
`updated_at` *	date-time
`version_name`	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{id}/estimate/activities/

Parameters

Name	Location	Details
`id` *	path	uuid
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	EstimateActivity[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{id}/estimate/activities/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`activity_id`	integer
`description`	string
`duration_days`	integer
`group`	integer
`group_name`	string
`labour_total`	JSON	Computed JSON value; may be null when access is restricted.
`location_mode`	boolean
`material_total`	JSON	Computed JSON value; may be null when access is restricted.
`name` *	string
`other_total`	JSON	Computed JSON value; may be null when access is restricted.
`parent`	uuid
`plant_total`	JSON	Computed JSON value; may be null when access is restricted.
`set_id`	integer
`sort`	integer
`subcontract_total`	JSON	Computed JSON value; may be null when access is restricted.

Responses

201 — Success

Field	Type	Details
`activity_id`	integer
`description`	string
`duration_days`	integer
`estimate` *	uuid
`group`	integer
`group_name`	string
`id` *	uuid
`labour_total`	JSON	Computed JSON value; may be null when access is restricted.
`location_mode`	boolean
`material_total`	JSON	Computed JSON value; may be null when access is restricted.
`name` *	string
`other_total`	JSON	Computed JSON value; may be null when access is restricted.
`parent`	uuid
`plant_total`	JSON	Computed JSON value; may be null when access is restricted.
`set_id`	integer
`sort`	integer
`subcontract_total`	JSON	Computed JSON value; may be null when access is restricted.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{id}/estimate/activities/{aid}/

Required scopes and service-account permissions: estimates:manage, estimates:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Block estimate API when the workspace module is disabled.

Parameters

Name	Location	Details
`aid` *	path	uuid
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{id}/estimate/activities/{aid}/

Parameters

Name	Location	Details
`aid` *	path	uuid
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`activity_id`	integer
`description`	string
`duration_days`	integer
`estimate` *	uuid
`group`	integer
`group_name`	string
`id` *	uuid
`labour_total`	JSON	Computed JSON value; may be null when access is restricted.
`location_mode`	boolean
`material_total`	JSON	Computed JSON value; may be null when access is restricted.
`name` *	string
`other_total`	JSON	Computed JSON value; may be null when access is restricted.
`parent`	uuid
`plant_total`	JSON	Computed JSON value; may be null when access is restricted.
`set_id`	integer
`sort`	integer
`subcontract_total`	JSON	Computed JSON value; may be null when access is restricted.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{id}/estimate/activities/{aid}/

Parameters

Name	Location	Details
`aid` *	path	uuid
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`activity_id`	integer
`description`	string
`duration_days`	integer
`group`	integer
`group_name`	string
`labour_total`	JSON	Computed JSON value; may be null when access is restricted.
`location_mode`	boolean
`material_total`	JSON	Computed JSON value; may be null when access is restricted.
`name`	string
`other_total`	JSON	Computed JSON value; may be null when access is restricted.
`parent`	uuid
`plant_total`	JSON	Computed JSON value; may be null when access is restricted.
`set_id`	integer
`sort`	integer
`subcontract_total`	JSON	Computed JSON value; may be null when access is restricted.

Responses

200 — Success

Field	Type	Details
`activity_id`	integer
`description`	string
`duration_days`	integer
`estimate` *	uuid
`group`	integer
`group_name`	string
`id` *	uuid
`labour_total`	JSON	Computed JSON value; may be null when access is restricted.
`location_mode`	boolean
`material_total`	JSON	Computed JSON value; may be null when access is restricted.
`name` *	string
`other_total`	JSON	Computed JSON value; may be null when access is restricted.
`parent`	uuid
`plant_total`	JSON	Computed JSON value; may be null when access is restricted.
`set_id`	integer
`sort`	integer
`subcontract_total`	JSON	Computed JSON value; may be null when access is restricted.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{id}/estimate/locations/

Parameters

Name	Location	Details
`id` *	path	uuid
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	EstimateLocation[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{id}/estimate/locations/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`code`	string
`description`	string
`house_type`	string
`house_type_definition`	uuid
`house_type_overrides`	JSON	Computed JSON value; may be null when access is restricted.
`name` *	string
`parent`	uuid
`plot_gdv`	decimal
`plot_gifa_sq_ft`	decimal
`sort_order`	integer
`tenure`	string

Responses

201 — Success

Field	Type	Details
`code`	string
`description`	string
`estimate` *	uuid
`house_type`	string
`house_type_definition`	uuid
`house_type_details` *	EstimateHouseType
`house_type_overrides`	JSON	Computed JSON value; may be null when access is restricted.
`id` *	uuid
`name` *	string
`parent`	uuid
`plot_gdv`	decimal
`plot_gifa_sq_ft`	decimal
`sort_order`	integer
`tenure`	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{id}/estimate/locations/{lid}/

Parameters

Name	Location	Details
`id` *	path	uuid
`lid` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{id}/estimate/locations/{lid}/

Parameters

Name	Location	Details
`id` *	path	uuid
`lid` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`code`	string
`description`	string
`estimate` *	uuid
`house_type`	string
`house_type_definition`	uuid
`house_type_details` *	EstimateHouseType
`house_type_overrides`	JSON	Computed JSON value; may be null when access is restricted.
`id` *	uuid
`name` *	string
`parent`	uuid
`plot_gdv`	decimal
`plot_gifa_sq_ft`	decimal
`sort_order`	integer
`tenure`	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{id}/estimate/locations/{lid}/

Parameters

Name	Location	Details
`id` *	path	uuid
`lid` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`code`	string
`description`	string
`house_type`	string
`house_type_definition`	uuid
`house_type_overrides`	JSON	Computed JSON value; may be null when access is restricted.
`name`	string
`parent`	uuid
`plot_gdv`	decimal
`plot_gifa_sq_ft`	decimal
`sort_order`	integer
`tenure`	string

Responses

200 — Success

Field	Type	Details
`code`	string
`description`	string
`estimate` *	uuid
`house_type`	string
`house_type_definition`	uuid
`house_type_details` *	EstimateHouseType
`house_type_overrides`	JSON	Computed JSON value; may be null when access is restricted.
`id` *	uuid
`name` *	string
`parent`	uuid
`plot_gdv`	decimal
`plot_gifa_sq_ft`	decimal
`sort_order`	integer
`tenure`	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{id}/estimate/work-items/

Parameters

Name	Location	Details
`id` *	path	uuid
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	EstimateWorkItem[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{id}/estimate/work-items/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`activity`	uuid
`boq_path`	JSON	Computed JSON value; may be null when access is restricted.
`description`	string
`est_line`	uuid
`group`	integer
`is_spot_item`	boolean
`is_unit_price`	boolean
`line_total`	decimal
`name` *	string
`ohp_pct_override`	decimal
`payment_stage`	JSON	Computed JSON value; may be null when access is restricted.
`payment_stage_id`	uuid
`quantity`	decimal
`sell_markup_pct`	decimal
`sell_total`	decimal
`sort`	integer
`source_lib_line`	uuid
`source_library_id`	string
`source_library_name`	string
`source_library_type`	string
`source_work_item_id`	integer
`unit_of_measure`	string
`unit_rate`	decimal
`visibility`	string	* `rollup` - Roll-up * `expanded` - Expanded Options: rollup, expanded

Responses

201 — Success

Field	Type	Details
`activity`	uuid
`base_total`	decimal
`boq_path`	JSON	Computed JSON value; may be null when access is restricted.
`description`	string
`est_line`	uuid
`estimate` *	uuid
`group`	integer
`id` *	uuid
`is_spot_item`	boolean
`is_unit_price`	boolean
`line_total`	decimal
`name` *	string
`ohp_pct_override`	decimal
`payment_stage`	JSON	Computed JSON value; may be null when access is restricted.
`profit_total`	decimal
`quantity`	decimal
`sell_markup_pct`	decimal
`sell_total`	decimal
`sort`	integer
`source_library_id`	string
`source_library_name`	string
`source_library_type`	string
`source_work_item_id`	integer
`unit_of_measure`	string
`unit_rate`	decimal
`visibility`	string	* `rollup` - Roll-up * `expanded` - Expanded Options: rollup, expanded

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{id}/estimate/work-items/{wid}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`wid` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{id}/estimate/work-items/{wid}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`wid` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`activity`	uuid
`base_total`	decimal
`boq_path`	JSON	Computed JSON value; may be null when access is restricted.
`description`	string
`est_line`	uuid
`estimate` *	uuid
`group`	integer
`id` *	uuid
`is_spot_item`	boolean
`is_unit_price`	boolean
`line_total`	decimal
`name` *	string
`ohp_pct_override`	decimal
`payment_stage`	JSON	Computed JSON value; may be null when access is restricted.
`profit_total`	decimal
`quantity`	decimal
`sell_markup_pct`	decimal
`sell_total`	decimal
`sort`	integer
`source_library_id`	string
`source_library_name`	string
`source_library_type`	string
`source_work_item_id`	integer
`unit_of_measure`	string
`unit_rate`	decimal
`visibility`	string	* `rollup` - Roll-up * `expanded` - Expanded Options: rollup, expanded

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{id}/estimate/work-items/{wid}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`wid` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`activity`	uuid
`boq_path`	JSON	Computed JSON value; may be null when access is restricted.
`description`	string
`est_line`	uuid
`group`	integer
`is_spot_item`	boolean
`is_unit_price`	boolean
`line_total`	decimal
`name`	string
`ohp_pct_override`	decimal
`payment_stage`	JSON	Computed JSON value; may be null when access is restricted.
`payment_stage_id`	uuid
`quantity`	decimal
`sell_markup_pct`	decimal
`sell_total`	decimal
`sort`	integer
`source_lib_line`	uuid
`source_library_id`	string
`source_library_name`	string
`source_library_type`	string
`source_work_item_id`	integer
`unit_of_measure`	string
`unit_rate`	decimal
`visibility`	string	* `rollup` - Roll-up * `expanded` - Expanded Options: rollup, expanded

Responses

200 — Success

Field	Type	Details
`activity`	uuid
`base_total`	decimal
`boq_path`	JSON	Computed JSON value; may be null when access is restricted.
`description`	string
`est_line`	uuid
`estimate` *	uuid
`group`	integer
`id` *	uuid
`is_spot_item`	boolean
`is_unit_price`	boolean
`line_total`	decimal
`name` *	string
`ohp_pct_override`	decimal
`payment_stage`	JSON	Computed JSON value; may be null when access is restricted.
`profit_total`	decimal
`quantity`	decimal
`sell_markup_pct`	decimal
`sell_total`	decimal
`sort`	integer
`source_library_id`	string
`source_library_name`	string
`source_library_type`	string
`source_work_item_id`	integer
`unit_of_measure`	string
`unit_rate`	decimal
`visibility`	string	* `rollup` - Roll-up * `expanded` - Expanded Options: rollup, expanded

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{id}/reject/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`note`	string

Responses

200 — Success

Field	Type	Details
`actioned_by_ip_address` *	string	IP address of the user who approved/rejected the request.
`approval_method` *	string	How the request was actioned, e.g., 'in_app', 'email_link'.
`approved_at` *	date-time
`assumption_items`	JSON	Structured assumption/exclusion items with optional client ack flags.
`assumptions`	string	Assumptions made for this quote.
`attached_files`	uuid[]
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`base_quote`	JSON	Computed JSON value; may be null when access is restricted.
`brief_snapshot_id`	uuid
`client_action_note` *	string	Note added by the client when they approved or rejected.
`created_at` *	date-time
`created_by` *	uuid
`customer_name`	string
`delivery_status` *	string
`document_type`	string	* `quote` - Quotation * `estimate` - Estimate * `variation` - Variation Options: quote, estimate, variation
`estimate_approved_at` *	date-time
`estimate_id`	JSON	Computed JSON value; may be null when access is restricted.
`estimate_is_approved` *	boolean
`estimate_last_synced_at` *	date-time
`estimate_source_quote_version` *	integer
`id` *	uuid
`is_main_quote`	boolean	Exactly one quote per project may be marked main; baseline for final account / linked flows.
`last_updated_at`	JSON	Computed JSON value; may be null when access is restricted.
`latest_variation_id`	JSON	Computed JSON value; may be null when access is restricted.
`linked_invoice_count`	JSON	Computed JSON value; may be null when access is restricted.
`linked_quote`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string	Private notes for the builder.
`pricing_mode`	string	* `quick` - Quick quote * `estimate` - Linked estimate * `external` - External contract Options: quick, estimate, external
`primary_estimate`	uuid
`primary_estimate_quote_id`	JSON	Computed JSON value; may be null when access is restricted.
`project` *	uuid
`project_address`	JSON	Computed JSON value; may be null when access is restricted.
`project_id` *	uuid
`project_name` *	string
`quote_number` *	string	Workspace-unique quote number (e.g., QUO-001).
`rejected_at` *	date-time
`revised_total`	JSON	Computed JSON value; may be null when access is restricted.
`sent_at` *	date-time
`source_change_request_id`	JSON	Computed JSON value; may be null when access is restricted.
`source_change_request_register_number`	JSON	Computed JSON value; may be null when access is restricted.
`source_change_request_title`	JSON	Computed JSON value; may be null when access is restricted.
`status` *	string	* `draft` - Draft * `sent` - Sent * `approved` - Approved * `rejected` - Rejected * `superseded` - Superseded * `locked` - Locked (linked to quote) * `archived` - Archived Options: draft, sent, approved, rejected, superseded, locked, archived
`subtotal`	JSON	Computed JSON value; may be null when access is restricted.
`tax_amount`	JSON	Computed JSON value; may be null when access is restricted.
`tax_breakdown`	JSON	Computed JSON value; may be null when access is restricted.
`tax_name`	string	The name of the tax applied (VAT, Sales Tax, ...).
`tax_rate`	decimal	The tax rate (e.g., 20.00 for 20%). Null means 'not explicitly set' and falls back to the workspace default; 0 means explicitly tax-exempt.
`terms_and_conditions`	string	Client-facing terms and conditions.
`title`	string	'Quotation for Kitchen Renovation'
`total`	JSON	Computed JSON value; may be null when access is restricted.
`updated_at` *	date-time
`variation_count`	JSON	Computed JSON value; may be null when access is restricted.
`version` *	integer	Highest version number in QuoteVersion for this series.
`workspace_business_address`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_company_name` *	string
`workspace_currency`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_daywork_defaults`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_default_tax_rate` *	decimal
`workspace_default_terms` *	string
`workspace_language` *	string
`workspace_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_market_code`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_name` *	string
`workspace_tax_id` *	string
`workspace_tax_label`	JSON	Computed JSON value; may be null when access is restricted.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{id}/send/

Required scopes and service-account permissions: quotes:send, quotes:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Reusable security logic for any Workspace-scoped resource.

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`note`	string

Responses

200 — Success

Field	Type	Details
`actioned_by_ip_address` *	string	IP address of the user who approved/rejected the request.
`approval_method` *	string	How the request was actioned, e.g., 'in_app', 'email_link'.
`approved_at` *	date-time
`assumption_items`	JSON	Structured assumption/exclusion items with optional client ack flags.
`assumptions`	string	Assumptions made for this quote.
`attached_files`	uuid[]
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`base_quote`	JSON	Computed JSON value; may be null when access is restricted.
`brief_snapshot_id`	uuid
`client_action_note` *	string	Note added by the client when they approved or rejected.
`created_at` *	date-time
`created_by` *	uuid
`customer_name`	string
`delivery_status` *	string
`document_type`	string	* `quote` - Quotation * `estimate` - Estimate * `variation` - Variation Options: quote, estimate, variation
`estimate_approved_at` *	date-time
`estimate_id`	JSON	Computed JSON value; may be null when access is restricted.
`estimate_is_approved` *	boolean
`estimate_last_synced_at` *	date-time
`estimate_source_quote_version` *	integer
`id` *	uuid
`is_main_quote`	boolean	Exactly one quote per project may be marked main; baseline for final account / linked flows.
`last_updated_at`	JSON	Computed JSON value; may be null when access is restricted.
`latest_variation_id`	JSON	Computed JSON value; may be null when access is restricted.
`linked_invoice_count`	JSON	Computed JSON value; may be null when access is restricted.
`linked_quote`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string	Private notes for the builder.
`pricing_mode`	string	* `quick` - Quick quote * `estimate` - Linked estimate * `external` - External contract Options: quick, estimate, external
`primary_estimate`	uuid
`primary_estimate_quote_id`	JSON	Computed JSON value; may be null when access is restricted.
`project` *	uuid
`project_address`	JSON	Computed JSON value; may be null when access is restricted.
`project_id` *	uuid
`project_name` *	string
`quote_number` *	string	Workspace-unique quote number (e.g., QUO-001).
`rejected_at` *	date-time
`revised_total`	JSON	Computed JSON value; may be null when access is restricted.
`sent_at` *	date-time
`source_change_request_id`	JSON	Computed JSON value; may be null when access is restricted.
`source_change_request_register_number`	JSON	Computed JSON value; may be null when access is restricted.
`source_change_request_title`	JSON	Computed JSON value; may be null when access is restricted.
`status` *	string	* `draft` - Draft * `sent` - Sent * `approved` - Approved * `rejected` - Rejected * `superseded` - Superseded * `locked` - Locked (linked to quote) * `archived` - Archived Options: draft, sent, approved, rejected, superseded, locked, archived
`subtotal`	JSON	Computed JSON value; may be null when access is restricted.
`tax_amount`	JSON	Computed JSON value; may be null when access is restricted.
`tax_breakdown`	JSON	Computed JSON value; may be null when access is restricted.
`tax_name`	string	The name of the tax applied (VAT, Sales Tax, ...).
`tax_rate`	decimal	The tax rate (e.g., 20.00 for 20%). Null means 'not explicitly set' and falls back to the workspace default; 0 means explicitly tax-exempt.
`terms_and_conditions`	string	Client-facing terms and conditions.
`title`	string	'Quotation for Kitchen Renovation'
`total`	JSON	Computed JSON value; may be null when access is restricted.
`updated_at` *	date-time
`variation_count`	JSON	Computed JSON value; may be null when access is restricted.
`version` *	integer	Highest version number in QuoteVersion for this series.
`workspace_business_address`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_company_name` *	string
`workspace_currency`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_daywork_defaults`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_default_tax_rate` *	decimal
`workspace_default_terms` *	string
`workspace_language` *	string
`workspace_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_market_code`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_name` *	string
`workspace_tax_id` *	string
`workspace_tax_label`	JSON	Computed JSON value; may be null when access is restricted.

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{quote_pk}/items/

Parameters

Name	Location	Details
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`project_id` *	path	uuid
`quote_pk` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	QuoteLineItem[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{quote_pk}/items/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`project_id` *	path	uuid
`quote_pk` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`cost_category`	string	* `labour` - Labour * `materials` - Materials * `plant` - Plant * `subcontract` - Subcontract * `overhead` - Overhead * `other` - Other * `professional` - Professional Options: labour, materials, plant, subcontract, overhead, other, professional
`cost_code`	integer
`cost_code_category`	JSON	Computed JSON value; may be null when access is restricted.
`description` *	string
`effective_tax_rate`	JSON	Computed JSON value; may be null when access is restricted.
`is_provisional`	boolean
`order`	integer
`payment_stage_id`	uuid
`plot`	uuid	Optional plot this quoted work is tagged to.
`quantity`	decimal
`resource`	integer	If set, description/UoM defaults from Resource; price from current rate.
`resource_type`	JSON	Computed JSON value; may be null when access is restricted.
`resources`	JSON	Computed JSON value; may be null when access is restricted.
`section`	string
`show_resource_breakdown`	boolean
`tax_rate`	decimal	Line tax rate (e.g. 20.00 for 20%). Null inherits the quote/workspace default; 0 means this line is tax-exempt.
`unit_of_measure`	string
`unit_price`	decimal

Responses

201 — Success

Field	Type	Details
`cost_category`	string	* `labour` - Labour * `materials` - Materials * `plant` - Plant * `subcontract` - Subcontract * `overhead` - Overhead * `other` - Other * `professional` - Professional Options: labour, materials, plant, subcontract, overhead, other, professional
`cost_code`	integer
`cost_code_category`	JSON	Computed JSON value; may be null when access is restricted.
`description` *	string
`effective_tax_rate`	JSON	Computed JSON value; may be null when access is restricted.
`id` *	uuid
`is_provisional`	boolean
`line_total`	decimal
`order`	integer
`payment_stage` *	PaymentStage
`payment_stage_id`	uuid
`plot`	uuid	Optional plot this quoted work is tagged to.
`plot_name`	string
`quantity`	decimal
`quote` *	uuid
`resource`	integer	If set, description/UoM defaults from Resource; price from current rate.
`resource_type`	JSON	Computed JSON value; may be null when access is restricted.
`resources`	JSON	Computed JSON value; may be null when access is restricted.
`section`	string
`show_resource_breakdown`	boolean
`tax_rate`	decimal	Line tax rate (e.g. 20.00 for 20%). Null inherits the quote/workspace default; 0 means this line is tax-exempt.
`unit_of_measure`	string
`unit_price`	decimal

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{quote_pk}/items/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`quote_pk` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{quote_pk}/items/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`quote_pk` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`cost_category`	string	* `labour` - Labour * `materials` - Materials * `plant` - Plant * `subcontract` - Subcontract * `overhead` - Overhead * `other` - Other * `professional` - Professional Options: labour, materials, plant, subcontract, overhead, other, professional
`cost_code`	integer
`cost_code_category`	JSON	Computed JSON value; may be null when access is restricted.
`description` *	string
`effective_tax_rate`	JSON	Computed JSON value; may be null when access is restricted.
`id` *	uuid
`is_provisional`	boolean
`line_total`	decimal
`order`	integer
`payment_stage` *	PaymentStage
`payment_stage_id`	uuid
`plot`	uuid	Optional plot this quoted work is tagged to.
`plot_name`	string
`quantity`	decimal
`quote` *	uuid
`resource`	integer	If set, description/UoM defaults from Resource; price from current rate.
`resource_type`	JSON	Computed JSON value; may be null when access is restricted.
`resources`	JSON	Computed JSON value; may be null when access is restricted.
`section`	string
`show_resource_breakdown`	boolean
`tax_rate`	decimal	Line tax rate (e.g. 20.00 for 20%). Null inherits the quote/workspace default; 0 means this line is tax-exempt.
`unit_of_measure`	string
`unit_price`	decimal

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{quote_pk}/items/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`quote_pk` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`cost_category`	string	* `labour` - Labour * `materials` - Materials * `plant` - Plant * `subcontract` - Subcontract * `overhead` - Overhead * `other` - Other * `professional` - Professional Options: labour, materials, plant, subcontract, overhead, other, professional
`cost_code`	integer
`cost_code_category`	JSON	Computed JSON value; may be null when access is restricted.
`description`	string
`effective_tax_rate`	JSON	Computed JSON value; may be null when access is restricted.
`is_provisional`	boolean
`order`	integer
`payment_stage_id`	uuid
`plot`	uuid	Optional plot this quoted work is tagged to.
`quantity`	decimal
`resource`	integer	If set, description/UoM defaults from Resource; price from current rate.
`resource_type`	JSON	Computed JSON value; may be null when access is restricted.
`resources`	JSON	Computed JSON value; may be null when access is restricted.
`section`	string
`show_resource_breakdown`	boolean
`tax_rate`	decimal	Line tax rate (e.g. 20.00 for 20%). Null inherits the quote/workspace default; 0 means this line is tax-exempt.
`unit_of_measure`	string
`unit_price`	decimal

Responses

200 — Success

Field	Type	Details
`cost_category`	string	* `labour` - Labour * `materials` - Materials * `plant` - Plant * `subcontract` - Subcontract * `overhead` - Overhead * `other` - Other * `professional` - Professional Options: labour, materials, plant, subcontract, overhead, other, professional
`cost_code`	integer
`cost_code_category`	JSON	Computed JSON value; may be null when access is restricted.
`description` *	string
`effective_tax_rate`	JSON	Computed JSON value; may be null when access is restricted.
`id` *	uuid
`is_provisional`	boolean
`line_total`	decimal
`order`	integer
`payment_stage` *	PaymentStage
`payment_stage_id`	uuid
`plot`	uuid	Optional plot this quoted work is tagged to.
`plot_name`	string
`quantity`	decimal
`quote` *	uuid
`resource`	integer	If set, description/UoM defaults from Resource; price from current rate.
`resource_type`	JSON	Computed JSON value; may be null when access is restricted.
`resources`	JSON	Computed JSON value; may be null when access is restricted.
`section`	string
`show_resource_breakdown`	boolean
`tax_rate`	decimal	Line tax rate (e.g. 20.00 for 20%). Null inherits the quote/workspace default; 0 means this line is tax-exempt.
`unit_of_measure`	string
`unit_price`	decimal

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{quote_pk}/payment-stages/

Parameters

Name	Location	Details
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`project_id` *	path	uuid
`quote_pk` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	PaymentStage[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{quote_pk}/payment-stages/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`project_id` *	path	uuid
`quote_pk` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`name` *	string
`order`	integer
`target_percentage`	decimal

Responses

201 — Success

Field	Type	Details
`generated_by_handoff` *	boolean
`id` *	uuid
`name` *	string
`order`	integer
`quote` *	uuid
`source_estimate_activity` *	uuid
`source_handoff_key` *	string
`target_percentage`	decimal

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{quote_pk}/payment-stages/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`quote_pk` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{quote_pk}/payment-stages/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`quote_pk` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`generated_by_handoff` *	boolean
`id` *	uuid
`name` *	string
`order`	integer
`quote` *	uuid
`source_estimate_activity` *	uuid
`source_handoff_key` *	string
`target_percentage`	decimal

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{quote_pk}/payment-stages/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`quote_pk` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`name`	string
`order`	integer
`target_percentage`	decimal

Responses

200 — Success

Field	Type	Details
`generated_by_handoff` *	boolean
`id` *	uuid
`name` *	string
`order`	integer
`quote` *	uuid
`source_estimate_activity` *	uuid
`source_handoff_key` *	string
`target_percentage`	decimal

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{quote_pk}/sections/

Required scopes and service-account permissions: quotes:read, quotes:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Reusable security logic for any Workspace-scoped resource.

Parameters

Name	Location	Details
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`project_id` *	path	uuid
`quote_pk` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	QuoteSection[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{quote_pk}/sections/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`project_id` *	path	uuid
`quote_pk` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`content`	JSON	Block-specific settings and content payload.
`custom_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`footer_text`	string	Optional footer text shown below this section.
`header_text`	string	Optional header text shown above this section.
`order`	integer	Display order within the quote builder.
`title`	string	Optional internal title/label for this section.
`type` *	string	Kind of section/block, e.g. 'cover', 'items_table', 'dayworks'. * `cover` - Cover page * `header` - Page header * `intro` - Introduction * `items_table` - Items table * `summary` - Summary * `totals` - Totals & breakdown * `assumptions` - Assumptions * `terms` - Terms & conditions * `signature` - Signature block * `free_text` - Free text block * `dayworks` - Dayworks * `attendances` - Attendances * `variation_details` - Variation Details * `payment_schedule` - Payment Schedule Options: cover, header, intro, items_table, summary, totals, assumptions, terms, signature, free_text, dayworks, attendances, variation_details, payment_schedule

Responses

201 — Success

Field	Type	Details
`content`	JSON	Block-specific settings and content payload.
`created_at` *	date-time
`custom_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`footer_text`	string	Optional footer text shown below this section.
`header_text`	string	Optional header text shown above this section.
`id` *	uuid
`order`	integer	Display order within the quote builder.
`quote` *	uuid
`title`	string	Optional internal title/label for this section.
`type` *	string	Kind of section/block, e.g. 'cover', 'items_table', 'dayworks'. * `cover` - Cover page * `header` - Page header * `intro` - Introduction * `items_table` - Items table * `summary` - Summary * `totals` - Totals & breakdown * `assumptions` - Assumptions * `terms` - Terms & conditions * `signature` - Signature block * `free_text` - Free text block * `dayworks` - Dayworks * `attendances` - Attendances * `variation_details` - Variation Details * `payment_schedule` - Payment Schedule Options: cover, header, intro, items_table, summary, totals, assumptions, terms, signature, free_text, dayworks, attendances, variation_details, payment_schedule
`updated_at` *	date-time

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{quote_pk}/sections/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`quote_pk` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{quote_pk}/sections/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`quote_pk` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`content`	JSON	Block-specific settings and content payload.
`created_at` *	date-time
`custom_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`footer_text`	string	Optional footer text shown below this section.
`header_text`	string	Optional header text shown above this section.
`id` *	uuid
`order`	integer	Display order within the quote builder.
`quote` *	uuid
`title`	string	Optional internal title/label for this section.
`type` *	string	Kind of section/block, e.g. 'cover', 'items_table', 'dayworks'. * `cover` - Cover page * `header` - Page header * `intro` - Introduction * `items_table` - Items table * `summary` - Summary * `totals` - Totals & breakdown * `assumptions` - Assumptions * `terms` - Terms & conditions * `signature` - Signature block * `free_text` - Free text block * `dayworks` - Dayworks * `attendances` - Attendances * `variation_details` - Variation Details * `payment_schedule` - Payment Schedule Options: cover, header, intro, items_table, summary, totals, assumptions, terms, signature, free_text, dayworks, attendances, variation_details, payment_schedule
`updated_at` *	date-time

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/projects/{project_id}/quotes/{quote_pk}/sections/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`quote_pk` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`content`	JSON	Block-specific settings and content payload.
`custom_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`footer_text`	string	Optional footer text shown below this section.
`header_text`	string	Optional header text shown above this section.
`order`	integer	Display order within the quote builder.
`title`	string	Optional internal title/label for this section.
`type`	string	Kind of section/block, e.g. 'cover', 'items_table', 'dayworks'. * `cover` - Cover page * `header` - Page header * `intro` - Introduction * `items_table` - Items table * `summary` - Summary * `totals` - Totals & breakdown * `assumptions` - Assumptions * `terms` - Terms & conditions * `signature` - Signature block * `free_text` - Free text block * `dayworks` - Dayworks * `attendances` - Attendances * `variation_details` - Variation Details * `payment_schedule` - Payment Schedule Options: cover, header, intro, items_table, summary, totals, assumptions, terms, signature, free_text, dayworks, attendances, variation_details, payment_schedule

Responses

200 — Success

Field	Type	Details
`content`	JSON	Block-specific settings and content payload.
`created_at` *	date-time
`custom_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`footer_text`	string	Optional footer text shown below this section.
`header_text`	string	Optional header text shown above this section.
`id` *	uuid
`order`	integer	Display order within the quote builder.
`quote` *	uuid
`title`	string	Optional internal title/label for this section.
`type` *	string	Kind of section/block, e.g. 'cover', 'items_table', 'dayworks'. * `cover` - Cover page * `header` - Page header * `intro` - Introduction * `items_table` - Items table * `summary` - Summary * `totals` - Totals & breakdown * `assumptions` - Assumptions * `terms` - Terms & conditions * `signature` - Signature block * `free_text` - Free text block * `dayworks` - Dayworks * `attendances` - Attendances * `variation_details` - Variation Details * `payment_schedule` - Payment Schedule Options: cover, header, intro, items_table, summary, totals, assumptions, terms, signature, free_text, dayworks, attendances, variation_details, payment_schedule
`updated_at` *	date-time

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/rfis/

Required scopes and service-account permissions: rfis:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Enforce a workspace capability in addition to RBAC.

Parameters

Name	Location	Details
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	RFI[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/rfis/

Required scopes and service-account permissions: rfis:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Enforce a workspace capability in addition to RBAC.

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`attachment_count`	JSON	Computed JSON value; may be null when access is restricted.
`attachment_ids`	uuid[]
`completion_policy`	string	* `none` - No evidence required * `note` - Note required * `file` - Photo or file required * `note_or_file` - Note or photo/file required * `note_and_file` - Note and photo/file required Options: none, note, file, note_or_file, note_and_file, ,
`description`	string
`discipline`	string
`doer`	JSON	Computed JSON value; may be null when access is restricted.
`doer_email`	email
`doer_partner_contact_id`	uuid
`doer_partner_id`	uuid
`doer_user_id`	uuid
`drawing_refs`	string	Drawing or spec references.
`due_date`	date
`estimate_location_id`	uuid
`managed_by_id`	uuid
`resolved_completion_policy`	JSON	Computed JSON value; may be null when access is restricted.
`show_on_calendar`	boolean	If True, this RFI appears on calendars when it has a due date.
`show_on_gantt`	boolean	If True, this RFI appears on the project Gantt chart when it has a due date.
`source_timeline_entry_id`	uuid	Optional source timeline entry when this RFI was created from a message.
`status`	string	* `draft` - Draft * `issued` - Issued * `responded` - Responded * `closed` - Closed Options: draft, issued, responded, closed
`subject` *	string

Responses

201 — Success

Field	Type	Details
`attachment_count`	JSON	Computed JSON value; may be null when access is restricted.
`attachments` *	FileDetail[]
`closed_at` *	date-time
`completion_policy`	string	* `none` - No evidence required * `note` - Note required * `file` - Photo or file required * `note_or_file` - Note or photo/file required * `note_and_file` - Note and photo/file required Options: none, note, file, note_or_file, note_and_file, ,
`created_at` *	date-time
`description`	string
`discipline`	string
`doer`	JSON	Computed JSON value; may be null when access is restricted.
`drawing_refs`	string	Drawing or spec references.
`due_date`	date
`estimate_location_id`	uuid
`estimate_location_name`	string
`id` *	uuid
`managed_by` *	UserPublic
`number` *	string
`project` *	uuid	The job this RFI belongs to.
`project_name` *	string
`raised_by` *	UserPublic
`resolved_completion_policy`	JSON	Computed JSON value; may be null when access is restricted.
`responded_at` *	date-time	When the RFI first reached Responded status.
`show_on_calendar`	boolean	If True, this RFI appears on calendars when it has a due date.
`show_on_gantt`	boolean	If True, this RFI appears on the project Gantt chart when it has a due date.
`source_timeline_entry_id`	uuid	Optional source timeline entry when this RFI was created from a message.
`status`	string	* `draft` - Draft * `issued` - Issued * `responded` - Responded * `closed` - Closed Options: draft, issued, responded, closed
`subject` *	string
`updated_at` *	date-time

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/projects/{project_id}/rfis/{id}/

Required scopes and service-account permissions: rfis:manage. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Enforce a workspace capability in addition to RBAC.

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/rfis/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`attachment_count`	JSON	Computed JSON value; may be null when access is restricted.
`attachments` *	FileDetail[]
`closed_at` *	date-time
`completion_policy`	string	* `none` - No evidence required * `note` - Note required * `file` - Photo or file required * `note_or_file` - Note or photo/file required * `note_and_file` - Note and photo/file required Options: none, note, file, note_or_file, note_and_file, ,
`created_at` *	date-time
`description`	string
`discipline`	string
`doer`	JSON	Computed JSON value; may be null when access is restricted.
`drawing_refs`	string	Drawing or spec references.
`due_date`	date
`estimate_location_id`	uuid
`estimate_location_name`	string
`id` *	uuid
`managed_by` *	UserPublic
`number` *	string
`project` *	uuid	The job this RFI belongs to.
`project_name` *	string
`raised_by` *	UserPublic
`resolved_completion_policy`	JSON	Computed JSON value; may be null when access is restricted.
`responded_at` *	date-time	When the RFI first reached Responded status.
`show_on_calendar`	boolean	If True, this RFI appears on calendars when it has a due date.
`show_on_gantt`	boolean	If True, this RFI appears on the project Gantt chart when it has a due date.
`source_timeline_entry_id`	uuid	Optional source timeline entry when this RFI was created from a message.
`status`	string	* `draft` - Draft * `issued` - Issued * `responded` - Responded * `closed` - Closed Options: draft, issued, responded, closed
`subject` *	string
`updated_at` *	date-time

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/projects/{project_id}/rfis/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`attachment_count`	JSON	Computed JSON value; may be null when access is restricted.
`attachment_ids`	uuid[]
`completion_policy`	string	* `none` - No evidence required * `note` - Note required * `file` - Photo or file required * `note_or_file` - Note or photo/file required * `note_and_file` - Note and photo/file required Options: none, note, file, note_or_file, note_and_file, ,
`description`	string
`discipline`	string
`doer`	JSON	Computed JSON value; may be null when access is restricted.
`doer_email`	email
`doer_partner_contact_id`	uuid
`doer_partner_id`	uuid
`doer_user_id`	uuid
`drawing_refs`	string	Drawing or spec references.
`due_date`	date
`estimate_location_id`	uuid
`managed_by_id`	uuid
`resolved_completion_policy`	JSON	Computed JSON value; may be null when access is restricted.
`show_on_calendar`	boolean	If True, this RFI appears on calendars when it has a due date.
`show_on_gantt`	boolean	If True, this RFI appears on the project Gantt chart when it has a due date.
`source_timeline_entry_id`	uuid	Optional source timeline entry when this RFI was created from a message.
`status`	string	* `draft` - Draft * `issued` - Issued * `responded` - Responded * `closed` - Closed Options: draft, issued, responded, closed
`subject`	string

Responses

200 — Success

Field	Type	Details
`attachment_count`	JSON	Computed JSON value; may be null when access is restricted.
`attachments` *	FileDetail[]
`closed_at` *	date-time
`completion_policy`	string	* `none` - No evidence required * `note` - Note required * `file` - Photo or file required * `note_or_file` - Note or photo/file required * `note_and_file` - Note and photo/file required Options: none, note, file, note_or_file, note_and_file, ,
`created_at` *	date-time
`description`	string
`discipline`	string
`doer`	JSON	Computed JSON value; may be null when access is restricted.
`drawing_refs`	string	Drawing or spec references.
`due_date`	date
`estimate_location_id`	uuid
`estimate_location_name`	string
`id` *	uuid
`managed_by` *	UserPublic
`number` *	string
`project` *	uuid	The job this RFI belongs to.
`project_name` *	string
`raised_by` *	UserPublic
`resolved_completion_policy`	JSON	Computed JSON value; may be null when access is restricted.
`responded_at` *	date-time	When the RFI first reached Responded status.
`show_on_calendar`	boolean	If True, this RFI appears on calendars when it has a due date.
`show_on_gantt`	boolean	If True, this RFI appears on the project Gantt chart when it has a due date.
`source_timeline_entry_id`	uuid	Optional source timeline entry when this RFI was created from a message.
`status`	string	* `draft` - Draft * `issued` - Issued * `responded` - Responded * `closed` - Closed Options: draft, issued, responded, closed
`subject` *	string
`updated_at` *	date-time

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/rfis/{id}/transition/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`status` *	string	* `draft` - Draft * `issued` - Issued * `responded` - Responded * `closed` - Closed Options: draft, issued, responded, closed

Responses

200 — Success

Field	Type	Details
`attachment_count`	JSON	Computed JSON value; may be null when access is restricted.
`attachments` *	FileDetail[]
`closed_at` *	date-time
`completion_policy`	string	* `none` - No evidence required * `note` - Note required * `file` - Photo or file required * `note_or_file` - Note or photo/file required * `note_and_file` - Note and photo/file required Options: none, note, file, note_or_file, note_and_file, ,
`created_at` *	date-time
`description`	string
`discipline`	string
`doer`	JSON	Computed JSON value; may be null when access is restricted.
`drawing_refs`	string	Drawing or spec references.
`due_date`	date
`estimate_location_id`	uuid
`estimate_location_name`	string
`id` *	uuid
`managed_by` *	UserPublic
`number` *	string
`project` *	uuid	The job this RFI belongs to.
`project_name` *	string
`raised_by` *	UserPublic
`resolved_completion_policy`	JSON	Computed JSON value; may be null when access is restricted.
`responded_at` *	date-time	When the RFI first reached Responded status.
`show_on_calendar`	boolean	If True, this RFI appears on calendars when it has a due date.
`show_on_gantt`	boolean	If True, this RFI appears on the project Gantt chart when it has a due date.
`source_timeline_entry_id`	uuid	Optional source timeline entry when this RFI was created from a message.
`status`	string	* `draft` - Draft * `issued` - Issued * `responded` - Responded * `closed` - Closed Options: draft, issued, responded, closed
`subject` *	string
`updated_at` *	date-time

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/schedule-dependencies/

Required scopes and service-account permissions: schedules:read, tasks:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. FLEXIBLE SECURITY: For Project-scoped resources (Tasks, Events, Files). Allows both internal Workspace members AND external Project Guests (Clients).

Parameters

Name	Location	Details
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	ScheduleDependency[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/schedule-dependencies/

Required scopes and service-account permissions: schedules:write, tasks:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. FLEXIBLE SECURITY: For Project-scoped resources (Tasks, Events, Files). Allows both internal Workspace members AND external Project Guests (Clients).

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`dependency_type`	string	* `FS` - Finish-to-Start * `SS` - Start-to-Start * `FF` - Finish-to-Finish * `SF` - Start-to-Finish Options: FS, SS, FF, SF
`gate_status`	string	RFI milestone required before the successor can proceed. * `responded` - Responded * `closed` - Closed Options: responded, closed
`is_satisfied`	JSON	Computed JSON value; may be null when access is restricted.
`lag_days`	integer
`rfi`	JSON	Computed JSON value; may be null when access is restricted.
`rfi_id`	uuid
`successor_id`	uuid

Responses

201 — Success

Field	Type	Details
`dependency_type`	string	* `FS` - Finish-to-Start * `SS` - Start-to-Start * `FF` - Finish-to-Finish * `SF` - Start-to-Finish Options: FS, SS, FF, SF
`gate_status`	string	RFI milestone required before the successor can proceed. * `responded` - Responded * `closed` - Closed Options: responded, closed
`id` *	uuid
`is_satisfied`	JSON	Computed JSON value; may be null when access is restricted.
`lag_days`	integer
`rfi`	JSON	Computed JSON value; may be null when access is restricted.
`successor` *	TaskSimple

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/projects/{project_id}/schedule-dependencies/{id}/

Required scopes and service-account permissions: schedules:manage, tasks:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. FLEXIBLE SECURITY: For Project-scoped resources (Tasks, Events, Files). Allows both internal Workspace members AND external Project Guests (Clients).

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/schedule-dependencies/{id}/

Required scopes and service-account permissions: schedules:read, tasks:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. FLEXIBLE SECURITY: For Project-scoped resources (Tasks, Events, Files). Allows both internal Workspace members AND external Project Guests (Clients).

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`dependency_type`	string	* `FS` - Finish-to-Start * `SS` - Start-to-Start * `FF` - Finish-to-Finish * `SF` - Start-to-Finish Options: FS, SS, FF, SF
`gate_status`	string	RFI milestone required before the successor can proceed. * `responded` - Responded * `closed` - Closed Options: responded, closed
`id` *	uuid
`is_satisfied`	JSON	Computed JSON value; may be null when access is restricted.
`lag_days`	integer
`rfi`	JSON	Computed JSON value; may be null when access is restricted.
`successor` *	TaskSimple

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/projects/{project_id}/schedule-dependencies/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`dependency_type`	string	* `FS` - Finish-to-Start * `SS` - Start-to-Start * `FF` - Finish-to-Finish * `SF` - Start-to-Finish Options: FS, SS, FF, SF
`gate_status`	string	RFI milestone required before the successor can proceed. * `responded` - Responded * `closed` - Closed Options: responded, closed
`is_satisfied`	JSON	Computed JSON value; may be null when access is restricted.
`lag_days`	integer
`rfi`	JSON	Computed JSON value; may be null when access is restricted.
`rfi_id`	uuid
`successor_id`	uuid

Responses

200 — Success

Field	Type	Details
`dependency_type`	string	* `FS` - Finish-to-Start * `SS` - Start-to-Start * `FF` - Finish-to-Finish * `SF` - Start-to-Finish Options: FS, SS, FF, SF
`gate_status`	string	RFI milestone required before the successor can proceed. * `responded` - Responded * `closed` - Closed Options: responded, closed
`id` *	uuid
`is_satisfied`	JSON	Computed JSON value; may be null when access is restricted.
`lag_days`	integer
`rfi`	JSON	Computed JSON value; may be null when access is restricted.
`successor` *	TaskSimple

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/site-logs/

Required scopes and service-account permissions: sitediary:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Enforce a workspace capability in addition to RBAC.

Parameters

Name	Location	Details
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	SiteLog[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/site-logs/

Required scopes and service-account permissions: sitediary:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Enforce a workspace capability in addition to RBAC.

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`attached_files`	uuid[]
`client_summary`	string	Short client-facing summary used when preparing client updates.
`cost_impact_type`	string	* `none` - No cost impact noted * `estimate` - Estimated cost impact * `tbd` - Cost impact to be determined Options: none, estimate, tbd
`delay_days`	integer	Estimated delay in days caused by the logged issue.
`deliveries_notes`	string
`equipment_on_site`	string
`estimated_cost_amount`	decimal	Optional estimated cost impact amount.
`estimated_cost_currency`	string	ISO currency code for the estimated cost amount.
`internal_notes`	string	Private notes for the project team. Not included in client reports.
`issues_notes`	string
`locks_at`	JSON	Computed JSON value; may be null when access is restricted.
`log_date` *	date
`progress_notes`	string
`recommendation`	string
`responsible_party`	string	* `client` - Client * `builder` - Builder * `third_party` - Third party * `unknown` - Unknown Options: client, builder, third_party, unknown
`risk_level`	string	* `low` - Low * `medium` - Medium * `high` - High Options: low, medium, high
`safety_observations`	string
`staff_on_site`	integer
`visitors`	string
`weather`	string

Responses

201 — Success

Field	Type	Details
`amendments` *	SiteLogAmendment[]
`attached_files`	uuid[]
`author` *	uuid
`author_avatar_color`	string
`author_avatar_mode`	string
`author_avatar_url`	uri
`author_name`	string
`client_summary`	string	Short client-facing summary used when preparing client updates.
`cost_impact_type`	string	* `none` - No cost impact noted * `estimate` - Estimated cost impact * `tbd` - Cost impact to be determined Options: none, estimate, tbd
`created_at` *	date-time
`delay_days`	integer	Estimated delay in days caused by the logged issue.
`deliveries_notes`	string
`equipment_on_site`	string
`estimated_cost_amount`	decimal	Optional estimated cost impact amount.
`estimated_cost_currency`	string	ISO currency code for the estimated cost amount.
`id` *	uuid
`internal_notes`	string	Private notes for the project team. Not included in client reports.
`is_locked` *	boolean
`issues_notes`	string
`locks_at`	JSON	Computed JSON value; may be null when access is restricted.
`log_date` *	date
`progress_notes`	string
`project` *	uuid
`recommendation`	string
`responsible_party`	string	* `client` - Client * `builder` - Builder * `third_party` - Third party * `unknown` - Unknown Options: client, builder, third_party, unknown
`risk_level`	string	* `low` - Low * `medium` - Medium * `high` - High Options: low, medium, high
`safety_observations`	string
`staff_on_site`	integer
`updated_at` *	date-time
`visitors`	string
`weather`	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/projects/{project_id}/site-logs/{id}/

Required scopes and service-account permissions: sitediary:manage. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Enforce a workspace capability in addition to RBAC.

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/site-logs/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`amendments` *	SiteLogAmendment[]
`attached_files`	uuid[]
`author` *	uuid
`author_avatar_color`	string
`author_avatar_mode`	string
`author_avatar_url`	uri
`author_name`	string
`client_summary`	string	Short client-facing summary used when preparing client updates.
`cost_impact_type`	string	* `none` - No cost impact noted * `estimate` - Estimated cost impact * `tbd` - Cost impact to be determined Options: none, estimate, tbd
`created_at` *	date-time
`delay_days`	integer	Estimated delay in days caused by the logged issue.
`deliveries_notes`	string
`equipment_on_site`	string
`estimated_cost_amount`	decimal	Optional estimated cost impact amount.
`estimated_cost_currency`	string	ISO currency code for the estimated cost amount.
`id` *	uuid
`internal_notes`	string	Private notes for the project team. Not included in client reports.
`is_locked` *	boolean
`issues_notes`	string
`locks_at`	JSON	Computed JSON value; may be null when access is restricted.
`log_date` *	date
`progress_notes`	string
`project` *	uuid
`recommendation`	string
`responsible_party`	string	* `client` - Client * `builder` - Builder * `third_party` - Third party * `unknown` - Unknown Options: client, builder, third_party, unknown
`risk_level`	string	* `low` - Low * `medium` - Medium * `high` - High Options: low, medium, high
`safety_observations`	string
`staff_on_site`	integer
`updated_at` *	date-time
`visitors`	string
`weather`	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/projects/{project_id}/site-logs/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`attached_files`	uuid[]
`client_summary`	string	Short client-facing summary used when preparing client updates.
`cost_impact_type`	string	* `none` - No cost impact noted * `estimate` - Estimated cost impact * `tbd` - Cost impact to be determined Options: none, estimate, tbd
`delay_days`	integer	Estimated delay in days caused by the logged issue.
`deliveries_notes`	string
`equipment_on_site`	string
`estimated_cost_amount`	decimal	Optional estimated cost impact amount.
`estimated_cost_currency`	string	ISO currency code for the estimated cost amount.
`internal_notes`	string	Private notes for the project team. Not included in client reports.
`issues_notes`	string
`locks_at`	JSON	Computed JSON value; may be null when access is restricted.
`log_date`	date
`progress_notes`	string
`recommendation`	string
`responsible_party`	string	* `client` - Client * `builder` - Builder * `third_party` - Third party * `unknown` - Unknown Options: client, builder, third_party, unknown
`risk_level`	string	* `low` - Low * `medium` - Medium * `high` - High Options: low, medium, high
`safety_observations`	string
`staff_on_site`	integer
`visitors`	string
`weather`	string

Responses

200 — Success

Field	Type	Details
`amendments` *	SiteLogAmendment[]
`attached_files`	uuid[]
`author` *	uuid
`author_avatar_color`	string
`author_avatar_mode`	string
`author_avatar_url`	uri
`author_name`	string
`client_summary`	string	Short client-facing summary used when preparing client updates.
`cost_impact_type`	string	* `none` - No cost impact noted * `estimate` - Estimated cost impact * `tbd` - Cost impact to be determined Options: none, estimate, tbd
`created_at` *	date-time
`delay_days`	integer	Estimated delay in days caused by the logged issue.
`deliveries_notes`	string
`equipment_on_site`	string
`estimated_cost_amount`	decimal	Optional estimated cost impact amount.
`estimated_cost_currency`	string	ISO currency code for the estimated cost amount.
`id` *	uuid
`internal_notes`	string	Private notes for the project team. Not included in client reports.
`is_locked` *	boolean
`issues_notes`	string
`locks_at`	JSON	Computed JSON value; may be null when access is restricted.
`log_date` *	date
`progress_notes`	string
`project` *	uuid
`recommendation`	string
`responsible_party`	string	* `client` - Client * `builder` - Builder * `third_party` - Third party * `unknown` - Unknown Options: client, builder, third_party, unknown
`risk_level`	string	* `low` - Low * `medium` - Medium * `high` - High Options: low, medium, high
`safety_observations`	string
`staff_on_site`	integer
`updated_at` *	date-time
`visitors`	string
`weather`	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/snags/

Required scopes and service-account permissions: snags:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Enforce a workspace capability in addition to RBAC.

Parameters

Name	Location	Details
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	Snag[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/snags/

Required scopes and service-account permissions: snags:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Enforce a workspace capability in addition to RBAC.

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`attachment_count`	JSON	Computed JSON value; may be null when access is restricted.
`attachment_ids`	uuid[]
`completion_policy`	string	* `none` - No evidence required * `note` - Note required * `file` - Photo or file required * `note_or_file` - Note or photo/file required * `note_and_file` - Note and photo/file required Options: none, note, file, note_or_file, note_and_file, ,
`daywork_applicable`	string	* `yes` - Yes * `no` - No * `tbc` - TBC Options: yes, no, tbc
`description`	string
`doer`	JSON	Computed JSON value; may be null when access is restricted.
`doer_email`	email
`doer_partner_contact_id`	uuid
`doer_partner_id`	uuid
`doer_user_id`	uuid
`due_date`	date
`estimate_location_id`	uuid
`location`	string
`managed_by_id`	uuid
`priority`	string	* `low` - Low * `medium` - Medium * `high` - High * `urgent` - Urgent Options: low, medium, high, urgent
`resolved_completion_policy`	JSON	Computed JSON value; may be null when access is restricted.
`show_on_calendar`	boolean	If True, this snag appears on calendars when it has a due date.
`show_on_gantt`	boolean	If True, this snag appears on the project Gantt chart when it has a due date.
`source_timeline_entry_id`	uuid	Optional source timeline entry id when this snag was created from a message.
`status`	string	* `open` - Open * `in_progress` - In progress * `ready_for_inspection` - Ready for inspection * `rejected` - Rejected * `closed` - Closed Options: open, in_progress, ready_for_inspection, rejected, closed
`title` *	string

Responses

201 — Success

Field	Type	Details
`attachment_count`	JSON	Computed JSON value; may be null when access is restricted.
`attachments` *	FileDetail[]
`closed_at` *	date-time
`completion_policy`	string	* `none` - No evidence required * `note` - Note required * `file` - Photo or file required * `note_or_file` - Note or photo/file required * `note_and_file` - Note and photo/file required Options: none, note, file, note_or_file, note_and_file, ,
`created_at` *	date-time
`daywork_applicable`	string	* `yes` - Yes * `no` - No * `tbc` - TBC Options: yes, no, tbc
`description`	string
`doer`	JSON	Computed JSON value; may be null when access is restricted.
`due_date`	date
`estimate_location_id`	uuid
`estimate_location_name`	string
`id` *	uuid
`location`	string
`managed_by` *	UserPublic
`number` *	string
`priority`	string	* `low` - Low * `medium` - Medium * `high` - High * `urgent` - Urgent Options: low, medium, high, urgent
`project` *	uuid	The job this snag belongs to.
`project_name` *	string
`raised_by` *	UserPublic
`resolved_completion_policy`	JSON	Computed JSON value; may be null when access is restricted.
`show_on_calendar`	boolean	If True, this snag appears on calendars when it has a due date.
`show_on_gantt`	boolean	If True, this snag appears on the project Gantt chart when it has a due date.
`source_timeline_entry_id`	uuid	Optional source timeline entry id when this snag was created from a message.
`status`	string	* `open` - Open * `in_progress` - In progress * `ready_for_inspection` - Ready for inspection * `rejected` - Rejected * `closed` - Closed Options: open, in_progress, ready_for_inspection, rejected, closed
`title` *	string
`updated_at` *	date-time

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/projects/{project_id}/snags/{id}/

Required scopes and service-account permissions: snags:manage. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Enforce a workspace capability in addition to RBAC.

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/snags/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`attachment_count`	JSON	Computed JSON value; may be null when access is restricted.
`attachments` *	FileDetail[]
`closed_at` *	date-time
`completion_policy`	string	* `none` - No evidence required * `note` - Note required * `file` - Photo or file required * `note_or_file` - Note or photo/file required * `note_and_file` - Note and photo/file required Options: none, note, file, note_or_file, note_and_file, ,
`created_at` *	date-time
`daywork_applicable`	string	* `yes` - Yes * `no` - No * `tbc` - TBC Options: yes, no, tbc
`description`	string
`doer`	JSON	Computed JSON value; may be null when access is restricted.
`due_date`	date
`estimate_location_id`	uuid
`estimate_location_name`	string
`id` *	uuid
`location`	string
`managed_by` *	UserPublic
`number` *	string
`priority`	string	* `low` - Low * `medium` - Medium * `high` - High * `urgent` - Urgent Options: low, medium, high, urgent
`project` *	uuid	The job this snag belongs to.
`project_name` *	string
`raised_by` *	UserPublic
`resolved_completion_policy`	JSON	Computed JSON value; may be null when access is restricted.
`show_on_calendar`	boolean	If True, this snag appears on calendars when it has a due date.
`show_on_gantt`	boolean	If True, this snag appears on the project Gantt chart when it has a due date.
`source_timeline_entry_id`	uuid	Optional source timeline entry id when this snag was created from a message.
`status`	string	* `open` - Open * `in_progress` - In progress * `ready_for_inspection` - Ready for inspection * `rejected` - Rejected * `closed` - Closed Options: open, in_progress, ready_for_inspection, rejected, closed
`title` *	string
`updated_at` *	date-time

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/projects/{project_id}/snags/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`attachment_count`	JSON	Computed JSON value; may be null when access is restricted.
`attachment_ids`	uuid[]
`completion_policy`	string	* `none` - No evidence required * `note` - Note required * `file` - Photo or file required * `note_or_file` - Note or photo/file required * `note_and_file` - Note and photo/file required Options: none, note, file, note_or_file, note_and_file, ,
`daywork_applicable`	string	* `yes` - Yes * `no` - No * `tbc` - TBC Options: yes, no, tbc
`description`	string
`doer`	JSON	Computed JSON value; may be null when access is restricted.
`doer_email`	email
`doer_partner_contact_id`	uuid
`doer_partner_id`	uuid
`doer_user_id`	uuid
`due_date`	date
`estimate_location_id`	uuid
`location`	string
`managed_by_id`	uuid
`priority`	string	* `low` - Low * `medium` - Medium * `high` - High * `urgent` - Urgent Options: low, medium, high, urgent
`resolved_completion_policy`	JSON	Computed JSON value; may be null when access is restricted.
`show_on_calendar`	boolean	If True, this snag appears on calendars when it has a due date.
`show_on_gantt`	boolean	If True, this snag appears on the project Gantt chart when it has a due date.
`source_timeline_entry_id`	uuid	Optional source timeline entry id when this snag was created from a message.
`status`	string	* `open` - Open * `in_progress` - In progress * `ready_for_inspection` - Ready for inspection * `rejected` - Rejected * `closed` - Closed Options: open, in_progress, ready_for_inspection, rejected, closed
`title`	string

Responses

200 — Success

Field	Type	Details
`attachment_count`	JSON	Computed JSON value; may be null when access is restricted.
`attachments` *	FileDetail[]
`closed_at` *	date-time
`completion_policy`	string	* `none` - No evidence required * `note` - Note required * `file` - Photo or file required * `note_or_file` - Note or photo/file required * `note_and_file` - Note and photo/file required Options: none, note, file, note_or_file, note_and_file, ,
`created_at` *	date-time
`daywork_applicable`	string	* `yes` - Yes * `no` - No * `tbc` - TBC Options: yes, no, tbc
`description`	string
`doer`	JSON	Computed JSON value; may be null when access is restricted.
`due_date`	date
`estimate_location_id`	uuid
`estimate_location_name`	string
`id` *	uuid
`location`	string
`managed_by` *	UserPublic
`number` *	string
`priority`	string	* `low` - Low * `medium` - Medium * `high` - High * `urgent` - Urgent Options: low, medium, high, urgent
`project` *	uuid	The job this snag belongs to.
`project_name` *	string
`raised_by` *	UserPublic
`resolved_completion_policy`	JSON	Computed JSON value; may be null when access is restricted.
`show_on_calendar`	boolean	If True, this snag appears on calendars when it has a due date.
`show_on_gantt`	boolean	If True, this snag appears on the project Gantt chart when it has a due date.
`source_timeline_entry_id`	uuid	Optional source timeline entry id when this snag was created from a message.
`status`	string	* `open` - Open * `in_progress` - In progress * `ready_for_inspection` - Ready for inspection * `rejected` - Rejected * `closed` - Closed Options: open, in_progress, ready_for_inspection, rejected, closed
`title` *	string
`updated_at` *	date-time

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/snags/{id}/transition/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`status` *	string	* `open` - Open * `in_progress` - In progress * `ready_for_inspection` - Ready for inspection * `rejected` - Rejected * `closed` - Closed Options: open, in_progress, ready_for_inspection, rejected, closed

Responses

200 — Success

Field	Type	Details
`attachment_count`	JSON	Computed JSON value; may be null when access is restricted.
`attachments` *	FileDetail[]
`closed_at` *	date-time
`completion_policy`	string	* `none` - No evidence required * `note` - Note required * `file` - Photo or file required * `note_or_file` - Note or photo/file required * `note_and_file` - Note and photo/file required Options: none, note, file, note_or_file, note_and_file, ,
`created_at` *	date-time
`daywork_applicable`	string	* `yes` - Yes * `no` - No * `tbc` - TBC Options: yes, no, tbc
`description`	string
`doer`	JSON	Computed JSON value; may be null when access is restricted.
`due_date`	date
`estimate_location_id`	uuid
`estimate_location_name`	string
`id` *	uuid
`location`	string
`managed_by` *	UserPublic
`number` *	string
`priority`	string	* `low` - Low * `medium` - Medium * `high` - High * `urgent` - Urgent Options: low, medium, high, urgent
`project` *	uuid	The job this snag belongs to.
`project_name` *	string
`raised_by` *	UserPublic
`resolved_completion_policy`	JSON	Computed JSON value; may be null when access is restricted.
`show_on_calendar`	boolean	If True, this snag appears on calendars when it has a due date.
`show_on_gantt`	boolean	If True, this snag appears on the project Gantt chart when it has a due date.
`source_timeline_entry_id`	uuid	Optional source timeline entry id when this snag was created from a message.
`status`	string	* `open` - Open * `in_progress` - In progress * `ready_for_inspection` - Ready for inspection * `rejected` - Rejected * `closed` - Closed Options: open, in_progress, ready_for_inspection, rejected, closed
`title` *	string
`updated_at` *	date-time

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/task-dependencies/

Required scopes and service-account permissions: tasks:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. FLEXIBLE SECURITY: For Project-scoped resources (Tasks, Events, Files). Allows both internal Workspace members AND external Project Guests (Clients).

Parameters

Name	Location	Details
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	TaskDependency[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/task-dependencies/

Required scopes and service-account permissions: tasks:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. FLEXIBLE SECURITY: For Project-scoped resources (Tasks, Events, Files). Allows both internal Workspace members AND external Project Guests (Clients).

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`dependency_type`	string	* `FS` - Finish-to-Start * `SS` - Start-to-Start * `FF` - Finish-to-Finish * `SF` - Start-to-Finish Options: FS, SS, FF, SF
`lag_days`	integer
`predecessor_id`	uuid
`successor_id`	uuid

Responses

201 — Success

Field	Type	Details
`dependency_type`	string	* `FS` - Finish-to-Start * `SS` - Start-to-Start * `FF` - Finish-to-Finish * `SF` - Start-to-Finish Options: FS, SS, FF, SF
`id` *	uuid
`lag_days`	integer
`predecessor` *	TaskSimple
`successor` *	TaskSimple

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/projects/{project_id}/task-dependencies/{id}/

Required scopes and service-account permissions: tasks:manage, tasks:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. FLEXIBLE SECURITY: For Project-scoped resources (Tasks, Events, Files). Allows both internal Workspace members AND external Project Guests (Clients).

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/task-dependencies/{id}/

Required scopes and service-account permissions: tasks:read, tasks:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. FLEXIBLE SECURITY: For Project-scoped resources (Tasks, Events, Files). Allows both internal Workspace members AND external Project Guests (Clients).

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`dependency_type`	string	* `FS` - Finish-to-Start * `SS` - Start-to-Start * `FF` - Finish-to-Finish * `SF` - Start-to-Finish Options: FS, SS, FF, SF
`id` *	uuid
`lag_days`	integer
`predecessor` *	TaskSimple
`successor` *	TaskSimple

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/projects/{project_id}/task-dependencies/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`dependency_type`	string	* `FS` - Finish-to-Start * `SS` - Start-to-Start * `FF` - Finish-to-Finish * `SF` - Start-to-Finish Options: FS, SS, FF, SF
`lag_days`	integer
`predecessor_id`	uuid
`successor_id`	uuid

Responses

200 — Success

Field	Type	Details
`dependency_type`	string	* `FS` - Finish-to-Start * `SS` - Start-to-Start * `FF` - Finish-to-Finish * `SF` - Start-to-Finish Options: FS, SS, FF, SF
`id` *	uuid
`lag_days`	integer
`predecessor` *	TaskSimple
`successor` *	TaskSimple

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/tasks/

Parameters

Name	Location	Details
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	TaskList[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/tasks/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`actual_end_date`	date
`actual_start_date`	date
`all_day`	boolean
`assignee_ids`	uuid[]
`audience_type`	string	* `builder_internal` - Builder staff * `builder_team` - Builder side * `builder_client` - Builder and client teams * `client_team` - Client team * `everyone` - Everyone on this job * `selected_people` - Selected people Options: builder_internal, builder_team, builder_client, client_team, everyone, selected_people
`checklist_items`	JSON	A list of simple checklist sub-items for this task.
`completion_policy`	string	Leave blank to use the workspace default. * `none` - No evidence required * `note` - Note required * `file` - Photo or file required * `note_or_file` - Note or photo/file required * `note_and_file` - Note and photo/file required Options: none, note, file, note_or_file, note_and_file, ,
`constraint_date`	date
`constraint_type`	string	* `as_soon_as_possible` - As soon as possible * `as_late_as_possible` - As late as possible * `must_start_on` - Must start on * `must_finish_on` - Must finish on * `start_no_earlier_than` - Start no earlier than * `finish_no_later_than` - Finish no later than Options: as_soon_as_possible, as_late_as_possible, must_start_on, must_finish_on, start_no_earlier_than, finish_no_later_than, ,
`description`	string
`due_date`	date
`duration_days`	integer
`end_date`	date
`end_time`	time
`estimate_location_id`	uuid
`file_ids`	uuid[]	Set the attached files for this task
`is_date_locked`	boolean	If True, this task's dates will not be automatically adjusted by dependencies.
`is_milestone`	boolean	If True, this task is a major project milestone.
`is_private`	boolean
`name` *	string
`order`	integer	The order of the task in a list view.
`parent_id`	uuid
`predecessors`	PredecessorInputRequest[]
`progress`	integer
`resolved_completion_policy`	JSON	Computed JSON value; may be null when access is restricted.
`selected_user_ids`	JSON
`show_on_calendar`	boolean	If True, this task appears on the user and project calendars.
`show_on_gantt`	boolean	If True, this task appears on the project Gantt chart.
`source_quote_line_item`	uuid
`source_quote_number`	JSON	Computed JSON value; may be null when access is restricted.
`source_timeline_entry_id`	uuid
`start_date`	date
`start_time`	time
`status`	string	* `todo` - To Do * `in_progress` - In Progress * `done` - Done * `on_hold` - On Hold * `overdue` - Overdue * `blocked` - Blocked Options: todo, in_progress, done, on_hold, overdue, blocked
`task_type_id`	uuid
`value`	decimal

Responses

201 — Success

Field	Type	Details
`actual_end_date`	date
`actual_start_date`	date
`all_day`	boolean
`assignees` *	UserPublic[]
`attached_files` *	FileDetail[]
`audience_type`	string	* `builder_internal` - Builder staff * `builder_team` - Builder side * `builder_client` - Builder and client teams * `client_team` - Client team * `everyone` - Everyone on this job * `selected_people` - Selected people Options: builder_internal, builder_team, builder_client, client_team, everyone, selected_people
`checklist_items`	JSON	A list of simple checklist sub-items for this task.
`completed_at` *	date-time
`completion_policy`	string	Leave blank to use the workspace default. * `none` - No evidence required * `note` - Note required * `file` - Photo or file required * `note_or_file` - Note or photo/file required * `note_and_file` - Note and photo/file required Options: none, note, file, note_or_file, note_and_file, ,
`constraint_date`	date
`constraint_type`	string	* `as_soon_as_possible` - As soon as possible * `as_late_as_possible` - As late as possible * `must_start_on` - Must start on * `must_finish_on` - Must finish on * `start_no_earlier_than` - Start no earlier than * `finish_no_later_than` - Finish no later than Options: as_soon_as_possible, as_late_as_possible, must_start_on, must_finish_on, start_no_earlier_than, finish_no_later_than, ,
`created_at` *	date-time
`created_by` *	uuid
`deleted_at` *	date-time
`deleted_by` *	uuid
`dependency_predecessors` *	TaskDependency[]
`dependency_successors` *	TaskDependency[]
`description`	string
`due_date`	date
`duration_days`	integer
`end_date`	date
`end_time`	time
`estimate_location_id`	uuid
`estimate_location_name`	string
`id` *	uuid
`is_date_locked`	boolean	If True, this task's dates will not be automatically adjusted by dependencies.
`is_deleted` *	boolean
`is_milestone`	boolean	If True, this task is a major project milestone.
`is_private`	boolean
`name` *	string
`order`	integer	The order of the task in a list view.
`parent` *	ParentTask
`progress`	integer
`project` *	uuid
`resolved_completion_policy`	JSON	Computed JSON value; may be null when access is restricted.
`schedule_predecessors` *	ScheduleDependency[]
`selected_user_ids`	JSON
`show_on_calendar`	boolean	If True, this task appears on the user and project calendars.
`show_on_gantt`	boolean	If True, this task appears on the project Gantt chart.
`source_quote_line_item`	uuid
`source_quote_number`	JSON	Computed JSON value; may be null when access is restricted.
`source_timeline_entry_id`	uuid
`start_date`	date
`start_time`	time
`status`	string	* `todo` - To Do * `in_progress` - In Progress * `done` - Done * `on_hold` - On Hold * `overdue` - Overdue * `blocked` - Blocked Options: todo, in_progress, done, on_hold, overdue, blocked
`sub_tasks` *	SubTask[]
`task_type` *	TaskType
`updated_at` *	date-time
`value`	decimal

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/projects/{project_id}/tasks/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/tasks/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`actual_end_date`	date
`actual_start_date`	date
`all_day`	boolean
`assignees` *	UserPublic[]
`attached_files` *	FileDetail[]
`audience_type`	string	* `builder_internal` - Builder staff * `builder_team` - Builder side * `builder_client` - Builder and client teams * `client_team` - Client team * `everyone` - Everyone on this job * `selected_people` - Selected people Options: builder_internal, builder_team, builder_client, client_team, everyone, selected_people
`checklist_items`	JSON	A list of simple checklist sub-items for this task.
`completed_at` *	date-time
`completion_policy`	string	Leave blank to use the workspace default. * `none` - No evidence required * `note` - Note required * `file` - Photo or file required * `note_or_file` - Note or photo/file required * `note_and_file` - Note and photo/file required Options: none, note, file, note_or_file, note_and_file, ,
`constraint_date`	date
`constraint_type`	string	* `as_soon_as_possible` - As soon as possible * `as_late_as_possible` - As late as possible * `must_start_on` - Must start on * `must_finish_on` - Must finish on * `start_no_earlier_than` - Start no earlier than * `finish_no_later_than` - Finish no later than Options: as_soon_as_possible, as_late_as_possible, must_start_on, must_finish_on, start_no_earlier_than, finish_no_later_than, ,
`created_at` *	date-time
`created_by` *	uuid
`deleted_at` *	date-time
`deleted_by` *	uuid
`dependency_predecessors` *	TaskDependency[]
`dependency_successors` *	TaskDependency[]
`description`	string
`due_date`	date
`duration_days`	integer
`end_date`	date
`end_time`	time
`estimate_location_id`	uuid
`estimate_location_name`	string
`id` *	uuid
`is_date_locked`	boolean	If True, this task's dates will not be automatically adjusted by dependencies.
`is_deleted` *	boolean
`is_milestone`	boolean	If True, this task is a major project milestone.
`is_private`	boolean
`name` *	string
`order`	integer	The order of the task in a list view.
`parent` *	ParentTask
`progress`	integer
`project` *	uuid
`resolved_completion_policy`	JSON	Computed JSON value; may be null when access is restricted.
`schedule_predecessors` *	ScheduleDependency[]
`selected_user_ids`	JSON
`show_on_calendar`	boolean	If True, this task appears on the user and project calendars.
`show_on_gantt`	boolean	If True, this task appears on the project Gantt chart.
`source_quote_line_item`	uuid
`source_quote_number`	JSON	Computed JSON value; may be null when access is restricted.
`source_timeline_entry_id`	uuid
`start_date`	date
`start_time`	time
`status`	string	* `todo` - To Do * `in_progress` - In Progress * `done` - Done * `on_hold` - On Hold * `overdue` - Overdue * `blocked` - Blocked Options: todo, in_progress, done, on_hold, overdue, blocked
`sub_tasks` *	SubTask[]
`task_type` *	TaskType
`updated_at` *	date-time
`value`	decimal

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/projects/{project_id}/tasks/{id}/

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`actual_end_date`	date
`actual_start_date`	date
`all_day`	boolean
`assignee_ids`	uuid[]
`audience_type`	string	* `builder_internal` - Builder staff * `builder_team` - Builder side * `builder_client` - Builder and client teams * `client_team` - Client team * `everyone` - Everyone on this job * `selected_people` - Selected people Options: builder_internal, builder_team, builder_client, client_team, everyone, selected_people
`checklist_items`	JSON	A list of simple checklist sub-items for this task.
`completion_policy`	string	Leave blank to use the workspace default. * `none` - No evidence required * `note` - Note required * `file` - Photo or file required * `note_or_file` - Note or photo/file required * `note_and_file` - Note and photo/file required Options: none, note, file, note_or_file, note_and_file, ,
`constraint_date`	date
`constraint_type`	string	* `as_soon_as_possible` - As soon as possible * `as_late_as_possible` - As late as possible * `must_start_on` - Must start on * `must_finish_on` - Must finish on * `start_no_earlier_than` - Start no earlier than * `finish_no_later_than` - Finish no later than Options: as_soon_as_possible, as_late_as_possible, must_start_on, must_finish_on, start_no_earlier_than, finish_no_later_than, ,
`description`	string
`due_date`	date
`duration_days`	integer
`end_date`	date
`end_time`	time
`estimate_location_id`	uuid
`file_ids`	uuid[]	Set the attached files for this task
`is_date_locked`	boolean	If True, this task's dates will not be automatically adjusted by dependencies.
`is_milestone`	boolean	If True, this task is a major project milestone.
`is_private`	boolean
`name`	string
`order`	integer	The order of the task in a list view.
`parent_id`	uuid
`predecessors`	PredecessorInputRequest[]
`progress`	integer
`resolved_completion_policy`	JSON	Computed JSON value; may be null when access is restricted.
`selected_user_ids`	JSON
`show_on_calendar`	boolean	If True, this task appears on the user and project calendars.
`show_on_gantt`	boolean	If True, this task appears on the project Gantt chart.
`source_quote_line_item`	uuid
`source_quote_number`	JSON	Computed JSON value; may be null when access is restricted.
`source_timeline_entry_id`	uuid
`start_date`	date
`start_time`	time
`status`	string	* `todo` - To Do * `in_progress` - In Progress * `done` - Done * `on_hold` - On Hold * `overdue` - Overdue * `blocked` - Blocked Options: todo, in_progress, done, on_hold, overdue, blocked
`task_type_id`	uuid
`value`	decimal

Responses

200 — Success

Field	Type	Details
`actual_end_date`	date
`actual_start_date`	date
`all_day`	boolean
`assignees` *	UserPublic[]
`attached_files` *	FileDetail[]
`audience_type`	string	* `builder_internal` - Builder staff * `builder_team` - Builder side * `builder_client` - Builder and client teams * `client_team` - Client team * `everyone` - Everyone on this job * `selected_people` - Selected people Options: builder_internal, builder_team, builder_client, client_team, everyone, selected_people
`checklist_items`	JSON	A list of simple checklist sub-items for this task.
`completed_at` *	date-time
`completion_policy`	string	Leave blank to use the workspace default. * `none` - No evidence required * `note` - Note required * `file` - Photo or file required * `note_or_file` - Note or photo/file required * `note_and_file` - Note and photo/file required Options: none, note, file, note_or_file, note_and_file, ,
`constraint_date`	date
`constraint_type`	string	* `as_soon_as_possible` - As soon as possible * `as_late_as_possible` - As late as possible * `must_start_on` - Must start on * `must_finish_on` - Must finish on * `start_no_earlier_than` - Start no earlier than * `finish_no_later_than` - Finish no later than Options: as_soon_as_possible, as_late_as_possible, must_start_on, must_finish_on, start_no_earlier_than, finish_no_later_than, ,
`created_at` *	date-time
`created_by` *	uuid
`deleted_at` *	date-time
`deleted_by` *	uuid
`dependency_predecessors` *	TaskDependency[]
`dependency_successors` *	TaskDependency[]
`description`	string
`due_date`	date
`duration_days`	integer
`end_date`	date
`end_time`	time
`estimate_location_id`	uuid
`estimate_location_name`	string
`id` *	uuid
`is_date_locked`	boolean	If True, this task's dates will not be automatically adjusted by dependencies.
`is_deleted` *	boolean
`is_milestone`	boolean	If True, this task is a major project milestone.
`is_private`	boolean
`name` *	string
`order`	integer	The order of the task in a list view.
`parent` *	ParentTask
`progress`	integer
`project` *	uuid
`resolved_completion_policy`	JSON	Computed JSON value; may be null when access is restricted.
`schedule_predecessors` *	ScheduleDependency[]
`selected_user_ids`	JSON
`show_on_calendar`	boolean	If True, this task appears on the user and project calendars.
`show_on_gantt`	boolean	If True, this task appears on the project Gantt chart.
`source_quote_line_item`	uuid
`source_quote_number`	JSON	Computed JSON value; may be null when access is restricted.
`source_timeline_entry_id`	uuid
`start_date`	date
`start_time`	time
`status`	string	* `todo` - To Do * `in_progress` - In Progress * `done` - Done * `on_hold` - On Hold * `overdue` - Overdue * `blocked` - Blocked Options: todo, in_progress, done, on_hold, overdue, blocked
`sub_tasks` *	SubTask[]
`task_type` *	TaskType
`updated_at` *	date-time
`value`	decimal

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/timesheets/

Required scopes and service-account permissions: timesheets:approve, timesheets:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes.

Parameters

Name	Location	Details
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	Timesheet[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/timesheets/{id}/approve/

Required scopes and service-account permissions: timesheets:approve, timesheets:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Block timesheet API when the workspace module is disabled.

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`note`	string

Responses

200 — Success

Field	Type	Details
`approval`	JSON	Computed JSON value; may be null when access is restricted.
`approved_at` *	date-time
`can_edit`	JSON	Computed JSON value; may be null when access is restricted.
`can_submit`	JSON	Computed JSON value; may be null when access is restricted.
`can_unsubmit`	JSON	Computed JSON value; may be null when access is restricted.
`created_at` *	date-time
`entries` *	TimesheetEntry[]
`id` *	uuid
`status` *	string	* `draft` - Draft * `submitted` - Submitted * `approved` - Approved * `rejected` - Rejected Options: draft, submitted, approved, rejected
`submitted_at` *	date-time
`total_hours`	JSON	Computed JSON value; may be null when access is restricted.
`updated_at` *	date-time
`user_id` *	uuid
`user_name`	JSON	Computed JSON value; may be null when access is restricted.
`warnings`	JSON	Computed JSON value; may be null when access is restricted.
`week_end` *	date
`week_start` *	date

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/timesheets/{id}/reject/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`note`	string

Responses

200 — Success

Field	Type	Details
`approval`	JSON	Computed JSON value; may be null when access is restricted.
`approved_at` *	date-time
`can_edit`	JSON	Computed JSON value; may be null when access is restricted.
`can_submit`	JSON	Computed JSON value; may be null when access is restricted.
`can_unsubmit`	JSON	Computed JSON value; may be null when access is restricted.
`created_at` *	date-time
`entries` *	TimesheetEntry[]
`id` *	uuid
`status` *	string	* `draft` - Draft * `submitted` - Submitted * `approved` - Approved * `rejected` - Rejected Options: draft, submitted, approved, rejected
`submitted_at` *	date-time
`total_hours`	JSON	Computed JSON value; may be null when access is restricted.
`updated_at` *	date-time
`user_id` *	uuid
`user_name`	JSON	Computed JSON value; may be null when access is restricted.
`warnings`	JSON	Computed JSON value; may be null when access is restricted.
`week_end` *	date
`week_start` *	date

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/variations/

Required scopes and service-account permissions: variations:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Enforce a workspace capability in addition to RBAC.

Parameters

Name	Location	Details
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	ChangeRequest[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/variations/

Required scopes and service-account permissions: variations:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Enforce a workspace capability in addition to RBAC.

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`addition_pricing_type`	string	Classification for newly added work in instructed value flows. * `none` - Not specified * `quoted` - This adds a new, quoted item * `unquoted` - This adds a new, unquoted item Options: none, quoted, unquoted
`adjusts_existing_work`	boolean
`anticipated_form_reference`	string
`attached_file_ids`	uuid[]
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`authority_certainty`	string	Bucket 1: definitive vs provisional instruction certainty. * `definitive` - Definitive * `provisional` - Provisional Options: definitive, provisional,
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`base_quote`	uuid	The original approved Quote/Agreement this change applies to.
`base_quote_number`	JSON	Computed JSON value; may be null when access is restricted.
`base_quote_title`	JSON	Computed JSON value; may be null when access is restricted.
`builder_proceeds`	boolean	Does the builder agree to proceed?
`builder_reject_reason`	string	Required if builder_proceeds is False.
`builder_signed_at`	date-time
`ca_financial_note`	string	Optional CA note attached when submitting for client financial approval.
`classification_other`	boolean	Other classification selected: requires classification_other_text.
`classification_other_text`	string	Mandatory free text when classification_other is set.
`client_countersigned_at`	date-time
`client_document_reference`	string	Client / CA reference number from the source document, if any.
`communication_method`	string	How the instruction was received (e.g., email, in_person).
`current_sla`	JSON	Computed JSON value; may be null when access is restricted.
`cvr_next_step`	string	CVR: request formal instruction or formal quote. * `request_instruction` - Request client to officially instruct * `request_quote` - Request client to ask for a formal quote Options: request_instruction, request_quote,
`delay_causes`	JSON	Notice of Delay cause checkbox keys.
`delay_narrative`	string	Notice of Delay free-text narrative.
`document_layout_mode`	JSON	Computed JSON value; may be null when access is restricted.
`draft_init`	boolean
`draft_prefill_instruction_text`	string
`effective_workflow_tier`	JSON	Computed JSON value; may be null when access is restricted.
`eot_to_be_determined`	boolean	True if EOT is acknowledged but will be calculated later.
`extension_of_time_days`	integer	Requested adjustment to the completion date (EOT).
`extension_of_time_hours`	decimal	Requested hours of time impact, in addition to extension_of_time_days.
`given_by`	string	Name of the person who gave the instruction.
`given_by_email`	email	Email for the given_by contact when selected from the project directory.
`given_by_member_id`	uuid
`has_public_consent`	JSON	Computed JSON value; may be null when access is restricted.
`impacts_design`	boolean	Does this change the design?
`impacts_quality`	boolean	Does this affect quality standards?
`impacts_quantity`	boolean	Does this change quantities?
`includes_loss_and_expense`	boolean	Does this claim include additional costs for delay/disruption?
`includes_preparation_costs`	boolean	Does this claim include the cost of preparing the quotation?
`initiation_route`	string	Stable create-route id used to tailor the editable detail view.
`instruction_text`	string	The core instruction given.
`is_addition`	boolean
`is_omission`	boolean
`is_proxy`	boolean	Whether this record was logged on behalf of another party.
`is_substitution`	boolean
`lead_time_dependent`	boolean	Material or specialist lead-time dependency on a simple CVI/CVR/proposal.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_impact`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`payment_timing`	string	Consumer/unadministered: how the variation will be paid. * `invoice_now` - Invoice immediately as a standalone item * `next_stage` - Add to the next stage payment * `final_invoice` - Add to the final project invoice Options: invoice_now, next_stage, final_invoice,
`pci_type`	string	Budget PCI purpose when estimating is on. Empty = paper-only change. * `CLIENT_VARIATION` - Client variation * `INTERNAL_SPEC` - Internal specification change * `PROV_SUM_EXPEND` - Provisional sum expend * `RISK_RELEASE` - Risk / contingency release Options: CLIENT_VARIATION, INTERNAL_SPEC, PROV_SUM_EXPEND, RISK_RELEASE,
`price_agreed_before_start`	boolean	True if price is agreed before work commences, False if proceeding immediately.
`pricing_strategy`	string	Explicit pricing pathway; synced with price_agreed_before_start. * `price_upfront` - Price upfront before work starts * `valuation_method` - Agree a method of valuation * `price_later` - Proceed immediately, price later Options: price_upfront, valuation_method, price_later,
`quote_validity_days`	integer	Validity period (days) when builder submits a quotation.
`quoted_source_quote`	uuid	If this change adds a new quoted item, link the source quote.
`reason`	string	Why is this change happening?
`reason_codes`	JSON	Simple CVI/CVR/proposal reason tick keys.
`reason_other_text`	string
`received_by`	string
`received_by_email`	email
`received_by_member_id`	uuid
`remove_attached_file_ids`	uuid[]
`request_date`	date
`request_time`	time	Time the verbal instruction/request was given.
`request_type`	string	* `request` - Variation Request * `instruction` - Variation Instruction * `early_warning` - Early Warning * `notice_of_delay` - Notice of Delay * `quote_request` - Quote Request * `confirmation` - CVI * `cvi` - Confirmation of Verbal Instruction (CVI) * `cvr` - Confirmation of Verbal Request (CVR) * `change_order` - Change Order * `potential_change_order` - Potential Change Order * `field_directive` - Field Directive Options: request, instruction, early_warning, notice_of_delay, quote_request, confirmation, cvi, cvr, change_order, potential_change_order, field_directive
`response_deadline`	date-time	The deadline for the client/builder to respond before default acceptance/rejection.
`restocking_fees`	decimal	Consumer contracts: restocking / non-refundable deposits.
`resulting_variation_invoice_count`	JSON	Computed JSON value; may be null when access is restricted.
`revised_completion_date`	date	Requested revised completion / working-period end date.
`risk_contingency_value`	decimal	Early warning approximate risk / contingency value.
`signature_loop_stage`	string	* `none` - Not required * `awaiting_builder` - Awaiting builder signature * `awaiting_client` - Awaiting client countersignature * `complete` - Fully signed Options: none, awaiting_builder, awaiting_client, complete,
`simple_issuer_contact`	string
`simple_issuer_contact_email`	email
`simple_issuer_contact_member_id`	uuid
`simple_paper_kind`	JSON	Computed JSON value; may be null when access is restricted.
`simple_price_certainty`	string	Simple workflow: fixed, estimated/indicative, quote requested, no price change, or not assessed. * `fixed` - Fixed price * `estimated` - Estimated / Indicative * `quote_requested` - Quote Requested * `no_price_change` - No price change * `not_assessed` - Not assessed Options: fixed, estimated, quote_requested, no_price_change, not_assessed,
`simple_recipient`	string
`simple_recipient_email`	email
`simple_recipient_member_id`	uuid
`simple_time_certainty`	string	Simple workflow: estimated, definitive / fixed, post-completion, or no time impact. * `estimated` - Estimated / Indicative * `definitive` - Definitive / Fixed * `post_completion` - Assessed / agreed post-completion * `not_assessed` - No time impact Options: estimated, definitive, post_completion, not_assessed,
`sla_deadlines`	JSON	Computed JSON value; may be null when access is restricted.
`source_document_type`	string	Client-issued instruction: type of source document received. * `architect_instruction` - Architect's Instruction (AI/CAI) * `signed_change_agreement` - Signed Change / Variation Agreement * `quote_request` - Quote Request * `site_direction_minutes` - Site Direction / Meeting Minutes * `email_confirmation` - Email Confirmation Options: architect_instruction, signed_change_agreement, quote_request, site_direction_minutes, email_confirmation,
`source_site_log`	uuid
`source_site_log_cost_impact_type`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_date`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_delay_days`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_estimated_cost_amount`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_estimated_cost_currency`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_recommendation`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_responsible_party`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_risk_level`	JSON	Computed JSON value; may be null when access is restricted.
`source_timeline_entry`	uuid
`source_timeline_entry_preview`	JSON	Computed JSON value; may be null when access is restricted.
`status`	string	* `registered` - Draft / Registered * `issued` - Issued / Submitted * `issued_validated` - Instruction Validated * `issued_not_valid` - Instruction Invalid * `rejected_by_builder` - Rejected by Builder * `being_priced` - Pricing in Progress * `pricing_submitted` - Pricing Submitted * `price_agreed` - Price Agreed * `price_rejected` - Price Rejected * `terms_agreed` - Variation Approved * `terms_rejected` - Variation Rejected * `being_repriced` - Repricing in Progress * `priced_by_client` - To be Priced by Client * `terms_renegotiated` - Terms being Renegotiated * `cancelled` - Cancelled * `claimed` - Claimed * `paid` - Paid * `pending_client_financial` - Pending Client Financial Approval * `awaiting_external_ca_auth` - Awaiting External CA Authorization * `pending_ca_triage` - Pending CA Review Options: registered, issued, issued_validated, issued_not_valid, rejected_by_builder, being_priced, pricing_submitted, price_agreed, price_rejected, terms_agreed, terms_rejected, being_repriced, priced_by_client, terms_renegotiated, cancelled, claimed, paid, pending_client_financial, awaiting_external_ca_auth, pending_ca_triage
`status_label`	JSON	Computed JSON value; may be null when access is restricted.
`title` *	string	Short summary of the instruction.
`valuation_basis`	string	Legacy single valuation method. Prefer valuation_methods.
`valuation_markup_percent`	decimal	Markup percent when valuation_basis is actual cost + markup.
`valuation_method_terms`	string	Agreed valuation method terms (dayworks, schedule of rates, etc.).
`valuation_methods`	JSON	Ordered proposed valuation methods (priority 1, 2, 3).
`variation_group`	string	Logical grouping for filters (warning, instruction, request, confirmation, advisory).
`workflow_tier`	string	UI workflow tier for this record; upgrade from simple to comprehensive. * `simple` - Simple * `comprehensive` - Comprehensive Options: simple, comprehensive

Responses

201 — Success

Field	Type	Details
`addition_pricing_type`	string	Classification for newly added work in instructed value flows. * `none` - Not specified * `quoted` - This adds a new, quoted item * `unquoted` - This adds a new, unquoted item Options: none, quoted, unquoted
`adjusts_existing_work`	boolean
`anticipated_form_reference`	string
`attached_files` *	FileDetail[]
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`authority_certainty`	string	Bucket 1: definitive vs provisional instruction certainty. * `definitive` - Definitive * `provisional` - Provisional Options: definitive, provisional,
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`base_quote`	uuid	The original approved Quote/Agreement this change applies to.
`base_quote_number`	JSON	Computed JSON value; may be null when access is restricted.
`base_quote_title`	JSON	Computed JSON value; may be null when access is restricted.
`builder_proceeds`	boolean	Does the builder agree to proceed?
`builder_reject_reason`	string	Required if builder_proceeds is False.
`builder_signed_at`	date-time
`ca_financial_note`	string	Optional CA note attached when submitting for client financial approval.
`classification_other`	boolean	Other classification selected: requires classification_other_text.
`classification_other_text`	string	Mandatory free text when classification_other is set.
`client_countersigned_at`	date-time
`client_document_reference`	string	Client / CA reference number from the source document, if any.
`communication_method`	string	How the instruction was received (e.g., email, in_person).
`created_at` *	date-time
`current_sla`	JSON	Computed JSON value; may be null when access is restricted.
`cvr_next_step`	string	CVR: request formal instruction or formal quote. * `request_instruction` - Request client to officially instruct * `request_quote` - Request client to ask for a formal quote Options: request_instruction, request_quote,
`delay_causes`	JSON	Notice of Delay cause checkbox keys.
`delay_narrative`	string	Notice of Delay free-text narrative.
`document_layout_mode`	JSON	Computed JSON value; may be null when access is restricted.
`effective_workflow_tier`	JSON	Computed JSON value; may be null when access is restricted.
`entered_by` *	uuid
`eot_to_be_determined`	boolean	True if EOT is acknowledged but will be calculated later.
`extension_of_time_days`	integer	Requested adjustment to the completion date (EOT).
`extension_of_time_hours`	decimal	Requested hours of time impact, in addition to extension_of_time_days.
`given_by`	string	Name of the person who gave the instruction.
`given_by_email`	email	Email for the given_by contact when selected from the project directory.
`given_by_member_id`	uuid
`has_public_consent`	JSON	Computed JSON value; may be null when access is restricted.
`id` *	uuid
`impacts_design`	boolean	Does this change the design?
`impacts_quality`	boolean	Does this affect quality standards?
`impacts_quantity`	boolean	Does this change quantities?
`includes_loss_and_expense`	boolean	Does this claim include additional costs for delay/disruption?
`includes_preparation_costs`	boolean	Does this claim include the cost of preparing the quotation?
`initiation_route`	string	Stable create-route id used to tailor the editable detail view.
`instruction_text`	string	The core instruction given.
`is_addition`	boolean
`is_omission`	boolean
`is_proxy`	boolean	Whether this record was logged on behalf of another party.
`is_substitution`	boolean
`items` *	ChangeItem[]
`lead_time_dependent`	boolean	Material or specialist lead-time dependency on a simple CVI/CVR/proposal.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_impact`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`payment_timing`	string	Consumer/unadministered: how the variation will be paid. * `invoice_now` - Invoice immediately as a standalone item * `next_stage` - Add to the next stage payment * `final_invoice` - Add to the final project invoice Options: invoice_now, next_stage, final_invoice,
`pci_type`	string	Budget PCI purpose when estimating is on. Empty = paper-only change. * `CLIENT_VARIATION` - Client variation * `INTERNAL_SPEC` - Internal specification change * `PROV_SUM_EXPEND` - Provisional sum expend * `RISK_RELEASE` - Risk / contingency release Options: CLIENT_VARIATION, INTERNAL_SPEC, PROV_SUM_EXPEND, RISK_RELEASE,
`price_agreed_before_start`	boolean	True if price is agreed before work commences, False if proceeding immediately.
`pricing_strategy`	string	Explicit pricing pathway; synced with price_agreed_before_start. * `price_upfront` - Price upfront before work starts * `valuation_method` - Agree a method of valuation * `price_later` - Proceed immediately, price later Options: price_upfront, valuation_method, price_later,
`project` *	uuid
`project_name` *	string	Name of the project.
`quote_validity_days`	integer	Validity period (days) when builder submits a quotation.
`quoted_source_quote`	uuid	If this change adds a new quoted item, link the source quote.
`reason`	string	Why is this change happening?
`reason_codes`	JSON	Simple CVI/CVR/proposal reason tick keys.
`reason_other_text`	string
`received_by`	string
`received_by_email`	email
`received_by_member_id`	uuid
`register_number` *	string	Stable display ref e.g. CHG-001. Terminology labels are separate.
`register_sequence` *	integer	Project-scoped sequence used to build register_number.
`request_date`	date
`request_time`	time	Time the verbal instruction/request was given.
`request_type`	string	* `request` - Variation Request * `instruction` - Variation Instruction * `early_warning` - Early Warning * `notice_of_delay` - Notice of Delay * `quote_request` - Quote Request * `confirmation` - CVI * `cvi` - Confirmation of Verbal Instruction (CVI) * `cvr` - Confirmation of Verbal Request (CVR) * `change_order` - Change Order * `potential_change_order` - Potential Change Order * `field_directive` - Field Directive Options: request, instruction, early_warning, notice_of_delay, quote_request, confirmation, cvi, cvr, change_order, potential_change_order, field_directive
`response_deadline`	date-time	The deadline for the client/builder to respond before default acceptance/rejection.
`restocking_fees`	decimal	Consumer contracts: restocking / non-refundable deposits.
`restocking_fees_currency` *	string	* `XUA` - ADB Unit of Account * `AFN` - Afghan Afghani * `AFA` - Afghan Afghani (1927–2002) * `ALL` - Albanian Lek * `ALK` - Albanian Lek (1946–1965) * `DZD` - Algerian Dinar * `ADP` - Andorran Peseta * `AOA` - Angolan Kwanza * `AOK` - Angolan Kwanza (1977–1991) * `AON` - Angolan New Kwanza (1990–2000) * `AOR` - Angolan Readjusted Kwanza (1995–1999) * `ARA` - Argentine Austral * `ARS` - Argentine Peso * `ARM` - Argentine Peso (1881–1970) * `ARP` - Argentine Peso (1983–1985) * `ARL` - Argentine Peso Ley (1970–1983) * `AMD` - Armenian Dram * `AWG` - Aruban Florin * `AUD` - Australian Dollar * `ATS` - Austrian Schilling * `AZN` - Azerbaijani Manat * `AZM` - Azerbaijani Manat (1993–2006) * `BSD` - Bahamian Dollar * `BHD` - Bahraini Dinar * `BDT` - Bangladeshi Taka * `BBD` - Barbadian Dollar * `BYN` - Belarusian Ruble * `BYB` - Belarusian Ruble (1994–1999) * `BYR` - Belarusian Ruble (2000–2016) * `BEF` - Belgian Franc * `BEC` - Belgian Franc (convertible) * `BEL` - Belgian Franc (financial) * `BZD` - Belize Dollar * `BMD` - Bermudan Dollar * `BTN` - Bhutanese Ngultrum * `BOB` - Bolivian Boliviano * `BOL` - Bolivian Boliviano (1863–1963) * `BOV` - Bolivian Mvdol * `BOP` - Bolivian Peso * `VED` - Bolívar Soberano * `BAM` - Bosnia-Herzegovina Convertible Mark * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) * `BWP` - Botswanan Pula * `BRC` - Brazilian Cruzado (1986–1989) * `BRZ` - Brazilian Cruzeiro (1942–1967) * `BRE` - Brazilian Cruzeiro (1990–1993) * `BRR` - Brazilian Cruzeiro (1993–1994) * `BRN` - Brazilian New Cruzado (1989–1990) * `BRB` - Brazilian New Cruzeiro (1967–1986) * `BRL` - Brazilian Real * `GBP` - British Pound * `BND` - Brunei Dollar * `BGL` - Bulgarian Hard Lev * `BGN` - Bulgarian Lev * `BGO` - Bulgarian Lev (1879–1952) * `BGM` - Bulgarian Socialist Lev * `BUK` - Burmese Kyat * `BIF` - Burundian Franc * `XPF` - CFP Franc * `KHR` - Cambodian Riel * `CAD` - Canadian Dollar * `CVE` - Cape Verdean Escudo * `KYD` - Cayman Islands Dollar * `XAF` - Central African CFA Franc * `CLE` - Chilean Escudo * `CLP` - Chilean Peso * `CLF` - Chilean Unit of Account (UF) * `CNX` - Chinese People’s Bank Dollar * `CNY` - Chinese Yuan * `CNH` - Chinese Yuan (offshore) * `COP` - Colombian Peso * `COU` - Colombian Real Value Unit * `KMF` - Comorian Franc * `CDF` - Congolese Franc * `CRC` - Costa Rican Colón * `HRD` - Croatian Dinar * `HRK` - Croatian Kuna * `CUC` - Cuban Convertible Peso * `CUP` - Cuban Peso * `CYP` - Cypriot Pound * `CZK` - Czech Koruna * `CSK` - Czechoslovak Hard Koruna * `DKK` - Danish Krone * `DJF` - Djiboutian Franc * `DOP` - Dominican Peso * `NLG` - Dutch Guilder * `XCD` - East Caribbean Dollar * `DDM` - East German Mark * `ECS` - Ecuadorian Sucre * `ECV` - Ecuadorian Unit of Constant Value * `EGP` - Egyptian Pound * `GQE` - Equatorial Guinean Ekwele * `ERN` - Eritrean Nakfa * `EEK` - Estonian Kroon * `ETB` - Ethiopian Birr * `EUR` - Euro * `XBA` - European Composite Unit * `XEU` - European Currency Unit * `XBB` - European Monetary Unit * `XBC` - European Unit of Account (XBC) * `XBD` - European Unit of Account (XBD) * `FKP` - Falkland Islands Pound * `FJD` - Fijian Dollar * `FIM` - Finnish Markka * `FRF` - French Franc * `XFO` - French Gold Franc * `XFU` - French UIC-Franc * `GMD` - Gambian Dalasi * `GEK` - Georgian Kupon Larit * `GEL` - Georgian Lari * `DEM` - German Mark * `GHS` - Ghanaian Cedi * `GHC` - Ghanaian Cedi (1979–2007) * `GIP` - Gibraltar Pound * `XAU` - Gold * `GRD` - Greek Drachma * `GTQ` - Guatemalan Quetzal * `GWP` - Guinea-Bissau Peso * `GNF` - Guinean Franc * `GNS` - Guinean Syli * `GYD` - Guyanaese Dollar * `HTG` - Haitian Gourde * `HNL` - Honduran Lempira * `HKD` - Hong Kong Dollar * `HUF` - Hungarian Forint * `IMP` - IMP * `ISK` - Icelandic Króna * `ISJ` - Icelandic Króna (1918–1981) * `INR` - Indian Rupee * `IDR` - Indonesian Rupiah * `IRR` - Iranian Rial * `IQD` - Iraqi Dinar * `IEP` - Irish Pound * `ILS` - Israeli New Shekel * `ILP` - Israeli Pound * `ILR` - Israeli Shekel (1980–1985) * `ITL` - Italian Lira * `JMD` - Jamaican Dollar * `JPY` - Japanese Yen * `JOD` - Jordanian Dinar * `KZT` - Kazakhstani Tenge * `KES` - Kenyan Shilling * `KWD` - Kuwaiti Dinar * `KGS` - Kyrgystani Som * `LAK` - Laotian Kip * `LVL` - Latvian Lats * `LVR` - Latvian Ruble * `LBP` - Lebanese Pound * `LSL` - Lesotho Loti * `LRD` - Liberian Dollar * `LYD` - Libyan Dinar * `LTL` - Lithuanian Litas * `LTT` - Lithuanian Talonas * `LUL` - Luxembourg Financial Franc * `LUC` - Luxembourgian Convertible Franc * `LUF` - Luxembourgian Franc * `MOP` - Macanese Pataca * `MKD` - Macedonian Denar * `MKN` - Macedonian Denar (1992–1993) * `MGA` - Malagasy Ariary * `MGF` - Malagasy Franc * `MWK` - Malawian Kwacha * `MYR` - Malaysian Ringgit * `MVR` - Maldivian Rufiyaa * `MVP` - Maldivian Rupee (1947–1981) * `MLF` - Malian Franc * `MTL` - Maltese Lira * `MTP` - Maltese Pound * `MRU` - Mauritanian Ouguiya * `MRO` - Mauritanian Ouguiya (1973–2017) * `MUR` - Mauritian Rupee * `MXV` - Mexican Investment Unit * `MXN` - Mexican Peso * `MXP` - Mexican Silver Peso (1861–1992) * `MDC` - Moldovan Cupon * `MDL` - Moldovan Leu * `MCF` - Monegasque Franc * `MNT` - Mongolian Tugrik * `MAD` - Moroccan Dirham * `MAF` - Moroccan Franc * `MZE` - Mozambican Escudo * `MZN` - Mozambican Metical * `MZM` - Mozambican Metical (1980–2006) * `MMK` - Myanmar Kyat * `NAD` - Namibian Dollar * `NPR` - Nepalese Rupee * `ANG` - Netherlands Antillean Guilder * `TWD` - New Taiwan Dollar * `NZD` - New Zealand Dollar * `NIO` - Nicaraguan Córdoba * `NIC` - Nicaraguan Córdoba (1988–1991) * `NGN` - Nigerian Naira * `KPW` - North Korean Won * `NOK` - Norwegian Krone * `OMR` - Omani Rial * `PKR` - Pakistani Rupee * `XPD` - Palladium * `PAB` - Panamanian Balboa * `PGK` - Papua New Guinean Kina * `PYG` - Paraguayan Guarani * `PEI` - Peruvian Inti * `PEN` - Peruvian Sol * `PES` - Peruvian Sol (1863–1965) * `PHP` - Philippine Peso * `XPT` - Platinum * `PLN` - Polish Zloty * `PLZ` - Polish Zloty (1950–1995) * `PTE` - Portuguese Escudo * `GWE` - Portuguese Guinea Escudo * `QAR` - Qatari Riyal * `XRE` - RINET Funds * `RHD` - Rhodesian Dollar * `RON` - Romanian Leu * `ROL` - Romanian Leu (1952–2006) * `RUB` - Russian Ruble * `RUR` - Russian Ruble (1991–1998) * `RWF` - Rwandan Franc * `SVC` - Salvadoran Colón * `WST` - Samoan Tala * `SAR` - Saudi Riyal * `RSD` - Serbian Dinar * `CSD` - Serbian Dinar (2002–2006) * `SCR` - Seychellois Rupee * `SLE` - Sierra Leonean Leone * `SLL` - Sierra Leonean Leone (1964—2022) * `XAG` - Silver * `SGD` - Singapore Dollar * `SKK` - Slovak Koruna * `SIT` - Slovenian Tolar * `SBD` - Solomon Islands Dollar * `SOS` - Somali Shilling * `ZAR` - South African Rand * `ZAL` - South African Rand (financial) * `KRH` - South Korean Hwan (1953–1962) * `KRW` - South Korean Won * `KRO` - South Korean Won (1945–1953) * `SSP` - South Sudanese Pound * `SUR` - Soviet Rouble * `ESP` - Spanish Peseta * `ESA` - Spanish Peseta (A account) * `ESB` - Spanish Peseta (convertible account) * `XDR` - Special Drawing Rights * `LKR` - Sri Lankan Rupee * `SHP` - St. Helena Pound * `XSU` - Sucre * `SDD` - Sudanese Dinar (1992–2007) * `SDG` - Sudanese Pound * `SDP` - Sudanese Pound (1957–1998) * `SRD` - Surinamese Dollar * `SRG` - Surinamese Guilder * `SZL` - Swazi Lilangeni * `SEK` - Swedish Krona * `CHF` - Swiss Franc * `SYP` - Syrian Pound * `STN` - São Tomé & Príncipe Dobra * `STD` - São Tomé & Príncipe Dobra (1977–2017) * `TVD` - TVD * `TJR` - Tajikistani Ruble * `TJS` - Tajikistani Somoni * `TZS` - Tanzanian Shilling * `XTS` - Testing Currency Code * `THB` - Thai Baht * `TPE` - Timorese Escudo * `TOP` - Tongan Paʻanga * `TTD` - Trinidad & Tobago Dollar * `TND` - Tunisian Dinar * `TRY` - Turkish Lira * `TRL` - Turkish Lira (1922–2005) * `TMT` - Turkmenistani Manat * `TMM` - Turkmenistani Manat (1993–2009) * `USD` - US Dollar * `USN` - US Dollar (Next day) * `USS` - US Dollar (Same day) * `UGX` - Ugandan Shilling * `UGS` - Ugandan Shilling (1966–1987) * `UAH` - Ukrainian Hryvnia * `UAK` - Ukrainian Karbovanets * `AED` - United Arab Emirates Dirham * `UYW` - Uruguayan Nominal Wage Index Unit * `UYU` - Uruguayan Peso * `UYP` - Uruguayan Peso (1975–1993) * `UYI` - Uruguayan Peso (Indexed Units) * `UZS` - Uzbekistani Som * `VUV` - Vanuatu Vatu * `VES` - Venezuelan Bolívar * `VEB` - Venezuelan Bolívar (1871–2008) * `VEF` - Venezuelan Bolívar (2008–2018) * `VND` - Vietnamese Dong * `VNN` - Vietnamese Dong (1978–1985) * `CHE` - WIR Euro * `CHW` - WIR Franc * `XOF` - West African CFA Franc * `YDD` - Yemeni Dinar * `YER` - Yemeni Rial * `YUN` - Yugoslavian Convertible Dinar (1990–1992) * `YUD` - Yugoslavian Hard Dinar (1966–1990) * `YUM` - Yugoslavian New Dinar (1994–2002) * `YUR` - Yugoslavian Reformed Dinar (1992–1993) * `ZWN` - ZWN * `ZRN` - Zairean New Zaire (1993–1998) * `ZRZ` - Zairean Zaire (1971–1993) * `ZMW` - Zambian Kwacha * `ZMK` - Zambian Kwacha (1968–2012) * `ZWD` - Zimbabwean Dollar (1980–2008) * `ZWR` - Zimbabwean Dollar (2008) * `ZWL` - Zimbabwean Dollar (2009–2024) Options: XUA, AFN, AFA, ALL, ALK, DZD, ADP, AOA, AOK, AON, AOR, ARA, ARS, ARM, ARP, ARL, AMD, AWG, AUD, ATS, AZN, AZM, BSD, BHD, BDT, BBD, BYN, BYB, BYR, BEF, BEC, BEL, BZD, BMD, BTN, BOB, BOL, BOV, BOP, VED, BAM, BAD, BAN, BWP, BRC, BRZ, BRE, BRR, BRN, BRB, BRL, GBP, BND, BGL, BGN, BGO, BGM, BUK, BIF, XPF, KHR, CAD, CVE, KYD, XAF, CLE, CLP, CLF, CNX, CNY, CNH, COP, COU, KMF, CDF, CRC, HRD, HRK, CUC, CUP, CYP, CZK, CSK, DKK, DJF, DOP, NLG, XCD, DDM, ECS, ECV, EGP, GQE, ERN, EEK, ETB, EUR, XBA, XEU, XBB, XBC, XBD, FKP, FJD, FIM, FRF, XFO, XFU, GMD, GEK, GEL, DEM, GHS, GHC, GIP, XAU, GRD, GTQ, GWP, GNF, GNS, GYD, HTG, HNL, HKD, HUF, IMP, ISK, ISJ, INR, IDR, IRR, IQD, IEP, ILS, ILP, ILR, ITL, JMD, JPY, JOD, KZT, KES, KWD, KGS, LAK, LVL, LVR, LBP, LSL, LRD, LYD, LTL, LTT, LUL, LUC, LUF, MOP, MKD, MKN, MGA, MGF, MWK, MYR, MVR, MVP, MLF, MTL, MTP, MRU, MRO, MUR, MXV, MXN, MXP, MDC, MDL, MCF, MNT, MAD, MAF, MZE, MZN, MZM, MMK, NAD, NPR, ANG, TWD, NZD, NIO, NIC, NGN, KPW, NOK, OMR, PKR, XPD, PAB, PGK, PYG, PEI, PEN, PES, PHP, XPT, PLN, PLZ, PTE, GWE, QAR, XRE, RHD, RON, ROL, RUB, RUR, RWF, SVC, WST, SAR, RSD, CSD, SCR, SLE, SLL, XAG, SGD, SKK, SIT, SBD, SOS, ZAR, ZAL, KRH, KRW, KRO, SSP, SUR, ESP, ESA, ESB, XDR, LKR, SHP, XSU, SDD, SDG, SDP, SRD, SRG, SZL, SEK, CHF, SYP, STN, STD, TVD, TJR, TJS, TZS, XTS, THB, TPE, TOP, TTD, TND, TRY, TRL, TMT, TMM, USD, USN, USS, UGX, UGS, UAH, UAK, AED, UYW, UYU, UYP, UYI, UZS, VUV, VES, VEB, VEF, VND, VNN, CHE, CHW, XOF, YDD, YER, YUN, YUD, YUM, YUR, ZWN, ZRN, ZRZ, ZMW, ZMK, ZWD, ZWR, ZWL,
`resulting_variation` *	uuid	The formal Variation Quote generated from this request.
`resulting_variation_invoice_count`	JSON	Computed JSON value; may be null when access is restricted.
`resulting_variation_number`	string	Workspace-unique quote number (e.g., QUO-001).
`resulting_variation_sequence`	integer	Sequential number if this is a variation (e.g., 1, 2, 3).
`resulting_variation_status`	string	* `draft` - Draft * `sent` - Sent * `approved` - Approved * `rejected` - Rejected * `superseded` - Superseded * `locked` - Locked (linked to quote) * `archived` - Archived Options: draft, sent, approved, rejected, superseded, locked, archived
`revised_completion_date`	date	Requested revised completion / working-period end date.
`risk_contingency_value`	decimal	Early warning approximate risk / contingency value.
`risk_contingency_value_currency` *	string	* `XUA` - ADB Unit of Account * `AFN` - Afghan Afghani * `AFA` - Afghan Afghani (1927–2002) * `ALL` - Albanian Lek * `ALK` - Albanian Lek (1946–1965) * `DZD` - Algerian Dinar * `ADP` - Andorran Peseta * `AOA` - Angolan Kwanza * `AOK` - Angolan Kwanza (1977–1991) * `AON` - Angolan New Kwanza (1990–2000) * `AOR` - Angolan Readjusted Kwanza (1995–1999) * `ARA` - Argentine Austral * `ARS` - Argentine Peso * `ARM` - Argentine Peso (1881–1970) * `ARP` - Argentine Peso (1983–1985) * `ARL` - Argentine Peso Ley (1970–1983) * `AMD` - Armenian Dram * `AWG` - Aruban Florin * `AUD` - Australian Dollar * `ATS` - Austrian Schilling * `AZN` - Azerbaijani Manat * `AZM` - Azerbaijani Manat (1993–2006) * `BSD` - Bahamian Dollar * `BHD` - Bahraini Dinar * `BDT` - Bangladeshi Taka * `BBD` - Barbadian Dollar * `BYN` - Belarusian Ruble * `BYB` - Belarusian Ruble (1994–1999) * `BYR` - Belarusian Ruble (2000–2016) * `BEF` - Belgian Franc * `BEC` - Belgian Franc (convertible) * `BEL` - Belgian Franc (financial) * `BZD` - Belize Dollar * `BMD` - Bermudan Dollar * `BTN` - Bhutanese Ngultrum * `BOB` - Bolivian Boliviano * `BOL` - Bolivian Boliviano (1863–1963) * `BOV` - Bolivian Mvdol * `BOP` - Bolivian Peso * `VED` - Bolívar Soberano * `BAM` - Bosnia-Herzegovina Convertible Mark * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) * `BWP` - Botswanan Pula * `BRC` - Brazilian Cruzado (1986–1989) * `BRZ` - Brazilian Cruzeiro (1942–1967) * `BRE` - Brazilian Cruzeiro (1990–1993) * `BRR` - Brazilian Cruzeiro (1993–1994) * `BRN` - Brazilian New Cruzado (1989–1990) * `BRB` - Brazilian New Cruzeiro (1967–1986) * `BRL` - Brazilian Real * `GBP` - British Pound * `BND` - Brunei Dollar * `BGL` - Bulgarian Hard Lev * `BGN` - Bulgarian Lev * `BGO` - Bulgarian Lev (1879–1952) * `BGM` - Bulgarian Socialist Lev * `BUK` - Burmese Kyat * `BIF` - Burundian Franc * `XPF` - CFP Franc * `KHR` - Cambodian Riel * `CAD` - Canadian Dollar * `CVE` - Cape Verdean Escudo * `KYD` - Cayman Islands Dollar * `XAF` - Central African CFA Franc * `CLE` - Chilean Escudo * `CLP` - Chilean Peso * `CLF` - Chilean Unit of Account (UF) * `CNX` - Chinese People’s Bank Dollar * `CNY` - Chinese Yuan * `CNH` - Chinese Yuan (offshore) * `COP` - Colombian Peso * `COU` - Colombian Real Value Unit * `KMF` - Comorian Franc * `CDF` - Congolese Franc * `CRC` - Costa Rican Colón * `HRD` - Croatian Dinar * `HRK` - Croatian Kuna * `CUC` - Cuban Convertible Peso * `CUP` - Cuban Peso * `CYP` - Cypriot Pound * `CZK` - Czech Koruna * `CSK` - Czechoslovak Hard Koruna * `DKK` - Danish Krone * `DJF` - Djiboutian Franc * `DOP` - Dominican Peso * `NLG` - Dutch Guilder * `XCD` - East Caribbean Dollar * `DDM` - East German Mark * `ECS` - Ecuadorian Sucre * `ECV` - Ecuadorian Unit of Constant Value * `EGP` - Egyptian Pound * `GQE` - Equatorial Guinean Ekwele * `ERN` - Eritrean Nakfa * `EEK` - Estonian Kroon * `ETB` - Ethiopian Birr * `EUR` - Euro * `XBA` - European Composite Unit * `XEU` - European Currency Unit * `XBB` - European Monetary Unit * `XBC` - European Unit of Account (XBC) * `XBD` - European Unit of Account (XBD) * `FKP` - Falkland Islands Pound * `FJD` - Fijian Dollar * `FIM` - Finnish Markka * `FRF` - French Franc * `XFO` - French Gold Franc * `XFU` - French UIC-Franc * `GMD` - Gambian Dalasi * `GEK` - Georgian Kupon Larit * `GEL` - Georgian Lari * `DEM` - German Mark * `GHS` - Ghanaian Cedi * `GHC` - Ghanaian Cedi (1979–2007) * `GIP` - Gibraltar Pound * `XAU` - Gold * `GRD` - Greek Drachma * `GTQ` - Guatemalan Quetzal * `GWP` - Guinea-Bissau Peso * `GNF` - Guinean Franc * `GNS` - Guinean Syli * `GYD` - Guyanaese Dollar * `HTG` - Haitian Gourde * `HNL` - Honduran Lempira * `HKD` - Hong Kong Dollar * `HUF` - Hungarian Forint * `IMP` - IMP * `ISK` - Icelandic Króna * `ISJ` - Icelandic Króna (1918–1981) * `INR` - Indian Rupee * `IDR` - Indonesian Rupiah * `IRR` - Iranian Rial * `IQD` - Iraqi Dinar * `IEP` - Irish Pound * `ILS` - Israeli New Shekel * `ILP` - Israeli Pound * `ILR` - Israeli Shekel (1980–1985) * `ITL` - Italian Lira * `JMD` - Jamaican Dollar * `JPY` - Japanese Yen * `JOD` - Jordanian Dinar * `KZT` - Kazakhstani Tenge * `KES` - Kenyan Shilling * `KWD` - Kuwaiti Dinar * `KGS` - Kyrgystani Som * `LAK` - Laotian Kip * `LVL` - Latvian Lats * `LVR` - Latvian Ruble * `LBP` - Lebanese Pound * `LSL` - Lesotho Loti * `LRD` - Liberian Dollar * `LYD` - Libyan Dinar * `LTL` - Lithuanian Litas * `LTT` - Lithuanian Talonas * `LUL` - Luxembourg Financial Franc * `LUC` - Luxembourgian Convertible Franc * `LUF` - Luxembourgian Franc * `MOP` - Macanese Pataca * `MKD` - Macedonian Denar * `MKN` - Macedonian Denar (1992–1993) * `MGA` - Malagasy Ariary * `MGF` - Malagasy Franc * `MWK` - Malawian Kwacha * `MYR` - Malaysian Ringgit * `MVR` - Maldivian Rufiyaa * `MVP` - Maldivian Rupee (1947–1981) * `MLF` - Malian Franc * `MTL` - Maltese Lira * `MTP` - Maltese Pound * `MRU` - Mauritanian Ouguiya * `MRO` - Mauritanian Ouguiya (1973–2017) * `MUR` - Mauritian Rupee * `MXV` - Mexican Investment Unit * `MXN` - Mexican Peso * `MXP` - Mexican Silver Peso (1861–1992) * `MDC` - Moldovan Cupon * `MDL` - Moldovan Leu * `MCF` - Monegasque Franc * `MNT` - Mongolian Tugrik * `MAD` - Moroccan Dirham * `MAF` - Moroccan Franc * `MZE` - Mozambican Escudo * `MZN` - Mozambican Metical * `MZM` - Mozambican Metical (1980–2006) * `MMK` - Myanmar Kyat * `NAD` - Namibian Dollar * `NPR` - Nepalese Rupee * `ANG` - Netherlands Antillean Guilder * `TWD` - New Taiwan Dollar * `NZD` - New Zealand Dollar * `NIO` - Nicaraguan Córdoba * `NIC` - Nicaraguan Córdoba (1988–1991) * `NGN` - Nigerian Naira * `KPW` - North Korean Won * `NOK` - Norwegian Krone * `OMR` - Omani Rial * `PKR` - Pakistani Rupee * `XPD` - Palladium * `PAB` - Panamanian Balboa * `PGK` - Papua New Guinean Kina * `PYG` - Paraguayan Guarani * `PEI` - Peruvian Inti * `PEN` - Peruvian Sol * `PES` - Peruvian Sol (1863–1965) * `PHP` - Philippine Peso * `XPT` - Platinum * `PLN` - Polish Zloty * `PLZ` - Polish Zloty (1950–1995) * `PTE` - Portuguese Escudo * `GWE` - Portuguese Guinea Escudo * `QAR` - Qatari Riyal * `XRE` - RINET Funds * `RHD` - Rhodesian Dollar * `RON` - Romanian Leu * `ROL` - Romanian Leu (1952–2006) * `RUB` - Russian Ruble * `RUR` - Russian Ruble (1991–1998) * `RWF` - Rwandan Franc * `SVC` - Salvadoran Colón * `WST` - Samoan Tala * `SAR` - Saudi Riyal * `RSD` - Serbian Dinar * `CSD` - Serbian Dinar (2002–2006) * `SCR` - Seychellois Rupee * `SLE` - Sierra Leonean Leone * `SLL` - Sierra Leonean Leone (1964—2022) * `XAG` - Silver * `SGD` - Singapore Dollar * `SKK` - Slovak Koruna * `SIT` - Slovenian Tolar * `SBD` - Solomon Islands Dollar * `SOS` - Somali Shilling * `ZAR` - South African Rand * `ZAL` - South African Rand (financial) * `KRH` - South Korean Hwan (1953–1962) * `KRW` - South Korean Won * `KRO` - South Korean Won (1945–1953) * `SSP` - South Sudanese Pound * `SUR` - Soviet Rouble * `ESP` - Spanish Peseta * `ESA` - Spanish Peseta (A account) * `ESB` - Spanish Peseta (convertible account) * `XDR` - Special Drawing Rights * `LKR` - Sri Lankan Rupee * `SHP` - St. Helena Pound * `XSU` - Sucre * `SDD` - Sudanese Dinar (1992–2007) * `SDG` - Sudanese Pound * `SDP` - Sudanese Pound (1957–1998) * `SRD` - Surinamese Dollar * `SRG` - Surinamese Guilder * `SZL` - Swazi Lilangeni * `SEK` - Swedish Krona * `CHF` - Swiss Franc * `SYP` - Syrian Pound * `STN` - São Tomé & Príncipe Dobra * `STD` - São Tomé & Príncipe Dobra (1977–2017) * `TVD` - TVD * `TJR` - Tajikistani Ruble * `TJS` - Tajikistani Somoni * `TZS` - Tanzanian Shilling * `XTS` - Testing Currency Code * `THB` - Thai Baht * `TPE` - Timorese Escudo * `TOP` - Tongan Paʻanga * `TTD` - Trinidad & Tobago Dollar * `TND` - Tunisian Dinar * `TRY` - Turkish Lira * `TRL` - Turkish Lira (1922–2005) * `TMT` - Turkmenistani Manat * `TMM` - Turkmenistani Manat (1993–2009) * `USD` - US Dollar * `USN` - US Dollar (Next day) * `USS` - US Dollar (Same day) * `UGX` - Ugandan Shilling * `UGS` - Ugandan Shilling (1966–1987) * `UAH` - Ukrainian Hryvnia * `UAK` - Ukrainian Karbovanets * `AED` - United Arab Emirates Dirham * `UYW` - Uruguayan Nominal Wage Index Unit * `UYU` - Uruguayan Peso * `UYP` - Uruguayan Peso (1975–1993) * `UYI` - Uruguayan Peso (Indexed Units) * `UZS` - Uzbekistani Som * `VUV` - Vanuatu Vatu * `VES` - Venezuelan Bolívar * `VEB` - Venezuelan Bolívar (1871–2008) * `VEF` - Venezuelan Bolívar (2008–2018) * `VND` - Vietnamese Dong * `VNN` - Vietnamese Dong (1978–1985) * `CHE` - WIR Euro * `CHW` - WIR Franc * `XOF` - West African CFA Franc * `YDD` - Yemeni Dinar * `YER` - Yemeni Rial * `YUN` - Yugoslavian Convertible Dinar (1990–1992) * `YUD` - Yugoslavian Hard Dinar (1966–1990) * `YUM` - Yugoslavian New Dinar (1994–2002) * `YUR` - Yugoslavian Reformed Dinar (1992–1993) * `ZWN` - ZWN * `ZRN` - Zairean New Zaire (1993–1998) * `ZRZ` - Zairean Zaire (1971–1993) * `ZMW` - Zambian Kwacha * `ZMK` - Zambian Kwacha (1968–2012) * `ZWD` - Zimbabwean Dollar (1980–2008) * `ZWR` - Zimbabwean Dollar (2008) * `ZWL` - Zimbabwean Dollar (2009–2024) Options: XUA, AFN, AFA, ALL, ALK, DZD, ADP, AOA, AOK, AON, AOR, ARA, ARS, ARM, ARP, ARL, AMD, AWG, AUD, ATS, AZN, AZM, BSD, BHD, BDT, BBD, BYN, BYB, BYR, BEF, BEC, BEL, BZD, BMD, BTN, BOB, BOL, BOV, BOP, VED, BAM, BAD, BAN, BWP, BRC, BRZ, BRE, BRR, BRN, BRB, BRL, GBP, BND, BGL, BGN, BGO, BGM, BUK, BIF, XPF, KHR, CAD, CVE, KYD, XAF, CLE, CLP, CLF, CNX, CNY, CNH, COP, COU, KMF, CDF, CRC, HRD, HRK, CUC, CUP, CYP, CZK, CSK, DKK, DJF, DOP, NLG, XCD, DDM, ECS, ECV, EGP, GQE, ERN, EEK, ETB, EUR, XBA, XEU, XBB, XBC, XBD, FKP, FJD, FIM, FRF, XFO, XFU, GMD, GEK, GEL, DEM, GHS, GHC, GIP, XAU, GRD, GTQ, GWP, GNF, GNS, GYD, HTG, HNL, HKD, HUF, IMP, ISK, ISJ, INR, IDR, IRR, IQD, IEP, ILS, ILP, ILR, ITL, JMD, JPY, JOD, KZT, KES, KWD, KGS, LAK, LVL, LVR, LBP, LSL, LRD, LYD, LTL, LTT, LUL, LUC, LUF, MOP, MKD, MKN, MGA, MGF, MWK, MYR, MVR, MVP, MLF, MTL, MTP, MRU, MRO, MUR, MXV, MXN, MXP, MDC, MDL, MCF, MNT, MAD, MAF, MZE, MZN, MZM, MMK, NAD, NPR, ANG, TWD, NZD, NIO, NIC, NGN, KPW, NOK, OMR, PKR, XPD, PAB, PGK, PYG, PEI, PEN, PES, PHP, XPT, PLN, PLZ, PTE, GWE, QAR, XRE, RHD, RON, ROL, RUB, RUR, RWF, SVC, WST, SAR, RSD, CSD, SCR, SLE, SLL, XAG, SGD, SKK, SIT, SBD, SOS, ZAR, ZAL, KRH, KRW, KRO, SSP, SUR, ESP, ESA, ESB, XDR, LKR, SHP, XSU, SDD, SDG, SDP, SRD, SRG, SZL, SEK, CHF, SYP, STN, STD, TVD, TJR, TJS, TZS, XTS, THB, TPE, TOP, TTD, TND, TRY, TRL, TMT, TMM, USD, USN, USS, UGX, UGS, UAH, UAK, AED, UYW, UYU, UYP, UYI, UZS, VUV, VES, VEB, VEF, VND, VNN, CHE, CHW, XOF, YDD, YER, YUN, YUD, YUM, YUR, ZWN, ZRN, ZRZ, ZMW, ZMK, ZWD, ZWR, ZWL,
`signature_loop_stage`	string	* `none` - Not required * `awaiting_builder` - Awaiting builder signature * `awaiting_client` - Awaiting client countersignature * `complete` - Fully signed Options: none, awaiting_builder, awaiting_client, complete,
`simple_issuer_contact`	string
`simple_issuer_contact_email`	email
`simple_issuer_contact_member_id`	uuid
`simple_paper_kind`	JSON	Computed JSON value; may be null when access is restricted.
`simple_price_certainty`	string	Simple workflow: fixed, estimated/indicative, quote requested, no price change, or not assessed. * `fixed` - Fixed price * `estimated` - Estimated / Indicative * `quote_requested` - Quote Requested * `no_price_change` - No price change * `not_assessed` - Not assessed Options: fixed, estimated, quote_requested, no_price_change, not_assessed,
`simple_recipient`	string
`simple_recipient_email`	email
`simple_recipient_member_id`	uuid
`simple_time_certainty`	string	Simple workflow: estimated, definitive / fixed, post-completion, or no time impact. * `estimated` - Estimated / Indicative * `definitive` - Definitive / Fixed * `post_completion` - Assessed / agreed post-completion * `not_assessed` - No time impact Options: estimated, definitive, post_completion, not_assessed,
`sla_deadlines`	JSON	Computed JSON value; may be null when access is restricted.
`source_document_type`	string	Client-issued instruction: type of source document received. * `architect_instruction` - Architect's Instruction (AI/CAI) * `signed_change_agreement` - Signed Change / Variation Agreement * `quote_request` - Quote Request * `site_direction_minutes` - Site Direction / Meeting Minutes * `email_confirmation` - Email Confirmation Options: architect_instruction, signed_change_agreement, quote_request, site_direction_minutes, email_confirmation,
`source_site_log`	uuid
`source_site_log_cost_impact_type`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_date`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_delay_days`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_estimated_cost_amount`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_estimated_cost_currency`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_recommendation`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_responsible_party`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_risk_level`	JSON	Computed JSON value; may be null when access is restricted.
`source_timeline_entry`	uuid
`source_timeline_entry_id` *	uuid
`source_timeline_entry_preview`	JSON	Computed JSON value; may be null when access is restricted.
`status`	string	* `registered` - Draft / Registered * `issued` - Issued / Submitted * `issued_validated` - Instruction Validated * `issued_not_valid` - Instruction Invalid * `rejected_by_builder` - Rejected by Builder * `being_priced` - Pricing in Progress * `pricing_submitted` - Pricing Submitted * `price_agreed` - Price Agreed * `price_rejected` - Price Rejected * `terms_agreed` - Variation Approved * `terms_rejected` - Variation Rejected * `being_repriced` - Repricing in Progress * `priced_by_client` - To be Priced by Client * `terms_renegotiated` - Terms being Renegotiated * `cancelled` - Cancelled * `claimed` - Claimed * `paid` - Paid * `pending_client_financial` - Pending Client Financial Approval * `awaiting_external_ca_auth` - Awaiting External CA Authorization * `pending_ca_triage` - Pending CA Review Options: registered, issued, issued_validated, issued_not_valid, rejected_by_builder, being_priced, pricing_submitted, price_agreed, price_rejected, terms_agreed, terms_rejected, being_repriced, priced_by_client, terms_renegotiated, cancelled, claimed, paid, pending_client_financial, awaiting_external_ca_auth, pending_ca_triage
`status_label`	JSON	Computed JSON value; may be null when access is restricted.
`title` *	string	Short summary of the instruction.
`type_label` *	string
`updated_at` *	date-time
`valuation_basis`	string	Legacy single valuation method. Prefer valuation_methods.
`valuation_markup_percent`	decimal	Markup percent when valuation_basis is actual cost + markup.
`valuation_method_terms`	string	Agreed valuation method terms (dayworks, schedule of rates, etc.).
`valuation_methods`	JSON	Ordered proposed valuation methods (priority 1, 2, 3).
`variation_group`	string	Logical grouping for filters (warning, instruction, request, confirmation, advisory).
`workflow_tier`	string	UI workflow tier for this record; upgrade from simple to comprehensive. * `simple` - Simple * `comprehensive` - Comprehensive Options: simple, comprehensive

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/variations/{change_request_pk}/items/

Parameters

Name	Location	Details
`change_request_pk` *	path	uuid
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	ChangeItem[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/projects/{project_id}/variations/{change_request_pk}/items/

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`change_request_pk` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`add_value`	string or number
`adjusted_estimate_work_item`	uuid
`adjusted_quote_line`	uuid
`adjusts_existing`	boolean	Does this specific item adjust existing work?
`description` *	string	Specific work item description.
`is_omission`	boolean
`is_provisional_sum`	boolean	Is this adjusting a Prov Sum?
`omit_value`	string or number
`quantity`	decimal
`resource`	integer	Link to a standard library resource for exact pricing matches.
`source_type`	string	* `manual` - New priced line * `contract_line` - Original contract line * `resource` - Library resource * `legacy_cost_matrix` - Migrated legacy pricing Options: manual, contract_line, resource, legacy_cost_matrix
`unit_of_measure`	string
`unit_rate`	string or number
`work_category`	string	* `labour` - Labour * `materials` - Materials * `plant` - Plant * `subcontract` - Subcontract * `overhead_profit` - Overheads & profit * `other` - Other Options: labour, materials, plant, subcontract, overhead_profit, other

Responses

201 — Success

Field	Type	Details
`add_value`	object
`adjusted_estimate_work_item`	uuid
`adjusted_quote_line`	uuid
`adjusts_existing`	boolean	Does this specific item adjust existing work?
`created_at` *	date-time
`description` *	string	Specific work item description.
`id` *	uuid
`is_omission`	boolean
`is_provisional_sum`	boolean	Is this adjusting a Prov Sum?
`omit_value`	object
`price_agreed` *	boolean
`pricing_provenance` *	JSON	How the current price was derived, including method and markup inputs.
`quantity`	decimal
`resource`	integer	Link to a standard library resource for exact pricing matches.
`resource_name`	string
`source_type`	string	* `manual` - New priced line * `contract_line` - Original contract line * `resource` - Library resource * `legacy_cost_matrix` - Migrated legacy pricing Options: manual, contract_line, resource, legacy_cost_matrix
`status` *	string	* `draft` - Draft * `pricing` - Pricing * `submitted` - Submitted to Client * `agreed` - Agreed * `rejected` - Rejected * `withdrawn` - Withdrawn Options: draft, pricing, submitted, agreed, rejected, withdrawn
`terms_agreed` *	boolean
`unit_of_measure`	string
`unit_rate`	object
`updated_at` *	date-time
`work_category`	string	* `labour` - Labour * `materials` - Materials * `plant` - Plant * `subcontract` - Subcontract * `overhead_profit` - Overheads & profit * `other` - Other Options: labour, materials, plant, subcontract, overhead_profit, other

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/projects/{project_id}/variations/{change_request_pk}/items/{id}/

Required scopes and service-account permissions: variations:manage. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Enforce a workspace capability in addition to RBAC.

Parameters

Name	Location	Details
`change_request_pk` *	path	uuid
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/variations/{change_request_pk}/items/{id}/

Parameters

Name	Location	Details
`change_request_pk` *	path	uuid
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`add_value`	object
`adjusted_estimate_work_item`	uuid
`adjusted_quote_line`	uuid
`adjusts_existing`	boolean	Does this specific item adjust existing work?
`created_at` *	date-time
`description` *	string	Specific work item description.
`id` *	uuid
`is_omission`	boolean
`is_provisional_sum`	boolean	Is this adjusting a Prov Sum?
`omit_value`	object
`price_agreed` *	boolean
`pricing_provenance` *	JSON	How the current price was derived, including method and markup inputs.
`quantity`	decimal
`resource`	integer	Link to a standard library resource for exact pricing matches.
`resource_name`	string
`source_type`	string	* `manual` - New priced line * `contract_line` - Original contract line * `resource` - Library resource * `legacy_cost_matrix` - Migrated legacy pricing Options: manual, contract_line, resource, legacy_cost_matrix
`status` *	string	* `draft` - Draft * `pricing` - Pricing * `submitted` - Submitted to Client * `agreed` - Agreed * `rejected` - Rejected * `withdrawn` - Withdrawn Options: draft, pricing, submitted, agreed, rejected, withdrawn
`terms_agreed` *	boolean
`unit_of_measure`	string
`unit_rate`	object
`updated_at` *	date-time
`work_category`	string	* `labour` - Labour * `materials` - Materials * `plant` - Plant * `subcontract` - Subcontract * `overhead_profit` - Overheads & profit * `other` - Other Options: labour, materials, plant, subcontract, overhead_profit, other

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/projects/{project_id}/variations/{change_request_pk}/items/{id}/

Parameters

Name	Location	Details
`change_request_pk` *	path	uuid
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`add_value`	string or number
`adjusted_estimate_work_item`	uuid
`adjusted_quote_line`	uuid
`adjusts_existing`	boolean	Does this specific item adjust existing work?
`description`	string	Specific work item description.
`is_omission`	boolean
`is_provisional_sum`	boolean	Is this adjusting a Prov Sum?
`omit_value`	string or number
`quantity`	decimal
`resource`	integer	Link to a standard library resource for exact pricing matches.
`source_type`	string	* `manual` - New priced line * `contract_line` - Original contract line * `resource` - Library resource * `legacy_cost_matrix` - Migrated legacy pricing Options: manual, contract_line, resource, legacy_cost_matrix
`unit_of_measure`	string
`unit_rate`	string or number
`work_category`	string	* `labour` - Labour * `materials` - Materials * `plant` - Plant * `subcontract` - Subcontract * `overhead_profit` - Overheads & profit * `other` - Other Options: labour, materials, plant, subcontract, overhead_profit, other

Responses

200 — Success

Field	Type	Details
`add_value`	object
`adjusted_estimate_work_item`	uuid
`adjusted_quote_line`	uuid
`adjusts_existing`	boolean	Does this specific item adjust existing work?
`created_at` *	date-time
`description` *	string	Specific work item description.
`id` *	uuid
`is_omission`	boolean
`is_provisional_sum`	boolean	Is this adjusting a Prov Sum?
`omit_value`	object
`price_agreed` *	boolean
`pricing_provenance` *	JSON	How the current price was derived, including method and markup inputs.
`quantity`	decimal
`resource`	integer	Link to a standard library resource for exact pricing matches.
`resource_name`	string
`source_type`	string	* `manual` - New priced line * `contract_line` - Original contract line * `resource` - Library resource * `legacy_cost_matrix` - Migrated legacy pricing Options: manual, contract_line, resource, legacy_cost_matrix
`status` *	string	* `draft` - Draft * `pricing` - Pricing * `submitted` - Submitted to Client * `agreed` - Agreed * `rejected` - Rejected * `withdrawn` - Withdrawn Options: draft, pricing, submitted, agreed, rejected, withdrawn
`terms_agreed` *	boolean
`unit_of_measure`	string
`unit_rate`	object
`updated_at` *	date-time
`work_category`	string	* `labour` - Labour * `materials` - Materials * `plant` - Plant * `subcontract` - Subcontract * `overhead_profit` - Overheads & profit * `other` - Other Options: labour, materials, plant, subcontract, overhead_profit, other

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/projects/{project_id}/variations/{id}/

Required scopes and service-account permissions: variations:manage. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Helper for endpoints where the URL does NOT include project_pk, so we must attach request.workspace_id / request.project_id before permissions run.

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/projects/{project_id}/variations/{id}/

Required scopes and service-account permissions: variations:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Helper for endpoints where the URL does NOT include project_pk, so we must attach request.workspace_id / request.project_id before permissions run.

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`addition_pricing_type`	string	Classification for newly added work in instructed value flows. * `none` - Not specified * `quoted` - This adds a new, quoted item * `unquoted` - This adds a new, unquoted item Options: none, quoted, unquoted
`adjusts_existing_work`	boolean
`anticipated_form_reference`	string
`attached_files` *	FileDetail[]
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`authority_certainty`	string	Bucket 1: definitive vs provisional instruction certainty. * `definitive` - Definitive * `provisional` - Provisional Options: definitive, provisional,
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`base_quote`	uuid	The original approved Quote/Agreement this change applies to.
`base_quote_number`	JSON	Computed JSON value; may be null when access is restricted.
`base_quote_title`	JSON	Computed JSON value; may be null when access is restricted.
`builder_proceeds`	boolean	Does the builder agree to proceed?
`builder_reject_reason`	string	Required if builder_proceeds is False.
`builder_signed_at`	date-time
`ca_financial_note`	string	Optional CA note attached when submitting for client financial approval.
`classification_other`	boolean	Other classification selected: requires classification_other_text.
`classification_other_text`	string	Mandatory free text when classification_other is set.
`client_countersigned_at`	date-time
`client_document_reference`	string	Client / CA reference number from the source document, if any.
`communication_method`	string	How the instruction was received (e.g., email, in_person).
`created_at` *	date-time
`current_sla`	JSON	Computed JSON value; may be null when access is restricted.
`cvr_next_step`	string	CVR: request formal instruction or formal quote. * `request_instruction` - Request client to officially instruct * `request_quote` - Request client to ask for a formal quote Options: request_instruction, request_quote,
`delay_causes`	JSON	Notice of Delay cause checkbox keys.
`delay_narrative`	string	Notice of Delay free-text narrative.
`document_layout_mode`	JSON	Computed JSON value; may be null when access is restricted.
`effective_workflow_tier`	JSON	Computed JSON value; may be null when access is restricted.
`entered_by` *	uuid
`eot_to_be_determined`	boolean	True if EOT is acknowledged but will be calculated later.
`extension_of_time_days`	integer	Requested adjustment to the completion date (EOT).
`extension_of_time_hours`	decimal	Requested hours of time impact, in addition to extension_of_time_days.
`given_by`	string	Name of the person who gave the instruction.
`given_by_email`	email	Email for the given_by contact when selected from the project directory.
`given_by_member_id`	uuid
`has_public_consent`	JSON	Computed JSON value; may be null when access is restricted.
`id` *	uuid
`impacts_design`	boolean	Does this change the design?
`impacts_quality`	boolean	Does this affect quality standards?
`impacts_quantity`	boolean	Does this change quantities?
`includes_loss_and_expense`	boolean	Does this claim include additional costs for delay/disruption?
`includes_preparation_costs`	boolean	Does this claim include the cost of preparing the quotation?
`initiation_route`	string	Stable create-route id used to tailor the editable detail view.
`instruction_text`	string	The core instruction given.
`is_addition`	boolean
`is_omission`	boolean
`is_proxy`	boolean	Whether this record was logged on behalf of another party.
`is_substitution`	boolean
`items` *	ChangeItem[]
`lead_time_dependent`	boolean	Material or specialist lead-time dependency on a simple CVI/CVR/proposal.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_impact`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`payment_timing`	string	Consumer/unadministered: how the variation will be paid. * `invoice_now` - Invoice immediately as a standalone item * `next_stage` - Add to the next stage payment * `final_invoice` - Add to the final project invoice Options: invoice_now, next_stage, final_invoice,
`pci_type`	string	Budget PCI purpose when estimating is on. Empty = paper-only change. * `CLIENT_VARIATION` - Client variation * `INTERNAL_SPEC` - Internal specification change * `PROV_SUM_EXPEND` - Provisional sum expend * `RISK_RELEASE` - Risk / contingency release Options: CLIENT_VARIATION, INTERNAL_SPEC, PROV_SUM_EXPEND, RISK_RELEASE,
`price_agreed_before_start`	boolean	True if price is agreed before work commences, False if proceeding immediately.
`pricing_strategy`	string	Explicit pricing pathway; synced with price_agreed_before_start. * `price_upfront` - Price upfront before work starts * `valuation_method` - Agree a method of valuation * `price_later` - Proceed immediately, price later Options: price_upfront, valuation_method, price_later,
`project` *	uuid
`project_name` *	string	Name of the project.
`quote_validity_days`	integer	Validity period (days) when builder submits a quotation.
`quoted_source_quote`	uuid	If this change adds a new quoted item, link the source quote.
`reason`	string	Why is this change happening?
`reason_codes`	JSON	Simple CVI/CVR/proposal reason tick keys.
`reason_other_text`	string
`received_by`	string
`received_by_email`	email
`received_by_member_id`	uuid
`register_number` *	string	Stable display ref e.g. CHG-001. Terminology labels are separate.
`register_sequence` *	integer	Project-scoped sequence used to build register_number.
`request_date`	date
`request_time`	time	Time the verbal instruction/request was given.
`request_type`	string	* `request` - Variation Request * `instruction` - Variation Instruction * `early_warning` - Early Warning * `notice_of_delay` - Notice of Delay * `quote_request` - Quote Request * `confirmation` - CVI * `cvi` - Confirmation of Verbal Instruction (CVI) * `cvr` - Confirmation of Verbal Request (CVR) * `change_order` - Change Order * `potential_change_order` - Potential Change Order * `field_directive` - Field Directive Options: request, instruction, early_warning, notice_of_delay, quote_request, confirmation, cvi, cvr, change_order, potential_change_order, field_directive
`response_deadline`	date-time	The deadline for the client/builder to respond before default acceptance/rejection.
`restocking_fees`	decimal	Consumer contracts: restocking / non-refundable deposits.
`restocking_fees_currency` *	string	* `XUA` - ADB Unit of Account * `AFN` - Afghan Afghani * `AFA` - Afghan Afghani (1927–2002) * `ALL` - Albanian Lek * `ALK` - Albanian Lek (1946–1965) * `DZD` - Algerian Dinar * `ADP` - Andorran Peseta * `AOA` - Angolan Kwanza * `AOK` - Angolan Kwanza (1977–1991) * `AON` - Angolan New Kwanza (1990–2000) * `AOR` - Angolan Readjusted Kwanza (1995–1999) * `ARA` - Argentine Austral * `ARS` - Argentine Peso * `ARM` - Argentine Peso (1881–1970) * `ARP` - Argentine Peso (1983–1985) * `ARL` - Argentine Peso Ley (1970–1983) * `AMD` - Armenian Dram * `AWG` - Aruban Florin * `AUD` - Australian Dollar * `ATS` - Austrian Schilling * `AZN` - Azerbaijani Manat * `AZM` - Azerbaijani Manat (1993–2006) * `BSD` - Bahamian Dollar * `BHD` - Bahraini Dinar * `BDT` - Bangladeshi Taka * `BBD` - Barbadian Dollar * `BYN` - Belarusian Ruble * `BYB` - Belarusian Ruble (1994–1999) * `BYR` - Belarusian Ruble (2000–2016) * `BEF` - Belgian Franc * `BEC` - Belgian Franc (convertible) * `BEL` - Belgian Franc (financial) * `BZD` - Belize Dollar * `BMD` - Bermudan Dollar * `BTN` - Bhutanese Ngultrum * `BOB` - Bolivian Boliviano * `BOL` - Bolivian Boliviano (1863–1963) * `BOV` - Bolivian Mvdol * `BOP` - Bolivian Peso * `VED` - Bolívar Soberano * `BAM` - Bosnia-Herzegovina Convertible Mark * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) * `BWP` - Botswanan Pula * `BRC` - Brazilian Cruzado (1986–1989) * `BRZ` - Brazilian Cruzeiro (1942–1967) * `BRE` - Brazilian Cruzeiro (1990–1993) * `BRR` - Brazilian Cruzeiro (1993–1994) * `BRN` - Brazilian New Cruzado (1989–1990) * `BRB` - Brazilian New Cruzeiro (1967–1986) * `BRL` - Brazilian Real * `GBP` - British Pound * `BND` - Brunei Dollar * `BGL` - Bulgarian Hard Lev * `BGN` - Bulgarian Lev * `BGO` - Bulgarian Lev (1879–1952) * `BGM` - Bulgarian Socialist Lev * `BUK` - Burmese Kyat * `BIF` - Burundian Franc * `XPF` - CFP Franc * `KHR` - Cambodian Riel * `CAD` - Canadian Dollar * `CVE` - Cape Verdean Escudo * `KYD` - Cayman Islands Dollar * `XAF` - Central African CFA Franc * `CLE` - Chilean Escudo * `CLP` - Chilean Peso * `CLF` - Chilean Unit of Account (UF) * `CNX` - Chinese People’s Bank Dollar * `CNY` - Chinese Yuan * `CNH` - Chinese Yuan (offshore) * `COP` - Colombian Peso * `COU` - Colombian Real Value Unit * `KMF` - Comorian Franc * `CDF` - Congolese Franc * `CRC` - Costa Rican Colón * `HRD` - Croatian Dinar * `HRK` - Croatian Kuna * `CUC` - Cuban Convertible Peso * `CUP` - Cuban Peso * `CYP` - Cypriot Pound * `CZK` - Czech Koruna * `CSK` - Czechoslovak Hard Koruna * `DKK` - Danish Krone * `DJF` - Djiboutian Franc * `DOP` - Dominican Peso * `NLG` - Dutch Guilder * `XCD` - East Caribbean Dollar * `DDM` - East German Mark * `ECS` - Ecuadorian Sucre * `ECV` - Ecuadorian Unit of Constant Value * `EGP` - Egyptian Pound * `GQE` - Equatorial Guinean Ekwele * `ERN` - Eritrean Nakfa * `EEK` - Estonian Kroon * `ETB` - Ethiopian Birr * `EUR` - Euro * `XBA` - European Composite Unit * `XEU` - European Currency Unit * `XBB` - European Monetary Unit * `XBC` - European Unit of Account (XBC) * `XBD` - European Unit of Account (XBD) * `FKP` - Falkland Islands Pound * `FJD` - Fijian Dollar * `FIM` - Finnish Markka * `FRF` - French Franc * `XFO` - French Gold Franc * `XFU` - French UIC-Franc * `GMD` - Gambian Dalasi * `GEK` - Georgian Kupon Larit * `GEL` - Georgian Lari * `DEM` - German Mark * `GHS` - Ghanaian Cedi * `GHC` - Ghanaian Cedi (1979–2007) * `GIP` - Gibraltar Pound * `XAU` - Gold * `GRD` - Greek Drachma * `GTQ` - Guatemalan Quetzal * `GWP` - Guinea-Bissau Peso * `GNF` - Guinean Franc * `GNS` - Guinean Syli * `GYD` - Guyanaese Dollar * `HTG` - Haitian Gourde * `HNL` - Honduran Lempira * `HKD` - Hong Kong Dollar * `HUF` - Hungarian Forint * `IMP` - IMP * `ISK` - Icelandic Króna * `ISJ` - Icelandic Króna (1918–1981) * `INR` - Indian Rupee * `IDR` - Indonesian Rupiah * `IRR` - Iranian Rial * `IQD` - Iraqi Dinar * `IEP` - Irish Pound * `ILS` - Israeli New Shekel * `ILP` - Israeli Pound * `ILR` - Israeli Shekel (1980–1985) * `ITL` - Italian Lira * `JMD` - Jamaican Dollar * `JPY` - Japanese Yen * `JOD` - Jordanian Dinar * `KZT` - Kazakhstani Tenge * `KES` - Kenyan Shilling * `KWD` - Kuwaiti Dinar * `KGS` - Kyrgystani Som * `LAK` - Laotian Kip * `LVL` - Latvian Lats * `LVR` - Latvian Ruble * `LBP` - Lebanese Pound * `LSL` - Lesotho Loti * `LRD` - Liberian Dollar * `LYD` - Libyan Dinar * `LTL` - Lithuanian Litas * `LTT` - Lithuanian Talonas * `LUL` - Luxembourg Financial Franc * `LUC` - Luxembourgian Convertible Franc * `LUF` - Luxembourgian Franc * `MOP` - Macanese Pataca * `MKD` - Macedonian Denar * `MKN` - Macedonian Denar (1992–1993) * `MGA` - Malagasy Ariary * `MGF` - Malagasy Franc * `MWK` - Malawian Kwacha * `MYR` - Malaysian Ringgit * `MVR` - Maldivian Rufiyaa * `MVP` - Maldivian Rupee (1947–1981) * `MLF` - Malian Franc * `MTL` - Maltese Lira * `MTP` - Maltese Pound * `MRU` - Mauritanian Ouguiya * `MRO` - Mauritanian Ouguiya (1973–2017) * `MUR` - Mauritian Rupee * `MXV` - Mexican Investment Unit * `MXN` - Mexican Peso * `MXP` - Mexican Silver Peso (1861–1992) * `MDC` - Moldovan Cupon * `MDL` - Moldovan Leu * `MCF` - Monegasque Franc * `MNT` - Mongolian Tugrik * `MAD` - Moroccan Dirham * `MAF` - Moroccan Franc * `MZE` - Mozambican Escudo * `MZN` - Mozambican Metical * `MZM` - Mozambican Metical (1980–2006) * `MMK` - Myanmar Kyat * `NAD` - Namibian Dollar * `NPR` - Nepalese Rupee * `ANG` - Netherlands Antillean Guilder * `TWD` - New Taiwan Dollar * `NZD` - New Zealand Dollar * `NIO` - Nicaraguan Córdoba * `NIC` - Nicaraguan Córdoba (1988–1991) * `NGN` - Nigerian Naira * `KPW` - North Korean Won * `NOK` - Norwegian Krone * `OMR` - Omani Rial * `PKR` - Pakistani Rupee * `XPD` - Palladium * `PAB` - Panamanian Balboa * `PGK` - Papua New Guinean Kina * `PYG` - Paraguayan Guarani * `PEI` - Peruvian Inti * `PEN` - Peruvian Sol * `PES` - Peruvian Sol (1863–1965) * `PHP` - Philippine Peso * `XPT` - Platinum * `PLN` - Polish Zloty * `PLZ` - Polish Zloty (1950–1995) * `PTE` - Portuguese Escudo * `GWE` - Portuguese Guinea Escudo * `QAR` - Qatari Riyal * `XRE` - RINET Funds * `RHD` - Rhodesian Dollar * `RON` - Romanian Leu * `ROL` - Romanian Leu (1952–2006) * `RUB` - Russian Ruble * `RUR` - Russian Ruble (1991–1998) * `RWF` - Rwandan Franc * `SVC` - Salvadoran Colón * `WST` - Samoan Tala * `SAR` - Saudi Riyal * `RSD` - Serbian Dinar * `CSD` - Serbian Dinar (2002–2006) * `SCR` - Seychellois Rupee * `SLE` - Sierra Leonean Leone * `SLL` - Sierra Leonean Leone (1964—2022) * `XAG` - Silver * `SGD` - Singapore Dollar * `SKK` - Slovak Koruna * `SIT` - Slovenian Tolar * `SBD` - Solomon Islands Dollar * `SOS` - Somali Shilling * `ZAR` - South African Rand * `ZAL` - South African Rand (financial) * `KRH` - South Korean Hwan (1953–1962) * `KRW` - South Korean Won * `KRO` - South Korean Won (1945–1953) * `SSP` - South Sudanese Pound * `SUR` - Soviet Rouble * `ESP` - Spanish Peseta * `ESA` - Spanish Peseta (A account) * `ESB` - Spanish Peseta (convertible account) * `XDR` - Special Drawing Rights * `LKR` - Sri Lankan Rupee * `SHP` - St. Helena Pound * `XSU` - Sucre * `SDD` - Sudanese Dinar (1992–2007) * `SDG` - Sudanese Pound * `SDP` - Sudanese Pound (1957–1998) * `SRD` - Surinamese Dollar * `SRG` - Surinamese Guilder * `SZL` - Swazi Lilangeni * `SEK` - Swedish Krona * `CHF` - Swiss Franc * `SYP` - Syrian Pound * `STN` - São Tomé & Príncipe Dobra * `STD` - São Tomé & Príncipe Dobra (1977–2017) * `TVD` - TVD * `TJR` - Tajikistani Ruble * `TJS` - Tajikistani Somoni * `TZS` - Tanzanian Shilling * `XTS` - Testing Currency Code * `THB` - Thai Baht * `TPE` - Timorese Escudo * `TOP` - Tongan Paʻanga * `TTD` - Trinidad & Tobago Dollar * `TND` - Tunisian Dinar * `TRY` - Turkish Lira * `TRL` - Turkish Lira (1922–2005) * `TMT` - Turkmenistani Manat * `TMM` - Turkmenistani Manat (1993–2009) * `USD` - US Dollar * `USN` - US Dollar (Next day) * `USS` - US Dollar (Same day) * `UGX` - Ugandan Shilling * `UGS` - Ugandan Shilling (1966–1987) * `UAH` - Ukrainian Hryvnia * `UAK` - Ukrainian Karbovanets * `AED` - United Arab Emirates Dirham * `UYW` - Uruguayan Nominal Wage Index Unit * `UYU` - Uruguayan Peso * `UYP` - Uruguayan Peso (1975–1993) * `UYI` - Uruguayan Peso (Indexed Units) * `UZS` - Uzbekistani Som * `VUV` - Vanuatu Vatu * `VES` - Venezuelan Bolívar * `VEB` - Venezuelan Bolívar (1871–2008) * `VEF` - Venezuelan Bolívar (2008–2018) * `VND` - Vietnamese Dong * `VNN` - Vietnamese Dong (1978–1985) * `CHE` - WIR Euro * `CHW` - WIR Franc * `XOF` - West African CFA Franc * `YDD` - Yemeni Dinar * `YER` - Yemeni Rial * `YUN` - Yugoslavian Convertible Dinar (1990–1992) * `YUD` - Yugoslavian Hard Dinar (1966–1990) * `YUM` - Yugoslavian New Dinar (1994–2002) * `YUR` - Yugoslavian Reformed Dinar (1992–1993) * `ZWN` - ZWN * `ZRN` - Zairean New Zaire (1993–1998) * `ZRZ` - Zairean Zaire (1971–1993) * `ZMW` - Zambian Kwacha * `ZMK` - Zambian Kwacha (1968–2012) * `ZWD` - Zimbabwean Dollar (1980–2008) * `ZWR` - Zimbabwean Dollar (2008) * `ZWL` - Zimbabwean Dollar (2009–2024) Options: XUA, AFN, AFA, ALL, ALK, DZD, ADP, AOA, AOK, AON, AOR, ARA, ARS, ARM, ARP, ARL, AMD, AWG, AUD, ATS, AZN, AZM, BSD, BHD, BDT, BBD, BYN, BYB, BYR, BEF, BEC, BEL, BZD, BMD, BTN, BOB, BOL, BOV, BOP, VED, BAM, BAD, BAN, BWP, BRC, BRZ, BRE, BRR, BRN, BRB, BRL, GBP, BND, BGL, BGN, BGO, BGM, BUK, BIF, XPF, KHR, CAD, CVE, KYD, XAF, CLE, CLP, CLF, CNX, CNY, CNH, COP, COU, KMF, CDF, CRC, HRD, HRK, CUC, CUP, CYP, CZK, CSK, DKK, DJF, DOP, NLG, XCD, DDM, ECS, ECV, EGP, GQE, ERN, EEK, ETB, EUR, XBA, XEU, XBB, XBC, XBD, FKP, FJD, FIM, FRF, XFO, XFU, GMD, GEK, GEL, DEM, GHS, GHC, GIP, XAU, GRD, GTQ, GWP, GNF, GNS, GYD, HTG, HNL, HKD, HUF, IMP, ISK, ISJ, INR, IDR, IRR, IQD, IEP, ILS, ILP, ILR, ITL, JMD, JPY, JOD, KZT, KES, KWD, KGS, LAK, LVL, LVR, LBP, LSL, LRD, LYD, LTL, LTT, LUL, LUC, LUF, MOP, MKD, MKN, MGA, MGF, MWK, MYR, MVR, MVP, MLF, MTL, MTP, MRU, MRO, MUR, MXV, MXN, MXP, MDC, MDL, MCF, MNT, MAD, MAF, MZE, MZN, MZM, MMK, NAD, NPR, ANG, TWD, NZD, NIO, NIC, NGN, KPW, NOK, OMR, PKR, XPD, PAB, PGK, PYG, PEI, PEN, PES, PHP, XPT, PLN, PLZ, PTE, GWE, QAR, XRE, RHD, RON, ROL, RUB, RUR, RWF, SVC, WST, SAR, RSD, CSD, SCR, SLE, SLL, XAG, SGD, SKK, SIT, SBD, SOS, ZAR, ZAL, KRH, KRW, KRO, SSP, SUR, ESP, ESA, ESB, XDR, LKR, SHP, XSU, SDD, SDG, SDP, SRD, SRG, SZL, SEK, CHF, SYP, STN, STD, TVD, TJR, TJS, TZS, XTS, THB, TPE, TOP, TTD, TND, TRY, TRL, TMT, TMM, USD, USN, USS, UGX, UGS, UAH, UAK, AED, UYW, UYU, UYP, UYI, UZS, VUV, VES, VEB, VEF, VND, VNN, CHE, CHW, XOF, YDD, YER, YUN, YUD, YUM, YUR, ZWN, ZRN, ZRZ, ZMW, ZMK, ZWD, ZWR, ZWL,
`resulting_variation` *	uuid	The formal Variation Quote generated from this request.
`resulting_variation_invoice_count`	JSON	Computed JSON value; may be null when access is restricted.
`resulting_variation_number`	string	Workspace-unique quote number (e.g., QUO-001).
`resulting_variation_sequence`	integer	Sequential number if this is a variation (e.g., 1, 2, 3).
`resulting_variation_status`	string	* `draft` - Draft * `sent` - Sent * `approved` - Approved * `rejected` - Rejected * `superseded` - Superseded * `locked` - Locked (linked to quote) * `archived` - Archived Options: draft, sent, approved, rejected, superseded, locked, archived
`revised_completion_date`	date	Requested revised completion / working-period end date.
`risk_contingency_value`	decimal	Early warning approximate risk / contingency value.
`risk_contingency_value_currency` *	string	* `XUA` - ADB Unit of Account * `AFN` - Afghan Afghani * `AFA` - Afghan Afghani (1927–2002) * `ALL` - Albanian Lek * `ALK` - Albanian Lek (1946–1965) * `DZD` - Algerian Dinar * `ADP` - Andorran Peseta * `AOA` - Angolan Kwanza * `AOK` - Angolan Kwanza (1977–1991) * `AON` - Angolan New Kwanza (1990–2000) * `AOR` - Angolan Readjusted Kwanza (1995–1999) * `ARA` - Argentine Austral * `ARS` - Argentine Peso * `ARM` - Argentine Peso (1881–1970) * `ARP` - Argentine Peso (1983–1985) * `ARL` - Argentine Peso Ley (1970–1983) * `AMD` - Armenian Dram * `AWG` - Aruban Florin * `AUD` - Australian Dollar * `ATS` - Austrian Schilling * `AZN` - Azerbaijani Manat * `AZM` - Azerbaijani Manat (1993–2006) * `BSD` - Bahamian Dollar * `BHD` - Bahraini Dinar * `BDT` - Bangladeshi Taka * `BBD` - Barbadian Dollar * `BYN` - Belarusian Ruble * `BYB` - Belarusian Ruble (1994–1999) * `BYR` - Belarusian Ruble (2000–2016) * `BEF` - Belgian Franc * `BEC` - Belgian Franc (convertible) * `BEL` - Belgian Franc (financial) * `BZD` - Belize Dollar * `BMD` - Bermudan Dollar * `BTN` - Bhutanese Ngultrum * `BOB` - Bolivian Boliviano * `BOL` - Bolivian Boliviano (1863–1963) * `BOV` - Bolivian Mvdol * `BOP` - Bolivian Peso * `VED` - Bolívar Soberano * `BAM` - Bosnia-Herzegovina Convertible Mark * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) * `BWP` - Botswanan Pula * `BRC` - Brazilian Cruzado (1986–1989) * `BRZ` - Brazilian Cruzeiro (1942–1967) * `BRE` - Brazilian Cruzeiro (1990–1993) * `BRR` - Brazilian Cruzeiro (1993–1994) * `BRN` - Brazilian New Cruzado (1989–1990) * `BRB` - Brazilian New Cruzeiro (1967–1986) * `BRL` - Brazilian Real * `GBP` - British Pound * `BND` - Brunei Dollar * `BGL` - Bulgarian Hard Lev * `BGN` - Bulgarian Lev * `BGO` - Bulgarian Lev (1879–1952) * `BGM` - Bulgarian Socialist Lev * `BUK` - Burmese Kyat * `BIF` - Burundian Franc * `XPF` - CFP Franc * `KHR` - Cambodian Riel * `CAD` - Canadian Dollar * `CVE` - Cape Verdean Escudo * `KYD` - Cayman Islands Dollar * `XAF` - Central African CFA Franc * `CLE` - Chilean Escudo * `CLP` - Chilean Peso * `CLF` - Chilean Unit of Account (UF) * `CNX` - Chinese People’s Bank Dollar * `CNY` - Chinese Yuan * `CNH` - Chinese Yuan (offshore) * `COP` - Colombian Peso * `COU` - Colombian Real Value Unit * `KMF` - Comorian Franc * `CDF` - Congolese Franc * `CRC` - Costa Rican Colón * `HRD` - Croatian Dinar * `HRK` - Croatian Kuna * `CUC` - Cuban Convertible Peso * `CUP` - Cuban Peso * `CYP` - Cypriot Pound * `CZK` - Czech Koruna * `CSK` - Czechoslovak Hard Koruna * `DKK` - Danish Krone * `DJF` - Djiboutian Franc * `DOP` - Dominican Peso * `NLG` - Dutch Guilder * `XCD` - East Caribbean Dollar * `DDM` - East German Mark * `ECS` - Ecuadorian Sucre * `ECV` - Ecuadorian Unit of Constant Value * `EGP` - Egyptian Pound * `GQE` - Equatorial Guinean Ekwele * `ERN` - Eritrean Nakfa * `EEK` - Estonian Kroon * `ETB` - Ethiopian Birr * `EUR` - Euro * `XBA` - European Composite Unit * `XEU` - European Currency Unit * `XBB` - European Monetary Unit * `XBC` - European Unit of Account (XBC) * `XBD` - European Unit of Account (XBD) * `FKP` - Falkland Islands Pound * `FJD` - Fijian Dollar * `FIM` - Finnish Markka * `FRF` - French Franc * `XFO` - French Gold Franc * `XFU` - French UIC-Franc * `GMD` - Gambian Dalasi * `GEK` - Georgian Kupon Larit * `GEL` - Georgian Lari * `DEM` - German Mark * `GHS` - Ghanaian Cedi * `GHC` - Ghanaian Cedi (1979–2007) * `GIP` - Gibraltar Pound * `XAU` - Gold * `GRD` - Greek Drachma * `GTQ` - Guatemalan Quetzal * `GWP` - Guinea-Bissau Peso * `GNF` - Guinean Franc * `GNS` - Guinean Syli * `GYD` - Guyanaese Dollar * `HTG` - Haitian Gourde * `HNL` - Honduran Lempira * `HKD` - Hong Kong Dollar * `HUF` - Hungarian Forint * `IMP` - IMP * `ISK` - Icelandic Króna * `ISJ` - Icelandic Króna (1918–1981) * `INR` - Indian Rupee * `IDR` - Indonesian Rupiah * `IRR` - Iranian Rial * `IQD` - Iraqi Dinar * `IEP` - Irish Pound * `ILS` - Israeli New Shekel * `ILP` - Israeli Pound * `ILR` - Israeli Shekel (1980–1985) * `ITL` - Italian Lira * `JMD` - Jamaican Dollar * `JPY` - Japanese Yen * `JOD` - Jordanian Dinar * `KZT` - Kazakhstani Tenge * `KES` - Kenyan Shilling * `KWD` - Kuwaiti Dinar * `KGS` - Kyrgystani Som * `LAK` - Laotian Kip * `LVL` - Latvian Lats * `LVR` - Latvian Ruble * `LBP` - Lebanese Pound * `LSL` - Lesotho Loti * `LRD` - Liberian Dollar * `LYD` - Libyan Dinar * `LTL` - Lithuanian Litas * `LTT` - Lithuanian Talonas * `LUL` - Luxembourg Financial Franc * `LUC` - Luxembourgian Convertible Franc * `LUF` - Luxembourgian Franc * `MOP` - Macanese Pataca * `MKD` - Macedonian Denar * `MKN` - Macedonian Denar (1992–1993) * `MGA` - Malagasy Ariary * `MGF` - Malagasy Franc * `MWK` - Malawian Kwacha * `MYR` - Malaysian Ringgit * `MVR` - Maldivian Rufiyaa * `MVP` - Maldivian Rupee (1947–1981) * `MLF` - Malian Franc * `MTL` - Maltese Lira * `MTP` - Maltese Pound * `MRU` - Mauritanian Ouguiya * `MRO` - Mauritanian Ouguiya (1973–2017) * `MUR` - Mauritian Rupee * `MXV` - Mexican Investment Unit * `MXN` - Mexican Peso * `MXP` - Mexican Silver Peso (1861–1992) * `MDC` - Moldovan Cupon * `MDL` - Moldovan Leu * `MCF` - Monegasque Franc * `MNT` - Mongolian Tugrik * `MAD` - Moroccan Dirham * `MAF` - Moroccan Franc * `MZE` - Mozambican Escudo * `MZN` - Mozambican Metical * `MZM` - Mozambican Metical (1980–2006) * `MMK` - Myanmar Kyat * `NAD` - Namibian Dollar * `NPR` - Nepalese Rupee * `ANG` - Netherlands Antillean Guilder * `TWD` - New Taiwan Dollar * `NZD` - New Zealand Dollar * `NIO` - Nicaraguan Córdoba * `NIC` - Nicaraguan Córdoba (1988–1991) * `NGN` - Nigerian Naira * `KPW` - North Korean Won * `NOK` - Norwegian Krone * `OMR` - Omani Rial * `PKR` - Pakistani Rupee * `XPD` - Palladium * `PAB` - Panamanian Balboa * `PGK` - Papua New Guinean Kina * `PYG` - Paraguayan Guarani * `PEI` - Peruvian Inti * `PEN` - Peruvian Sol * `PES` - Peruvian Sol (1863–1965) * `PHP` - Philippine Peso * `XPT` - Platinum * `PLN` - Polish Zloty * `PLZ` - Polish Zloty (1950–1995) * `PTE` - Portuguese Escudo * `GWE` - Portuguese Guinea Escudo * `QAR` - Qatari Riyal * `XRE` - RINET Funds * `RHD` - Rhodesian Dollar * `RON` - Romanian Leu * `ROL` - Romanian Leu (1952–2006) * `RUB` - Russian Ruble * `RUR` - Russian Ruble (1991–1998) * `RWF` - Rwandan Franc * `SVC` - Salvadoran Colón * `WST` - Samoan Tala * `SAR` - Saudi Riyal * `RSD` - Serbian Dinar * `CSD` - Serbian Dinar (2002–2006) * `SCR` - Seychellois Rupee * `SLE` - Sierra Leonean Leone * `SLL` - Sierra Leonean Leone (1964—2022) * `XAG` - Silver * `SGD` - Singapore Dollar * `SKK` - Slovak Koruna * `SIT` - Slovenian Tolar * `SBD` - Solomon Islands Dollar * `SOS` - Somali Shilling * `ZAR` - South African Rand * `ZAL` - South African Rand (financial) * `KRH` - South Korean Hwan (1953–1962) * `KRW` - South Korean Won * `KRO` - South Korean Won (1945–1953) * `SSP` - South Sudanese Pound * `SUR` - Soviet Rouble * `ESP` - Spanish Peseta * `ESA` - Spanish Peseta (A account) * `ESB` - Spanish Peseta (convertible account) * `XDR` - Special Drawing Rights * `LKR` - Sri Lankan Rupee * `SHP` - St. Helena Pound * `XSU` - Sucre * `SDD` - Sudanese Dinar (1992–2007) * `SDG` - Sudanese Pound * `SDP` - Sudanese Pound (1957–1998) * `SRD` - Surinamese Dollar * `SRG` - Surinamese Guilder * `SZL` - Swazi Lilangeni * `SEK` - Swedish Krona * `CHF` - Swiss Franc * `SYP` - Syrian Pound * `STN` - São Tomé & Príncipe Dobra * `STD` - São Tomé & Príncipe Dobra (1977–2017) * `TVD` - TVD * `TJR` - Tajikistani Ruble * `TJS` - Tajikistani Somoni * `TZS` - Tanzanian Shilling * `XTS` - Testing Currency Code * `THB` - Thai Baht * `TPE` - Timorese Escudo * `TOP` - Tongan Paʻanga * `TTD` - Trinidad & Tobago Dollar * `TND` - Tunisian Dinar * `TRY` - Turkish Lira * `TRL` - Turkish Lira (1922–2005) * `TMT` - Turkmenistani Manat * `TMM` - Turkmenistani Manat (1993–2009) * `USD` - US Dollar * `USN` - US Dollar (Next day) * `USS` - US Dollar (Same day) * `UGX` - Ugandan Shilling * `UGS` - Ugandan Shilling (1966–1987) * `UAH` - Ukrainian Hryvnia * `UAK` - Ukrainian Karbovanets * `AED` - United Arab Emirates Dirham * `UYW` - Uruguayan Nominal Wage Index Unit * `UYU` - Uruguayan Peso * `UYP` - Uruguayan Peso (1975–1993) * `UYI` - Uruguayan Peso (Indexed Units) * `UZS` - Uzbekistani Som * `VUV` - Vanuatu Vatu * `VES` - Venezuelan Bolívar * `VEB` - Venezuelan Bolívar (1871–2008) * `VEF` - Venezuelan Bolívar (2008–2018) * `VND` - Vietnamese Dong * `VNN` - Vietnamese Dong (1978–1985) * `CHE` - WIR Euro * `CHW` - WIR Franc * `XOF` - West African CFA Franc * `YDD` - Yemeni Dinar * `YER` - Yemeni Rial * `YUN` - Yugoslavian Convertible Dinar (1990–1992) * `YUD` - Yugoslavian Hard Dinar (1966–1990) * `YUM` - Yugoslavian New Dinar (1994–2002) * `YUR` - Yugoslavian Reformed Dinar (1992–1993) * `ZWN` - ZWN * `ZRN` - Zairean New Zaire (1993–1998) * `ZRZ` - Zairean Zaire (1971–1993) * `ZMW` - Zambian Kwacha * `ZMK` - Zambian Kwacha (1968–2012) * `ZWD` - Zimbabwean Dollar (1980–2008) * `ZWR` - Zimbabwean Dollar (2008) * `ZWL` - Zimbabwean Dollar (2009–2024) Options: XUA, AFN, AFA, ALL, ALK, DZD, ADP, AOA, AOK, AON, AOR, ARA, ARS, ARM, ARP, ARL, AMD, AWG, AUD, ATS, AZN, AZM, BSD, BHD, BDT, BBD, BYN, BYB, BYR, BEF, BEC, BEL, BZD, BMD, BTN, BOB, BOL, BOV, BOP, VED, BAM, BAD, BAN, BWP, BRC, BRZ, BRE, BRR, BRN, BRB, BRL, GBP, BND, BGL, BGN, BGO, BGM, BUK, BIF, XPF, KHR, CAD, CVE, KYD, XAF, CLE, CLP, CLF, CNX, CNY, CNH, COP, COU, KMF, CDF, CRC, HRD, HRK, CUC, CUP, CYP, CZK, CSK, DKK, DJF, DOP, NLG, XCD, DDM, ECS, ECV, EGP, GQE, ERN, EEK, ETB, EUR, XBA, XEU, XBB, XBC, XBD, FKP, FJD, FIM, FRF, XFO, XFU, GMD, GEK, GEL, DEM, GHS, GHC, GIP, XAU, GRD, GTQ, GWP, GNF, GNS, GYD, HTG, HNL, HKD, HUF, IMP, ISK, ISJ, INR, IDR, IRR, IQD, IEP, ILS, ILP, ILR, ITL, JMD, JPY, JOD, KZT, KES, KWD, KGS, LAK, LVL, LVR, LBP, LSL, LRD, LYD, LTL, LTT, LUL, LUC, LUF, MOP, MKD, MKN, MGA, MGF, MWK, MYR, MVR, MVP, MLF, MTL, MTP, MRU, MRO, MUR, MXV, MXN, MXP, MDC, MDL, MCF, MNT, MAD, MAF, MZE, MZN, MZM, MMK, NAD, NPR, ANG, TWD, NZD, NIO, NIC, NGN, KPW, NOK, OMR, PKR, XPD, PAB, PGK, PYG, PEI, PEN, PES, PHP, XPT, PLN, PLZ, PTE, GWE, QAR, XRE, RHD, RON, ROL, RUB, RUR, RWF, SVC, WST, SAR, RSD, CSD, SCR, SLE, SLL, XAG, SGD, SKK, SIT, SBD, SOS, ZAR, ZAL, KRH, KRW, KRO, SSP, SUR, ESP, ESA, ESB, XDR, LKR, SHP, XSU, SDD, SDG, SDP, SRD, SRG, SZL, SEK, CHF, SYP, STN, STD, TVD, TJR, TJS, TZS, XTS, THB, TPE, TOP, TTD, TND, TRY, TRL, TMT, TMM, USD, USN, USS, UGX, UGS, UAH, UAK, AED, UYW, UYU, UYP, UYI, UZS, VUV, VES, VEB, VEF, VND, VNN, CHE, CHW, XOF, YDD, YER, YUN, YUD, YUM, YUR, ZWN, ZRN, ZRZ, ZMW, ZMK, ZWD, ZWR, ZWL,
`signature_loop_stage`	string	* `none` - Not required * `awaiting_builder` - Awaiting builder signature * `awaiting_client` - Awaiting client countersignature * `complete` - Fully signed Options: none, awaiting_builder, awaiting_client, complete,
`simple_issuer_contact`	string
`simple_issuer_contact_email`	email
`simple_issuer_contact_member_id`	uuid
`simple_paper_kind`	JSON	Computed JSON value; may be null when access is restricted.
`simple_price_certainty`	string	Simple workflow: fixed, estimated/indicative, quote requested, no price change, or not assessed. * `fixed` - Fixed price * `estimated` - Estimated / Indicative * `quote_requested` - Quote Requested * `no_price_change` - No price change * `not_assessed` - Not assessed Options: fixed, estimated, quote_requested, no_price_change, not_assessed,
`simple_recipient`	string
`simple_recipient_email`	email
`simple_recipient_member_id`	uuid
`simple_time_certainty`	string	Simple workflow: estimated, definitive / fixed, post-completion, or no time impact. * `estimated` - Estimated / Indicative * `definitive` - Definitive / Fixed * `post_completion` - Assessed / agreed post-completion * `not_assessed` - No time impact Options: estimated, definitive, post_completion, not_assessed,
`sla_deadlines`	JSON	Computed JSON value; may be null when access is restricted.
`source_document_type`	string	Client-issued instruction: type of source document received. * `architect_instruction` - Architect's Instruction (AI/CAI) * `signed_change_agreement` - Signed Change / Variation Agreement * `quote_request` - Quote Request * `site_direction_minutes` - Site Direction / Meeting Minutes * `email_confirmation` - Email Confirmation Options: architect_instruction, signed_change_agreement, quote_request, site_direction_minutes, email_confirmation,
`source_site_log`	uuid
`source_site_log_cost_impact_type`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_date`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_delay_days`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_estimated_cost_amount`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_estimated_cost_currency`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_recommendation`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_responsible_party`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_risk_level`	JSON	Computed JSON value; may be null when access is restricted.
`source_timeline_entry`	uuid
`source_timeline_entry_id` *	uuid
`source_timeline_entry_preview`	JSON	Computed JSON value; may be null when access is restricted.
`status`	string	* `registered` - Draft / Registered * `issued` - Issued / Submitted * `issued_validated` - Instruction Validated * `issued_not_valid` - Instruction Invalid * `rejected_by_builder` - Rejected by Builder * `being_priced` - Pricing in Progress * `pricing_submitted` - Pricing Submitted * `price_agreed` - Price Agreed * `price_rejected` - Price Rejected * `terms_agreed` - Variation Approved * `terms_rejected` - Variation Rejected * `being_repriced` - Repricing in Progress * `priced_by_client` - To be Priced by Client * `terms_renegotiated` - Terms being Renegotiated * `cancelled` - Cancelled * `claimed` - Claimed * `paid` - Paid * `pending_client_financial` - Pending Client Financial Approval * `awaiting_external_ca_auth` - Awaiting External CA Authorization * `pending_ca_triage` - Pending CA Review Options: registered, issued, issued_validated, issued_not_valid, rejected_by_builder, being_priced, pricing_submitted, price_agreed, price_rejected, terms_agreed, terms_rejected, being_repriced, priced_by_client, terms_renegotiated, cancelled, claimed, paid, pending_client_financial, awaiting_external_ca_auth, pending_ca_triage
`status_label`	JSON	Computed JSON value; may be null when access is restricted.
`title` *	string	Short summary of the instruction.
`type_label` *	string
`updated_at` *	date-time
`valuation_basis`	string	Legacy single valuation method. Prefer valuation_methods.
`valuation_markup_percent`	decimal	Markup percent when valuation_basis is actual cost + markup.
`valuation_method_terms`	string	Agreed valuation method terms (dayworks, schedule of rates, etc.).
`valuation_methods`	JSON	Ordered proposed valuation methods (priority 1, 2, 3).
`variation_group`	string	Logical grouping for filters (warning, instruction, request, confirmation, advisory).
`workflow_tier`	string	UI workflow tier for this record; upgrade from simple to comprehensive. * `simple` - Simple * `comprehensive` - Comprehensive Options: simple, comprehensive

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/projects/{project_id}/variations/{id}/

Required scopes and service-account permissions: variations:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes. Helper for endpoints where the URL does NOT include project_pk, so we must attach request.workspace_id / request.project_id before permissions run.

Parameters

Name	Location	Details
`id` *	path	uuid
`project_id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`addition_pricing_type`	string	Classification for newly added work in instructed value flows. * `none` - Not specified * `quoted` - This adds a new, quoted item * `unquoted` - This adds a new, unquoted item Options: none, quoted, unquoted
`adjusts_existing_work`	boolean
`anticipated_form_reference`	string
`attached_file_ids`	uuid[]
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`authority_certainty`	string	Bucket 1: definitive vs provisional instruction certainty. * `definitive` - Definitive * `provisional` - Provisional Options: definitive, provisional,
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`base_quote`	uuid	The original approved Quote/Agreement this change applies to.
`base_quote_number`	JSON	Computed JSON value; may be null when access is restricted.
`base_quote_title`	JSON	Computed JSON value; may be null when access is restricted.
`builder_proceeds`	boolean	Does the builder agree to proceed?
`builder_reject_reason`	string	Required if builder_proceeds is False.
`builder_signed_at`	date-time
`ca_financial_note`	string	Optional CA note attached when submitting for client financial approval.
`classification_other`	boolean	Other classification selected: requires classification_other_text.
`classification_other_text`	string	Mandatory free text when classification_other is set.
`client_countersigned_at`	date-time
`client_document_reference`	string	Client / CA reference number from the source document, if any.
`communication_method`	string	How the instruction was received (e.g., email, in_person).
`current_sla`	JSON	Computed JSON value; may be null when access is restricted.
`cvr_next_step`	string	CVR: request formal instruction or formal quote. * `request_instruction` - Request client to officially instruct * `request_quote` - Request client to ask for a formal quote Options: request_instruction, request_quote,
`delay_causes`	JSON	Notice of Delay cause checkbox keys.
`delay_narrative`	string	Notice of Delay free-text narrative.
`document_layout_mode`	JSON	Computed JSON value; may be null when access is restricted.
`draft_init`	boolean
`draft_prefill_instruction_text`	string
`effective_workflow_tier`	JSON	Computed JSON value; may be null when access is restricted.
`eot_to_be_determined`	boolean	True if EOT is acknowledged but will be calculated later.
`extension_of_time_days`	integer	Requested adjustment to the completion date (EOT).
`extension_of_time_hours`	decimal	Requested hours of time impact, in addition to extension_of_time_days.
`given_by`	string	Name of the person who gave the instruction.
`given_by_email`	email	Email for the given_by contact when selected from the project directory.
`given_by_member_id`	uuid
`has_public_consent`	JSON	Computed JSON value; may be null when access is restricted.
`impacts_design`	boolean	Does this change the design?
`impacts_quality`	boolean	Does this affect quality standards?
`impacts_quantity`	boolean	Does this change quantities?
`includes_loss_and_expense`	boolean	Does this claim include additional costs for delay/disruption?
`includes_preparation_costs`	boolean	Does this claim include the cost of preparing the quotation?
`initiation_route`	string	Stable create-route id used to tailor the editable detail view.
`instruction_text`	string	The core instruction given.
`is_addition`	boolean
`is_omission`	boolean
`is_proxy`	boolean	Whether this record was logged on behalf of another party.
`is_substitution`	boolean
`lead_time_dependent`	boolean	Material or specialist lead-time dependency on a simple CVI/CVR/proposal.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_impact`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`payment_timing`	string	Consumer/unadministered: how the variation will be paid. * `invoice_now` - Invoice immediately as a standalone item * `next_stage` - Add to the next stage payment * `final_invoice` - Add to the final project invoice Options: invoice_now, next_stage, final_invoice,
`pci_type`	string	Budget PCI purpose when estimating is on. Empty = paper-only change. * `CLIENT_VARIATION` - Client variation * `INTERNAL_SPEC` - Internal specification change * `PROV_SUM_EXPEND` - Provisional sum expend * `RISK_RELEASE` - Risk / contingency release Options: CLIENT_VARIATION, INTERNAL_SPEC, PROV_SUM_EXPEND, RISK_RELEASE,
`price_agreed_before_start`	boolean	True if price is agreed before work commences, False if proceeding immediately.
`pricing_strategy`	string	Explicit pricing pathway; synced with price_agreed_before_start. * `price_upfront` - Price upfront before work starts * `valuation_method` - Agree a method of valuation * `price_later` - Proceed immediately, price later Options: price_upfront, valuation_method, price_later,
`quote_validity_days`	integer	Validity period (days) when builder submits a quotation.
`quoted_source_quote`	uuid	If this change adds a new quoted item, link the source quote.
`reason`	string	Why is this change happening?
`reason_codes`	JSON	Simple CVI/CVR/proposal reason tick keys.
`reason_other_text`	string
`received_by`	string
`received_by_email`	email
`received_by_member_id`	uuid
`remove_attached_file_ids`	uuid[]
`request_date`	date
`request_time`	time	Time the verbal instruction/request was given.
`request_type`	string	* `request` - Variation Request * `instruction` - Variation Instruction * `early_warning` - Early Warning * `notice_of_delay` - Notice of Delay * `quote_request` - Quote Request * `confirmation` - CVI * `cvi` - Confirmation of Verbal Instruction (CVI) * `cvr` - Confirmation of Verbal Request (CVR) * `change_order` - Change Order * `potential_change_order` - Potential Change Order * `field_directive` - Field Directive Options: request, instruction, early_warning, notice_of_delay, quote_request, confirmation, cvi, cvr, change_order, potential_change_order, field_directive
`response_deadline`	date-time	The deadline for the client/builder to respond before default acceptance/rejection.
`restocking_fees`	decimal	Consumer contracts: restocking / non-refundable deposits.
`resulting_variation_invoice_count`	JSON	Computed JSON value; may be null when access is restricted.
`revised_completion_date`	date	Requested revised completion / working-period end date.
`risk_contingency_value`	decimal	Early warning approximate risk / contingency value.
`signature_loop_stage`	string	* `none` - Not required * `awaiting_builder` - Awaiting builder signature * `awaiting_client` - Awaiting client countersignature * `complete` - Fully signed Options: none, awaiting_builder, awaiting_client, complete,
`simple_issuer_contact`	string
`simple_issuer_contact_email`	email
`simple_issuer_contact_member_id`	uuid
`simple_paper_kind`	JSON	Computed JSON value; may be null when access is restricted.
`simple_price_certainty`	string	Simple workflow: fixed, estimated/indicative, quote requested, no price change, or not assessed. * `fixed` - Fixed price * `estimated` - Estimated / Indicative * `quote_requested` - Quote Requested * `no_price_change` - No price change * `not_assessed` - Not assessed Options: fixed, estimated, quote_requested, no_price_change, not_assessed,
`simple_recipient`	string
`simple_recipient_email`	email
`simple_recipient_member_id`	uuid
`simple_time_certainty`	string	Simple workflow: estimated, definitive / fixed, post-completion, or no time impact. * `estimated` - Estimated / Indicative * `definitive` - Definitive / Fixed * `post_completion` - Assessed / agreed post-completion * `not_assessed` - No time impact Options: estimated, definitive, post_completion, not_assessed,
`sla_deadlines`	JSON	Computed JSON value; may be null when access is restricted.
`source_document_type`	string	Client-issued instruction: type of source document received. * `architect_instruction` - Architect's Instruction (AI/CAI) * `signed_change_agreement` - Signed Change / Variation Agreement * `quote_request` - Quote Request * `site_direction_minutes` - Site Direction / Meeting Minutes * `email_confirmation` - Email Confirmation Options: architect_instruction, signed_change_agreement, quote_request, site_direction_minutes, email_confirmation,
`source_site_log`	uuid
`source_site_log_cost_impact_type`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_date`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_delay_days`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_estimated_cost_amount`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_estimated_cost_currency`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_recommendation`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_responsible_party`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_risk_level`	JSON	Computed JSON value; may be null when access is restricted.
`source_timeline_entry`	uuid
`source_timeline_entry_preview`	JSON	Computed JSON value; may be null when access is restricted.
`status`	string	* `registered` - Draft / Registered * `issued` - Issued / Submitted * `issued_validated` - Instruction Validated * `issued_not_valid` - Instruction Invalid * `rejected_by_builder` - Rejected by Builder * `being_priced` - Pricing in Progress * `pricing_submitted` - Pricing Submitted * `price_agreed` - Price Agreed * `price_rejected` - Price Rejected * `terms_agreed` - Variation Approved * `terms_rejected` - Variation Rejected * `being_repriced` - Repricing in Progress * `priced_by_client` - To be Priced by Client * `terms_renegotiated` - Terms being Renegotiated * `cancelled` - Cancelled * `claimed` - Claimed * `paid` - Paid * `pending_client_financial` - Pending Client Financial Approval * `awaiting_external_ca_auth` - Awaiting External CA Authorization * `pending_ca_triage` - Pending CA Review Options: registered, issued, issued_validated, issued_not_valid, rejected_by_builder, being_priced, pricing_submitted, price_agreed, price_rejected, terms_agreed, terms_rejected, being_repriced, priced_by_client, terms_renegotiated, cancelled, claimed, paid, pending_client_financial, awaiting_external_ca_auth, pending_ca_triage
`status_label`	JSON	Computed JSON value; may be null when access is restricted.
`title`	string	Short summary of the instruction.
`valuation_basis`	string	Legacy single valuation method. Prefer valuation_methods.
`valuation_markup_percent`	decimal	Markup percent when valuation_basis is actual cost + markup.
`valuation_method_terms`	string	Agreed valuation method terms (dayworks, schedule of rates, etc.).
`valuation_methods`	JSON	Ordered proposed valuation methods (priority 1, 2, 3).
`variation_group`	string	Logical grouping for filters (warning, instruction, request, confirmation, advisory).
`workflow_tier`	string	UI workflow tier for this record; upgrade from simple to comprehensive. * `simple` - Simple * `comprehensive` - Comprehensive Options: simple, comprehensive

Responses

200 — Success

Field	Type	Details
`addition_pricing_type`	string	Classification for newly added work in instructed value flows. * `none` - Not specified * `quoted` - This adds a new, quoted item * `unquoted` - This adds a new, unquoted item Options: none, quoted, unquoted
`adjusts_existing_work`	boolean
`anticipated_form_reference`	string
`attached_files` *	FileDetail[]
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`authority_certainty`	string	Bucket 1: definitive vs provisional instruction certainty. * `definitive` - Definitive * `provisional` - Provisional Options: definitive, provisional,
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`base_quote`	uuid	The original approved Quote/Agreement this change applies to.
`base_quote_number`	JSON	Computed JSON value; may be null when access is restricted.
`base_quote_title`	JSON	Computed JSON value; may be null when access is restricted.
`builder_proceeds`	boolean	Does the builder agree to proceed?
`builder_reject_reason`	string	Required if builder_proceeds is False.
`builder_signed_at`	date-time
`ca_financial_note`	string	Optional CA note attached when submitting for client financial approval.
`classification_other`	boolean	Other classification selected: requires classification_other_text.
`classification_other_text`	string	Mandatory free text when classification_other is set.
`client_countersigned_at`	date-time
`client_document_reference`	string	Client / CA reference number from the source document, if any.
`communication_method`	string	How the instruction was received (e.g., email, in_person).
`created_at` *	date-time
`current_sla`	JSON	Computed JSON value; may be null when access is restricted.
`cvr_next_step`	string	CVR: request formal instruction or formal quote. * `request_instruction` - Request client to officially instruct * `request_quote` - Request client to ask for a formal quote Options: request_instruction, request_quote,
`delay_causes`	JSON	Notice of Delay cause checkbox keys.
`delay_narrative`	string	Notice of Delay free-text narrative.
`document_layout_mode`	JSON	Computed JSON value; may be null when access is restricted.
`effective_workflow_tier`	JSON	Computed JSON value; may be null when access is restricted.
`entered_by` *	uuid
`eot_to_be_determined`	boolean	True if EOT is acknowledged but will be calculated later.
`extension_of_time_days`	integer	Requested adjustment to the completion date (EOT).
`extension_of_time_hours`	decimal	Requested hours of time impact, in addition to extension_of_time_days.
`given_by`	string	Name of the person who gave the instruction.
`given_by_email`	email	Email for the given_by contact when selected from the project directory.
`given_by_member_id`	uuid
`has_public_consent`	JSON	Computed JSON value; may be null when access is restricted.
`id` *	uuid
`impacts_design`	boolean	Does this change the design?
`impacts_quality`	boolean	Does this affect quality standards?
`impacts_quantity`	boolean	Does this change quantities?
`includes_loss_and_expense`	boolean	Does this claim include additional costs for delay/disruption?
`includes_preparation_costs`	boolean	Does this claim include the cost of preparing the quotation?
`initiation_route`	string	Stable create-route id used to tailor the editable detail view.
`instruction_text`	string	The core instruction given.
`is_addition`	boolean
`is_omission`	boolean
`is_proxy`	boolean	Whether this record was logged on behalf of another party.
`is_substitution`	boolean
`items` *	ChangeItem[]
`lead_time_dependent`	boolean	Material or specialist lead-time dependency on a simple CVI/CVR/proposal.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_impact`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`payment_timing`	string	Consumer/unadministered: how the variation will be paid. * `invoice_now` - Invoice immediately as a standalone item * `next_stage` - Add to the next stage payment * `final_invoice` - Add to the final project invoice Options: invoice_now, next_stage, final_invoice,
`pci_type`	string	Budget PCI purpose when estimating is on. Empty = paper-only change. * `CLIENT_VARIATION` - Client variation * `INTERNAL_SPEC` - Internal specification change * `PROV_SUM_EXPEND` - Provisional sum expend * `RISK_RELEASE` - Risk / contingency release Options: CLIENT_VARIATION, INTERNAL_SPEC, PROV_SUM_EXPEND, RISK_RELEASE,
`price_agreed_before_start`	boolean	True if price is agreed before work commences, False if proceeding immediately.
`pricing_strategy`	string	Explicit pricing pathway; synced with price_agreed_before_start. * `price_upfront` - Price upfront before work starts * `valuation_method` - Agree a method of valuation * `price_later` - Proceed immediately, price later Options: price_upfront, valuation_method, price_later,
`project` *	uuid
`project_name` *	string	Name of the project.
`quote_validity_days`	integer	Validity period (days) when builder submits a quotation.
`quoted_source_quote`	uuid	If this change adds a new quoted item, link the source quote.
`reason`	string	Why is this change happening?
`reason_codes`	JSON	Simple CVI/CVR/proposal reason tick keys.
`reason_other_text`	string
`received_by`	string
`received_by_email`	email
`received_by_member_id`	uuid
`register_number` *	string	Stable display ref e.g. CHG-001. Terminology labels are separate.
`register_sequence` *	integer	Project-scoped sequence used to build register_number.
`request_date`	date
`request_time`	time	Time the verbal instruction/request was given.
`request_type`	string	* `request` - Variation Request * `instruction` - Variation Instruction * `early_warning` - Early Warning * `notice_of_delay` - Notice of Delay * `quote_request` - Quote Request * `confirmation` - CVI * `cvi` - Confirmation of Verbal Instruction (CVI) * `cvr` - Confirmation of Verbal Request (CVR) * `change_order` - Change Order * `potential_change_order` - Potential Change Order * `field_directive` - Field Directive Options: request, instruction, early_warning, notice_of_delay, quote_request, confirmation, cvi, cvr, change_order, potential_change_order, field_directive
`response_deadline`	date-time	The deadline for the client/builder to respond before default acceptance/rejection.
`restocking_fees`	decimal	Consumer contracts: restocking / non-refundable deposits.
`restocking_fees_currency` *	string	* `XUA` - ADB Unit of Account * `AFN` - Afghan Afghani * `AFA` - Afghan Afghani (1927–2002) * `ALL` - Albanian Lek * `ALK` - Albanian Lek (1946–1965) * `DZD` - Algerian Dinar * `ADP` - Andorran Peseta * `AOA` - Angolan Kwanza * `AOK` - Angolan Kwanza (1977–1991) * `AON` - Angolan New Kwanza (1990–2000) * `AOR` - Angolan Readjusted Kwanza (1995–1999) * `ARA` - Argentine Austral * `ARS` - Argentine Peso * `ARM` - Argentine Peso (1881–1970) * `ARP` - Argentine Peso (1983–1985) * `ARL` - Argentine Peso Ley (1970–1983) * `AMD` - Armenian Dram * `AWG` - Aruban Florin * `AUD` - Australian Dollar * `ATS` - Austrian Schilling * `AZN` - Azerbaijani Manat * `AZM` - Azerbaijani Manat (1993–2006) * `BSD` - Bahamian Dollar * `BHD` - Bahraini Dinar * `BDT` - Bangladeshi Taka * `BBD` - Barbadian Dollar * `BYN` - Belarusian Ruble * `BYB` - Belarusian Ruble (1994–1999) * `BYR` - Belarusian Ruble (2000–2016) * `BEF` - Belgian Franc * `BEC` - Belgian Franc (convertible) * `BEL` - Belgian Franc (financial) * `BZD` - Belize Dollar * `BMD` - Bermudan Dollar * `BTN` - Bhutanese Ngultrum * `BOB` - Bolivian Boliviano * `BOL` - Bolivian Boliviano (1863–1963) * `BOV` - Bolivian Mvdol * `BOP` - Bolivian Peso * `VED` - Bolívar Soberano * `BAM` - Bosnia-Herzegovina Convertible Mark * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) * `BWP` - Botswanan Pula * `BRC` - Brazilian Cruzado (1986–1989) * `BRZ` - Brazilian Cruzeiro (1942–1967) * `BRE` - Brazilian Cruzeiro (1990–1993) * `BRR` - Brazilian Cruzeiro (1993–1994) * `BRN` - Brazilian New Cruzado (1989–1990) * `BRB` - Brazilian New Cruzeiro (1967–1986) * `BRL` - Brazilian Real * `GBP` - British Pound * `BND` - Brunei Dollar * `BGL` - Bulgarian Hard Lev * `BGN` - Bulgarian Lev * `BGO` - Bulgarian Lev (1879–1952) * `BGM` - Bulgarian Socialist Lev * `BUK` - Burmese Kyat * `BIF` - Burundian Franc * `XPF` - CFP Franc * `KHR` - Cambodian Riel * `CAD` - Canadian Dollar * `CVE` - Cape Verdean Escudo * `KYD` - Cayman Islands Dollar * `XAF` - Central African CFA Franc * `CLE` - Chilean Escudo * `CLP` - Chilean Peso * `CLF` - Chilean Unit of Account (UF) * `CNX` - Chinese People’s Bank Dollar * `CNY` - Chinese Yuan * `CNH` - Chinese Yuan (offshore) * `COP` - Colombian Peso * `COU` - Colombian Real Value Unit * `KMF` - Comorian Franc * `CDF` - Congolese Franc * `CRC` - Costa Rican Colón * `HRD` - Croatian Dinar * `HRK` - Croatian Kuna * `CUC` - Cuban Convertible Peso * `CUP` - Cuban Peso * `CYP` - Cypriot Pound * `CZK` - Czech Koruna * `CSK` - Czechoslovak Hard Koruna * `DKK` - Danish Krone * `DJF` - Djiboutian Franc * `DOP` - Dominican Peso * `NLG` - Dutch Guilder * `XCD` - East Caribbean Dollar * `DDM` - East German Mark * `ECS` - Ecuadorian Sucre * `ECV` - Ecuadorian Unit of Constant Value * `EGP` - Egyptian Pound * `GQE` - Equatorial Guinean Ekwele * `ERN` - Eritrean Nakfa * `EEK` - Estonian Kroon * `ETB` - Ethiopian Birr * `EUR` - Euro * `XBA` - European Composite Unit * `XEU` - European Currency Unit * `XBB` - European Monetary Unit * `XBC` - European Unit of Account (XBC) * `XBD` - European Unit of Account (XBD) * `FKP` - Falkland Islands Pound * `FJD` - Fijian Dollar * `FIM` - Finnish Markka * `FRF` - French Franc * `XFO` - French Gold Franc * `XFU` - French UIC-Franc * `GMD` - Gambian Dalasi * `GEK` - Georgian Kupon Larit * `GEL` - Georgian Lari * `DEM` - German Mark * `GHS` - Ghanaian Cedi * `GHC` - Ghanaian Cedi (1979–2007) * `GIP` - Gibraltar Pound * `XAU` - Gold * `GRD` - Greek Drachma * `GTQ` - Guatemalan Quetzal * `GWP` - Guinea-Bissau Peso * `GNF` - Guinean Franc * `GNS` - Guinean Syli * `GYD` - Guyanaese Dollar * `HTG` - Haitian Gourde * `HNL` - Honduran Lempira * `HKD` - Hong Kong Dollar * `HUF` - Hungarian Forint * `IMP` - IMP * `ISK` - Icelandic Króna * `ISJ` - Icelandic Króna (1918–1981) * `INR` - Indian Rupee * `IDR` - Indonesian Rupiah * `IRR` - Iranian Rial * `IQD` - Iraqi Dinar * `IEP` - Irish Pound * `ILS` - Israeli New Shekel * `ILP` - Israeli Pound * `ILR` - Israeli Shekel (1980–1985) * `ITL` - Italian Lira * `JMD` - Jamaican Dollar * `JPY` - Japanese Yen * `JOD` - Jordanian Dinar * `KZT` - Kazakhstani Tenge * `KES` - Kenyan Shilling * `KWD` - Kuwaiti Dinar * `KGS` - Kyrgystani Som * `LAK` - Laotian Kip * `LVL` - Latvian Lats * `LVR` - Latvian Ruble * `LBP` - Lebanese Pound * `LSL` - Lesotho Loti * `LRD` - Liberian Dollar * `LYD` - Libyan Dinar * `LTL` - Lithuanian Litas * `LTT` - Lithuanian Talonas * `LUL` - Luxembourg Financial Franc * `LUC` - Luxembourgian Convertible Franc * `LUF` - Luxembourgian Franc * `MOP` - Macanese Pataca * `MKD` - Macedonian Denar * `MKN` - Macedonian Denar (1992–1993) * `MGA` - Malagasy Ariary * `MGF` - Malagasy Franc * `MWK` - Malawian Kwacha * `MYR` - Malaysian Ringgit * `MVR` - Maldivian Rufiyaa * `MVP` - Maldivian Rupee (1947–1981) * `MLF` - Malian Franc * `MTL` - Maltese Lira * `MTP` - Maltese Pound * `MRU` - Mauritanian Ouguiya * `MRO` - Mauritanian Ouguiya (1973–2017) * `MUR` - Mauritian Rupee * `MXV` - Mexican Investment Unit * `MXN` - Mexican Peso * `MXP` - Mexican Silver Peso (1861–1992) * `MDC` - Moldovan Cupon * `MDL` - Moldovan Leu * `MCF` - Monegasque Franc * `MNT` - Mongolian Tugrik * `MAD` - Moroccan Dirham * `MAF` - Moroccan Franc * `MZE` - Mozambican Escudo * `MZN` - Mozambican Metical * `MZM` - Mozambican Metical (1980–2006) * `MMK` - Myanmar Kyat * `NAD` - Namibian Dollar * `NPR` - Nepalese Rupee * `ANG` - Netherlands Antillean Guilder * `TWD` - New Taiwan Dollar * `NZD` - New Zealand Dollar * `NIO` - Nicaraguan Córdoba * `NIC` - Nicaraguan Córdoba (1988–1991) * `NGN` - Nigerian Naira * `KPW` - North Korean Won * `NOK` - Norwegian Krone * `OMR` - Omani Rial * `PKR` - Pakistani Rupee * `XPD` - Palladium * `PAB` - Panamanian Balboa * `PGK` - Papua New Guinean Kina * `PYG` - Paraguayan Guarani * `PEI` - Peruvian Inti * `PEN` - Peruvian Sol * `PES` - Peruvian Sol (1863–1965) * `PHP` - Philippine Peso * `XPT` - Platinum * `PLN` - Polish Zloty * `PLZ` - Polish Zloty (1950–1995) * `PTE` - Portuguese Escudo * `GWE` - Portuguese Guinea Escudo * `QAR` - Qatari Riyal * `XRE` - RINET Funds * `RHD` - Rhodesian Dollar * `RON` - Romanian Leu * `ROL` - Romanian Leu (1952–2006) * `RUB` - Russian Ruble * `RUR` - Russian Ruble (1991–1998) * `RWF` - Rwandan Franc * `SVC` - Salvadoran Colón * `WST` - Samoan Tala * `SAR` - Saudi Riyal * `RSD` - Serbian Dinar * `CSD` - Serbian Dinar (2002–2006) * `SCR` - Seychellois Rupee * `SLE` - Sierra Leonean Leone * `SLL` - Sierra Leonean Leone (1964—2022) * `XAG` - Silver * `SGD` - Singapore Dollar * `SKK` - Slovak Koruna * `SIT` - Slovenian Tolar * `SBD` - Solomon Islands Dollar * `SOS` - Somali Shilling * `ZAR` - South African Rand * `ZAL` - South African Rand (financial) * `KRH` - South Korean Hwan (1953–1962) * `KRW` - South Korean Won * `KRO` - South Korean Won (1945–1953) * `SSP` - South Sudanese Pound * `SUR` - Soviet Rouble * `ESP` - Spanish Peseta * `ESA` - Spanish Peseta (A account) * `ESB` - Spanish Peseta (convertible account) * `XDR` - Special Drawing Rights * `LKR` - Sri Lankan Rupee * `SHP` - St. Helena Pound * `XSU` - Sucre * `SDD` - Sudanese Dinar (1992–2007) * `SDG` - Sudanese Pound * `SDP` - Sudanese Pound (1957–1998) * `SRD` - Surinamese Dollar * `SRG` - Surinamese Guilder * `SZL` - Swazi Lilangeni * `SEK` - Swedish Krona * `CHF` - Swiss Franc * `SYP` - Syrian Pound * `STN` - São Tomé & Príncipe Dobra * `STD` - São Tomé & Príncipe Dobra (1977–2017) * `TVD` - TVD * `TJR` - Tajikistani Ruble * `TJS` - Tajikistani Somoni * `TZS` - Tanzanian Shilling * `XTS` - Testing Currency Code * `THB` - Thai Baht * `TPE` - Timorese Escudo * `TOP` - Tongan Paʻanga * `TTD` - Trinidad & Tobago Dollar * `TND` - Tunisian Dinar * `TRY` - Turkish Lira * `TRL` - Turkish Lira (1922–2005) * `TMT` - Turkmenistani Manat * `TMM` - Turkmenistani Manat (1993–2009) * `USD` - US Dollar * `USN` - US Dollar (Next day) * `USS` - US Dollar (Same day) * `UGX` - Ugandan Shilling * `UGS` - Ugandan Shilling (1966–1987) * `UAH` - Ukrainian Hryvnia * `UAK` - Ukrainian Karbovanets * `AED` - United Arab Emirates Dirham * `UYW` - Uruguayan Nominal Wage Index Unit * `UYU` - Uruguayan Peso * `UYP` - Uruguayan Peso (1975–1993) * `UYI` - Uruguayan Peso (Indexed Units) * `UZS` - Uzbekistani Som * `VUV` - Vanuatu Vatu * `VES` - Venezuelan Bolívar * `VEB` - Venezuelan Bolívar (1871–2008) * `VEF` - Venezuelan Bolívar (2008–2018) * `VND` - Vietnamese Dong * `VNN` - Vietnamese Dong (1978–1985) * `CHE` - WIR Euro * `CHW` - WIR Franc * `XOF` - West African CFA Franc * `YDD` - Yemeni Dinar * `YER` - Yemeni Rial * `YUN` - Yugoslavian Convertible Dinar (1990–1992) * `YUD` - Yugoslavian Hard Dinar (1966–1990) * `YUM` - Yugoslavian New Dinar (1994–2002) * `YUR` - Yugoslavian Reformed Dinar (1992–1993) * `ZWN` - ZWN * `ZRN` - Zairean New Zaire (1993–1998) * `ZRZ` - Zairean Zaire (1971–1993) * `ZMW` - Zambian Kwacha * `ZMK` - Zambian Kwacha (1968–2012) * `ZWD` - Zimbabwean Dollar (1980–2008) * `ZWR` - Zimbabwean Dollar (2008) * `ZWL` - Zimbabwean Dollar (2009–2024) Options: XUA, AFN, AFA, ALL, ALK, DZD, ADP, AOA, AOK, AON, AOR, ARA, ARS, ARM, ARP, ARL, AMD, AWG, AUD, ATS, AZN, AZM, BSD, BHD, BDT, BBD, BYN, BYB, BYR, BEF, BEC, BEL, BZD, BMD, BTN, BOB, BOL, BOV, BOP, VED, BAM, BAD, BAN, BWP, BRC, BRZ, BRE, BRR, BRN, BRB, BRL, GBP, BND, BGL, BGN, BGO, BGM, BUK, BIF, XPF, KHR, CAD, CVE, KYD, XAF, CLE, CLP, CLF, CNX, CNY, CNH, COP, COU, KMF, CDF, CRC, HRD, HRK, CUC, CUP, CYP, CZK, CSK, DKK, DJF, DOP, NLG, XCD, DDM, ECS, ECV, EGP, GQE, ERN, EEK, ETB, EUR, XBA, XEU, XBB, XBC, XBD, FKP, FJD, FIM, FRF, XFO, XFU, GMD, GEK, GEL, DEM, GHS, GHC, GIP, XAU, GRD, GTQ, GWP, GNF, GNS, GYD, HTG, HNL, HKD, HUF, IMP, ISK, ISJ, INR, IDR, IRR, IQD, IEP, ILS, ILP, ILR, ITL, JMD, JPY, JOD, KZT, KES, KWD, KGS, LAK, LVL, LVR, LBP, LSL, LRD, LYD, LTL, LTT, LUL, LUC, LUF, MOP, MKD, MKN, MGA, MGF, MWK, MYR, MVR, MVP, MLF, MTL, MTP, MRU, MRO, MUR, MXV, MXN, MXP, MDC, MDL, MCF, MNT, MAD, MAF, MZE, MZN, MZM, MMK, NAD, NPR, ANG, TWD, NZD, NIO, NIC, NGN, KPW, NOK, OMR, PKR, XPD, PAB, PGK, PYG, PEI, PEN, PES, PHP, XPT, PLN, PLZ, PTE, GWE, QAR, XRE, RHD, RON, ROL, RUB, RUR, RWF, SVC, WST, SAR, RSD, CSD, SCR, SLE, SLL, XAG, SGD, SKK, SIT, SBD, SOS, ZAR, ZAL, KRH, KRW, KRO, SSP, SUR, ESP, ESA, ESB, XDR, LKR, SHP, XSU, SDD, SDG, SDP, SRD, SRG, SZL, SEK, CHF, SYP, STN, STD, TVD, TJR, TJS, TZS, XTS, THB, TPE, TOP, TTD, TND, TRY, TRL, TMT, TMM, USD, USN, USS, UGX, UGS, UAH, UAK, AED, UYW, UYU, UYP, UYI, UZS, VUV, VES, VEB, VEF, VND, VNN, CHE, CHW, XOF, YDD, YER, YUN, YUD, YUM, YUR, ZWN, ZRN, ZRZ, ZMW, ZMK, ZWD, ZWR, ZWL,
`resulting_variation` *	uuid	The formal Variation Quote generated from this request.
`resulting_variation_invoice_count`	JSON	Computed JSON value; may be null when access is restricted.
`resulting_variation_number`	string	Workspace-unique quote number (e.g., QUO-001).
`resulting_variation_sequence`	integer	Sequential number if this is a variation (e.g., 1, 2, 3).
`resulting_variation_status`	string	* `draft` - Draft * `sent` - Sent * `approved` - Approved * `rejected` - Rejected * `superseded` - Superseded * `locked` - Locked (linked to quote) * `archived` - Archived Options: draft, sent, approved, rejected, superseded, locked, archived
`revised_completion_date`	date	Requested revised completion / working-period end date.
`risk_contingency_value`	decimal	Early warning approximate risk / contingency value.
`risk_contingency_value_currency` *	string	* `XUA` - ADB Unit of Account * `AFN` - Afghan Afghani * `AFA` - Afghan Afghani (1927–2002) * `ALL` - Albanian Lek * `ALK` - Albanian Lek (1946–1965) * `DZD` - Algerian Dinar * `ADP` - Andorran Peseta * `AOA` - Angolan Kwanza * `AOK` - Angolan Kwanza (1977–1991) * `AON` - Angolan New Kwanza (1990–2000) * `AOR` - Angolan Readjusted Kwanza (1995–1999) * `ARA` - Argentine Austral * `ARS` - Argentine Peso * `ARM` - Argentine Peso (1881–1970) * `ARP` - Argentine Peso (1983–1985) * `ARL` - Argentine Peso Ley (1970–1983) * `AMD` - Armenian Dram * `AWG` - Aruban Florin * `AUD` - Australian Dollar * `ATS` - Austrian Schilling * `AZN` - Azerbaijani Manat * `AZM` - Azerbaijani Manat (1993–2006) * `BSD` - Bahamian Dollar * `BHD` - Bahraini Dinar * `BDT` - Bangladeshi Taka * `BBD` - Barbadian Dollar * `BYN` - Belarusian Ruble * `BYB` - Belarusian Ruble (1994–1999) * `BYR` - Belarusian Ruble (2000–2016) * `BEF` - Belgian Franc * `BEC` - Belgian Franc (convertible) * `BEL` - Belgian Franc (financial) * `BZD` - Belize Dollar * `BMD` - Bermudan Dollar * `BTN` - Bhutanese Ngultrum * `BOB` - Bolivian Boliviano * `BOL` - Bolivian Boliviano (1863–1963) * `BOV` - Bolivian Mvdol * `BOP` - Bolivian Peso * `VED` - Bolívar Soberano * `BAM` - Bosnia-Herzegovina Convertible Mark * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) * `BWP` - Botswanan Pula * `BRC` - Brazilian Cruzado (1986–1989) * `BRZ` - Brazilian Cruzeiro (1942–1967) * `BRE` - Brazilian Cruzeiro (1990–1993) * `BRR` - Brazilian Cruzeiro (1993–1994) * `BRN` - Brazilian New Cruzado (1989–1990) * `BRB` - Brazilian New Cruzeiro (1967–1986) * `BRL` - Brazilian Real * `GBP` - British Pound * `BND` - Brunei Dollar * `BGL` - Bulgarian Hard Lev * `BGN` - Bulgarian Lev * `BGO` - Bulgarian Lev (1879–1952) * `BGM` - Bulgarian Socialist Lev * `BUK` - Burmese Kyat * `BIF` - Burundian Franc * `XPF` - CFP Franc * `KHR` - Cambodian Riel * `CAD` - Canadian Dollar * `CVE` - Cape Verdean Escudo * `KYD` - Cayman Islands Dollar * `XAF` - Central African CFA Franc * `CLE` - Chilean Escudo * `CLP` - Chilean Peso * `CLF` - Chilean Unit of Account (UF) * `CNX` - Chinese People’s Bank Dollar * `CNY` - Chinese Yuan * `CNH` - Chinese Yuan (offshore) * `COP` - Colombian Peso * `COU` - Colombian Real Value Unit * `KMF` - Comorian Franc * `CDF` - Congolese Franc * `CRC` - Costa Rican Colón * `HRD` - Croatian Dinar * `HRK` - Croatian Kuna * `CUC` - Cuban Convertible Peso * `CUP` - Cuban Peso * `CYP` - Cypriot Pound * `CZK` - Czech Koruna * `CSK` - Czechoslovak Hard Koruna * `DKK` - Danish Krone * `DJF` - Djiboutian Franc * `DOP` - Dominican Peso * `NLG` - Dutch Guilder * `XCD` - East Caribbean Dollar * `DDM` - East German Mark * `ECS` - Ecuadorian Sucre * `ECV` - Ecuadorian Unit of Constant Value * `EGP` - Egyptian Pound * `GQE` - Equatorial Guinean Ekwele * `ERN` - Eritrean Nakfa * `EEK` - Estonian Kroon * `ETB` - Ethiopian Birr * `EUR` - Euro * `XBA` - European Composite Unit * `XEU` - European Currency Unit * `XBB` - European Monetary Unit * `XBC` - European Unit of Account (XBC) * `XBD` - European Unit of Account (XBD) * `FKP` - Falkland Islands Pound * `FJD` - Fijian Dollar * `FIM` - Finnish Markka * `FRF` - French Franc * `XFO` - French Gold Franc * `XFU` - French UIC-Franc * `GMD` - Gambian Dalasi * `GEK` - Georgian Kupon Larit * `GEL` - Georgian Lari * `DEM` - German Mark * `GHS` - Ghanaian Cedi * `GHC` - Ghanaian Cedi (1979–2007) * `GIP` - Gibraltar Pound * `XAU` - Gold * `GRD` - Greek Drachma * `GTQ` - Guatemalan Quetzal * `GWP` - Guinea-Bissau Peso * `GNF` - Guinean Franc * `GNS` - Guinean Syli * `GYD` - Guyanaese Dollar * `HTG` - Haitian Gourde * `HNL` - Honduran Lempira * `HKD` - Hong Kong Dollar * `HUF` - Hungarian Forint * `IMP` - IMP * `ISK` - Icelandic Króna * `ISJ` - Icelandic Króna (1918–1981) * `INR` - Indian Rupee * `IDR` - Indonesian Rupiah * `IRR` - Iranian Rial * `IQD` - Iraqi Dinar * `IEP` - Irish Pound * `ILS` - Israeli New Shekel * `ILP` - Israeli Pound * `ILR` - Israeli Shekel (1980–1985) * `ITL` - Italian Lira * `JMD` - Jamaican Dollar * `JPY` - Japanese Yen * `JOD` - Jordanian Dinar * `KZT` - Kazakhstani Tenge * `KES` - Kenyan Shilling * `KWD` - Kuwaiti Dinar * `KGS` - Kyrgystani Som * `LAK` - Laotian Kip * `LVL` - Latvian Lats * `LVR` - Latvian Ruble * `LBP` - Lebanese Pound * `LSL` - Lesotho Loti * `LRD` - Liberian Dollar * `LYD` - Libyan Dinar * `LTL` - Lithuanian Litas * `LTT` - Lithuanian Talonas * `LUL` - Luxembourg Financial Franc * `LUC` - Luxembourgian Convertible Franc * `LUF` - Luxembourgian Franc * `MOP` - Macanese Pataca * `MKD` - Macedonian Denar * `MKN` - Macedonian Denar (1992–1993) * `MGA` - Malagasy Ariary * `MGF` - Malagasy Franc * `MWK` - Malawian Kwacha * `MYR` - Malaysian Ringgit * `MVR` - Maldivian Rufiyaa * `MVP` - Maldivian Rupee (1947–1981) * `MLF` - Malian Franc * `MTL` - Maltese Lira * `MTP` - Maltese Pound * `MRU` - Mauritanian Ouguiya * `MRO` - Mauritanian Ouguiya (1973–2017) * `MUR` - Mauritian Rupee * `MXV` - Mexican Investment Unit * `MXN` - Mexican Peso * `MXP` - Mexican Silver Peso (1861–1992) * `MDC` - Moldovan Cupon * `MDL` - Moldovan Leu * `MCF` - Monegasque Franc * `MNT` - Mongolian Tugrik * `MAD` - Moroccan Dirham * `MAF` - Moroccan Franc * `MZE` - Mozambican Escudo * `MZN` - Mozambican Metical * `MZM` - Mozambican Metical (1980–2006) * `MMK` - Myanmar Kyat * `NAD` - Namibian Dollar * `NPR` - Nepalese Rupee * `ANG` - Netherlands Antillean Guilder * `TWD` - New Taiwan Dollar * `NZD` - New Zealand Dollar * `NIO` - Nicaraguan Córdoba * `NIC` - Nicaraguan Córdoba (1988–1991) * `NGN` - Nigerian Naira * `KPW` - North Korean Won * `NOK` - Norwegian Krone * `OMR` - Omani Rial * `PKR` - Pakistani Rupee * `XPD` - Palladium * `PAB` - Panamanian Balboa * `PGK` - Papua New Guinean Kina * `PYG` - Paraguayan Guarani * `PEI` - Peruvian Inti * `PEN` - Peruvian Sol * `PES` - Peruvian Sol (1863–1965) * `PHP` - Philippine Peso * `XPT` - Platinum * `PLN` - Polish Zloty * `PLZ` - Polish Zloty (1950–1995) * `PTE` - Portuguese Escudo * `GWE` - Portuguese Guinea Escudo * `QAR` - Qatari Riyal * `XRE` - RINET Funds * `RHD` - Rhodesian Dollar * `RON` - Romanian Leu * `ROL` - Romanian Leu (1952–2006) * `RUB` - Russian Ruble * `RUR` - Russian Ruble (1991–1998) * `RWF` - Rwandan Franc * `SVC` - Salvadoran Colón * `WST` - Samoan Tala * `SAR` - Saudi Riyal * `RSD` - Serbian Dinar * `CSD` - Serbian Dinar (2002–2006) * `SCR` - Seychellois Rupee * `SLE` - Sierra Leonean Leone * `SLL` - Sierra Leonean Leone (1964—2022) * `XAG` - Silver * `SGD` - Singapore Dollar * `SKK` - Slovak Koruna * `SIT` - Slovenian Tolar * `SBD` - Solomon Islands Dollar * `SOS` - Somali Shilling * `ZAR` - South African Rand * `ZAL` - South African Rand (financial) * `KRH` - South Korean Hwan (1953–1962) * `KRW` - South Korean Won * `KRO` - South Korean Won (1945–1953) * `SSP` - South Sudanese Pound * `SUR` - Soviet Rouble * `ESP` - Spanish Peseta * `ESA` - Spanish Peseta (A account) * `ESB` - Spanish Peseta (convertible account) * `XDR` - Special Drawing Rights * `LKR` - Sri Lankan Rupee * `SHP` - St. Helena Pound * `XSU` - Sucre * `SDD` - Sudanese Dinar (1992–2007) * `SDG` - Sudanese Pound * `SDP` - Sudanese Pound (1957–1998) * `SRD` - Surinamese Dollar * `SRG` - Surinamese Guilder * `SZL` - Swazi Lilangeni * `SEK` - Swedish Krona * `CHF` - Swiss Franc * `SYP` - Syrian Pound * `STN` - São Tomé & Príncipe Dobra * `STD` - São Tomé & Príncipe Dobra (1977–2017) * `TVD` - TVD * `TJR` - Tajikistani Ruble * `TJS` - Tajikistani Somoni * `TZS` - Tanzanian Shilling * `XTS` - Testing Currency Code * `THB` - Thai Baht * `TPE` - Timorese Escudo * `TOP` - Tongan Paʻanga * `TTD` - Trinidad & Tobago Dollar * `TND` - Tunisian Dinar * `TRY` - Turkish Lira * `TRL` - Turkish Lira (1922–2005) * `TMT` - Turkmenistani Manat * `TMM` - Turkmenistani Manat (1993–2009) * `USD` - US Dollar * `USN` - US Dollar (Next day) * `USS` - US Dollar (Same day) * `UGX` - Ugandan Shilling * `UGS` - Ugandan Shilling (1966–1987) * `UAH` - Ukrainian Hryvnia * `UAK` - Ukrainian Karbovanets * `AED` - United Arab Emirates Dirham * `UYW` - Uruguayan Nominal Wage Index Unit * `UYU` - Uruguayan Peso * `UYP` - Uruguayan Peso (1975–1993) * `UYI` - Uruguayan Peso (Indexed Units) * `UZS` - Uzbekistani Som * `VUV` - Vanuatu Vatu * `VES` - Venezuelan Bolívar * `VEB` - Venezuelan Bolívar (1871–2008) * `VEF` - Venezuelan Bolívar (2008–2018) * `VND` - Vietnamese Dong * `VNN` - Vietnamese Dong (1978–1985) * `CHE` - WIR Euro * `CHW` - WIR Franc * `XOF` - West African CFA Franc * `YDD` - Yemeni Dinar * `YER` - Yemeni Rial * `YUN` - Yugoslavian Convertible Dinar (1990–1992) * `YUD` - Yugoslavian Hard Dinar (1966–1990) * `YUM` - Yugoslavian New Dinar (1994–2002) * `YUR` - Yugoslavian Reformed Dinar (1992–1993) * `ZWN` - ZWN * `ZRN` - Zairean New Zaire (1993–1998) * `ZRZ` - Zairean Zaire (1971–1993) * `ZMW` - Zambian Kwacha * `ZMK` - Zambian Kwacha (1968–2012) * `ZWD` - Zimbabwean Dollar (1980–2008) * `ZWR` - Zimbabwean Dollar (2008) * `ZWL` - Zimbabwean Dollar (2009–2024) Options: XUA, AFN, AFA, ALL, ALK, DZD, ADP, AOA, AOK, AON, AOR, ARA, ARS, ARM, ARP, ARL, AMD, AWG, AUD, ATS, AZN, AZM, BSD, BHD, BDT, BBD, BYN, BYB, BYR, BEF, BEC, BEL, BZD, BMD, BTN, BOB, BOL, BOV, BOP, VED, BAM, BAD, BAN, BWP, BRC, BRZ, BRE, BRR, BRN, BRB, BRL, GBP, BND, BGL, BGN, BGO, BGM, BUK, BIF, XPF, KHR, CAD, CVE, KYD, XAF, CLE, CLP, CLF, CNX, CNY, CNH, COP, COU, KMF, CDF, CRC, HRD, HRK, CUC, CUP, CYP, CZK, CSK, DKK, DJF, DOP, NLG, XCD, DDM, ECS, ECV, EGP, GQE, ERN, EEK, ETB, EUR, XBA, XEU, XBB, XBC, XBD, FKP, FJD, FIM, FRF, XFO, XFU, GMD, GEK, GEL, DEM, GHS, GHC, GIP, XAU, GRD, GTQ, GWP, GNF, GNS, GYD, HTG, HNL, HKD, HUF, IMP, ISK, ISJ, INR, IDR, IRR, IQD, IEP, ILS, ILP, ILR, ITL, JMD, JPY, JOD, KZT, KES, KWD, KGS, LAK, LVL, LVR, LBP, LSL, LRD, LYD, LTL, LTT, LUL, LUC, LUF, MOP, MKD, MKN, MGA, MGF, MWK, MYR, MVR, MVP, MLF, MTL, MTP, MRU, MRO, MUR, MXV, MXN, MXP, MDC, MDL, MCF, MNT, MAD, MAF, MZE, MZN, MZM, MMK, NAD, NPR, ANG, TWD, NZD, NIO, NIC, NGN, KPW, NOK, OMR, PKR, XPD, PAB, PGK, PYG, PEI, PEN, PES, PHP, XPT, PLN, PLZ, PTE, GWE, QAR, XRE, RHD, RON, ROL, RUB, RUR, RWF, SVC, WST, SAR, RSD, CSD, SCR, SLE, SLL, XAG, SGD, SKK, SIT, SBD, SOS, ZAR, ZAL, KRH, KRW, KRO, SSP, SUR, ESP, ESA, ESB, XDR, LKR, SHP, XSU, SDD, SDG, SDP, SRD, SRG, SZL, SEK, CHF, SYP, STN, STD, TVD, TJR, TJS, TZS, XTS, THB, TPE, TOP, TTD, TND, TRY, TRL, TMT, TMM, USD, USN, USS, UGX, UGS, UAH, UAK, AED, UYW, UYU, UYP, UYI, UZS, VUV, VES, VEB, VEF, VND, VNN, CHE, CHW, XOF, YDD, YER, YUN, YUD, YUM, YUR, ZWN, ZRN, ZRZ, ZMW, ZMK, ZWD, ZWR, ZWL,
`signature_loop_stage`	string	* `none` - Not required * `awaiting_builder` - Awaiting builder signature * `awaiting_client` - Awaiting client countersignature * `complete` - Fully signed Options: none, awaiting_builder, awaiting_client, complete,
`simple_issuer_contact`	string
`simple_issuer_contact_email`	email
`simple_issuer_contact_member_id`	uuid
`simple_paper_kind`	JSON	Computed JSON value; may be null when access is restricted.
`simple_price_certainty`	string	Simple workflow: fixed, estimated/indicative, quote requested, no price change, or not assessed. * `fixed` - Fixed price * `estimated` - Estimated / Indicative * `quote_requested` - Quote Requested * `no_price_change` - No price change * `not_assessed` - Not assessed Options: fixed, estimated, quote_requested, no_price_change, not_assessed,
`simple_recipient`	string
`simple_recipient_email`	email
`simple_recipient_member_id`	uuid
`simple_time_certainty`	string	Simple workflow: estimated, definitive / fixed, post-completion, or no time impact. * `estimated` - Estimated / Indicative * `definitive` - Definitive / Fixed * `post_completion` - Assessed / agreed post-completion * `not_assessed` - No time impact Options: estimated, definitive, post_completion, not_assessed,
`sla_deadlines`	JSON	Computed JSON value; may be null when access is restricted.
`source_document_type`	string	Client-issued instruction: type of source document received. * `architect_instruction` - Architect's Instruction (AI/CAI) * `signed_change_agreement` - Signed Change / Variation Agreement * `quote_request` - Quote Request * `site_direction_minutes` - Site Direction / Meeting Minutes * `email_confirmation` - Email Confirmation Options: architect_instruction, signed_change_agreement, quote_request, site_direction_minutes, email_confirmation,
`source_site_log`	uuid
`source_site_log_cost_impact_type`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_date`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_delay_days`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_estimated_cost_amount`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_estimated_cost_currency`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_recommendation`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_responsible_party`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_risk_level`	JSON	Computed JSON value; may be null when access is restricted.
`source_timeline_entry`	uuid
`source_timeline_entry_id` *	uuid
`source_timeline_entry_preview`	JSON	Computed JSON value; may be null when access is restricted.
`status`	string	* `registered` - Draft / Registered * `issued` - Issued / Submitted * `issued_validated` - Instruction Validated * `issued_not_valid` - Instruction Invalid * `rejected_by_builder` - Rejected by Builder * `being_priced` - Pricing in Progress * `pricing_submitted` - Pricing Submitted * `price_agreed` - Price Agreed * `price_rejected` - Price Rejected * `terms_agreed` - Variation Approved * `terms_rejected` - Variation Rejected * `being_repriced` - Repricing in Progress * `priced_by_client` - To be Priced by Client * `terms_renegotiated` - Terms being Renegotiated * `cancelled` - Cancelled * `claimed` - Claimed * `paid` - Paid * `pending_client_financial` - Pending Client Financial Approval * `awaiting_external_ca_auth` - Awaiting External CA Authorization * `pending_ca_triage` - Pending CA Review Options: registered, issued, issued_validated, issued_not_valid, rejected_by_builder, being_priced, pricing_submitted, price_agreed, price_rejected, terms_agreed, terms_rejected, being_repriced, priced_by_client, terms_renegotiated, cancelled, claimed, paid, pending_client_financial, awaiting_external_ca_auth, pending_ca_triage
`status_label`	JSON	Computed JSON value; may be null when access is restricted.
`title` *	string	Short summary of the instruction.
`type_label` *	string
`updated_at` *	date-time
`valuation_basis`	string	Legacy single valuation method. Prefer valuation_methods.
`valuation_markup_percent`	decimal	Markup percent when valuation_basis is actual cost + markup.
`valuation_method_terms`	string	Agreed valuation method terms (dayworks, schedule of rates, etc.).
`valuation_methods`	JSON	Ordered proposed valuation methods (priority 1, 2, 3).
`variation_group`	string	Logical grouping for filters (warning, instruction, request, confirmation, advisory).
`workflow_tier`	string	UI workflow tier for this record; upgrade from simple to comprehensive. * `simple` - Simple * `comprehensive` - Comprehensive Options: simple, comprehensive

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/properties/

Required scopes and service-account permissions: properties:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes.

Parameters

Name	Location	Details
`page`	query	A page number within the paginated result set.
`page_size`	query	Number of results to return per page.
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	Property[]

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

POST /api/v1/workspaces/{workspace_id}/properties/

Required scopes and service-account permissions: properties:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes.

Parameters

Name	Location	Details
`Idempotency-Key` *	header	Unique per service account; retained for 24 hours. Reuse only for an identical retry.
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`customer_id` *	uuid
`name`	string
`notes`	string
`property_address`	AddressRequest

Responses

201 — Success

Field	Type	Details
`created_at` *	date-time
`customer` *	uuid
`customer_name` *	string
`id` *	uuid
`name`	string
`notes`	string
`property_address`	Address
`updated_at` *	date-time
`workspace` *	uuid
`workspace_name` *	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

DELETE /api/v1/workspaces/{workspace_id}/properties/{id}/

Required scopes and service-account permissions: properties:manage, properties:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes.

Parameters

Name	Location	Details
`id` *	path	uuid
`workspace_id` *	path	uuid

Responses

204 — No response body

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

GET /api/v1/workspaces/{workspace_id}/properties/{id}/

Required scopes and service-account permissions: properties:read. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes.

Parameters

Name	Location	Details
`id` *	path	uuid
`workspace_id` *	path	uuid

Responses

200 — Success

Field	Type	Details
`created_at` *	date-time
`customer` *	uuid
`customer_name` *	string
`id` *	uuid
`name`	string
`notes`	string
`property_address`	Address
`updated_at` *	date-time
`workspace` *	uuid
`workspace_name` *	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

PATCH /api/v1/workspaces/{workspace_id}/properties/{id}/

Required scopes and service-account permissions: properties:write. Workspace and project access are checked on every request. Financial fields follow their separate visibility scopes.

Parameters

Name	Location	Details
`id` *	path	uuid
`workspace_id` *	path	uuid

JSON request

Field	Type	Details
`customer_id`	uuid
`name`	string
`notes`	string
`property_address`	AddressRequest

Responses

200 — Success

Field	Type	Details
`created_at` *	date-time
`customer` *	uuid
`customer_name` *	string
`id` *	uuid
`name`	string
`notes`	string
`property_address`	Address
`updated_at` *	date-time
`workspace` *	uuid
`workspace_name` *	string

400 — Invalid request

Field	Type	Details
`error` *	object

401 — Missing, invalid, expired, or revoked key

Field	Type	Details
`error` *	object

403 — Insufficient permissions or disabled access

Field	Type	Details
`error` *	object

404 — Resource not found

Field	Type	Details
`error` *	object

409 — Idempotency conflict or invalid business transition

Field	Type	Details
`error` *	object

429 — Request quota exceeded

Field	Type	Details
`error` *	object

500 — Unexpected server error; use the request ID when contacting support

Field	Type	Details
`error` *	object

503 — API limits unavailable

Field	Type	Details
`error` *	object

Reusable schemas

APIError

Field	Type	Details
`error` *	object

ActionInputRequest

Field	Type	Details
`note`	string

Activity

Field	Type	Details
`code`	string
`default_waste_pct`	decimal
`description`	string
`group`	integer
`group_name`	string
`id` *	integer
`is_active`	boolean
`last_reviewed_at`	date
`name` *	string
`notes_internal`	string
`parent`	integer
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived
`set` *	integer
`set_name` *	string
`sort`	integer
`updated_at` *	date-time
`work_item_count` *	integer
`work_items`	JSON	Computed JSON value; may be null when access is restricted.

ActivityGroup

Field	Type	Details
`id` *	integer
`name` *	string

ActivityGroupRequest

Field	Type	Details
`name` *	string

ActivityRequest

Field	Type	Details
`code`	string
`default_waste_pct`	decimal
`description`	string
`group`	integer
`is_active`	boolean
`last_reviewed_at`	date
`name` *	string
`notes_internal`	string
`parent`	integer
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived
`set` *	integer
`sort`	integer
`work_items`	JSON	Computed JSON value; may be null when access is restricted.
`work_items_input`	ActivityWorkItemInlineRequest[]

ActivitySet

Field	Type	Details
`code`	string
`default_waste_pct`	decimal
`description`	string
`id` *	integer
`last_reviewed_at`	date
`name` *	string
`notes_internal`	string
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived

ActivitySetRequest

Field	Type	Details
`code`	string
`default_waste_pct`	decimal
`description`	string
`last_reviewed_at`	date
`name` *	string
`notes_internal`	string
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived

ActivityWorkItemInline

Field	Type	Details
`default_quantity`	decimal
`uom_override`	string
`work_item` *	integer

ActivityWorkItemInlineRequest

Field	Type	Details
`default_quantity`	decimal
`uom_override`	string
`work_item` *	integer

Address

Field	Type	Details
`country`	string
`formatted_address`	string
`id` *	uuid
`latitude`	double
`locality`	string
`longitude`	double
`postal_code`	string
`region`	string
`street_address`	string

AddressRequest

Field	Type	Details
`country`	string
`formatted_address`	string
`latitude`	double
`locality`	string
`longitude`	double
`postal_code`	string
`region`	string
`street_address`	string

Attendee

Field	Type	Details
`email` *	email
`name`	string
`response_status`	string	* `accepted` - accepted * `declined` - declined * `tentative` - tentative * `needsAction` - needsAction Options: accepted, declined, tentative, needsAction,

AttendeeRequest

Field	Type	Details
`email` *	email
`name`	string
`response_status`	string	* `accepted` - accepted * `declined` - declined * `tentative` - tentative * `needsAction` - needsAction Options: accepted, declined, tentative, needsAction,

BudgetGroup

Field	Type	Details
`code`	string
`id` *	uuid
`is_active`	boolean
`job`	uuid	Optional job-specific group; null = workspace-global.
`name` *	string

BudgetGroupRequest

Field	Type	Details
`code`	string
`is_active`	boolean
`job`	uuid	Optional job-specific group; null = workspace-global.
`name` *	string

CDMDutyholder

Field	Type	Details
`contact_name`	string
`email`	email
`id`	integer
`organisation`	uuid
`phone`	string
`role` *	string	* `client` - Client * `principal_designer` - Principal Designer * `principal_contractor` - Principal Contractor * `designer` - Designer * `contractor` - Contractor Options: client, principal_designer, principal_contractor, designer, contractor

CDMDutyholderRequest

Field	Type	Details
`contact_name`	string
`email`	email
`id`	integer
`organisation`	uuid
`phone`	string
`role` *	string	* `client` - Client * `principal_designer` - Principal Designer * `principal_contractor` - Principal Contractor * `designer` - Designer * `contractor` - Contractor Options: client, principal_designer, principal_contractor, designer, contractor

CalendarException

Field	Type	Details
`date` *	date
`id` *	uuid
`is_working`	boolean	False = non-working; True = working override
`note`	string
`project`	uuid
`workspace` *	uuid

CalendarExceptionRequest

Field	Type	Details
`date` *	date
`is_working`	boolean	False = non-working; True = working override
`note`	string
`project`	uuid

ChangeItem

Field	Type	Details
`add_value`	object
`adjusted_estimate_work_item`	uuid
`adjusted_quote_line`	uuid
`adjusts_existing`	boolean	Does this specific item adjust existing work?
`created_at` *	date-time
`description` *	string	Specific work item description.
`id` *	uuid
`is_omission`	boolean
`is_provisional_sum`	boolean	Is this adjusting a Prov Sum?
`omit_value`	object
`price_agreed` *	boolean
`pricing_provenance` *	JSON	How the current price was derived, including method and markup inputs.
`quantity`	decimal
`resource`	integer	Link to a standard library resource for exact pricing matches.
`resource_name`	string
`source_type`	string	* `manual` - New priced line * `contract_line` - Original contract line * `resource` - Library resource * `legacy_cost_matrix` - Migrated legacy pricing Options: manual, contract_line, resource, legacy_cost_matrix
`status` *	string	* `draft` - Draft * `pricing` - Pricing * `submitted` - Submitted to Client * `agreed` - Agreed * `rejected` - Rejected * `withdrawn` - Withdrawn Options: draft, pricing, submitted, agreed, rejected, withdrawn
`terms_agreed` *	boolean
`unit_of_measure`	string
`unit_rate`	object
`updated_at` *	date-time
`work_category`	string	* `labour` - Labour * `materials` - Materials * `plant` - Plant * `subcontract` - Subcontract * `overhead_profit` - Overheads & profit * `other` - Other Options: labour, materials, plant, subcontract, overhead_profit, other

ChangeItemRequest

Field	Type	Details
`add_value`	string or number
`adjusted_estimate_work_item`	uuid
`adjusted_quote_line`	uuid
`adjusts_existing`	boolean	Does this specific item adjust existing work?
`description` *	string	Specific work item description.
`is_omission`	boolean
`is_provisional_sum`	boolean	Is this adjusting a Prov Sum?
`omit_value`	string or number
`quantity`	decimal
`resource`	integer	Link to a standard library resource for exact pricing matches.
`source_type`	string	* `manual` - New priced line * `contract_line` - Original contract line * `resource` - Library resource * `legacy_cost_matrix` - Migrated legacy pricing Options: manual, contract_line, resource, legacy_cost_matrix
`unit_of_measure`	string
`unit_rate`	string or number
`work_category`	string	* `labour` - Labour * `materials` - Materials * `plant` - Plant * `subcontract` - Subcontract * `overhead_profit` - Overheads & profit * `other` - Other Options: labour, materials, plant, subcontract, overhead_profit, other

ChangeRequest

Field	Type	Details
`addition_pricing_type`	string	Classification for newly added work in instructed value flows. * `none` - Not specified * `quoted` - This adds a new, quoted item * `unquoted` - This adds a new, unquoted item Options: none, quoted, unquoted
`adjusts_existing_work`	boolean
`anticipated_form_reference`	string
`attached_files` *	FileDetail[]
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`authority_certainty`	string	Bucket 1: definitive vs provisional instruction certainty. * `definitive` - Definitive * `provisional` - Provisional Options: definitive, provisional,
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`base_quote`	uuid	The original approved Quote/Agreement this change applies to.
`base_quote_number`	JSON	Computed JSON value; may be null when access is restricted.
`base_quote_title`	JSON	Computed JSON value; may be null when access is restricted.
`builder_proceeds`	boolean	Does the builder agree to proceed?
`builder_reject_reason`	string	Required if builder_proceeds is False.
`builder_signed_at`	date-time
`ca_financial_note`	string	Optional CA note attached when submitting for client financial approval.
`classification_other`	boolean	Other classification selected: requires classification_other_text.
`classification_other_text`	string	Mandatory free text when classification_other is set.
`client_countersigned_at`	date-time
`client_document_reference`	string	Client / CA reference number from the source document, if any.
`communication_method`	string	How the instruction was received (e.g., email, in_person).
`created_at` *	date-time
`current_sla`	JSON	Computed JSON value; may be null when access is restricted.
`cvr_next_step`	string	CVR: request formal instruction or formal quote. * `request_instruction` - Request client to officially instruct * `request_quote` - Request client to ask for a formal quote Options: request_instruction, request_quote,
`delay_causes`	JSON	Notice of Delay cause checkbox keys.
`delay_narrative`	string	Notice of Delay free-text narrative.
`document_layout_mode`	JSON	Computed JSON value; may be null when access is restricted.
`effective_workflow_tier`	JSON	Computed JSON value; may be null when access is restricted.
`entered_by` *	uuid
`eot_to_be_determined`	boolean	True if EOT is acknowledged but will be calculated later.
`extension_of_time_days`	integer	Requested adjustment to the completion date (EOT).
`extension_of_time_hours`	decimal	Requested hours of time impact, in addition to extension_of_time_days.
`given_by`	string	Name of the person who gave the instruction.
`given_by_email`	email	Email for the given_by contact when selected from the project directory.
`given_by_member_id`	uuid
`has_public_consent`	JSON	Computed JSON value; may be null when access is restricted.
`id` *	uuid
`impacts_design`	boolean	Does this change the design?
`impacts_quality`	boolean	Does this affect quality standards?
`impacts_quantity`	boolean	Does this change quantities?
`includes_loss_and_expense`	boolean	Does this claim include additional costs for delay/disruption?
`includes_preparation_costs`	boolean	Does this claim include the cost of preparing the quotation?
`initiation_route`	string	Stable create-route id used to tailor the editable detail view.
`instruction_text`	string	The core instruction given.
`is_addition`	boolean
`is_omission`	boolean
`is_proxy`	boolean	Whether this record was logged on behalf of another party.
`is_substitution`	boolean
`items` *	ChangeItem[]
`lead_time_dependent`	boolean	Material or specialist lead-time dependency on a simple CVI/CVR/proposal.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_impact`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`payment_timing`	string	Consumer/unadministered: how the variation will be paid. * `invoice_now` - Invoice immediately as a standalone item * `next_stage` - Add to the next stage payment * `final_invoice` - Add to the final project invoice Options: invoice_now, next_stage, final_invoice,
`pci_type`	string	Budget PCI purpose when estimating is on. Empty = paper-only change. * `CLIENT_VARIATION` - Client variation * `INTERNAL_SPEC` - Internal specification change * `PROV_SUM_EXPEND` - Provisional sum expend * `RISK_RELEASE` - Risk / contingency release Options: CLIENT_VARIATION, INTERNAL_SPEC, PROV_SUM_EXPEND, RISK_RELEASE,
`price_agreed_before_start`	boolean	True if price is agreed before work commences, False if proceeding immediately.
`pricing_strategy`	string	Explicit pricing pathway; synced with price_agreed_before_start. * `price_upfront` - Price upfront before work starts * `valuation_method` - Agree a method of valuation * `price_later` - Proceed immediately, price later Options: price_upfront, valuation_method, price_later,
`project` *	uuid
`project_name` *	string	Name of the project.
`quote_validity_days`	integer	Validity period (days) when builder submits a quotation.
`quoted_source_quote`	uuid	If this change adds a new quoted item, link the source quote.
`reason`	string	Why is this change happening?
`reason_codes`	JSON	Simple CVI/CVR/proposal reason tick keys.
`reason_other_text`	string
`received_by`	string
`received_by_email`	email
`received_by_member_id`	uuid
`register_number` *	string	Stable display ref e.g. CHG-001. Terminology labels are separate.
`register_sequence` *	integer	Project-scoped sequence used to build register_number.
`request_date`	date
`request_time`	time	Time the verbal instruction/request was given.
`request_type`	string	* `request` - Variation Request * `instruction` - Variation Instruction * `early_warning` - Early Warning * `notice_of_delay` - Notice of Delay * `quote_request` - Quote Request * `confirmation` - CVI * `cvi` - Confirmation of Verbal Instruction (CVI) * `cvr` - Confirmation of Verbal Request (CVR) * `change_order` - Change Order * `potential_change_order` - Potential Change Order * `field_directive` - Field Directive Options: request, instruction, early_warning, notice_of_delay, quote_request, confirmation, cvi, cvr, change_order, potential_change_order, field_directive
`response_deadline`	date-time	The deadline for the client/builder to respond before default acceptance/rejection.
`restocking_fees`	decimal	Consumer contracts: restocking / non-refundable deposits.
`restocking_fees_currency` *	string	* `XUA` - ADB Unit of Account * `AFN` - Afghan Afghani * `AFA` - Afghan Afghani (1927–2002) * `ALL` - Albanian Lek * `ALK` - Albanian Lek (1946–1965) * `DZD` - Algerian Dinar * `ADP` - Andorran Peseta * `AOA` - Angolan Kwanza * `AOK` - Angolan Kwanza (1977–1991) * `AON` - Angolan New Kwanza (1990–2000) * `AOR` - Angolan Readjusted Kwanza (1995–1999) * `ARA` - Argentine Austral * `ARS` - Argentine Peso * `ARM` - Argentine Peso (1881–1970) * `ARP` - Argentine Peso (1983–1985) * `ARL` - Argentine Peso Ley (1970–1983) * `AMD` - Armenian Dram * `AWG` - Aruban Florin * `AUD` - Australian Dollar * `ATS` - Austrian Schilling * `AZN` - Azerbaijani Manat * `AZM` - Azerbaijani Manat (1993–2006) * `BSD` - Bahamian Dollar * `BHD` - Bahraini Dinar * `BDT` - Bangladeshi Taka * `BBD` - Barbadian Dollar * `BYN` - Belarusian Ruble * `BYB` - Belarusian Ruble (1994–1999) * `BYR` - Belarusian Ruble (2000–2016) * `BEF` - Belgian Franc * `BEC` - Belgian Franc (convertible) * `BEL` - Belgian Franc (financial) * `BZD` - Belize Dollar * `BMD` - Bermudan Dollar * `BTN` - Bhutanese Ngultrum * `BOB` - Bolivian Boliviano * `BOL` - Bolivian Boliviano (1863–1963) * `BOV` - Bolivian Mvdol * `BOP` - Bolivian Peso * `VED` - Bolívar Soberano * `BAM` - Bosnia-Herzegovina Convertible Mark * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) * `BWP` - Botswanan Pula * `BRC` - Brazilian Cruzado (1986–1989) * `BRZ` - Brazilian Cruzeiro (1942–1967) * `BRE` - Brazilian Cruzeiro (1990–1993) * `BRR` - Brazilian Cruzeiro (1993–1994) * `BRN` - Brazilian New Cruzado (1989–1990) * `BRB` - Brazilian New Cruzeiro (1967–1986) * `BRL` - Brazilian Real * `GBP` - British Pound * `BND` - Brunei Dollar * `BGL` - Bulgarian Hard Lev * `BGN` - Bulgarian Lev * `BGO` - Bulgarian Lev (1879–1952) * `BGM` - Bulgarian Socialist Lev * `BUK` - Burmese Kyat * `BIF` - Burundian Franc * `XPF` - CFP Franc * `KHR` - Cambodian Riel * `CAD` - Canadian Dollar * `CVE` - Cape Verdean Escudo * `KYD` - Cayman Islands Dollar * `XAF` - Central African CFA Franc * `CLE` - Chilean Escudo * `CLP` - Chilean Peso * `CLF` - Chilean Unit of Account (UF) * `CNX` - Chinese People’s Bank Dollar * `CNY` - Chinese Yuan * `CNH` - Chinese Yuan (offshore) * `COP` - Colombian Peso * `COU` - Colombian Real Value Unit * `KMF` - Comorian Franc * `CDF` - Congolese Franc * `CRC` - Costa Rican Colón * `HRD` - Croatian Dinar * `HRK` - Croatian Kuna * `CUC` - Cuban Convertible Peso * `CUP` - Cuban Peso * `CYP` - Cypriot Pound * `CZK` - Czech Koruna * `CSK` - Czechoslovak Hard Koruna * `DKK` - Danish Krone * `DJF` - Djiboutian Franc * `DOP` - Dominican Peso * `NLG` - Dutch Guilder * `XCD` - East Caribbean Dollar * `DDM` - East German Mark * `ECS` - Ecuadorian Sucre * `ECV` - Ecuadorian Unit of Constant Value * `EGP` - Egyptian Pound * `GQE` - Equatorial Guinean Ekwele * `ERN` - Eritrean Nakfa * `EEK` - Estonian Kroon * `ETB` - Ethiopian Birr * `EUR` - Euro * `XBA` - European Composite Unit * `XEU` - European Currency Unit * `XBB` - European Monetary Unit * `XBC` - European Unit of Account (XBC) * `XBD` - European Unit of Account (XBD) * `FKP` - Falkland Islands Pound * `FJD` - Fijian Dollar * `FIM` - Finnish Markka * `FRF` - French Franc * `XFO` - French Gold Franc * `XFU` - French UIC-Franc * `GMD` - Gambian Dalasi * `GEK` - Georgian Kupon Larit * `GEL` - Georgian Lari * `DEM` - German Mark * `GHS` - Ghanaian Cedi * `GHC` - Ghanaian Cedi (1979–2007) * `GIP` - Gibraltar Pound * `XAU` - Gold * `GRD` - Greek Drachma * `GTQ` - Guatemalan Quetzal * `GWP` - Guinea-Bissau Peso * `GNF` - Guinean Franc * `GNS` - Guinean Syli * `GYD` - Guyanaese Dollar * `HTG` - Haitian Gourde * `HNL` - Honduran Lempira * `HKD` - Hong Kong Dollar * `HUF` - Hungarian Forint * `IMP` - IMP * `ISK` - Icelandic Króna * `ISJ` - Icelandic Króna (1918–1981) * `INR` - Indian Rupee * `IDR` - Indonesian Rupiah * `IRR` - Iranian Rial * `IQD` - Iraqi Dinar * `IEP` - Irish Pound * `ILS` - Israeli New Shekel * `ILP` - Israeli Pound * `ILR` - Israeli Shekel (1980–1985) * `ITL` - Italian Lira * `JMD` - Jamaican Dollar * `JPY` - Japanese Yen * `JOD` - Jordanian Dinar * `KZT` - Kazakhstani Tenge * `KES` - Kenyan Shilling * `KWD` - Kuwaiti Dinar * `KGS` - Kyrgystani Som * `LAK` - Laotian Kip * `LVL` - Latvian Lats * `LVR` - Latvian Ruble * `LBP` - Lebanese Pound * `LSL` - Lesotho Loti * `LRD` - Liberian Dollar * `LYD` - Libyan Dinar * `LTL` - Lithuanian Litas * `LTT` - Lithuanian Talonas * `LUL` - Luxembourg Financial Franc * `LUC` - Luxembourgian Convertible Franc * `LUF` - Luxembourgian Franc * `MOP` - Macanese Pataca * `MKD` - Macedonian Denar * `MKN` - Macedonian Denar (1992–1993) * `MGA` - Malagasy Ariary * `MGF` - Malagasy Franc * `MWK` - Malawian Kwacha * `MYR` - Malaysian Ringgit * `MVR` - Maldivian Rufiyaa * `MVP` - Maldivian Rupee (1947–1981) * `MLF` - Malian Franc * `MTL` - Maltese Lira * `MTP` - Maltese Pound * `MRU` - Mauritanian Ouguiya * `MRO` - Mauritanian Ouguiya (1973–2017) * `MUR` - Mauritian Rupee * `MXV` - Mexican Investment Unit * `MXN` - Mexican Peso * `MXP` - Mexican Silver Peso (1861–1992) * `MDC` - Moldovan Cupon * `MDL` - Moldovan Leu * `MCF` - Monegasque Franc * `MNT` - Mongolian Tugrik * `MAD` - Moroccan Dirham * `MAF` - Moroccan Franc * `MZE` - Mozambican Escudo * `MZN` - Mozambican Metical * `MZM` - Mozambican Metical (1980–2006) * `MMK` - Myanmar Kyat * `NAD` - Namibian Dollar * `NPR` - Nepalese Rupee * `ANG` - Netherlands Antillean Guilder * `TWD` - New Taiwan Dollar * `NZD` - New Zealand Dollar * `NIO` - Nicaraguan Córdoba * `NIC` - Nicaraguan Córdoba (1988–1991) * `NGN` - Nigerian Naira * `KPW` - North Korean Won * `NOK` - Norwegian Krone * `OMR` - Omani Rial * `PKR` - Pakistani Rupee * `XPD` - Palladium * `PAB` - Panamanian Balboa * `PGK` - Papua New Guinean Kina * `PYG` - Paraguayan Guarani * `PEI` - Peruvian Inti * `PEN` - Peruvian Sol * `PES` - Peruvian Sol (1863–1965) * `PHP` - Philippine Peso * `XPT` - Platinum * `PLN` - Polish Zloty * `PLZ` - Polish Zloty (1950–1995) * `PTE` - Portuguese Escudo * `GWE` - Portuguese Guinea Escudo * `QAR` - Qatari Riyal * `XRE` - RINET Funds * `RHD` - Rhodesian Dollar * `RON` - Romanian Leu * `ROL` - Romanian Leu (1952–2006) * `RUB` - Russian Ruble * `RUR` - Russian Ruble (1991–1998) * `RWF` - Rwandan Franc * `SVC` - Salvadoran Colón * `WST` - Samoan Tala * `SAR` - Saudi Riyal * `RSD` - Serbian Dinar * `CSD` - Serbian Dinar (2002–2006) * `SCR` - Seychellois Rupee * `SLE` - Sierra Leonean Leone * `SLL` - Sierra Leonean Leone (1964—2022) * `XAG` - Silver * `SGD` - Singapore Dollar * `SKK` - Slovak Koruna * `SIT` - Slovenian Tolar * `SBD` - Solomon Islands Dollar * `SOS` - Somali Shilling * `ZAR` - South African Rand * `ZAL` - South African Rand (financial) * `KRH` - South Korean Hwan (1953–1962) * `KRW` - South Korean Won * `KRO` - South Korean Won (1945–1953) * `SSP` - South Sudanese Pound * `SUR` - Soviet Rouble * `ESP` - Spanish Peseta * `ESA` - Spanish Peseta (A account) * `ESB` - Spanish Peseta (convertible account) * `XDR` - Special Drawing Rights * `LKR` - Sri Lankan Rupee * `SHP` - St. Helena Pound * `XSU` - Sucre * `SDD` - Sudanese Dinar (1992–2007) * `SDG` - Sudanese Pound * `SDP` - Sudanese Pound (1957–1998) * `SRD` - Surinamese Dollar * `SRG` - Surinamese Guilder * `SZL` - Swazi Lilangeni * `SEK` - Swedish Krona * `CHF` - Swiss Franc * `SYP` - Syrian Pound * `STN` - São Tomé & Príncipe Dobra * `STD` - São Tomé & Príncipe Dobra (1977–2017) * `TVD` - TVD * `TJR` - Tajikistani Ruble * `TJS` - Tajikistani Somoni * `TZS` - Tanzanian Shilling * `XTS` - Testing Currency Code * `THB` - Thai Baht * `TPE` - Timorese Escudo * `TOP` - Tongan Paʻanga * `TTD` - Trinidad & Tobago Dollar * `TND` - Tunisian Dinar * `TRY` - Turkish Lira * `TRL` - Turkish Lira (1922–2005) * `TMT` - Turkmenistani Manat * `TMM` - Turkmenistani Manat (1993–2009) * `USD` - US Dollar * `USN` - US Dollar (Next day) * `USS` - US Dollar (Same day) * `UGX` - Ugandan Shilling * `UGS` - Ugandan Shilling (1966–1987) * `UAH` - Ukrainian Hryvnia * `UAK` - Ukrainian Karbovanets * `AED` - United Arab Emirates Dirham * `UYW` - Uruguayan Nominal Wage Index Unit * `UYU` - Uruguayan Peso * `UYP` - Uruguayan Peso (1975–1993) * `UYI` - Uruguayan Peso (Indexed Units) * `UZS` - Uzbekistani Som * `VUV` - Vanuatu Vatu * `VES` - Venezuelan Bolívar * `VEB` - Venezuelan Bolívar (1871–2008) * `VEF` - Venezuelan Bolívar (2008–2018) * `VND` - Vietnamese Dong * `VNN` - Vietnamese Dong (1978–1985) * `CHE` - WIR Euro * `CHW` - WIR Franc * `XOF` - West African CFA Franc * `YDD` - Yemeni Dinar * `YER` - Yemeni Rial * `YUN` - Yugoslavian Convertible Dinar (1990–1992) * `YUD` - Yugoslavian Hard Dinar (1966–1990) * `YUM` - Yugoslavian New Dinar (1994–2002) * `YUR` - Yugoslavian Reformed Dinar (1992–1993) * `ZWN` - ZWN * `ZRN` - Zairean New Zaire (1993–1998) * `ZRZ` - Zairean Zaire (1971–1993) * `ZMW` - Zambian Kwacha * `ZMK` - Zambian Kwacha (1968–2012) * `ZWD` - Zimbabwean Dollar (1980–2008) * `ZWR` - Zimbabwean Dollar (2008) * `ZWL` - Zimbabwean Dollar (2009–2024) Options: XUA, AFN, AFA, ALL, ALK, DZD, ADP, AOA, AOK, AON, AOR, ARA, ARS, ARM, ARP, ARL, AMD, AWG, AUD, ATS, AZN, AZM, BSD, BHD, BDT, BBD, BYN, BYB, BYR, BEF, BEC, BEL, BZD, BMD, BTN, BOB, BOL, BOV, BOP, VED, BAM, BAD, BAN, BWP, BRC, BRZ, BRE, BRR, BRN, BRB, BRL, GBP, BND, BGL, BGN, BGO, BGM, BUK, BIF, XPF, KHR, CAD, CVE, KYD, XAF, CLE, CLP, CLF, CNX, CNY, CNH, COP, COU, KMF, CDF, CRC, HRD, HRK, CUC, CUP, CYP, CZK, CSK, DKK, DJF, DOP, NLG, XCD, DDM, ECS, ECV, EGP, GQE, ERN, EEK, ETB, EUR, XBA, XEU, XBB, XBC, XBD, FKP, FJD, FIM, FRF, XFO, XFU, GMD, GEK, GEL, DEM, GHS, GHC, GIP, XAU, GRD, GTQ, GWP, GNF, GNS, GYD, HTG, HNL, HKD, HUF, IMP, ISK, ISJ, INR, IDR, IRR, IQD, IEP, ILS, ILP, ILR, ITL, JMD, JPY, JOD, KZT, KES, KWD, KGS, LAK, LVL, LVR, LBP, LSL, LRD, LYD, LTL, LTT, LUL, LUC, LUF, MOP, MKD, MKN, MGA, MGF, MWK, MYR, MVR, MVP, MLF, MTL, MTP, MRU, MRO, MUR, MXV, MXN, MXP, MDC, MDL, MCF, MNT, MAD, MAF, MZE, MZN, MZM, MMK, NAD, NPR, ANG, TWD, NZD, NIO, NIC, NGN, KPW, NOK, OMR, PKR, XPD, PAB, PGK, PYG, PEI, PEN, PES, PHP, XPT, PLN, PLZ, PTE, GWE, QAR, XRE, RHD, RON, ROL, RUB, RUR, RWF, SVC, WST, SAR, RSD, CSD, SCR, SLE, SLL, XAG, SGD, SKK, SIT, SBD, SOS, ZAR, ZAL, KRH, KRW, KRO, SSP, SUR, ESP, ESA, ESB, XDR, LKR, SHP, XSU, SDD, SDG, SDP, SRD, SRG, SZL, SEK, CHF, SYP, STN, STD, TVD, TJR, TJS, TZS, XTS, THB, TPE, TOP, TTD, TND, TRY, TRL, TMT, TMM, USD, USN, USS, UGX, UGS, UAH, UAK, AED, UYW, UYU, UYP, UYI, UZS, VUV, VES, VEB, VEF, VND, VNN, CHE, CHW, XOF, YDD, YER, YUN, YUD, YUM, YUR, ZWN, ZRN, ZRZ, ZMW, ZMK, ZWD, ZWR, ZWL,
`resulting_variation` *	uuid	The formal Variation Quote generated from this request.
`resulting_variation_invoice_count`	JSON	Computed JSON value; may be null when access is restricted.
`resulting_variation_number`	string	Workspace-unique quote number (e.g., QUO-001).
`resulting_variation_sequence`	integer	Sequential number if this is a variation (e.g., 1, 2, 3).
`resulting_variation_status`	string	* `draft` - Draft * `sent` - Sent * `approved` - Approved * `rejected` - Rejected * `superseded` - Superseded * `locked` - Locked (linked to quote) * `archived` - Archived Options: draft, sent, approved, rejected, superseded, locked, archived
`revised_completion_date`	date	Requested revised completion / working-period end date.
`risk_contingency_value`	decimal	Early warning approximate risk / contingency value.
`risk_contingency_value_currency` *	string	* `XUA` - ADB Unit of Account * `AFN` - Afghan Afghani * `AFA` - Afghan Afghani (1927–2002) * `ALL` - Albanian Lek * `ALK` - Albanian Lek (1946–1965) * `DZD` - Algerian Dinar * `ADP` - Andorran Peseta * `AOA` - Angolan Kwanza * `AOK` - Angolan Kwanza (1977–1991) * `AON` - Angolan New Kwanza (1990–2000) * `AOR` - Angolan Readjusted Kwanza (1995–1999) * `ARA` - Argentine Austral * `ARS` - Argentine Peso * `ARM` - Argentine Peso (1881–1970) * `ARP` - Argentine Peso (1983–1985) * `ARL` - Argentine Peso Ley (1970–1983) * `AMD` - Armenian Dram * `AWG` - Aruban Florin * `AUD` - Australian Dollar * `ATS` - Austrian Schilling * `AZN` - Azerbaijani Manat * `AZM` - Azerbaijani Manat (1993–2006) * `BSD` - Bahamian Dollar * `BHD` - Bahraini Dinar * `BDT` - Bangladeshi Taka * `BBD` - Barbadian Dollar * `BYN` - Belarusian Ruble * `BYB` - Belarusian Ruble (1994–1999) * `BYR` - Belarusian Ruble (2000–2016) * `BEF` - Belgian Franc * `BEC` - Belgian Franc (convertible) * `BEL` - Belgian Franc (financial) * `BZD` - Belize Dollar * `BMD` - Bermudan Dollar * `BTN` - Bhutanese Ngultrum * `BOB` - Bolivian Boliviano * `BOL` - Bolivian Boliviano (1863–1963) * `BOV` - Bolivian Mvdol * `BOP` - Bolivian Peso * `VED` - Bolívar Soberano * `BAM` - Bosnia-Herzegovina Convertible Mark * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) * `BWP` - Botswanan Pula * `BRC` - Brazilian Cruzado (1986–1989) * `BRZ` - Brazilian Cruzeiro (1942–1967) * `BRE` - Brazilian Cruzeiro (1990–1993) * `BRR` - Brazilian Cruzeiro (1993–1994) * `BRN` - Brazilian New Cruzado (1989–1990) * `BRB` - Brazilian New Cruzeiro (1967–1986) * `BRL` - Brazilian Real * `GBP` - British Pound * `BND` - Brunei Dollar * `BGL` - Bulgarian Hard Lev * `BGN` - Bulgarian Lev * `BGO` - Bulgarian Lev (1879–1952) * `BGM` - Bulgarian Socialist Lev * `BUK` - Burmese Kyat * `BIF` - Burundian Franc * `XPF` - CFP Franc * `KHR` - Cambodian Riel * `CAD` - Canadian Dollar * `CVE` - Cape Verdean Escudo * `KYD` - Cayman Islands Dollar * `XAF` - Central African CFA Franc * `CLE` - Chilean Escudo * `CLP` - Chilean Peso * `CLF` - Chilean Unit of Account (UF) * `CNX` - Chinese People’s Bank Dollar * `CNY` - Chinese Yuan * `CNH` - Chinese Yuan (offshore) * `COP` - Colombian Peso * `COU` - Colombian Real Value Unit * `KMF` - Comorian Franc * `CDF` - Congolese Franc * `CRC` - Costa Rican Colón * `HRD` - Croatian Dinar * `HRK` - Croatian Kuna * `CUC` - Cuban Convertible Peso * `CUP` - Cuban Peso * `CYP` - Cypriot Pound * `CZK` - Czech Koruna * `CSK` - Czechoslovak Hard Koruna * `DKK` - Danish Krone * `DJF` - Djiboutian Franc * `DOP` - Dominican Peso * `NLG` - Dutch Guilder * `XCD` - East Caribbean Dollar * `DDM` - East German Mark * `ECS` - Ecuadorian Sucre * `ECV` - Ecuadorian Unit of Constant Value * `EGP` - Egyptian Pound * `GQE` - Equatorial Guinean Ekwele * `ERN` - Eritrean Nakfa * `EEK` - Estonian Kroon * `ETB` - Ethiopian Birr * `EUR` - Euro * `XBA` - European Composite Unit * `XEU` - European Currency Unit * `XBB` - European Monetary Unit * `XBC` - European Unit of Account (XBC) * `XBD` - European Unit of Account (XBD) * `FKP` - Falkland Islands Pound * `FJD` - Fijian Dollar * `FIM` - Finnish Markka * `FRF` - French Franc * `XFO` - French Gold Franc * `XFU` - French UIC-Franc * `GMD` - Gambian Dalasi * `GEK` - Georgian Kupon Larit * `GEL` - Georgian Lari * `DEM` - German Mark * `GHS` - Ghanaian Cedi * `GHC` - Ghanaian Cedi (1979–2007) * `GIP` - Gibraltar Pound * `XAU` - Gold * `GRD` - Greek Drachma * `GTQ` - Guatemalan Quetzal * `GWP` - Guinea-Bissau Peso * `GNF` - Guinean Franc * `GNS` - Guinean Syli * `GYD` - Guyanaese Dollar * `HTG` - Haitian Gourde * `HNL` - Honduran Lempira * `HKD` - Hong Kong Dollar * `HUF` - Hungarian Forint * `IMP` - IMP * `ISK` - Icelandic Króna * `ISJ` - Icelandic Króna (1918–1981) * `INR` - Indian Rupee * `IDR` - Indonesian Rupiah * `IRR` - Iranian Rial * `IQD` - Iraqi Dinar * `IEP` - Irish Pound * `ILS` - Israeli New Shekel * `ILP` - Israeli Pound * `ILR` - Israeli Shekel (1980–1985) * `ITL` - Italian Lira * `JMD` - Jamaican Dollar * `JPY` - Japanese Yen * `JOD` - Jordanian Dinar * `KZT` - Kazakhstani Tenge * `KES` - Kenyan Shilling * `KWD` - Kuwaiti Dinar * `KGS` - Kyrgystani Som * `LAK` - Laotian Kip * `LVL` - Latvian Lats * `LVR` - Latvian Ruble * `LBP` - Lebanese Pound * `LSL` - Lesotho Loti * `LRD` - Liberian Dollar * `LYD` - Libyan Dinar * `LTL` - Lithuanian Litas * `LTT` - Lithuanian Talonas * `LUL` - Luxembourg Financial Franc * `LUC` - Luxembourgian Convertible Franc * `LUF` - Luxembourgian Franc * `MOP` - Macanese Pataca * `MKD` - Macedonian Denar * `MKN` - Macedonian Denar (1992–1993) * `MGA` - Malagasy Ariary * `MGF` - Malagasy Franc * `MWK` - Malawian Kwacha * `MYR` - Malaysian Ringgit * `MVR` - Maldivian Rufiyaa * `MVP` - Maldivian Rupee (1947–1981) * `MLF` - Malian Franc * `MTL` - Maltese Lira * `MTP` - Maltese Pound * `MRU` - Mauritanian Ouguiya * `MRO` - Mauritanian Ouguiya (1973–2017) * `MUR` - Mauritian Rupee * `MXV` - Mexican Investment Unit * `MXN` - Mexican Peso * `MXP` - Mexican Silver Peso (1861–1992) * `MDC` - Moldovan Cupon * `MDL` - Moldovan Leu * `MCF` - Monegasque Franc * `MNT` - Mongolian Tugrik * `MAD` - Moroccan Dirham * `MAF` - Moroccan Franc * `MZE` - Mozambican Escudo * `MZN` - Mozambican Metical * `MZM` - Mozambican Metical (1980–2006) * `MMK` - Myanmar Kyat * `NAD` - Namibian Dollar * `NPR` - Nepalese Rupee * `ANG` - Netherlands Antillean Guilder * `TWD` - New Taiwan Dollar * `NZD` - New Zealand Dollar * `NIO` - Nicaraguan Córdoba * `NIC` - Nicaraguan Córdoba (1988–1991) * `NGN` - Nigerian Naira * `KPW` - North Korean Won * `NOK` - Norwegian Krone * `OMR` - Omani Rial * `PKR` - Pakistani Rupee * `XPD` - Palladium * `PAB` - Panamanian Balboa * `PGK` - Papua New Guinean Kina * `PYG` - Paraguayan Guarani * `PEI` - Peruvian Inti * `PEN` - Peruvian Sol * `PES` - Peruvian Sol (1863–1965) * `PHP` - Philippine Peso * `XPT` - Platinum * `PLN` - Polish Zloty * `PLZ` - Polish Zloty (1950–1995) * `PTE` - Portuguese Escudo * `GWE` - Portuguese Guinea Escudo * `QAR` - Qatari Riyal * `XRE` - RINET Funds * `RHD` - Rhodesian Dollar * `RON` - Romanian Leu * `ROL` - Romanian Leu (1952–2006) * `RUB` - Russian Ruble * `RUR` - Russian Ruble (1991–1998) * `RWF` - Rwandan Franc * `SVC` - Salvadoran Colón * `WST` - Samoan Tala * `SAR` - Saudi Riyal * `RSD` - Serbian Dinar * `CSD` - Serbian Dinar (2002–2006) * `SCR` - Seychellois Rupee * `SLE` - Sierra Leonean Leone * `SLL` - Sierra Leonean Leone (1964—2022) * `XAG` - Silver * `SGD` - Singapore Dollar * `SKK` - Slovak Koruna * `SIT` - Slovenian Tolar * `SBD` - Solomon Islands Dollar * `SOS` - Somali Shilling * `ZAR` - South African Rand * `ZAL` - South African Rand (financial) * `KRH` - South Korean Hwan (1953–1962) * `KRW` - South Korean Won * `KRO` - South Korean Won (1945–1953) * `SSP` - South Sudanese Pound * `SUR` - Soviet Rouble * `ESP` - Spanish Peseta * `ESA` - Spanish Peseta (A account) * `ESB` - Spanish Peseta (convertible account) * `XDR` - Special Drawing Rights * `LKR` - Sri Lankan Rupee * `SHP` - St. Helena Pound * `XSU` - Sucre * `SDD` - Sudanese Dinar (1992–2007) * `SDG` - Sudanese Pound * `SDP` - Sudanese Pound (1957–1998) * `SRD` - Surinamese Dollar * `SRG` - Surinamese Guilder * `SZL` - Swazi Lilangeni * `SEK` - Swedish Krona * `CHF` - Swiss Franc * `SYP` - Syrian Pound * `STN` - São Tomé & Príncipe Dobra * `STD` - São Tomé & Príncipe Dobra (1977–2017) * `TVD` - TVD * `TJR` - Tajikistani Ruble * `TJS` - Tajikistani Somoni * `TZS` - Tanzanian Shilling * `XTS` - Testing Currency Code * `THB` - Thai Baht * `TPE` - Timorese Escudo * `TOP` - Tongan Paʻanga * `TTD` - Trinidad & Tobago Dollar * `TND` - Tunisian Dinar * `TRY` - Turkish Lira * `TRL` - Turkish Lira (1922–2005) * `TMT` - Turkmenistani Manat * `TMM` - Turkmenistani Manat (1993–2009) * `USD` - US Dollar * `USN` - US Dollar (Next day) * `USS` - US Dollar (Same day) * `UGX` - Ugandan Shilling * `UGS` - Ugandan Shilling (1966–1987) * `UAH` - Ukrainian Hryvnia * `UAK` - Ukrainian Karbovanets * `AED` - United Arab Emirates Dirham * `UYW` - Uruguayan Nominal Wage Index Unit * `UYU` - Uruguayan Peso * `UYP` - Uruguayan Peso (1975–1993) * `UYI` - Uruguayan Peso (Indexed Units) * `UZS` - Uzbekistani Som * `VUV` - Vanuatu Vatu * `VES` - Venezuelan Bolívar * `VEB` - Venezuelan Bolívar (1871–2008) * `VEF` - Venezuelan Bolívar (2008–2018) * `VND` - Vietnamese Dong * `VNN` - Vietnamese Dong (1978–1985) * `CHE` - WIR Euro * `CHW` - WIR Franc * `XOF` - West African CFA Franc * `YDD` - Yemeni Dinar * `YER` - Yemeni Rial * `YUN` - Yugoslavian Convertible Dinar (1990–1992) * `YUD` - Yugoslavian Hard Dinar (1966–1990) * `YUM` - Yugoslavian New Dinar (1994–2002) * `YUR` - Yugoslavian Reformed Dinar (1992–1993) * `ZWN` - ZWN * `ZRN` - Zairean New Zaire (1993–1998) * `ZRZ` - Zairean Zaire (1971–1993) * `ZMW` - Zambian Kwacha * `ZMK` - Zambian Kwacha (1968–2012) * `ZWD` - Zimbabwean Dollar (1980–2008) * `ZWR` - Zimbabwean Dollar (2008) * `ZWL` - Zimbabwean Dollar (2009–2024) Options: XUA, AFN, AFA, ALL, ALK, DZD, ADP, AOA, AOK, AON, AOR, ARA, ARS, ARM, ARP, ARL, AMD, AWG, AUD, ATS, AZN, AZM, BSD, BHD, BDT, BBD, BYN, BYB, BYR, BEF, BEC, BEL, BZD, BMD, BTN, BOB, BOL, BOV, BOP, VED, BAM, BAD, BAN, BWP, BRC, BRZ, BRE, BRR, BRN, BRB, BRL, GBP, BND, BGL, BGN, BGO, BGM, BUK, BIF, XPF, KHR, CAD, CVE, KYD, XAF, CLE, CLP, CLF, CNX, CNY, CNH, COP, COU, KMF, CDF, CRC, HRD, HRK, CUC, CUP, CYP, CZK, CSK, DKK, DJF, DOP, NLG, XCD, DDM, ECS, ECV, EGP, GQE, ERN, EEK, ETB, EUR, XBA, XEU, XBB, XBC, XBD, FKP, FJD, FIM, FRF, XFO, XFU, GMD, GEK, GEL, DEM, GHS, GHC, GIP, XAU, GRD, GTQ, GWP, GNF, GNS, GYD, HTG, HNL, HKD, HUF, IMP, ISK, ISJ, INR, IDR, IRR, IQD, IEP, ILS, ILP, ILR, ITL, JMD, JPY, JOD, KZT, KES, KWD, KGS, LAK, LVL, LVR, LBP, LSL, LRD, LYD, LTL, LTT, LUL, LUC, LUF, MOP, MKD, MKN, MGA, MGF, MWK, MYR, MVR, MVP, MLF, MTL, MTP, MRU, MRO, MUR, MXV, MXN, MXP, MDC, MDL, MCF, MNT, MAD, MAF, MZE, MZN, MZM, MMK, NAD, NPR, ANG, TWD, NZD, NIO, NIC, NGN, KPW, NOK, OMR, PKR, XPD, PAB, PGK, PYG, PEI, PEN, PES, PHP, XPT, PLN, PLZ, PTE, GWE, QAR, XRE, RHD, RON, ROL, RUB, RUR, RWF, SVC, WST, SAR, RSD, CSD, SCR, SLE, SLL, XAG, SGD, SKK, SIT, SBD, SOS, ZAR, ZAL, KRH, KRW, KRO, SSP, SUR, ESP, ESA, ESB, XDR, LKR, SHP, XSU, SDD, SDG, SDP, SRD, SRG, SZL, SEK, CHF, SYP, STN, STD, TVD, TJR, TJS, TZS, XTS, THB, TPE, TOP, TTD, TND, TRY, TRL, TMT, TMM, USD, USN, USS, UGX, UGS, UAH, UAK, AED, UYW, UYU, UYP, UYI, UZS, VUV, VES, VEB, VEF, VND, VNN, CHE, CHW, XOF, YDD, YER, YUN, YUD, YUM, YUR, ZWN, ZRN, ZRZ, ZMW, ZMK, ZWD, ZWR, ZWL,
`signature_loop_stage`	string	* `none` - Not required * `awaiting_builder` - Awaiting builder signature * `awaiting_client` - Awaiting client countersignature * `complete` - Fully signed Options: none, awaiting_builder, awaiting_client, complete,
`simple_issuer_contact`	string
`simple_issuer_contact_email`	email
`simple_issuer_contact_member_id`	uuid
`simple_paper_kind`	JSON	Computed JSON value; may be null when access is restricted.
`simple_price_certainty`	string	Simple workflow: fixed, estimated/indicative, quote requested, no price change, or not assessed. * `fixed` - Fixed price * `estimated` - Estimated / Indicative * `quote_requested` - Quote Requested * `no_price_change` - No price change * `not_assessed` - Not assessed Options: fixed, estimated, quote_requested, no_price_change, not_assessed,
`simple_recipient`	string
`simple_recipient_email`	email
`simple_recipient_member_id`	uuid
`simple_time_certainty`	string	Simple workflow: estimated, definitive / fixed, post-completion, or no time impact. * `estimated` - Estimated / Indicative * `definitive` - Definitive / Fixed * `post_completion` - Assessed / agreed post-completion * `not_assessed` - No time impact Options: estimated, definitive, post_completion, not_assessed,
`sla_deadlines`	JSON	Computed JSON value; may be null when access is restricted.
`source_document_type`	string	Client-issued instruction: type of source document received. * `architect_instruction` - Architect's Instruction (AI/CAI) * `signed_change_agreement` - Signed Change / Variation Agreement * `quote_request` - Quote Request * `site_direction_minutes` - Site Direction / Meeting Minutes * `email_confirmation` - Email Confirmation Options: architect_instruction, signed_change_agreement, quote_request, site_direction_minutes, email_confirmation,
`source_site_log`	uuid
`source_site_log_cost_impact_type`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_date`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_delay_days`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_estimated_cost_amount`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_estimated_cost_currency`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_recommendation`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_responsible_party`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_risk_level`	JSON	Computed JSON value; may be null when access is restricted.
`source_timeline_entry`	uuid
`source_timeline_entry_id` *	uuid
`source_timeline_entry_preview`	JSON	Computed JSON value; may be null when access is restricted.
`status`	string	* `registered` - Draft / Registered * `issued` - Issued / Submitted * `issued_validated` - Instruction Validated * `issued_not_valid` - Instruction Invalid * `rejected_by_builder` - Rejected by Builder * `being_priced` - Pricing in Progress * `pricing_submitted` - Pricing Submitted * `price_agreed` - Price Agreed * `price_rejected` - Price Rejected * `terms_agreed` - Variation Approved * `terms_rejected` - Variation Rejected * `being_repriced` - Repricing in Progress * `priced_by_client` - To be Priced by Client * `terms_renegotiated` - Terms being Renegotiated * `cancelled` - Cancelled * `claimed` - Claimed * `paid` - Paid * `pending_client_financial` - Pending Client Financial Approval * `awaiting_external_ca_auth` - Awaiting External CA Authorization * `pending_ca_triage` - Pending CA Review Options: registered, issued, issued_validated, issued_not_valid, rejected_by_builder, being_priced, pricing_submitted, price_agreed, price_rejected, terms_agreed, terms_rejected, being_repriced, priced_by_client, terms_renegotiated, cancelled, claimed, paid, pending_client_financial, awaiting_external_ca_auth, pending_ca_triage
`status_label`	JSON	Computed JSON value; may be null when access is restricted.
`title` *	string	Short summary of the instruction.
`type_label` *	string
`updated_at` *	date-time
`valuation_basis`	string	Legacy single valuation method. Prefer valuation_methods.
`valuation_markup_percent`	decimal	Markup percent when valuation_basis is actual cost + markup.
`valuation_method_terms`	string	Agreed valuation method terms (dayworks, schedule of rates, etc.).
`valuation_methods`	JSON	Ordered proposed valuation methods (priority 1, 2, 3).
`variation_group`	string	Logical grouping for filters (warning, instruction, request, confirmation, advisory).
`workflow_tier`	string	UI workflow tier for this record; upgrade from simple to comprehensive. * `simple` - Simple * `comprehensive` - Comprehensive Options: simple, comprehensive

ChangeRequestRequest

Field	Type	Details
`addition_pricing_type`	string	Classification for newly added work in instructed value flows. * `none` - Not specified * `quoted` - This adds a new, quoted item * `unquoted` - This adds a new, unquoted item Options: none, quoted, unquoted
`adjusts_existing_work`	boolean
`anticipated_form_reference`	string
`attached_file_ids`	uuid[]
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`authority_certainty`	string	Bucket 1: definitive vs provisional instruction certainty. * `definitive` - Definitive * `provisional` - Provisional Options: definitive, provisional,
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`base_quote`	uuid	The original approved Quote/Agreement this change applies to.
`base_quote_number`	JSON	Computed JSON value; may be null when access is restricted.
`base_quote_title`	JSON	Computed JSON value; may be null when access is restricted.
`builder_proceeds`	boolean	Does the builder agree to proceed?
`builder_reject_reason`	string	Required if builder_proceeds is False.
`builder_signed_at`	date-time
`ca_financial_note`	string	Optional CA note attached when submitting for client financial approval.
`classification_other`	boolean	Other classification selected: requires classification_other_text.
`classification_other_text`	string	Mandatory free text when classification_other is set.
`client_countersigned_at`	date-time
`client_document_reference`	string	Client / CA reference number from the source document, if any.
`communication_method`	string	How the instruction was received (e.g., email, in_person).
`current_sla`	JSON	Computed JSON value; may be null when access is restricted.
`cvr_next_step`	string	CVR: request formal instruction or formal quote. * `request_instruction` - Request client to officially instruct * `request_quote` - Request client to ask for a formal quote Options: request_instruction, request_quote,
`delay_causes`	JSON	Notice of Delay cause checkbox keys.
`delay_narrative`	string	Notice of Delay free-text narrative.
`document_layout_mode`	JSON	Computed JSON value; may be null when access is restricted.
`draft_init`	boolean
`draft_prefill_instruction_text`	string
`effective_workflow_tier`	JSON	Computed JSON value; may be null when access is restricted.
`eot_to_be_determined`	boolean	True if EOT is acknowledged but will be calculated later.
`extension_of_time_days`	integer	Requested adjustment to the completion date (EOT).
`extension_of_time_hours`	decimal	Requested hours of time impact, in addition to extension_of_time_days.
`given_by`	string	Name of the person who gave the instruction.
`given_by_email`	email	Email for the given_by contact when selected from the project directory.
`given_by_member_id`	uuid
`has_public_consent`	JSON	Computed JSON value; may be null when access is restricted.
`impacts_design`	boolean	Does this change the design?
`impacts_quality`	boolean	Does this affect quality standards?
`impacts_quantity`	boolean	Does this change quantities?
`includes_loss_and_expense`	boolean	Does this claim include additional costs for delay/disruption?
`includes_preparation_costs`	boolean	Does this claim include the cost of preparing the quotation?
`initiation_route`	string	Stable create-route id used to tailor the editable detail view.
`instruction_text`	string	The core instruction given.
`is_addition`	boolean
`is_omission`	boolean
`is_proxy`	boolean	Whether this record was logged on behalf of another party.
`is_substitution`	boolean
`lead_time_dependent`	boolean	Material or specialist lead-time dependency on a simple CVI/CVR/proposal.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_impact`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`payment_timing`	string	Consumer/unadministered: how the variation will be paid. * `invoice_now` - Invoice immediately as a standalone item * `next_stage` - Add to the next stage payment * `final_invoice` - Add to the final project invoice Options: invoice_now, next_stage, final_invoice,
`pci_type`	string	Budget PCI purpose when estimating is on. Empty = paper-only change. * `CLIENT_VARIATION` - Client variation * `INTERNAL_SPEC` - Internal specification change * `PROV_SUM_EXPEND` - Provisional sum expend * `RISK_RELEASE` - Risk / contingency release Options: CLIENT_VARIATION, INTERNAL_SPEC, PROV_SUM_EXPEND, RISK_RELEASE,
`price_agreed_before_start`	boolean	True if price is agreed before work commences, False if proceeding immediately.
`pricing_strategy`	string	Explicit pricing pathway; synced with price_agreed_before_start. * `price_upfront` - Price upfront before work starts * `valuation_method` - Agree a method of valuation * `price_later` - Proceed immediately, price later Options: price_upfront, valuation_method, price_later,
`quote_validity_days`	integer	Validity period (days) when builder submits a quotation.
`quoted_source_quote`	uuid	If this change adds a new quoted item, link the source quote.
`reason`	string	Why is this change happening?
`reason_codes`	JSON	Simple CVI/CVR/proposal reason tick keys.
`reason_other_text`	string
`received_by`	string
`received_by_email`	email
`received_by_member_id`	uuid
`remove_attached_file_ids`	uuid[]
`request_date`	date
`request_time`	time	Time the verbal instruction/request was given.
`request_type`	string	* `request` - Variation Request * `instruction` - Variation Instruction * `early_warning` - Early Warning * `notice_of_delay` - Notice of Delay * `quote_request` - Quote Request * `confirmation` - CVI * `cvi` - Confirmation of Verbal Instruction (CVI) * `cvr` - Confirmation of Verbal Request (CVR) * `change_order` - Change Order * `potential_change_order` - Potential Change Order * `field_directive` - Field Directive Options: request, instruction, early_warning, notice_of_delay, quote_request, confirmation, cvi, cvr, change_order, potential_change_order, field_directive
`response_deadline`	date-time	The deadline for the client/builder to respond before default acceptance/rejection.
`restocking_fees`	decimal	Consumer contracts: restocking / non-refundable deposits.
`resulting_variation_invoice_count`	JSON	Computed JSON value; may be null when access is restricted.
`revised_completion_date`	date	Requested revised completion / working-period end date.
`risk_contingency_value`	decimal	Early warning approximate risk / contingency value.
`signature_loop_stage`	string	* `none` - Not required * `awaiting_builder` - Awaiting builder signature * `awaiting_client` - Awaiting client countersignature * `complete` - Fully signed Options: none, awaiting_builder, awaiting_client, complete,
`simple_issuer_contact`	string
`simple_issuer_contact_email`	email
`simple_issuer_contact_member_id`	uuid
`simple_paper_kind`	JSON	Computed JSON value; may be null when access is restricted.
`simple_price_certainty`	string	Simple workflow: fixed, estimated/indicative, quote requested, no price change, or not assessed. * `fixed` - Fixed price * `estimated` - Estimated / Indicative * `quote_requested` - Quote Requested * `no_price_change` - No price change * `not_assessed` - Not assessed Options: fixed, estimated, quote_requested, no_price_change, not_assessed,
`simple_recipient`	string
`simple_recipient_email`	email
`simple_recipient_member_id`	uuid
`simple_time_certainty`	string	Simple workflow: estimated, definitive / fixed, post-completion, or no time impact. * `estimated` - Estimated / Indicative * `definitive` - Definitive / Fixed * `post_completion` - Assessed / agreed post-completion * `not_assessed` - No time impact Options: estimated, definitive, post_completion, not_assessed,
`sla_deadlines`	JSON	Computed JSON value; may be null when access is restricted.
`source_document_type`	string	Client-issued instruction: type of source document received. * `architect_instruction` - Architect's Instruction (AI/CAI) * `signed_change_agreement` - Signed Change / Variation Agreement * `quote_request` - Quote Request * `site_direction_minutes` - Site Direction / Meeting Minutes * `email_confirmation` - Email Confirmation Options: architect_instruction, signed_change_agreement, quote_request, site_direction_minutes, email_confirmation,
`source_site_log`	uuid
`source_site_log_cost_impact_type`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_date`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_delay_days`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_estimated_cost_amount`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_estimated_cost_currency`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_recommendation`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_responsible_party`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_risk_level`	JSON	Computed JSON value; may be null when access is restricted.
`source_timeline_entry`	uuid
`source_timeline_entry_preview`	JSON	Computed JSON value; may be null when access is restricted.
`status`	string	* `registered` - Draft / Registered * `issued` - Issued / Submitted * `issued_validated` - Instruction Validated * `issued_not_valid` - Instruction Invalid * `rejected_by_builder` - Rejected by Builder * `being_priced` - Pricing in Progress * `pricing_submitted` - Pricing Submitted * `price_agreed` - Price Agreed * `price_rejected` - Price Rejected * `terms_agreed` - Variation Approved * `terms_rejected` - Variation Rejected * `being_repriced` - Repricing in Progress * `priced_by_client` - To be Priced by Client * `terms_renegotiated` - Terms being Renegotiated * `cancelled` - Cancelled * `claimed` - Claimed * `paid` - Paid * `pending_client_financial` - Pending Client Financial Approval * `awaiting_external_ca_auth` - Awaiting External CA Authorization * `pending_ca_triage` - Pending CA Review Options: registered, issued, issued_validated, issued_not_valid, rejected_by_builder, being_priced, pricing_submitted, price_agreed, price_rejected, terms_agreed, terms_rejected, being_repriced, priced_by_client, terms_renegotiated, cancelled, claimed, paid, pending_client_financial, awaiting_external_ca_auth, pending_ca_triage
`status_label`	JSON	Computed JSON value; may be null when access is restricted.
`title` *	string	Short summary of the instruction.
`valuation_basis`	string	Legacy single valuation method. Prefer valuation_methods.
`valuation_markup_percent`	decimal	Markup percent when valuation_basis is actual cost + markup.
`valuation_method_terms`	string	Agreed valuation method terms (dayworks, schedule of rates, etc.).
`valuation_methods`	JSON	Ordered proposed valuation methods (priority 1, 2, 3).
`variation_group`	string	Logical grouping for filters (warning, instruction, request, confirmation, advisory).
`workflow_tier`	string	UI workflow tier for this record; upgrade from simple to comprehensive. * `simple` - Simple * `comprehensive` - Comprehensive Options: simple, comprehensive

Contact

Field	Type	Details
`avatar_color`	string
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`email`	email
`id` *	uuid
`is_primary_contact`	boolean
`linked_user` *	LinkedUserAvatar
`name` *	string
`notes`	string
`phone_number`	string
`role`	string

ContactRequest

Field	Type	Details
`avatar_color`	string
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`email`	email
`is_primary_contact`	boolean
`name` *	string
`notes`	string
`phone_number`	string
`role`	string

CostCode

Field	Type	Details
`code`	string
`cost_types`	CostCodeTypeLink[]
`default_rate`	decimal
`default_unit`	string
`external_code`	string
`id` *	integer
`is_active`	boolean
`is_system` *	boolean
`name` *	string

CostCodeRequest

Field	Type	Details
`code`	string
`cost_types`	CostCodeTypeLinkRequest[]
`default_rate`	decimal
`default_unit`	string
`external_code`	string
`is_active`	boolean
`name` *	string

CostCodeTypeLink

Field	Type	Details
`cost_type` *	integer
`cost_type_key` *	string
`cost_type_name` *	string
`id`	integer
`nominal_code`	string
`sage_ledger_account_id`	string

CostCodeTypeLinkRequest

Field	Type	Details
`cost_type` *	integer
`id`	integer
`nominal_code`	string
`sage_ledger_account_id`	string

CostType

Field	Type	Details
`id` *	integer
`is_active`	boolean
`is_core` *	boolean
`key` *	string
`name` *	string
`sort_order`	integer

CostTypeRequest

Field	Type	Details
`is_active`	boolean
`name` *	string
`sort_order`	integer

CustomProjectStatus

Field	Type	Details
`color`	string	Optional hex color.
`description`	string	Optional tooltip description.
`id` *	uuid
`name` *	string	Display name, e.g., 'Quote Submitted'.
`order`	integer	Display order in dropdowns.
`status_set`	JSON	Computed JSON value; may be null when access is restricted.
`status_set_id`	uuid
`system_status` *	string	Core system status this maps to. * `planning` - Planning * `active` - Active * `on_hold` - On Hold * `completed` - Completed * `canceled` - Canceled Options: planning, active, on_hold, completed, canceled

CustomProjectStatusRequest

Field	Type	Details
`color`	string	Optional hex color.
`description`	string	Optional tooltip description.
`name` *	string	Display name, e.g., 'Quote Submitted'.
`order`	integer	Display order in dropdowns.
`status_set`	JSON	Computed JSON value; may be null when access is restricted.
`status_set_id`	uuid
`system_status` *	string	Core system status this maps to. * `planning` - Planning * `active` - Active * `on_hold` - On Hold * `completed` - Completed * `canceled` - Canceled Options: planning, active, on_hold, completed, canceled

Customer

Field	Type	Details
`avatar_color`	string
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`billing_address`	Address
`company`	string	Optional company name for the customer.
`contact_email`	email	Primary contact email for this customer entity.
`contacts` *	Contact[]
`customer_type`	string	* `residential` - Residential * `commercial` - Commercial Options: residential, commercial
`id` *	uuid
`name` *	string	Name of the customer (individual or company).
`notes`	string
`payment_terms_days`	integer	Default number of days until an invoice is due for this customer.
`phone_number`	string
`relationship_stage`	string	Prospect until a job is won; active once they have live or completed work. * `prospect` - Prospect * `active` - Active client * `past` - Past client Options: prospect, active, past
`tax_id`	string	Tax ID or VAT Number.
`workspace` *	uuid

CustomerList

Field	Type	Details
`avatar_color` *	string	Hex colour for initials fallback when no image is set.
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`billing_address` *	Address
`company` *	string	Optional company name for the customer.
`contact_email` *	email	Primary contact email for this customer entity.
`customer_type` *	string	* `residential` - Residential * `commercial` - Commercial Options: residential, commercial
`id` *	uuid
`name` *	string	Name of the customer (individual or company).
`notes` *	string
`payment_terms_days` *	integer	Default number of days until an invoice is due for this customer.
`phone_number` *	string
`tax_id` *	string	Tax ID or VAT Number.

CustomerRequest

Field	Type	Details
`avatar_color`	string
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`billing_address`	AddressRequest
`company`	string	Optional company name for the customer.
`contact_email`	email	Primary contact email for this customer entity.
`contacts_payload`	ContactRequest[]
`customer_type`	string	* `residential` - Residential * `commercial` - Commercial Options: residential, commercial
`name` *	string	Name of the customer (individual or company).
`notes`	string
`payment_terms_days`	integer	Default number of days until an invoice is due for this customer.
`phone_number`	string
`relationship_stage`	string	Prospect until a job is won; active once they have live or completed work. * `prospect` - Prospect * `active` - Active client * `past` - Past client Options: prospect, active, past
`tax_id`	string	Tax ID or VAT Number.

CustomerSimple

Field	Type	Details
`customer_type`	string	* `residential` - Residential * `commercial` - Commercial Options: residential, commercial
`id` *	uuid
`name` *	string	Name of the customer (individual or company).

CustomerSimpleRequest

Field	Type	Details
`customer_type`	string	* `residential` - Residential * `commercial` - Commercial Options: residential, commercial
`name` *	string	Name of the customer (individual or company).

DownloadResponse

Field	Type	Details
`url` *	uri

EOTEntry

Field	Type	Details
`approved_days`	integer
`claimed_at` *	date
`claimed_days` *	integer
`decision_date`	date
`id`	integer
`notes`	string
`reason`	string

EOTEntryRequest

Field	Type	Details
`approved_days`	integer
`claimed_days` *	integer
`decision_date`	date
`id`	integer
`notes`	string
`reason`	string

Entry

Field	Type	Details
`attached_files` *	FileDetail[]
`audience_type`	string	* `builder_internal` - Builder staff * `builder_team` - Builder side * `builder_client` - Builder and client teams * `client_team` - Client team * `everyone` - Everyone on this job * `selected_people` - Selected people Options: builder_internal, builder_team, builder_client, client_team, everyone, selected_people
`author` *	UserPublic
`can_manage_entry`	JSON	Computed JSON value; may be null when access is restricted.
`can_retract_entry`	JSON	Computed JSON value; may be null when access is restricted.
`can_view_original`	JSON	Computed JSON value; may be null when access is restricted.
`change_request`	JSON	Computed JSON value; may be null when access is restricted.
`content_original`	JSON	Computed JSON value; may be null when access is restricted.
`content_type`	integer
`content_visible`	JSON	Computed JSON value; may be null when access is restricted.
`converted_change_request`	JSON	Computed JSON value; may be null when access is restricted.
`converted_task`	JSON	Computed JSON value; may be null when access is restricted.
`created_at` *	date-time
`deliveries` *	EntryDelivery[]
`email_last_attempt_at`	date-time
`email_last_error`	string
`email_send_status`	string
`enquiry`	uuid	Pipeline enquiry this activity originated from.
`entry_type`	string	* `message` - User Message * `file_upload` - File Upload * `site_diary` - Site Diary * `actionable_item` - Actionable Item * `system_event` - System Event Options: message, file_upload, site_diary, actionable_item, system_event
`entry_type_display` *	string
`event_key`	string	Stable machine key for system-generated activity events.
`event_meta`	JSON	Structured, redacted metadata for audit/export details.
`external_sender_email`	email	Email of an external recipient when author is null.
`external_sender_via`	string	How the external sender responded (shared link or email reply). * `` - - * `portal` - Portal * `email` - Email Options: , portal, email
`id` *	uuid
`is_private`	boolean	If True, this entry is only visible to workspace members.
`is_tombstoned` *	boolean
`linked_object_kind` *	string
`linked_object_label` *	string
`linked_object_was_deleted` *	boolean
`made_public_at`	date-time	Timestamp for when a private note was made public.
`notified_users`	JSON	Computed JSON value; may be null when access is restricted.
`notify_mode`	string	Who should be notified about this entry. * `everyone` - Everyone * `none` - No one * `custom` - Custom Options: everyone, none, custom
`object_id`	uuid
`parent_entry`	uuid
`project`	uuid
`project_name`	string
`quote`	JSON	Computed JSON value; may be null when access is restricted.
`replies`	JSON	Computed JSON value; may be null when access is restricted.
`retracted_at`	date-time
`retracted_by` *	UserPublic
`selected_user_ids`	JSON
`site_diary`	JSON	Computed JSON value; may be null when access is restricted.
`status`	string	* `active` - Active * `retracted` - Retracted Options: active, retracted
`status_display` *	string
`tombstone_reason` *	string
`updated_at` *	date-time
`workspace` *	uuid	Direct scope for pre-project enquiry activity and workspace search.

EntryCreateRequest

Field	Type	Details
`attached_file_ids`	uuid[]
`audience_type`	string	* `builder_internal` - Builder staff * `builder_team` - Builder side * `builder_client` - Builder and client teams * `client_team` - Client team * `everyone` - Everyone on this job * `selected_people` - Selected people Options: builder_internal, builder_team, builder_client, client_team, everyone, selected_people
`content` *	string	The main text content or a description of the event.
`is_private`	boolean	If True, this entry is only visible to workspace members.
`notify_mode`	string	* `everyone` - Everyone * `none` - No one * `custom` - Custom Options: everyone, none, custom
`parent_entry`	uuid
`recipient_ids`	uuid[]
`selected_user_ids`	JSON

EntryDelivery

Field	Type	Details
`channel`	string	* `email` - Email * `portal` - Portal Options: email, portal
`id` *	uuid
`last_error`	string
`opened_at`	date-time
`queued_at` *	date-time
`recipient_email` *	email
`recipient_name`	string
`replied_at`	date-time
`sent_at`	date-time
`state`	string	* `queued` - Queued * `sent` - Sent * `failed` - Failed * `opened` - Opened * `replied` - Replied Options: queued, sent, failed, opened, replied

EntryDeliveryRequest

Field	Type	Details
`channel`	string	* `email` - Email * `portal` - Portal Options: email, portal
`last_error`	string
`opened_at`	date-time
`recipient_email` *	email
`recipient_name`	string
`replied_at`	date-time
`sent_at`	date-time
`state`	string	* `queued` - Queued * `sent` - Sent * `failed` - Failed * `opened` - Opened * `replied` - Replied Options: queued, sent, failed, opened, replied

Estimate

Field	Type	Details
`adjudication_mode`	string	* `CONTRACTING` - Contracting * `HOUSEBUILDER` - Housebuilder Options: CONTRACTING, HOUSEBUILDER
`as_of_date`	date
`auth_status` *	string	* `DRAFT` - Draft * `PENDING_REVIEW` - Pending review * `AUTHORIZED` - Authorized * `REJECTED` - Rejected Options: DRAFT, PENDING_REVIEW, AUTHORIZED, REJECTED
`contingency_amount`	decimal
`created_at` *	date-time
`id` *	uuid
`is_active`	boolean
`is_primary`	boolean
`markup_labour_percent`	decimal
`markup_material_percent`	decimal
`markup_other_percent`	decimal
`markup_plant_percent`	decimal
`markup_subcontract_percent`	decimal
`notes_internal`	string
`ohp_defaults`	JSON
`partner_id`	uuid
`profit_spread_mode`	string	* `SUMMARY_LUMP_SUM` - Summary lump sum * `SPREAD_IN_RATES` - Spread in rates Options: SUMMARY_LUMP_SUM, SPREAD_IN_RATES
`programme_weeks`	integer
`project` *	uuid
`quote` *	uuid
`requested_approver` *	uuid
`submitted_by` *	uuid
`target_gdv`	decimal
`total_gifa_sq_ft`	decimal
`total_gifa_sq_m`	decimal
`updated_at` *	date-time
`version_name`	string

EstimateActivity

Field	Type	Details
`activity_id`	integer
`description`	string
`duration_days`	integer
`estimate` *	uuid
`group`	integer
`group_name`	string
`id` *	uuid
`labour_total`	JSON	Computed JSON value; may be null when access is restricted.
`location_mode`	boolean
`material_total`	JSON	Computed JSON value; may be null when access is restricted.
`name` *	string
`other_total`	JSON	Computed JSON value; may be null when access is restricted.
`parent`	uuid
`plant_total`	JSON	Computed JSON value; may be null when access is restricted.
`set_id`	integer
`sort`	integer
`subcontract_total`	JSON	Computed JSON value; may be null when access is restricted.

EstimateActivityRequest

Field	Type	Details
`activity_id`	integer
`description`	string
`duration_days`	integer
`group`	integer
`group_name`	string
`labour_total`	JSON	Computed JSON value; may be null when access is restricted.
`location_mode`	boolean
`material_total`	JSON	Computed JSON value; may be null when access is restricted.
`name` *	string
`other_total`	JSON	Computed JSON value; may be null when access is restricted.
`parent`	uuid
`plant_total`	JSON	Computed JSON value; may be null when access is restricted.
`set_id`	integer
`sort`	integer
`subcontract_total`	JSON	Computed JSON value; may be null when access is restricted.

EstimateHouseType

Field	Type	Details
`bedrooms`	integer
`code`	string
`created_at` *	date-time
`default_gdv`	decimal
`default_gifa_sq_ft`	decimal
`default_tenure`	string
`description`	string
`estimate` *	uuid
`id` *	uuid
`is_active`	boolean
`name` *	string
`plot_count` *	integer
`revision` *	integer
`updated_at` *	date-time

EstimateHouseTypeRequest

Field	Type	Details
`bedrooms`	integer
`code`	string
`default_gdv`	decimal
`default_gifa_sq_ft`	decimal
`default_tenure`	string
`description`	string
`is_active`	boolean
`name` *	string

EstimateLocation

Field	Type	Details
`code`	string
`description`	string
`estimate` *	uuid
`house_type`	string
`house_type_definition`	uuid
`house_type_details` *	EstimateHouseType
`house_type_overrides`	JSON	Computed JSON value; may be null when access is restricted.
`id` *	uuid
`name` *	string
`parent`	uuid
`plot_gdv`	decimal
`plot_gifa_sq_ft`	decimal
`sort_order`	integer
`tenure`	string

EstimateLocationRequest

Field	Type	Details
`code`	string
`description`	string
`house_type`	string
`house_type_definition`	uuid
`house_type_overrides`	JSON	Computed JSON value; may be null when access is restricted.
`name` *	string
`parent`	uuid
`plot_gdv`	decimal
`plot_gifa_sq_ft`	decimal
`sort_order`	integer
`tenure`	string

EstimateWorkItem

Field	Type	Details
`activity`	uuid
`base_total`	decimal
`boq_path`	JSON	Computed JSON value; may be null when access is restricted.
`description`	string
`est_line`	uuid
`estimate` *	uuid
`group`	integer
`id` *	uuid
`is_spot_item`	boolean
`is_unit_price`	boolean
`line_total`	decimal
`name` *	string
`ohp_pct_override`	decimal
`payment_stage`	JSON	Computed JSON value; may be null when access is restricted.
`profit_total`	decimal
`quantity`	decimal
`sell_markup_pct`	decimal
`sell_total`	decimal
`sort`	integer
`source_library_id`	string
`source_library_name`	string
`source_library_type`	string
`source_work_item_id`	integer
`unit_of_measure`	string
`unit_rate`	decimal
`visibility`	string	* `rollup` - Roll-up * `expanded` - Expanded Options: rollup, expanded

EstimateWorkItemRequest

Field	Type	Details
`activity`	uuid
`boq_path`	JSON	Computed JSON value; may be null when access is restricted.
`description`	string
`est_line`	uuid
`group`	integer
`is_spot_item`	boolean
`is_unit_price`	boolean
`line_total`	decimal
`name` *	string
`ohp_pct_override`	decimal
`payment_stage`	JSON	Computed JSON value; may be null when access is restricted.
`payment_stage_id`	uuid
`quantity`	decimal
`sell_markup_pct`	decimal
`sell_total`	decimal
`sort`	integer
`source_lib_line`	uuid
`source_library_id`	string
`source_library_name`	string
`source_library_type`	string
`source_work_item_id`	integer
`unit_of_measure`	string
`unit_rate`	decimal
`visibility`	string	* `rollup` - Roll-up * `expanded` - Expanded Options: rollup, expanded

Event

Field	Type	Details
`all_day`	boolean
`attendees`	Attendee[]
`conference_url`	uri
`created_at` *	date-time
`created_by` *	uuid
`description`	string
`end` *	date-time
`external_uid`	string
`id` *	uuid
`is_private_read`	JSON	Computed JSON value; may be null when access is restricted.
`organizer_email`	email
`project` *	uuid
`recurrence_rrule`	string
`reminder_minutes`	integer
`start` *	date-time
`timezone`	string
`title` *	string
`updated_at` *	date-time
`url`	uri
`visibility`	string	* `project` - Project * `private` - Private * `workspace` - Workspace Options: project, private, workspace
`workspace` *	uuid

EventRequest

Field	Type	Details
`all_day`	boolean
`attendees`	AttendeeRequest[]
`conference_url`	uri
`description`	string
`end` *	date-time
`external_uid`	string
`is_private`	boolean
`is_private_read`	JSON	Computed JSON value; may be null when access is restricted.
`organizer_email`	email
`recurrence_rrule`	string
`reminder_minutes`	integer
`start` *	date-time
`timezone`	string
`title` *	string
`url`	uri
`visibility`	string	* `project` - Project * `private` - Private * `workspace` - Workspace Options: project, private, workspace

Expense

Field	Type	Details
`approval`	JSON	Computed JSON value; may be null when access is restricted.
`attached_receipts`	uuid[]
`attached_receipts_detail`	JSON	Computed JSON value; may be null when access is restricted.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`balance_due`	object
`cis_deduction_amount`	decimal
`cis_deduction_rate`	decimal
`cis_materials_amount`	decimal
`claimant`	uuid	The person who paid out of pocket and needs to be reimbursed.
`claimant_name`	string
`created_by` *	uuid
`description`	string
`document_type`	string	* `bill` - Bill * `credit_note` - Credit note Options: bill, credit_note
`due_date`	date
`effective_retention_held`	JSON	Computed JSON value; may be null when access is restricted.
`exchange_rate`	decimal	Rate used to convert Original -> Workspace.
`gross_amount`	object
`id` *	uuid
`is_converted`	JSON	Computed JSON value; may be null when access is restricted.
`is_reimbursable`	boolean	True if paid by employee (needs reimbursement). False if paid by company.
`issue_date` *	date
`latest_return_note` *	string
`lien_waiver_action_at` *	date-time
`lien_waiver_action_by` *	uuid
`lien_waiver_action_note` *	string
`lien_waiver_status` *	string	* `not_required` - Not required * `required` - Required * `received` - Received * `waived` - Requirement waived Options: not_required, required, received, waived
`lien_waivers` *	ExpenseLienWaiver[]
`line_items`	ExpenseLineItem[]
`match_exception_approved_at` *	date-time
`match_exception_approved_by` *	uuid
`match_notes` *	string
`match_status` *	string	* `unmatched` - Unmatched * `matched` - Matched * `exception` - Match exception * `exception_approved` - Exception approved Options: unmatched, matched, exception, exception_approved
`match_summary`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_amount`	object
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string	Internal notes or comments about this expense.
`original_currency`	string	ISO code of the original receipt currency.
`parent_expense_id`	uuid
`parsing_notes`	string	Context or warnings from the AI extraction.
`partner` *	ExpensePartner
`partner_id`	uuid
`payments`	ExpensePayment[]
`project` *	uuid
`purchase_order_id`	uuid
`purchase_order_number`	string
`record_type`	string	* `supplier_bill` - Supplier bill * `expense` - Everyday expense / receipt * `reimbursement` - Employee reimbursement Options: supplier_bill, expense, reimbursement
`reference`	string
`requested_approver`	uuid	The specific manager requested to approve this spend.
`retention_held`	object
`retention_percentage`	decimal
`retention_released`	object
`retention_releases` *	ExpenseRetentionRelease[]
`status`	string	* `draft` - Draft * `submitted` - Submitted * `approved` - Approved * `rejected` - Rejected * `partially_paid` - Partially Paid * `paid` - Paid * `overdue` - Overdue Options: draft, submitted, approved, rejected, partially_paid, paid, overdue
`supplier_invoice_number`	string
`tax_amount`	object
`tax_exempt`	boolean
`tax_treatment`	string	* `standard` - Standard * `reverse_charge` - Domestic reverse charge * `zero` - Zero rated * `reduced` - Reduced rated * `exempt` - Exempt * `use_tax` - Use tax Options: standard, reverse_charge, zero, reduced, exempt, use_tax
`total_paid`	object
`use_tax_amount`	decimal
`vendor_name` *	string	Vendor/supplier name.

ExpenseLienWaiver

Field	Type	Details
`amount`	object
`created_at` *	date-time
`expense` *	uuid
`id` *	uuid
`notes`	string
`payment`	uuid
`received_at` *	date-time
`received_by` *	uuid
`received_by_name`	string
`requested_at` *	date-time
`requested_by` *	uuid
`requested_by_name`	string
`status`	string	* `not_required` - Not required * `required` - Required * `requested` - Requested * `received` - Received * `waived` - Requirement waived Options: not_required, required, requested, received, waived
`updated_at` *	date-time
`uploaded_file` *	uuid
`uploaded_file_name`	string
`waived_at` *	date-time
`waived_by` *	uuid
`waived_by_name`	string
`waiver_kind`	string	* `conditional` - Conditional * `unconditional` - Unconditional Options: conditional, unconditional
`waiver_reason`	string
`waiver_scope`	string	* `partial` - Partial * `final` - Final Options: partial, final

ExpenseLienWaiverRequest

Field	Type	Details
`amount`	string or number or object
`notes`	string
`payment`	uuid
`status`	string	* `not_required` - Not required * `required` - Required * `requested` - Requested * `received` - Received * `waived` - Requirement waived Options: not_required, required, requested, received, waived
`waiver_kind`	string	* `conditional` - Conditional * `unconditional` - Unconditional Options: conditional, unconditional
`waiver_reason`	string
`waiver_scope`	string	* `partial` - Partial * `final` - Final Options: partial, final

ExpenseLineItem

Field	Type	Details
`category`	string	* `materials` - Materials * `labour` - Labour * `plant` - Plant * `subcontract` - Subcontract * `overhead` - Overhead * `other` - Other Options: materials, labour, plant, subcontract, overhead, other
`cost_code`	integer
`description` *	string
`id`	uuid
`line_gross`	object
`line_net`	object
`line_tax`	object
`purchase_order_line_id`	uuid
`quantity`	decimal
`tax_rate`	decimal
`unit_of_measure`	string
`unit_price`	object

ExpenseLineItemRequest

Field	Type	Details
`category`	string	* `materials` - Materials * `labour` - Labour * `plant` - Plant * `subcontract` - Subcontract * `overhead` - Overhead * `other` - Other Options: materials, labour, plant, subcontract, overhead, other
`cost_code`	integer
`description` *	string
`id`	uuid
`line_gross`	string or number or object
`line_net`	string or number or object
`line_tax`	string or number or object
`purchase_order_line_id`	uuid
`quantity`	decimal
`tax_rate`	decimal
`unit_of_measure`	string
`unit_price` *	string or number or object

ExpensePartner

Field	Type	Details
`backup_withholding_required`	boolean	US: payer should review backup withholding before payment.
`id` *	uuid
`is_1099_eligible`	boolean	US: vendor may require 1099 reporting.
`is_cis_registered`	boolean	UK: subcontractor is CIS-registered and needs verification on file.
`name` *	string	The partner's name or company name.
`tax_id`	string	VAT number, EIN, UTR, or other tax identifier.
`us_tax_classification`	string	US W-9 tax classification. Full tax IDs are not required here. * `` - Not recorded * `individual` - Individual / sole proprietor * `c_corp` - C corporation * `s_corp` - S corporation * `partnership` - Partnership * `trust_estate` - Trust / estate * `llc` - LLC * `other` - Other Options: , individual, c_corp, s_corp, partnership, trust_estate, llc, other
`us_tin_last_four`	string	US W-9 TIN/EIN last four only.
`us_tin_type`	string	US W-9 identifier type, stored without the full identifier. * `` - Not recorded * `ein` - EIN * `ssn` - SSN * `itin` - ITIN Options: , ein, ssn, itin
`w9_received_at`	date	Date a W-9 was received or confirmed.

ExpensePartnerRequest

Field	Type	Details
`backup_withholding_required`	boolean	US: payer should review backup withholding before payment.
`is_1099_eligible`	boolean	US: vendor may require 1099 reporting.
`is_cis_registered`	boolean	UK: subcontractor is CIS-registered and needs verification on file.
`name` *	string	The partner's name or company name.
`tax_id`	string	VAT number, EIN, UTR, or other tax identifier.
`us_tax_classification`	string	US W-9 tax classification. Full tax IDs are not required here. * `` - Not recorded * `individual` - Individual / sole proprietor * `c_corp` - C corporation * `s_corp` - S corporation * `partnership` - Partnership * `trust_estate` - Trust / estate * `llc` - LLC * `other` - Other Options: , individual, c_corp, s_corp, partnership, trust_estate, llc, other
`us_tin_last_four`	string	US W-9 TIN/EIN last four only.
`us_tin_type`	string	US W-9 identifier type, stored without the full identifier. * `` - Not recorded * `ein` - EIN * `ssn` - SSN * `itin` - ITIN Options: , ein, ssn, itin
`w9_received_at`	date	Date a W-9 was received or confirmed.

ExpensePayment

Field	Type	Details
`amount`	object
`cis_snapshot`	JSON	Computed JSON value; may be null when access is restricted.
`created_at` *	date-time
`date`	date
`id` *	uuid
`method`	string	e.g. 'Company Card', 'Bank Transfer', 'Petty Cash'
`note`	string
`reference`	string

ExpensePaymentRequest

Field	Type	Details
`amount` *	string or number or object
`cis_gross_amount`	decimal
`cis_materials_amount`	decimal
`cis_snapshot`	JSON	Computed JSON value; may be null when access is restricted.
`date`	date
`method`	string	e.g. 'Company Card', 'Bank Transfer', 'Petty Cash'
`note`	string
`reference`	string

ExpenseRequest

Field	Type	Details
`approval`	JSON	Computed JSON value; may be null when access is restricted.
`attached_receipts`	uuid[]
`attached_receipts_detail`	JSON	Computed JSON value; may be null when access is restricted.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`balance_due`	string or number or object
`cis_deduction_rate`	decimal
`cis_materials_amount`	decimal
`claimant`	uuid	The person who paid out of pocket and needs to be reimbursed.
`claimant_name`	string
`description`	string
`document_type`	string	* `bill` - Bill * `credit_note` - Credit note Options: bill, credit_note
`due_date`	date
`effective_retention_held`	JSON	Computed JSON value; may be null when access is restricted.
`exchange_rate`	decimal	Rate used to convert Original -> Workspace.
`gross_amount`	string or number or object
`is_converted`	JSON	Computed JSON value; may be null when access is restricted.
`is_reimbursable`	boolean	True if paid by employee (needs reimbursement). False if paid by company.
`issue_date` *	date
`line_items`	ExpenseLineItemRequest[]
`match_summary`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_amount`	string or number or object
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string	Internal notes or comments about this expense.
`original_currency`	string	ISO code of the original receipt currency.
`parent_expense_id`	uuid
`parsing_notes`	string	Context or warnings from the AI extraction.
`partner_id`	uuid
`purchase_order_id`	uuid
`record_type`	string	* `supplier_bill` - Supplier bill * `expense` - Everyday expense / receipt * `reimbursement` - Employee reimbursement Options: supplier_bill, expense, reimbursement
`reference`	string
`requested_approver`	uuid	The specific manager requested to approve this spend.
`retention_held`	string or number or object
`retention_percentage`	decimal
`retention_released`	string or number or object
`status`	string	* `draft` - Draft * `submitted` - Submitted * `approved` - Approved * `rejected` - Rejected * `partially_paid` - Partially Paid * `paid` - Paid * `overdue` - Overdue Options: draft, submitted, approved, rejected, partially_paid, paid, overdue
`supplier_invoice_number`	string
`tax_amount`	string or number or object
`tax_exempt`	boolean
`tax_treatment`	string	* `standard` - Standard * `reverse_charge` - Domestic reverse charge * `zero` - Zero rated * `reduced` - Reduced rated * `exempt` - Exempt * `use_tax` - Use tax Options: standard, reverse_charge, zero, reduced, exempt, use_tax
`total_paid`	string or number or object
`use_tax_amount`	decimal
`vendor_name` *	string	Vendor/supplier name.

ExpenseRetentionRelease

Field	Type	Details
`amount`	object
`id` *	uuid
`note` *	string
`released_at` *	date-time
`released_by` *	uuid
`released_by_name`	JSON	Computed JSON value; may be null when access is restricted.

ExpenseRetentionReleaseRequest

Field	Type	Details
`amount`	string or number or object
`released_by_name`	JSON	Computed JSON value; may be null when access is restricted.

File

Field	Type	Details
`audience_type`	string	* `builder_internal` - Builder staff * `builder_team` - Builder side * `builder_client` - Builder and client teams * `client_team` - Client team * `everyone` - Everyone on this job * `selected_people` - Selected people Options: builder_internal, builder_team, builder_client, client_team, everyone, selected_people
`created_at` *	date-time
`description`	string	A user-or-AI-generated description of the file's content.
`file`	uri
`folder_id`	uuid
`id` *	uuid
`is_private`	boolean	If True, this document is only visible to workspace members.
`selected_user_ids`	JSON
`status`	string	* `uploading` - Uploading * `processing` - Processing * `pending_review` - Pending Review * `approved` - Approved * `failed` - Failed Options: uploading, processing, pending_review, approved, failed
`superseded_by_id`	JSON	Computed JSON value; may be null when access is restricted.
`superseded_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`supersedes_id`	uuid
`tags`	uuid[]
`user_defined_name`	string

FileDetail

Field	Type	Details
`accuracy_m` *	double
`ai_suggestions`	JSON	Stores raw AI suggestions for name, tags, etc.
`analysis_error`	string
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`audience_type`	string	* `builder_internal` - Builder staff * `builder_team` - Builder side * `builder_client` - Builder and client teams * `client_team` - Client team * `everyone` - Everyone on this job * `selected_people` - Selected people Options: builder_internal, builder_team, builder_client, client_team, everyone, selected_people
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`captured_at` *	date-time
`created_at` *	date-time
`created_by_name`	string
`description`	string	A user-or-AI-generated description of the file's content.
`distance_from_site_m`	JSON	Computed JSON value; may be null when access is restricted.
`exif_latitude` *	double
`exif_longitude` *	double
`file` *	uri
`file_size`	integer	Size of the file in bytes.
`folder`	JSON	Computed JSON value; may be null when access is restricted.
`folder_id`	uuid
`id` *	uuid
`is_private`	boolean	If True, this document is only visible to workspace members.
`latitude` *	double
`location_source` *	string	* `device_gps` - Device GPS * `exif` - Photo EXIF Options: device_gps, exif
`longitude` *	double
`mime_type`	string	MIME type of the file.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`project`	uuid
`selected_user_ids`	JSON
`source`	string	* `general` - General Upload * `timeline` - Timeline Message * `site_diary` - Site Diary * `task` - Task Attachment * `expense` - Expense Receipt * `pickup` - Store Pickup Ticket * `delivery_ticket` - Delivery Docket * `quote` - Quote / Document Assets * `invoice` - Invoice / Document Assets * `partner_compliance` - Partner Compliance * `brief` - Builder Brief Options: general, timeline, site_diary, task, expense, pickup, delivery_ticket, quote, invoice, partner_compliance, brief
`status`	string	* `uploading` - Uploading * `processing` - Processing * `pending_review` - Pending Review * `approved` - Approved * `failed` - Failed Options: uploading, processing, pending_review, approved, failed
`storage_key` *	string
`superseded_by_id`	JSON	Computed JSON value; may be null when access is restricted.
`superseded_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`supersedes_id`	uuid
`tags` *	FileTag[]
`updated_at` *	date-time
`user_defined_name` *	string

FileDetailRequest

Field	Type	Details
`ai_suggestions`	JSON	Stores raw AI suggestions for name, tags, etc.
`analysis_error`	string
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`audience_type`	string	* `builder_internal` - Builder staff * `builder_team` - Builder side * `builder_client` - Builder and client teams * `client_team` - Client team * `everyone` - Everyone on this job * `selected_people` - Selected people Options: builder_internal, builder_team, builder_client, client_team, everyone, selected_people
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`description`	string	A user-or-AI-generated description of the file's content.
`distance_from_site_m`	JSON	Computed JSON value; may be null when access is restricted.
`file` *	binary
`file_size`	integer	Size of the file in bytes.
`folder`	JSON	Computed JSON value; may be null when access is restricted.
`folder_id`	uuid
`is_private`	boolean	If True, this document is only visible to workspace members.
`mime_type`	string	MIME type of the file.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`project`	uuid
`selected_user_ids`	JSON
`source`	string	* `general` - General Upload * `timeline` - Timeline Message * `site_diary` - Site Diary * `task` - Task Attachment * `expense` - Expense Receipt * `pickup` - Store Pickup Ticket * `delivery_ticket` - Delivery Docket * `quote` - Quote / Document Assets * `invoice` - Invoice / Document Assets * `partner_compliance` - Partner Compliance * `brief` - Builder Brief Options: general, timeline, site_diary, task, expense, pickup, delivery_ticket, quote, invoice, partner_compliance, brief
`status`	string	* `uploading` - Uploading * `processing` - Processing * `pending_review` - Pending Review * `approved` - Approved * `failed` - Failed Options: uploading, processing, pending_review, approved, failed
`superseded_by_id`	JSON	Computed JSON value; may be null when access is restricted.
`superseded_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`supersedes_id`	uuid
`user_defined_name` *	string

FileFinalizeRequestRequest

Field	Type	Details
`etag`	string

FilePresignRequestRequest

Field	Type	Details
`accuracy_m`	double
`audience_type`	string	* `builder_internal` - Builder staff * `builder_team` - Builder side * `builder_client` - Builder and client teams * `client_team` - Client team * `everyone` - Everyone on this job * `selected_people` - Selected people Options: builder_internal, builder_team, builder_client, client_team, everyone, selected_people
`captured_at`	date-time
`content_type` *	string
`exif_latitude`	double
`exif_longitude`	double
`filename` *	string
`is_private`	boolean
`latitude`	double
`location_source`	string	* `device_gps` - Device GPS * `exif` - Photo EXIF Options: device_gps, exif,
`longitude`	double
`selected_user_ids`	uuid[]
`size_bytes` *	integer
`source`	string	* `general` - General Upload * `timeline` - Timeline Message * `site_diary` - Site Diary * `task` - Task Attachment * `expense` - Expense Receipt * `pickup` - Store Pickup Ticket * `delivery_ticket` - Delivery Docket * `quote` - Quote / Document Assets * `invoice` - Invoice / Document Assets * `partner_compliance` - Partner Compliance * `brief` - Builder Brief Options: general, timeline, site_diary, task, expense, pickup, delivery_ticket, quote, invoice, partner_compliance, brief
`tags`	uuid[]

FileTag

Field	Type	Details
`category`	string	* `photos` - Photos * `documents` - Documents * `financial` - Financial * `plans` - Plans * `phases` - Project Phases Options: photos, documents, financial, plans, phases, ,
`description`	string
`id` *	uuid
`name` *	string

FileTagRequest

Field	Type	Details
`category`	string	* `photos` - Photos * `documents` - Documents * `financial` - Financial * `plans` - Plans * `phases` - Project Phases Options: photos, documents, financial, plans, phases, ,
`description`	string
`name` *	string

FinalAccountAssumption

Field	Type	Details
`assumption_percent`	integer
`change_request` *	uuid
`id` *	uuid
`included`	boolean
`project` *	uuid
`updated_at` *	date-time

FinalAccountAssumptionRequest

Field	Type	Details
`assumption_percent`	integer
`change_request` *	uuid
`included`	boolean

FinalAccountInputRequest

Field	Type	Details
`forecast_revenue_net`	decimal
`records` *	FinalAccountAssumptionRequest[]

FinancialSummary

Field	Type	Details
`accrued_cost` *	double
`actual_cost` *	double
`approved_actuals` *	double
`approved_expenses` *	double
`billed_margin` *	double
`budget_message` *	string
`budget_source` *	string
`budget_variance` *	double
`budget_variance_pct` *	double
`cash_in` *	double
`cash_out` *	double
`cash_paid` *	double
`cash_received` *	double
`client_credit_balance` *	double
`committed_cost` *	double
`committed_po_value` *	double
`contract_margin` *	double
`contract_margin_pct` *	double
`contract_sum` *	double
`cost_at_completion` *	double
`cost_movement` *	object
`forecast_cost` *	double
`forecast_margin` *	double
`forecast_margin_pct` *	double
`forecast_variance` *	double
`invoiced` *	double
`owed_by_client` *	double
`owed_to_suppliers` *	double
`pending_bills` *	double
`pending_payables` *	double
`planned_cost` *	double
`projected_profit` *	double
`remaining_commitment` *	double
`supplier_retention_held` *	double
`timesheet_cost` *	double
`timesheet_hours` *	double
`timesheet_labour` *	JSON
`total_exposure` *	double
`unordered_budget_residual` *	double

InvoiceDetail

Field	Type	Details
`allocations` *	PaymentAllocation[]
`amount_paid`	JSON	Computed JSON value; may be null when access is restricted.
`apply_cis`	boolean
`apply_drc`	boolean	If True, applies Domestic Reverse Charge (VAT = 0).
`apply_retention`	boolean
`apply_tax`	boolean	Whether VAT/tax is applied and shown on this invoice.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`balance_due`	JSON	Computed JSON value; may be null when access is restricted.
`bank_details`	string
`bill_to_address` *	Address
`cis_deduction_amount`	JSON	Computed JSON value; may be null when access is restricted.
`cis_rate`	decimal
`created_at` *	date-time
`created_by`	uuid
`customer_name`	string
`document_type`	string	* `invoice` - Invoice * `credit_note` - Credit Note * `retention_release` - Retention Release Options: invoice, credit_note, retention_release
`due_date` *	date
`effective_for_address`	JSON	Computed JSON value; may be null when access is restricted.
`effective_for_name`	JSON	Computed JSON value; may be null when access is restricted.
`effective_from_address`	JSON	Computed JSON value; may be null when access is restricted.
`effective_from_name`	JSON	Computed JSON value; may be null when access is restricted.
`effective_from_tax_id`	JSON	Computed JSON value; may be null when access is restricted.
`effective_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`effective_terms`	JSON	Computed JSON value; may be null when access is restricted.
`email_message`	string	Optional message to include in the email when sending/issuing. Not shown on the invoice PDF.
`header_config`	JSON
`id` *	uuid
`internal_notes`	string
`invoice_number` *	string	Workspace-unique invoice number (e.g., INV-0001).
`is_application`	JSON	Computed JSON value; may be null when access is restricted.
`issue_date` *	date
`line_items` *	InvoiceLineItem[]
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_payable`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string
`parent_invoice`	uuid
`previously_certified`	JSON	Computed JSON value; may be null when access is restricted.
`project` *	uuid
`project_name` *	string
`project_site_address` *	Address
`reference`	string
`retention_amount`	JSON	Computed JSON value; may be null when access is restricted.
`retention_rate`	decimal
`sections` *	InvoiceSection[]
`source_attributions`	JSON	Computed JSON value; may be null when access is restricted.
`source_document_type`	string
`source_quote`	uuid
`source_quote_number`	string
`source_quote_title`	string
`source_variation_number`	integer
`status` *	string	* `draft` - Draft * `issued` - Issued (Awaiting Payment) * `paid` - Paid * `partially_paid` - Partially Paid * `void` - Void Options: draft, issued, paid, partially_paid, void
`subtotal`	JSON	Computed JSON value; may be null when access is restricted.
`tax_amount`	JSON	Computed JSON value; may be null when access is restricted.
`tax_rate`	decimal	Override tax rate. If null, uses workspace default.
`terms_override`	string	Optional invoice-specific terms; if blank uses workspace default_terms_and_conditions.
`title`	string
`total`	JSON	Computed JSON value; may be null when access is restricted.
`updated_at` *	date-time
`workspace_bank_account_name` *	string
`workspace_bank_account_number` *	string
`workspace_bank_name` *	string
`workspace_bank_sort_code` *	string
`workspace_business_address` *	Address
`workspace_company_name` *	string
`workspace_country_iso2`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_default_payment_terms_days` *	integer
`workspace_default_tax_rate` *	decimal
`workspace_default_terms_and_conditions` *	string
`workspace_include_terms_in_invoices` *	boolean
`workspace_logo` *	uri
`workspace_name` *	string
`workspace_tax_id` *	string
`workspace_tax_label`	JSON	Computed JSON value; may be null when access is restricted.

InvoiceDetailRequest

Field	Type	Details
`amount_paid`	JSON	Computed JSON value; may be null when access is restricted.
`apply_cis`	boolean
`apply_drc`	boolean	If True, applies Domestic Reverse Charge (VAT = 0).
`apply_retention`	boolean
`apply_tax`	boolean	Whether VAT/tax is applied and shown on this invoice.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`balance_due`	JSON	Computed JSON value; may be null when access is restricted.
`bank_details`	string
`bill_to_address_id`	uuid
`cis_deduction_amount`	JSON	Computed JSON value; may be null when access is restricted.
`cis_rate`	decimal
`created_by`	uuid
`document_type`	string	* `invoice` - Invoice * `credit_note` - Credit Note * `retention_release` - Retention Release Options: invoice, credit_note, retention_release
`due_date` *	date
`effective_for_address`	JSON	Computed JSON value; may be null when access is restricted.
`effective_for_name`	JSON	Computed JSON value; may be null when access is restricted.
`effective_from_address`	JSON	Computed JSON value; may be null when access is restricted.
`effective_from_name`	JSON	Computed JSON value; may be null when access is restricted.
`effective_from_tax_id`	JSON	Computed JSON value; may be null when access is restricted.
`effective_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`effective_terms`	JSON	Computed JSON value; may be null when access is restricted.
`email_message`	string	Optional message to include in the email when sending/issuing. Not shown on the invoice PDF.
`header_config`	JSON
`internal_notes`	string
`is_application`	JSON	Computed JSON value; may be null when access is restricted.
`issue_date` *	date
`line_items` *	InvoiceLineItemRequest[]
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_payable`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string
`parent_invoice`	uuid
`previously_certified`	JSON	Computed JSON value; may be null when access is restricted.
`project` *	uuid
`reference`	string
`retention_amount`	JSON	Computed JSON value; may be null when access is restricted.
`retention_rate`	decimal
`source_attributions`	JSON	Computed JSON value; may be null when access is restricted.
`source_quote`	uuid
`subtotal`	JSON	Computed JSON value; may be null when access is restricted.
`tax_amount`	JSON	Computed JSON value; may be null when access is restricted.
`tax_rate`	decimal	Override tax rate. If null, uses workspace default.
`terms_override`	string	Optional invoice-specific terms; if blank uses workspace default_terms_and_conditions.
`title`	string
`total`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_country_iso2`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_tax_label`	JSON	Computed JSON value; may be null when access is restricted.

InvoiceLineItem

Field	Type	Details
`claim_percentage`	decimal	For progress claims, what % of the original sum is being billed now.
`cost_category`	string	* `labour` - Labour * `materials` - Materials * `plant` - Plant * `subcontract` - Subcontract * `overhead` - Overhead * `other` - Other * `professional` - Professional Options: labour, materials, plant, subcontract, overhead, other, professional
`cost_code`	integer
`cost_code_name`	JSON	Computed JSON value; may be null when access is restricted.
`description`	string
`id` *	uuid
`invoice` *	uuid
`line_total`	decimal
`order`	integer
`quantity`	decimal
`quote_line`	uuid
`section`	uuid	Pay-application section this line belongs to. Null on legacy free-text rows.
`unit_of_measure`	string
`unit_price`	decimal

InvoiceLineItemRequest

Field	Type	Details
`claim_percentage`	decimal	For progress claims, what % of the original sum is being billed now.
`cost_category`	string	* `labour` - Labour * `materials` - Materials * `plant` - Plant * `subcontract` - Subcontract * `overhead` - Overhead * `other` - Other * `professional` - Professional Options: labour, materials, plant, subcontract, overhead, other, professional
`cost_code`	integer
`cost_code_name`	JSON	Computed JSON value; may be null when access is restricted.
`description`	string
`order`	integer
`quantity`	decimal
`quote_line`	uuid
`section`	uuid	Pay-application section this line belongs to. Null on legacy free-text rows.
`unit_of_measure`	string
`unit_price` *	decimal

InvoiceSection

Field	Type	Details
`claim_percentage` *	decimal	This application's share of the section's original scheduled value.
`heading`	JSON	Computed JSON value; may be null when access is restricted.
`id` *	uuid
`kind` *	string	* `original_works` - Original works * `variation` - Variation Options: original_works, variation
`order` *	integer
`source_document_type`	string
`source_quote` *	uuid
`source_quote_number`	string
`source_quote_title`	string
`source_variation_number`	integer
`this_period`	JSON	Computed JSON value; may be null when access is restricted.

InvoiceSectionRequest

Field	Type	Details
`heading`	JSON	Computed JSON value; may be null when access is restricted.
`this_period`	JSON	Computed JSON value; may be null when access is restricted.

InvoiceSendInputRequest

Field	Type	Details
`copy_to_sender`	boolean
`email_bcc`	email[]
`email_body`	string
`email_cc`	email[]
`email_subject`	string
`email_to`	email[]
`schedule_follow_up`	boolean

InvoiceSendResult

Field	Type	Details
`doc`	object
`emailed_to` *	email[]
`invoice` *	InvoiceDetail	Serializer mixin for module-specific sensitive response fields. ``sensitive_fields_by_permission`` maps an independent permission key to the fields omitted when that key is absent. Nested serializers inherit the root request/project context from DRF.
`resent` *	boolean

LibWorkItemLine

Field	Type	Details
`boq_path`	JSON	Computed JSON value; may be null when access is restricted.
`classification_system`	string	* `NRM` - NRM * `BCIS` - BCIS * `CUSTOM` - Custom Options: NRM, BCIS, CUSTOM
`hierarchy_level` *	integer
`id` *	uuid
`lft` *	integer
`line_desc` *	string
`line_ref`	string
`line_type`	uuid
`parent`	uuid
`parent_level`	JSON	Computed JSON value; may be null when access is restricted.
`rgt` *	integer
`type_name` *	string
`work_item_count` *	integer
`work_items`	JSON	Computed JSON value; may be null when access is restricted.

LibWorkItemLineRequest

Field	Type	Details
`boq_path`	JSON	Computed JSON value; may be null when access is restricted.
`classification_system`	string	* `NRM` - NRM * `BCIS` - BCIS * `CUSTOM` - Custom Options: NRM, BCIS, CUSTOM
`line_desc` *	string
`line_ref`	string
`line_type`	uuid
`parent`	uuid
`parent_level`	JSON	Computed JSON value; may be null when access is restricted.
`work_items`	JSON	Computed JSON value; may be null when access is restricted.

LinkedUserAvatar

Field	Type	Details
`avatar_color` *	string	Hex color code for avatar fallback, generated from name.
`avatar_mode` *	string	Avatar rendering mode: auto, color, or image. * `auto` - Auto * `color` - Custom colour * `image` - Image Options: auto, color, image
`avatar_url` *	uri	URL for the user's profile picture.
`email` *	email
`first_name` *	string
`id` *	uuid
`last_name` *	string

Location

Field	Type	Details
`code`	string
`created_at` *	date-time
`description`	string
`id` *	integer
`is_active`	boolean
`name` *	string
`parent`	integer
`parent_name`	string
`sort_order`	integer
`updated_at` *	date-time

LocationRequest

Field	Type	Details
`code`	string
`description`	string
`is_active`	boolean
`name` *	string
`parent`	integer
`sort_order`	integer

PaginatedActivityGroupList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	ActivityGroup[]

PaginatedActivityList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	Activity[]

PaginatedActivitySetList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	ActivitySet[]

PaginatedBudgetGroupList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	BudgetGroup[]

PaginatedCalendarExceptionList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	CalendarException[]

PaginatedChangeItemList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	ChangeItem[]

PaginatedChangeRequestList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	ChangeRequest[]

PaginatedContactList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	Contact[]

PaginatedCostCodeList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	CostCode[]

PaginatedCostTypeList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	CostType[]

PaginatedCustomerListList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	CustomerList[]

PaginatedEntryList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	Entry[]

PaginatedEstimateActivityList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	EstimateActivity[]

PaginatedEstimateLocationList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	EstimateLocation[]

PaginatedEstimateWorkItemList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	EstimateWorkItem[]

PaginatedEventList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	Event[]

PaginatedExpenseList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	Expense[]

PaginatedFileDetailList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	FileDetail[]

PaginatedFinalAccountAssumptionList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	FinalAccountAssumption[]

PaginatedInvoiceDetailList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	InvoiceDetail[]

PaginatedLibWorkItemLineList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	LibWorkItemLine[]

PaginatedLocationList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	Location[]

PaginatedPartnerListList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	PartnerList[]

PaginatedPaymentStageList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	PaymentStage[]

PaginatedProjectList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	Project[]

PaginatedPropertyList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	Property[]

PaginatedPurchaseOrderList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	PurchaseOrder[]

PaginatedQuoteLineItemList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	QuoteLineItem[]

PaginatedQuoteList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	Quote[]

PaginatedQuoteSectionList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	QuoteSection[]

PaginatedRFIList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	RFI[]

PaginatedRequisitionItemList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	RequisitionItem[]

PaginatedResourceGroupList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	ResourceGroup[]

PaginatedResourceList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	Resource[]

PaginatedResourceNoteList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	ResourceNote[]

PaginatedResourcePriceList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	ResourcePrice[]

PaginatedResourceSupplierListingList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	ResourceSupplierListing[]

PaginatedScheduleDependencyList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	ScheduleDependency[]

PaginatedSiteLogList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	SiteLog[]

PaginatedSnagList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	Snag[]

PaginatedTaskDependencyList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	TaskDependency[]

PaginatedTaskListList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	TaskList[]

PaginatedTimesheetList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	Timesheet[]

PaginatedUnitList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	Unit[]

PaginatedWorkItemGroupList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	WorkItemGroup[]

PaginatedWorkItemList

Field	Type	Details
`count` *	integer
`next`	uri
`previous`	uri
`results` *	WorkItem[]

ParentTask

Field	Type	Details
`id` *	uuid
`name` *	string

ParentTaskRequest

Field	Type	Details
`name` *	string

Partner

Field	Type	Details
`address`	Address
`avatar_color`	string
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`backup_withholding_required`	boolean	US: payer should review backup withholding before payment.
`category` *	string	* `professional` - Professional Services * `trade` - Trades * `supplier` - Suppliers Options: professional, trade, supplier
`contacts` *	PartnerContact[]
`email`	email
`id` *	uuid
`is_1099_eligible`	boolean	US: vendor may require 1099 reporting.
`is_cis_registered`	boolean	UK: subcontractor is CIS-registered and needs verification on file.
`name` *	string	The partner's name or company name.
`notes`	string
`phone_number`	string
`specialties` *	PartnerSpecialty[]
`tax_id`	string	VAT number, EIN, UTR, or other tax identifier.
`us_tax_classification`	string	US W-9 tax classification. Full tax IDs are not required here. * `` - Not recorded * `individual` - Individual / sole proprietor * `c_corp` - C corporation * `s_corp` - S corporation * `partnership` - Partnership * `trust_estate` - Trust / estate * `llc` - LLC * `other` - Other Options: , individual, c_corp, s_corp, partnership, trust_estate, llc, other
`us_tin_last_four`	string	US W-9 TIN/EIN last four only.
`us_tin_type`	string	US W-9 identifier type, stored without the full identifier. * `` - Not recorded * `ein` - EIN * `ssn` - SSN * `itin` - ITIN Options: , ein, ssn, itin
`w9_received_at`	date	Date a W-9 was received or confirmed.
`workspace` *	uuid

PartnerContact

Field	Type	Details
`avatar_color`	string
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`email`	email
`id` *	uuid
`is_primary_contact`	boolean
`linked_user` *	LinkedUserAvatar
`name` *	string
`notes`	string
`phone_number`	string
`role`	string

PartnerContactRequest

Field	Type	Details
`avatar_color`	string
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`email`	email
`is_primary_contact`	boolean
`name` *	string
`notes`	string
`phone_number`	string
`role`	string

PartnerList

Field	Type	Details
`address` *	Address
`avatar_color` *	string
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`backup_withholding_required` *	boolean	US: payer should review backup withholding before payment.
`category` *	string	* `professional` - Professional Services * `trade` - Trades * `supplier` - Suppliers Options: professional, trade, supplier
`email` *	email
`id` *	uuid
`is_1099_eligible` *	boolean	US: vendor may require 1099 reporting.
`is_cis_registered` *	boolean	UK: subcontractor is CIS-registered and needs verification on file.
`name` *	string	The partner's name or company name.
`notes` *	string
`phone_number` *	string
`specialties` *	PartnerSpecialty[]
`tax_id` *	string	VAT number, EIN, UTR, or other tax identifier.
`us_tax_classification` *	string	US W-9 tax classification. Full tax IDs are not required here. * `` - Not recorded * `individual` - Individual / sole proprietor * `c_corp` - C corporation * `s_corp` - S corporation * `partnership` - Partnership * `trust_estate` - Trust / estate * `llc` - LLC * `other` - Other Options: , individual, c_corp, s_corp, partnership, trust_estate, llc, other
`us_tin_last_four` *	string	US W-9 TIN/EIN last four only.
`us_tin_type` *	string	US W-9 identifier type, stored without the full identifier. * `` - Not recorded * `ein` - EIN * `ssn` - SSN * `itin` - ITIN Options: , ein, ssn, itin
`w9_received_at` *	date	Date a W-9 was received or confirmed.

PartnerRequest

Field	Type	Details
`address`	AddressRequest
`avatar_color`	string
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`backup_withholding_required`	boolean	US: payer should review backup withholding before payment.
`category` *	string	* `professional` - Professional Services * `trade` - Trades * `supplier` - Suppliers Options: professional, trade, supplier
`contacts_payload`	PartnerContactRequest[]
`email`	email
`is_1099_eligible`	boolean	US: vendor may require 1099 reporting.
`is_cis_registered`	boolean	UK: subcontractor is CIS-registered and needs verification on file.
`name` *	string	The partner's name or company name.
`notes`	string
`phone_number`	string
`specialty_names`	string[]
`tax_id`	string	VAT number, EIN, UTR, or other tax identifier.
`us_tax_classification`	string	US W-9 tax classification. Full tax IDs are not required here. * `` - Not recorded * `individual` - Individual / sole proprietor * `c_corp` - C corporation * `s_corp` - S corporation * `partnership` - Partnership * `trust_estate` - Trust / estate * `llc` - LLC * `other` - Other Options: , individual, c_corp, s_corp, partnership, trust_estate, llc, other
`us_tin_last_four`	string	US W-9 TIN/EIN last four only.
`us_tin_type`	string	US W-9 identifier type, stored without the full identifier. * `` - Not recorded * `ein` - EIN * `ssn` - SSN * `itin` - ITIN Options: , ein, ssn, itin
`w9_received_at`	date	Date a W-9 was received or confirmed.

PartnerSpecialty

Field	Type	Details
`id` *	uuid
`name` *	string

PartnerSpecialtyRequest

Field	Type	Details
`name` *	string

PatchedActivityGroupRequest

Field	Type	Details
`name`	string

PatchedActivityRequest

Field	Type	Details
`code`	string
`default_waste_pct`	decimal
`description`	string
`group`	integer
`is_active`	boolean
`last_reviewed_at`	date
`name`	string
`notes_internal`	string
`parent`	integer
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived
`set`	integer
`sort`	integer
`work_items`	JSON	Computed JSON value; may be null when access is restricted.
`work_items_input`	ActivityWorkItemInlineRequest[]

PatchedActivitySetRequest

Field	Type	Details
`code`	string
`default_waste_pct`	decimal
`description`	string
`last_reviewed_at`	date
`name`	string
`notes_internal`	string
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived

PatchedBudgetGroupRequest

Field	Type	Details
`code`	string
`is_active`	boolean
`job`	uuid	Optional job-specific group; null = workspace-global.
`name`	string

PatchedCalendarExceptionRequest

Field	Type	Details
`date`	date
`is_working`	boolean	False = non-working; True = working override
`note`	string
`project`	uuid

PatchedChangeItemRequest

Field	Type	Details
`add_value`	string or number
`adjusted_estimate_work_item`	uuid
`adjusted_quote_line`	uuid
`adjusts_existing`	boolean	Does this specific item adjust existing work?
`description`	string	Specific work item description.
`is_omission`	boolean
`is_provisional_sum`	boolean	Is this adjusting a Prov Sum?
`omit_value`	string or number
`quantity`	decimal
`resource`	integer	Link to a standard library resource for exact pricing matches.
`source_type`	string	* `manual` - New priced line * `contract_line` - Original contract line * `resource` - Library resource * `legacy_cost_matrix` - Migrated legacy pricing Options: manual, contract_line, resource, legacy_cost_matrix
`unit_of_measure`	string
`unit_rate`	string or number
`work_category`	string	* `labour` - Labour * `materials` - Materials * `plant` - Plant * `subcontract` - Subcontract * `overhead_profit` - Overheads & profit * `other` - Other Options: labour, materials, plant, subcontract, overhead_profit, other

PatchedChangeRequestRequest

Field	Type	Details
`addition_pricing_type`	string	Classification for newly added work in instructed value flows. * `none` - Not specified * `quoted` - This adds a new, quoted item * `unquoted` - This adds a new, unquoted item Options: none, quoted, unquoted
`adjusts_existing_work`	boolean
`anticipated_form_reference`	string
`attached_file_ids`	uuid[]
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`authority_certainty`	string	Bucket 1: definitive vs provisional instruction certainty. * `definitive` - Definitive * `provisional` - Provisional Options: definitive, provisional,
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`base_quote`	uuid	The original approved Quote/Agreement this change applies to.
`base_quote_number`	JSON	Computed JSON value; may be null when access is restricted.
`base_quote_title`	JSON	Computed JSON value; may be null when access is restricted.
`builder_proceeds`	boolean	Does the builder agree to proceed?
`builder_reject_reason`	string	Required if builder_proceeds is False.
`builder_signed_at`	date-time
`ca_financial_note`	string	Optional CA note attached when submitting for client financial approval.
`classification_other`	boolean	Other classification selected: requires classification_other_text.
`classification_other_text`	string	Mandatory free text when classification_other is set.
`client_countersigned_at`	date-time
`client_document_reference`	string	Client / CA reference number from the source document, if any.
`communication_method`	string	How the instruction was received (e.g., email, in_person).
`current_sla`	JSON	Computed JSON value; may be null when access is restricted.
`cvr_next_step`	string	CVR: request formal instruction or formal quote. * `request_instruction` - Request client to officially instruct * `request_quote` - Request client to ask for a formal quote Options: request_instruction, request_quote,
`delay_causes`	JSON	Notice of Delay cause checkbox keys.
`delay_narrative`	string	Notice of Delay free-text narrative.
`document_layout_mode`	JSON	Computed JSON value; may be null when access is restricted.
`draft_init`	boolean
`draft_prefill_instruction_text`	string
`effective_workflow_tier`	JSON	Computed JSON value; may be null when access is restricted.
`eot_to_be_determined`	boolean	True if EOT is acknowledged but will be calculated later.
`extension_of_time_days`	integer	Requested adjustment to the completion date (EOT).
`extension_of_time_hours`	decimal	Requested hours of time impact, in addition to extension_of_time_days.
`given_by`	string	Name of the person who gave the instruction.
`given_by_email`	email	Email for the given_by contact when selected from the project directory.
`given_by_member_id`	uuid
`has_public_consent`	JSON	Computed JSON value; may be null when access is restricted.
`impacts_design`	boolean	Does this change the design?
`impacts_quality`	boolean	Does this affect quality standards?
`impacts_quantity`	boolean	Does this change quantities?
`includes_loss_and_expense`	boolean	Does this claim include additional costs for delay/disruption?
`includes_preparation_costs`	boolean	Does this claim include the cost of preparing the quotation?
`initiation_route`	string	Stable create-route id used to tailor the editable detail view.
`instruction_text`	string	The core instruction given.
`is_addition`	boolean
`is_omission`	boolean
`is_proxy`	boolean	Whether this record was logged on behalf of another party.
`is_substitution`	boolean
`lead_time_dependent`	boolean	Material or specialist lead-time dependency on a simple CVI/CVR/proposal.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_impact`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`payment_timing`	string	Consumer/unadministered: how the variation will be paid. * `invoice_now` - Invoice immediately as a standalone item * `next_stage` - Add to the next stage payment * `final_invoice` - Add to the final project invoice Options: invoice_now, next_stage, final_invoice,
`pci_type`	string	Budget PCI purpose when estimating is on. Empty = paper-only change. * `CLIENT_VARIATION` - Client variation * `INTERNAL_SPEC` - Internal specification change * `PROV_SUM_EXPEND` - Provisional sum expend * `RISK_RELEASE` - Risk / contingency release Options: CLIENT_VARIATION, INTERNAL_SPEC, PROV_SUM_EXPEND, RISK_RELEASE,
`price_agreed_before_start`	boolean	True if price is agreed before work commences, False if proceeding immediately.
`pricing_strategy`	string	Explicit pricing pathway; synced with price_agreed_before_start. * `price_upfront` - Price upfront before work starts * `valuation_method` - Agree a method of valuation * `price_later` - Proceed immediately, price later Options: price_upfront, valuation_method, price_later,
`quote_validity_days`	integer	Validity period (days) when builder submits a quotation.
`quoted_source_quote`	uuid	If this change adds a new quoted item, link the source quote.
`reason`	string	Why is this change happening?
`reason_codes`	JSON	Simple CVI/CVR/proposal reason tick keys.
`reason_other_text`	string
`received_by`	string
`received_by_email`	email
`received_by_member_id`	uuid
`remove_attached_file_ids`	uuid[]
`request_date`	date
`request_time`	time	Time the verbal instruction/request was given.
`request_type`	string	* `request` - Variation Request * `instruction` - Variation Instruction * `early_warning` - Early Warning * `notice_of_delay` - Notice of Delay * `quote_request` - Quote Request * `confirmation` - CVI * `cvi` - Confirmation of Verbal Instruction (CVI) * `cvr` - Confirmation of Verbal Request (CVR) * `change_order` - Change Order * `potential_change_order` - Potential Change Order * `field_directive` - Field Directive Options: request, instruction, early_warning, notice_of_delay, quote_request, confirmation, cvi, cvr, change_order, potential_change_order, field_directive
`response_deadline`	date-time	The deadline for the client/builder to respond before default acceptance/rejection.
`restocking_fees`	decimal	Consumer contracts: restocking / non-refundable deposits.
`resulting_variation_invoice_count`	JSON	Computed JSON value; may be null when access is restricted.
`revised_completion_date`	date	Requested revised completion / working-period end date.
`risk_contingency_value`	decimal	Early warning approximate risk / contingency value.
`signature_loop_stage`	string	* `none` - Not required * `awaiting_builder` - Awaiting builder signature * `awaiting_client` - Awaiting client countersignature * `complete` - Fully signed Options: none, awaiting_builder, awaiting_client, complete,
`simple_issuer_contact`	string
`simple_issuer_contact_email`	email
`simple_issuer_contact_member_id`	uuid
`simple_paper_kind`	JSON	Computed JSON value; may be null when access is restricted.
`simple_price_certainty`	string	Simple workflow: fixed, estimated/indicative, quote requested, no price change, or not assessed. * `fixed` - Fixed price * `estimated` - Estimated / Indicative * `quote_requested` - Quote Requested * `no_price_change` - No price change * `not_assessed` - Not assessed Options: fixed, estimated, quote_requested, no_price_change, not_assessed,
`simple_recipient`	string
`simple_recipient_email`	email
`simple_recipient_member_id`	uuid
`simple_time_certainty`	string	Simple workflow: estimated, definitive / fixed, post-completion, or no time impact. * `estimated` - Estimated / Indicative * `definitive` - Definitive / Fixed * `post_completion` - Assessed / agreed post-completion * `not_assessed` - No time impact Options: estimated, definitive, post_completion, not_assessed,
`sla_deadlines`	JSON	Computed JSON value; may be null when access is restricted.
`source_document_type`	string	Client-issued instruction: type of source document received. * `architect_instruction` - Architect's Instruction (AI/CAI) * `signed_change_agreement` - Signed Change / Variation Agreement * `quote_request` - Quote Request * `site_direction_minutes` - Site Direction / Meeting Minutes * `email_confirmation` - Email Confirmation Options: architect_instruction, signed_change_agreement, quote_request, site_direction_minutes, email_confirmation,
`source_site_log`	uuid
`source_site_log_cost_impact_type`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_date`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_delay_days`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_estimated_cost_amount`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_estimated_cost_currency`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_recommendation`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_responsible_party`	JSON	Computed JSON value; may be null when access is restricted.
`source_site_log_risk_level`	JSON	Computed JSON value; may be null when access is restricted.
`source_timeline_entry`	uuid
`source_timeline_entry_preview`	JSON	Computed JSON value; may be null when access is restricted.
`status`	string	* `registered` - Draft / Registered * `issued` - Issued / Submitted * `issued_validated` - Instruction Validated * `issued_not_valid` - Instruction Invalid * `rejected_by_builder` - Rejected by Builder * `being_priced` - Pricing in Progress * `pricing_submitted` - Pricing Submitted * `price_agreed` - Price Agreed * `price_rejected` - Price Rejected * `terms_agreed` - Variation Approved * `terms_rejected` - Variation Rejected * `being_repriced` - Repricing in Progress * `priced_by_client` - To be Priced by Client * `terms_renegotiated` - Terms being Renegotiated * `cancelled` - Cancelled * `claimed` - Claimed * `paid` - Paid * `pending_client_financial` - Pending Client Financial Approval * `awaiting_external_ca_auth` - Awaiting External CA Authorization * `pending_ca_triage` - Pending CA Review Options: registered, issued, issued_validated, issued_not_valid, rejected_by_builder, being_priced, pricing_submitted, price_agreed, price_rejected, terms_agreed, terms_rejected, being_repriced, priced_by_client, terms_renegotiated, cancelled, claimed, paid, pending_client_financial, awaiting_external_ca_auth, pending_ca_triage
`status_label`	JSON	Computed JSON value; may be null when access is restricted.
`title`	string	Short summary of the instruction.
`valuation_basis`	string	Legacy single valuation method. Prefer valuation_methods.
`valuation_markup_percent`	decimal	Markup percent when valuation_basis is actual cost + markup.
`valuation_method_terms`	string	Agreed valuation method terms (dayworks, schedule of rates, etc.).
`valuation_methods`	JSON	Ordered proposed valuation methods (priority 1, 2, 3).
`variation_group`	string	Logical grouping for filters (warning, instruction, request, confirmation, advisory).
`workflow_tier`	string	UI workflow tier for this record; upgrade from simple to comprehensive. * `simple` - Simple * `comprehensive` - Comprehensive Options: simple, comprehensive

PatchedContactRequest

Field	Type	Details
`avatar_color`	string
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`email`	email
`is_primary_contact`	boolean
`name`	string
`notes`	string
`phone_number`	string
`role`	string

PatchedCostCodeRequest

Field	Type	Details
`code`	string
`cost_types`	CostCodeTypeLinkRequest[]
`default_rate`	decimal
`default_unit`	string
`external_code`	string
`is_active`	boolean
`name`	string

PatchedCostTypeRequest

Field	Type	Details
`is_active`	boolean
`name`	string
`sort_order`	integer

PatchedCustomerRequest

Field	Type	Details
`avatar_color`	string
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`billing_address`	AddressRequest
`company`	string	Optional company name for the customer.
`contact_email`	email	Primary contact email for this customer entity.
`contacts_payload`	ContactRequest[]
`customer_type`	string	* `residential` - Residential * `commercial` - Commercial Options: residential, commercial
`name`	string	Name of the customer (individual or company).
`notes`	string
`payment_terms_days`	integer	Default number of days until an invoice is due for this customer.
`phone_number`	string
`relationship_stage`	string	Prospect until a job is won; active once they have live or completed work. * `prospect` - Prospect * `active` - Active client * `past` - Past client Options: prospect, active, past
`tax_id`	string	Tax ID or VAT Number.

PatchedEntryRequest

Field	Type	Details
`audience_type`	string	* `builder_internal` - Builder staff * `builder_team` - Builder side * `builder_client` - Builder and client teams * `client_team` - Client team * `everyone` - Everyone on this job * `selected_people` - Selected people Options: builder_internal, builder_team, builder_client, client_team, everyone, selected_people
`can_manage_entry`	JSON	Computed JSON value; may be null when access is restricted.
`can_retract_entry`	JSON	Computed JSON value; may be null when access is restricted.
`can_view_original`	JSON	Computed JSON value; may be null when access is restricted.
`change_request`	JSON	Computed JSON value; may be null when access is restricted.
`content_original`	JSON	Computed JSON value; may be null when access is restricted.
`content_type`	integer
`content_visible`	JSON	Computed JSON value; may be null when access is restricted.
`converted_change_request`	JSON	Computed JSON value; may be null when access is restricted.
`converted_task`	JSON	Computed JSON value; may be null when access is restricted.
`email_last_attempt_at`	date-time
`email_last_error`	string
`email_send_status`	string
`enquiry`	uuid	Pipeline enquiry this activity originated from.
`entry_type`	string	* `message` - User Message * `file_upload` - File Upload * `site_diary` - Site Diary * `actionable_item` - Actionable Item * `system_event` - System Event Options: message, file_upload, site_diary, actionable_item, system_event
`event_key`	string	Stable machine key for system-generated activity events.
`event_meta`	JSON	Structured, redacted metadata for audit/export details.
`external_sender_email`	email	Email of an external recipient when author is null.
`external_sender_via`	string	How the external sender responded (shared link or email reply). * `` - - * `portal` - Portal * `email` - Email Options: , portal, email
`is_private`	boolean	If True, this entry is only visible to workspace members.
`made_public_at`	date-time	Timestamp for when a private note was made public.
`notified_users`	JSON	Computed JSON value; may be null when access is restricted.
`notify_mode`	string	Who should be notified about this entry. * `everyone` - Everyone * `none` - No one * `custom` - Custom Options: everyone, none, custom
`object_id`	uuid
`parent_entry`	uuid
`project`	uuid
`quote`	JSON	Computed JSON value; may be null when access is restricted.
`replies`	JSON	Computed JSON value; may be null when access is restricted.
`retracted_at`	date-time
`selected_user_ids`	JSON
`site_diary`	JSON	Computed JSON value; may be null when access is restricted.
`status`	string	* `active` - Active * `retracted` - Retracted Options: active, retracted
`workspace`	uuid	Direct scope for pre-project enquiry activity and workspace search.

PatchedEstimateActivityRequest

Field	Type	Details
`activity_id`	integer
`description`	string
`duration_days`	integer
`group`	integer
`group_name`	string
`labour_total`	JSON	Computed JSON value; may be null when access is restricted.
`location_mode`	boolean
`material_total`	JSON	Computed JSON value; may be null when access is restricted.
`name`	string
`other_total`	JSON	Computed JSON value; may be null when access is restricted.
`parent`	uuid
`plant_total`	JSON	Computed JSON value; may be null when access is restricted.
`set_id`	integer
`sort`	integer
`subcontract_total`	JSON	Computed JSON value; may be null when access is restricted.

PatchedEstimateLocationRequest

Field	Type	Details
`code`	string
`description`	string
`house_type`	string
`house_type_definition`	uuid
`house_type_overrides`	JSON	Computed JSON value; may be null when access is restricted.
`name`	string
`parent`	uuid
`plot_gdv`	decimal
`plot_gifa_sq_ft`	decimal
`sort_order`	integer
`tenure`	string

PatchedEstimateRequest

Field	Type	Details
`adjudication_mode`	string	* `CONTRACTING` - Contracting * `HOUSEBUILDER` - Housebuilder Options: CONTRACTING, HOUSEBUILDER
`as_of_date`	date
`contingency_amount`	decimal
`is_active`	boolean
`is_primary`	boolean
`markup_labour_percent`	decimal
`markup_material_percent`	decimal
`markup_other_percent`	decimal
`markup_plant_percent`	decimal
`markup_subcontract_percent`	decimal
`notes_internal`	string
`ohp_defaults`	JSON
`partner_id`	uuid
`profit_spread_mode`	string	* `SUMMARY_LUMP_SUM` - Summary lump sum * `SPREAD_IN_RATES` - Spread in rates Options: SUMMARY_LUMP_SUM, SPREAD_IN_RATES
`programme_weeks`	integer
`target_gdv`	decimal
`total_gifa_sq_ft`	decimal
`total_gifa_sq_m`	decimal
`version_name`	string

PatchedEstimateWorkItemRequest

Field	Type	Details
`activity`	uuid
`boq_path`	JSON	Computed JSON value; may be null when access is restricted.
`description`	string
`est_line`	uuid
`group`	integer
`is_spot_item`	boolean
`is_unit_price`	boolean
`line_total`	decimal
`name`	string
`ohp_pct_override`	decimal
`payment_stage`	JSON	Computed JSON value; may be null when access is restricted.
`payment_stage_id`	uuid
`quantity`	decimal
`sell_markup_pct`	decimal
`sell_total`	decimal
`sort`	integer
`source_lib_line`	uuid
`source_library_id`	string
`source_library_name`	string
`source_library_type`	string
`source_work_item_id`	integer
`unit_of_measure`	string
`unit_rate`	decimal
`visibility`	string	* `rollup` - Roll-up * `expanded` - Expanded Options: rollup, expanded

PatchedEventRequest

Field	Type	Details
`all_day`	boolean
`attendees`	AttendeeRequest[]
`conference_url`	uri
`description`	string
`end`	date-time
`external_uid`	string
`is_private`	boolean
`is_private_read`	JSON	Computed JSON value; may be null when access is restricted.
`organizer_email`	email
`recurrence_rrule`	string
`reminder_minutes`	integer
`start`	date-time
`timezone`	string
`title`	string
`url`	uri
`visibility`	string	* `project` - Project * `private` - Private * `workspace` - Workspace Options: project, private, workspace

PatchedExpenseRequest

Field	Type	Details
`approval`	JSON	Computed JSON value; may be null when access is restricted.
`attached_receipts`	uuid[]
`attached_receipts_detail`	JSON	Computed JSON value; may be null when access is restricted.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`balance_due`	string or number or object
`cis_deduction_rate`	decimal
`cis_materials_amount`	decimal
`claimant`	uuid	The person who paid out of pocket and needs to be reimbursed.
`claimant_name`	string
`description`	string
`document_type`	string	* `bill` - Bill * `credit_note` - Credit note Options: bill, credit_note
`due_date`	date
`effective_retention_held`	JSON	Computed JSON value; may be null when access is restricted.
`exchange_rate`	decimal	Rate used to convert Original -> Workspace.
`gross_amount`	string or number or object
`is_converted`	JSON	Computed JSON value; may be null when access is restricted.
`is_reimbursable`	boolean	True if paid by employee (needs reimbursement). False if paid by company.
`issue_date`	date
`line_items`	ExpenseLineItemRequest[]
`match_summary`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_amount`	string or number or object
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string	Internal notes or comments about this expense.
`original_currency`	string	ISO code of the original receipt currency.
`parent_expense_id`	uuid
`parsing_notes`	string	Context or warnings from the AI extraction.
`partner_id`	uuid
`purchase_order_id`	uuid
`record_type`	string	* `supplier_bill` - Supplier bill * `expense` - Everyday expense / receipt * `reimbursement` - Employee reimbursement Options: supplier_bill, expense, reimbursement
`reference`	string
`requested_approver`	uuid	The specific manager requested to approve this spend.
`retention_held`	string or number or object
`retention_percentage`	decimal
`retention_released`	string or number or object
`status`	string	* `draft` - Draft * `submitted` - Submitted * `approved` - Approved * `rejected` - Rejected * `partially_paid` - Partially Paid * `paid` - Paid * `overdue` - Overdue Options: draft, submitted, approved, rejected, partially_paid, paid, overdue
`supplier_invoice_number`	string
`tax_amount`	string or number or object
`tax_exempt`	boolean
`tax_treatment`	string	* `standard` - Standard * `reverse_charge` - Domestic reverse charge * `zero` - Zero rated * `reduced` - Reduced rated * `exempt` - Exempt * `use_tax` - Use tax Options: standard, reverse_charge, zero, reduced, exempt, use_tax
`total_paid`	string or number or object
`use_tax_amount`	decimal
`vendor_name`	string	Vendor/supplier name.

PatchedFileRequest

Field	Type	Details
`audience_type`	string	* `builder_internal` - Builder staff * `builder_team` - Builder side * `builder_client` - Builder and client teams * `client_team` - Client team * `everyone` - Everyone on this job * `selected_people` - Selected people Options: builder_internal, builder_team, builder_client, client_team, everyone, selected_people
`description`	string	A user-or-AI-generated description of the file's content.
`file`	binary
`folder_id`	uuid
`is_private`	boolean	If True, this document is only visible to workspace members.
`selected_user_ids`	JSON
`source`	string
`status`	string	* `uploading` - Uploading * `processing` - Processing * `pending_review` - Pending Review * `approved` - Approved * `failed` - Failed Options: uploading, processing, pending_review, approved, failed
`superseded_by_id`	JSON	Computed JSON value; may be null when access is restricted.
`superseded_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`supersedes_id`	uuid
`tags`	uuid[]
`user_defined_name`	string

PatchedInvoiceDetailRequest

Field	Type	Details
`amount_paid`	JSON	Computed JSON value; may be null when access is restricted.
`apply_cis`	boolean
`apply_drc`	boolean	If True, applies Domestic Reverse Charge (VAT = 0).
`apply_retention`	boolean
`apply_tax`	boolean	Whether VAT/tax is applied and shown on this invoice.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`balance_due`	JSON	Computed JSON value; may be null when access is restricted.
`bank_details`	string
`bill_to_address_id`	uuid
`cis_deduction_amount`	JSON	Computed JSON value; may be null when access is restricted.
`cis_rate`	decimal
`created_by`	uuid
`document_type`	string	* `invoice` - Invoice * `credit_note` - Credit Note * `retention_release` - Retention Release Options: invoice, credit_note, retention_release
`due_date`	date
`effective_for_address`	JSON	Computed JSON value; may be null when access is restricted.
`effective_for_name`	JSON	Computed JSON value; may be null when access is restricted.
`effective_from_address`	JSON	Computed JSON value; may be null when access is restricted.
`effective_from_name`	JSON	Computed JSON value; may be null when access is restricted.
`effective_from_tax_id`	JSON	Computed JSON value; may be null when access is restricted.
`effective_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`effective_terms`	JSON	Computed JSON value; may be null when access is restricted.
`email_message`	string	Optional message to include in the email when sending/issuing. Not shown on the invoice PDF.
`header_config`	JSON
`internal_notes`	string
`is_application`	JSON	Computed JSON value; may be null when access is restricted.
`issue_date`	date
`line_items`	InvoiceLineItemRequest[]
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_payable`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string
`parent_invoice`	uuid
`previously_certified`	JSON	Computed JSON value; may be null when access is restricted.
`project`	uuid
`reference`	string
`retention_amount`	JSON	Computed JSON value; may be null when access is restricted.
`retention_rate`	decimal
`source_attributions`	JSON	Computed JSON value; may be null when access is restricted.
`source_quote`	uuid
`subtotal`	JSON	Computed JSON value; may be null when access is restricted.
`tax_amount`	JSON	Computed JSON value; may be null when access is restricted.
`tax_rate`	decimal	Override tax rate. If null, uses workspace default.
`terms_override`	string	Optional invoice-specific terms; if blank uses workspace default_terms_and_conditions.
`title`	string
`total`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_country_iso2`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_tax_label`	JSON	Computed JSON value; may be null when access is restricted.

PatchedLibWorkItemLineRequest

Field	Type	Details
`boq_path`	JSON	Computed JSON value; may be null when access is restricted.
`classification_system`	string	* `NRM` - NRM * `BCIS` - BCIS * `CUSTOM` - Custom Options: NRM, BCIS, CUSTOM
`line_desc`	string
`line_ref`	string
`line_type`	uuid
`parent`	uuid
`parent_level`	JSON	Computed JSON value; may be null when access is restricted.
`work_items`	JSON	Computed JSON value; may be null when access is restricted.

PatchedLocationRequest

Field	Type	Details
`code`	string
`description`	string
`is_active`	boolean
`name`	string
`parent`	integer
`sort_order`	integer

PatchedPartnerRequest

Field	Type	Details
`address`	AddressRequest
`avatar_color`	string
`avatar_url`	JSON	Computed JSON value; may be null when access is restricted.
`backup_withholding_required`	boolean	US: payer should review backup withholding before payment.
`category`	string	* `professional` - Professional Services * `trade` - Trades * `supplier` - Suppliers Options: professional, trade, supplier
`contacts_payload`	PartnerContactRequest[]
`email`	email
`is_1099_eligible`	boolean	US: vendor may require 1099 reporting.
`is_cis_registered`	boolean	UK: subcontractor is CIS-registered and needs verification on file.
`name`	string	The partner's name or company name.
`notes`	string
`phone_number`	string
`specialty_names`	string[]
`tax_id`	string	VAT number, EIN, UTR, or other tax identifier.
`us_tax_classification`	string	US W-9 tax classification. Full tax IDs are not required here. * `` - Not recorded * `individual` - Individual / sole proprietor * `c_corp` - C corporation * `s_corp` - S corporation * `partnership` - Partnership * `trust_estate` - Trust / estate * `llc` - LLC * `other` - Other Options: , individual, c_corp, s_corp, partnership, trust_estate, llc, other
`us_tin_last_four`	string	US W-9 TIN/EIN last four only.
`us_tin_type`	string	US W-9 identifier type, stored without the full identifier. * `` - Not recorded * `ein` - EIN * `ssn` - SSN * `itin` - ITIN Options: , ein, ssn, itin
`w9_received_at`	date	Date a W-9 was received or confirmed.

PatchedPaymentStageRequest

Field	Type	Details
`name`	string
`order`	integer
`target_percentage`	decimal

PatchedProjectRequest

Field	Type	Details
`allow_store_collection`	boolean	Override workspace store-collection toggle when set.
`archived_at`	date-time	Timestamp when the project was archived.
`budget`	decimal	Current agreed revenue budget visible to the client.
`commercial_summary`	JSON	Computed JSON value; may be null when access is restricted.
`cost_budget`	decimal	The internal cost budget, visible only to the builder's team.
`custom_status_id`	uuid
`customer_id`	uuid
`description`	string	Detailed description of the project.
`effective_estimating_enabled`	JSON	Computed JSON value; may be null when access is restricted.
`effective_variation_workflow`	JSON	Computed JSON value; may be null when access is restricted.
`enable_delivery_sign_off`	boolean	Override workspace delivery sign-off when set.
`enable_location_tagging`	boolean	Allow plot/location codes on purchase order lines.
`end_date_actual`	date
`end_date_planned`	date
`estimated_value`	decimal	Estimated value before a formal quote is issued.
`estimating_enabled`	boolean	Override workspace estimating_enabled when set.
`follow_up_date`	date
`initial_revenue_budget`	decimal	Snapshot of revenue at award (initial position), separate from current agreed budget.
`is_archived`	boolean
`is_location_unoccupied`	boolean	Will the work location be unoccupied during the project?
`local_restrictions`	string	Note any permit parking, delivery constraints, or noise restrictions.
`lost_reason`	string	Reason recorded when a job is marked lost or a quote is rejected.
`mandated_approver`	uuid	When set, all POs for this job require this approver.
`matching_mode`	string	two_way \| three_way; blank inherits workspace default.
`name`	string	Name of the project.
`next_visit_on`	JSON	Computed JSON value; may be null when access is restricted.
`notice_to_start_days`	integer	The required notice period in days before work can begin.
`open_task_count`	JSON	Computed JSON value; may be null when access is restricted.
`permit_authority`	uuid	Local building control, city planning, or permit office.
`permit_authority_id`	uuid
`pipeline_source`	string	How this job was sourced (sales pipeline).
`plot_count`	JSON	Computed JSON value; may be null when access is restricted.
`po_import_allow_boq`	boolean	Override workspace PO import-from-BOQ when set.
`po_import_allow_estimate`	boolean	Override workspace PO import-from-estimate when set.
`po_import_allow_imported`	boolean	Override workspace PO import-from-imported-resources when set.
`po_import_allow_library`	boolean	Override workspace PO import-from-library when set.
`po_import_allow_quote`	boolean	Override workspace PO import-from-quote when set.
`project_number`	string	Optional internal project number or code.
`project_type`	string	* `new_build` - New Build * `conversion` - Significant Conversion * `renovation` - Renovation * `extension` - Extension * `maintenance` - Maintenance Options: new_build, conversion, renovation, extension, maintenance,
`site_address`	AddressRequest
`site_working_hours`	string	e.g. Mon-Fri 8am-6pm, Sat 8am-1pm
`start_date_actual`	date
`start_date_planned`	date
`status_set_id`	uuid
`timesheet_identity_check_excluded`	boolean	Clock in and out on this job without a biometric or photo check.
`variation_workflow`	string	Override workspace default_variation_workflow when set. * `simple` - Simple * `comprehensive` - Comprehensive Options: simple, comprehensive, ,
`warranty_provider`	uuid
`warranty_provider_id`	uuid
`zoning_or_planning_ref`	string	Approved planning permission or zoning reference.

PatchedPropertyRequest

Field	Type	Details
`customer_id`	uuid
`name`	string
`notes`	string
`property_address`	AddressRequest

PatchedPurchaseOrderRequest

Field	Type	Details
`approval`	JSON	Computed JSON value; may be null when access is restricted.
`approved_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`cis_applies`	boolean
`cis_deduction_rate`	decimal
`created_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`delivery_address`	string	Required for material orders using site delivery (the default fulfilment method).
`delivery_instructions`	string
`description`	string
`fulfillment_method`	string	* `site_delivery` - Site delivery * `store_pickup` - Store pickup Options: site_delivery, store_pickup
`gross_amount`	string or number or object
`hire_calendar_override`	JSON
`last_return_note`	JSON	Computed JSON value; may be null when access is restricted.
`lien_waiver_required`	boolean
`line_items`	PurchaseOrderLineItemRequest[]
`needs_approval_for_current_user`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_amount`	string or number or object
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string
`off_hire_date`	date
`off_hire_reference`	string
`on_hire_date`	date
`order_type`	string	* `material` - Material * `plant` - Plant * `subcontract` - Subcontract * `professional` - Professional services * `store_collection` - Store collection Options: material, plant, subcontract, professional, store_collection
`parent_order_id`	uuid
`partner_id`	uuid
`payment_terms`	string
`pickup_paid_out_of_pocket`	boolean	Whether the store collection was paid personally or by company card.
`portal_actions`	JSON	Computed JSON value; may be null when access is restricted.
`requested_approver`	uuid
`required_by_date`	date	Required for material orders using site delivery (the default fulfilment method).
`returns`	JSON	Computed JSON value; may be null when access is restricted.
`source`	string	* `office` - Office * `material_request` - Material request * `pickup` - Pick-up order Options: office, material_request, pickup
`supplier_quote_ref`	string
`tax_amount`	string or number or object
`tax_exempt`	boolean
`tax_treatment`	string	* `standard` - Standard * `reverse_charge` - Domestic reverse charge * `zero` - Zero rated * `reduced` - Reduced rated * `exempt` - Exempt * `use_tax` - Use tax Options: standard, reverse_charge, zero, reduced, exempt, use_tax
`ticket_file_ids`	uuid[]
`ticket_files`	JSON	Computed JSON value; may be null when access is restricted.
`vendor_name`	string

PatchedQuoteLineItemRequest

Field	Type	Details
`cost_category`	string	* `labour` - Labour * `materials` - Materials * `plant` - Plant * `subcontract` - Subcontract * `overhead` - Overhead * `other` - Other * `professional` - Professional Options: labour, materials, plant, subcontract, overhead, other, professional
`cost_code`	integer
`cost_code_category`	JSON	Computed JSON value; may be null when access is restricted.
`description`	string
`effective_tax_rate`	JSON	Computed JSON value; may be null when access is restricted.
`is_provisional`	boolean
`order`	integer
`payment_stage_id`	uuid
`plot`	uuid	Optional plot this quoted work is tagged to.
`quantity`	decimal
`resource`	integer	If set, description/UoM defaults from Resource; price from current rate.
`resource_type`	JSON	Computed JSON value; may be null when access is restricted.
`resources`	JSON	Computed JSON value; may be null when access is restricted.
`section`	string
`show_resource_breakdown`	boolean
`tax_rate`	decimal	Line tax rate (e.g. 20.00 for 20%). Null inherits the quote/workspace default; 0 means this line is tax-exempt.
`unit_of_measure`	string
`unit_price`	decimal

PatchedQuoteRequest

Field	Type	Details
`assumption_items`	JSON	Structured assumption/exclusion items with optional client ack flags.
`assumptions`	string	Assumptions made for this quote.
`attached_files`	uuid[]
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`base_quote`	JSON	Computed JSON value; may be null when access is restricted.
`brief_snapshot_id`	uuid
`document_type`	string	* `quote` - Quotation * `estimate` - Estimate * `variation` - Variation Options: quote, estimate, variation
`estimate_id`	JSON	Computed JSON value; may be null when access is restricted.
`is_main_quote`	boolean	Exactly one quote per project may be marked main; baseline for final account / linked flows.
`last_updated_at`	JSON	Computed JSON value; may be null when access is restricted.
`latest_variation_id`	JSON	Computed JSON value; may be null when access is restricted.
`linked_invoice_count`	JSON	Computed JSON value; may be null when access is restricted.
`linked_quote`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string	Private notes for the builder.
`pricing_mode`	string	* `quick` - Quick quote * `estimate` - Linked estimate * `external` - External contract Options: quick, estimate, external
`primary_estimate`	uuid
`primary_estimate_quote_id`	JSON	Computed JSON value; may be null when access is restricted.
`project_address`	JSON	Computed JSON value; may be null when access is restricted.
`revised_total`	JSON	Computed JSON value; may be null when access is restricted.
`source_change_request_id`	JSON	Computed JSON value; may be null when access is restricted.
`source_change_request_register_number`	JSON	Computed JSON value; may be null when access is restricted.
`source_change_request_title`	JSON	Computed JSON value; may be null when access is restricted.
`subtotal`	JSON	Computed JSON value; may be null when access is restricted.
`tax_amount`	JSON	Computed JSON value; may be null when access is restricted.
`tax_breakdown`	JSON	Computed JSON value; may be null when access is restricted.
`tax_name`	string	The name of the tax applied (VAT, Sales Tax, ...).
`tax_rate`	decimal	The tax rate (e.g., 20.00 for 20%). Null means 'not explicitly set' and falls back to the workspace default; 0 means explicitly tax-exempt.
`template_id`	uuid
`terms_and_conditions`	string	Client-facing terms and conditions.
`title`	string	'Quotation for Kitchen Renovation'
`total`	JSON	Computed JSON value; may be null when access is restricted.
`variation_count`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_business_address`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_currency`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_daywork_defaults`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_market_code`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_tax_label`	JSON	Computed JSON value; may be null when access is restricted.

PatchedQuoteSectionRequest

Field	Type	Details
`content`	JSON	Block-specific settings and content payload.
`custom_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`footer_text`	string	Optional footer text shown below this section.
`header_text`	string	Optional header text shown above this section.
`order`	integer	Display order within the quote builder.
`title`	string	Optional internal title/label for this section.
`type`	string	Kind of section/block, e.g. 'cover', 'items_table', 'dayworks'. * `cover` - Cover page * `header` - Page header * `intro` - Introduction * `items_table` - Items table * `summary` - Summary * `totals` - Totals & breakdown * `assumptions` - Assumptions * `terms` - Terms & conditions * `signature` - Signature block * `free_text` - Free text block * `dayworks` - Dayworks * `attendances` - Attendances * `variation_details` - Variation Details * `payment_schedule` - Payment Schedule Options: cover, header, intro, items_table, summary, totals, assumptions, terms, signature, free_text, dayworks, attendances, variation_details, payment_schedule

PatchedRFIRequest

Field	Type	Details
`attachment_count`	JSON	Computed JSON value; may be null when access is restricted.
`attachment_ids`	uuid[]
`completion_policy`	string	* `none` - No evidence required * `note` - Note required * `file` - Photo or file required * `note_or_file` - Note or photo/file required * `note_and_file` - Note and photo/file required Options: none, note, file, note_or_file, note_and_file, ,
`description`	string
`discipline`	string
`doer`	JSON	Computed JSON value; may be null when access is restricted.
`doer_email`	email
`doer_partner_contact_id`	uuid
`doer_partner_id`	uuid
`doer_user_id`	uuid
`drawing_refs`	string	Drawing or spec references.
`due_date`	date
`estimate_location_id`	uuid
`managed_by_id`	uuid
`resolved_completion_policy`	JSON	Computed JSON value; may be null when access is restricted.
`show_on_calendar`	boolean	If True, this RFI appears on calendars when it has a due date.
`show_on_gantt`	boolean	If True, this RFI appears on the project Gantt chart when it has a due date.
`source_timeline_entry_id`	uuid	Optional source timeline entry when this RFI was created from a message.
`status`	string	* `draft` - Draft * `issued` - Issued * `responded` - Responded * `closed` - Closed Options: draft, issued, responded, closed
`subject`	string

PatchedRequisitionItemRequest

Field	Type	Details
`batch_summary`	JSON	Computed JSON value; may be null when access is restricted.
`boq_item`	uuid
`cost_code`	integer
`delivery_instructions`	string
`description`	string
`estimate_location`	uuid	Optional plot this line is tagged to.
`estimated_unit_rate`	decimal
`is_pending_coding`	boolean
`lead_in_warning`	JSON	Computed JSON value; may be null when access is restricted.
`location`	uuid
`note`	string
`order_type`	string	* `material` - Material * `plant` - Plant * `subcontract` - Subcontract * `professional` - Professional services Options: material, plant, subcontract, professional
`priority`	string	* `normal` - Normal * `high` - High Options: normal, high
`progress`	JSON	Computed JSON value; may be null when access is restricted.
`quantity_needed`	decimal
`requested_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`required_on_site_date`	date
`resource`	integer
`save_to_personal_library`	boolean
`source`	string	* `workspace_library` - Workspace library * `personal_library` - Personal library * `job_boq` - Job BOQ * `freehand` - Freehand Options: workspace_library, personal_library, job_boq, freehand
`source_estimate_resource`	uuid
`source_estimate_work_item`	uuid
`suggested_partner`	uuid
`unit`	uuid
`unit_of_measure`	string

PatchedResourceGroupRequest

Field	Type	Details
`name`	string

PatchedResourceNoteRequest

Field	Type	Details
`author_name`	JSON	Computed JSON value; may be null when access is restricted.
`body`	string
`resource`	integer

PatchedResourcePriceRequest

Field	Type	Details
`is_default`	boolean	Use this supplier price by default when the resource is added to an estimate.
`notes`	string
`partner`	uuid
`price_type`	string	* `general` - General * `partner` - Partner Options: general, partner
`rate`	decimal
`resource`	integer
`supplier_code`	string
`supplier_description`	string
`updated_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`valid_from`	date
`valid_to`	date

PatchedResourceRequest

Field	Type	Details
`base_cost_input`	string
`budget_group`	uuid	Commercial reporting group; falls back to resource group when null.
`code`	string
`cost_code`	integer
`cost_code_category`	JSON	Computed JSON value; may be null when access is restricted.
`default_supplier`	JSON	Computed JSON value; may be null when access is restricted.
`default_supplier_price`	JSON	Computed JSON value; may be null when access is restricted.
`default_unit`	uuid
`default_waste_pct`	decimal
`description`	string
`external_url`	uri
`extras_cost_input`	string
`general_price`	JSON	Computed JSON value; may be null when access is restricted.
`group`	integer
`initial_supplier`	uuid
`initial_supplier_code`	string
`initial_supplier_description`	string
`initial_supplier_name`	string
`initial_supplier_price`	decimal
`initial_supplier_price_valid_from`	date
`initial_supplier_product_url`	uri
`is_active`	boolean
`job`	uuid	Set for Source B (job resource / BOQ list).
`labour_cost_input`	string
`last_reviewed_at`	date
`lead_in_days`	integer
`materials_cost_input`	string
`name`	string
`notes_internal`	string
`rate_valid_from`	JSON	Computed JSON value; may be null when access is restricted.
`resource_type`	string	* `material` - Material * `labour` - Labour * `plant` - Plant * `subcontract` - Subcontract Options: material, labour, plant, subcontract
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived
`safety_url`	uri
`source_type`	string	* `WORKSPACE_A` - Workspace library * `JOB_B` - Job resource list * `USER_C` - Personal user library Options: WORKSPACE_A, JOB_B, USER_C
`supplier_listing_count`	JSON	Computed JSON value; may be null when access is restricted.
`supplier_price_count`	JSON	Computed JSON value; may be null when access is restricted.
`unit_of_measure`	string
`waste_percent`	decimal

PatchedResourceSupplierListingRequest

Field	Type	Details
`is_default`	boolean
`partner`	uuid
`product_url`	uri
`resource`	integer
`supplier_code`	string
`supplier_description`	string

PatchedScheduleDependencyRequest

Field	Type	Details
`dependency_type`	string	* `FS` - Finish-to-Start * `SS` - Start-to-Start * `FF` - Finish-to-Finish * `SF` - Start-to-Finish Options: FS, SS, FF, SF
`gate_status`	string	RFI milestone required before the successor can proceed. * `responded` - Responded * `closed` - Closed Options: responded, closed
`is_satisfied`	JSON	Computed JSON value; may be null when access is restricted.
`lag_days`	integer
`rfi`	JSON	Computed JSON value; may be null when access is restricted.
`rfi_id`	uuid
`successor_id`	uuid

PatchedSiteLogRequest

Field	Type	Details
`attached_files`	uuid[]
`client_summary`	string	Short client-facing summary used when preparing client updates.
`cost_impact_type`	string	* `none` - No cost impact noted * `estimate` - Estimated cost impact * `tbd` - Cost impact to be determined Options: none, estimate, tbd
`delay_days`	integer	Estimated delay in days caused by the logged issue.
`deliveries_notes`	string
`equipment_on_site`	string
`estimated_cost_amount`	decimal	Optional estimated cost impact amount.
`estimated_cost_currency`	string	ISO currency code for the estimated cost amount.
`internal_notes`	string	Private notes for the project team. Not included in client reports.
`issues_notes`	string
`locks_at`	JSON	Computed JSON value; may be null when access is restricted.
`log_date`	date
`progress_notes`	string
`recommendation`	string
`responsible_party`	string	* `client` - Client * `builder` - Builder * `third_party` - Third party * `unknown` - Unknown Options: client, builder, third_party, unknown
`risk_level`	string	* `low` - Low * `medium` - Medium * `high` - High Options: low, medium, high
`safety_observations`	string
`staff_on_site`	integer
`visitors`	string
`weather`	string

PatchedSnagRequest

Field	Type	Details
`attachment_count`	JSON	Computed JSON value; may be null when access is restricted.
`attachment_ids`	uuid[]
`completion_policy`	string	* `none` - No evidence required * `note` - Note required * `file` - Photo or file required * `note_or_file` - Note or photo/file required * `note_and_file` - Note and photo/file required Options: none, note, file, note_or_file, note_and_file, ,
`daywork_applicable`	string	* `yes` - Yes * `no` - No * `tbc` - TBC Options: yes, no, tbc
`description`	string
`doer`	JSON	Computed JSON value; may be null when access is restricted.
`doer_email`	email
`doer_partner_contact_id`	uuid
`doer_partner_id`	uuid
`doer_user_id`	uuid
`due_date`	date
`estimate_location_id`	uuid
`location`	string
`managed_by_id`	uuid
`priority`	string	* `low` - Low * `medium` - Medium * `high` - High * `urgent` - Urgent Options: low, medium, high, urgent
`resolved_completion_policy`	JSON	Computed JSON value; may be null when access is restricted.
`show_on_calendar`	boolean	If True, this snag appears on calendars when it has a due date.
`show_on_gantt`	boolean	If True, this snag appears on the project Gantt chart when it has a due date.
`source_timeline_entry_id`	uuid	Optional source timeline entry id when this snag was created from a message.
`status`	string	* `open` - Open * `in_progress` - In progress * `ready_for_inspection` - Ready for inspection * `rejected` - Rejected * `closed` - Closed Options: open, in_progress, ready_for_inspection, rejected, closed
`title`	string

PatchedTaskDependencyRequest

Field	Type	Details
`dependency_type`	string	* `FS` - Finish-to-Start * `SS` - Start-to-Start * `FF` - Finish-to-Finish * `SF` - Start-to-Finish Options: FS, SS, FF, SF
`lag_days`	integer
`predecessor_id`	uuid
`successor_id`	uuid

PatchedTaskRequest

Field	Type	Details
`actual_end_date`	date
`actual_start_date`	date
`all_day`	boolean
`assignee_ids`	uuid[]
`audience_type`	string	* `builder_internal` - Builder staff * `builder_team` - Builder side * `builder_client` - Builder and client teams * `client_team` - Client team * `everyone` - Everyone on this job * `selected_people` - Selected people Options: builder_internal, builder_team, builder_client, client_team, everyone, selected_people
`checklist_items`	JSON	A list of simple checklist sub-items for this task.
`completion_policy`	string	Leave blank to use the workspace default. * `none` - No evidence required * `note` - Note required * `file` - Photo or file required * `note_or_file` - Note or photo/file required * `note_and_file` - Note and photo/file required Options: none, note, file, note_or_file, note_and_file, ,
`constraint_date`	date
`constraint_type`	string	* `as_soon_as_possible` - As soon as possible * `as_late_as_possible` - As late as possible * `must_start_on` - Must start on * `must_finish_on` - Must finish on * `start_no_earlier_than` - Start no earlier than * `finish_no_later_than` - Finish no later than Options: as_soon_as_possible, as_late_as_possible, must_start_on, must_finish_on, start_no_earlier_than, finish_no_later_than, ,
`description`	string
`due_date`	date
`duration_days`	integer
`end_date`	date
`end_time`	time
`estimate_location_id`	uuid
`file_ids`	uuid[]	Set the attached files for this task
`is_date_locked`	boolean	If True, this task's dates will not be automatically adjusted by dependencies.
`is_milestone`	boolean	If True, this task is a major project milestone.
`is_private`	boolean
`name`	string
`order`	integer	The order of the task in a list view.
`parent_id`	uuid
`predecessors`	PredecessorInputRequest[]
`progress`	integer
`resolved_completion_policy`	JSON	Computed JSON value; may be null when access is restricted.
`selected_user_ids`	JSON
`show_on_calendar`	boolean	If True, this task appears on the user and project calendars.
`show_on_gantt`	boolean	If True, this task appears on the project Gantt chart.
`source_quote_line_item`	uuid
`source_quote_number`	JSON	Computed JSON value; may be null when access is restricted.
`source_timeline_entry_id`	uuid
`start_date`	date
`start_time`	time
`status`	string	* `todo` - To Do * `in_progress` - In Progress * `done` - Done * `on_hold` - On Hold * `overdue` - Overdue * `blocked` - Blocked Options: todo, in_progress, done, on_hold, overdue, blocked
`task_type_id`	uuid
`value`	decimal

PatchedWorkItemGroupRequest

Field	Type	Details
`name`	string

PatchedWorkItemRequest

Field	Type	Details
`boq_path`	JSON	Computed JSON value; may be null when access is restricted.
`code`	string
`default_waste_pct`	decimal
`description`	string
`group`	integer
`is_active`	boolean
`is_unit_price`	boolean
`items`	WorkItemItemRequest[]
`last_reviewed_at`	date
`lib_line`	uuid
`name`	string
`notes_internal`	string
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived
`unit_of_measure`	string

PaymentAllocation

Field	Type	Details
`amount` *	decimal
`created_at` *	date-time
`id` *	uuid
`method` *	string
`payment_date` *	date
`reference` *	string

PaymentAllocationRequest

Field	Type	Details
`amount` *	decimal

PaymentStage

Field	Type	Details
`generated_by_handoff` *	boolean
`id` *	uuid
`name` *	string
`order`	integer
`quote` *	uuid
`source_estimate_activity` *	uuid
`source_handoff_key` *	string
`target_percentage`	decimal

PaymentStageRequest

Field	Type	Details
`name` *	string
`order`	integer
`target_percentage`	decimal

PredecessorInput

Field	Type	Details
`dependency_type`	string	* `FS` - Finish-to-Start * `SS` - Start-to-Start * `FF` - Finish-to-Finish * `SF` - Start-to-Finish Options: FS, SS, FF, SF
`id` *	uuid
`lag_days`	integer

PredecessorInputRequest

Field	Type	Details
`dependency_type`	string	* `FS` - Finish-to-Start * `SS` - Start-to-Start * `FF` - Finish-to-Finish * `SF` - Start-to-Finish Options: FS, SS, FF, SF
`id` *	uuid
`lag_days`	integer

PresignResponse

Field	Type	Details
`bucket` *	string
`file_id` *	uuid
`key` *	string
`presigned_post` *	object

Project

Field	Type	Details
`allow_store_collection`	boolean	Override workspace store-collection toggle when set.
`archived_at`	date-time	Timestamp when the project was archived.
`brief_snapshot_id` *	uuid
`budget`	decimal	Current agreed revenue budget visible to the client.
`commercial`	ProjectCommercial
`commercial_summary`	JSON	Computed JSON value; may be null when access is restricted.
`cost_budget`	decimal	The internal cost budget, visible only to the builder's team.
`created_at` *	date-time
`custom_status` *	CustomProjectStatus
`customer` *	CustomerSimple
`description`	string	Detailed description of the project.
`effective_estimating_enabled`	JSON	Computed JSON value; may be null when access is restricted.
`effective_variation_workflow`	JSON	Computed JSON value; may be null when access is restricted.
`enable_delivery_sign_off`	boolean	Override workspace delivery sign-off when set.
`enable_location_tagging`	boolean	Allow plot/location codes on purchase order lines.
`end_date_actual`	date
`end_date_planned`	date
`estimated_value`	decimal	Estimated value before a formal quote is issued.
`estimating_enabled`	boolean	Override workspace estimating_enabled when set.
`follow_up_date`	date
`forecast_revenue_budget`	decimal	Last persisted final-account forecast total (net, same basis as ledger/variations).
`id` *	uuid
`initial_revenue_budget`	decimal	Snapshot of revenue at award (initial position), separate from current agreed budget.
`is_archived`	boolean
`is_location_unoccupied`	boolean	Will the work location be unoccupied during the project?
`job_cost_snapshot`	JSON
`local_restrictions`	string	Note any permit parking, delivery constraints, or noise restrictions.
`lost_reason`	string	Reason recorded when a job is marked lost or a quote is rejected.
`mandated_approver`	uuid	When set, all POs for this job require this approver.
`matching_mode`	string	two_way \| three_way; blank inherits workspace default.
`name` *	string	Name of the project.
`next_visit_on`	JSON	Computed JSON value; may be null when access is restricted.
`notice_to_start_days`	integer	The required notice period in days before work can begin.
`open_task_count`	JSON	Computed JSON value; may be null when access is restricted.
`permit_authority`	uuid	Local building control, city planning, or permit office.
`permit_authority_name`	string
`pipeline_source`	string	How this job was sourced (sales pipeline).
`plot_count`	JSON	Computed JSON value; may be null when access is restricted.
`po_import_allow_boq`	boolean	Override workspace PO import-from-BOQ when set.
`po_import_allow_estimate`	boolean	Override workspace PO import-from-estimate when set.
`po_import_allow_imported`	boolean	Override workspace PO import-from-imported-resources when set.
`po_import_allow_library`	boolean	Override workspace PO import-from-library when set.
`po_import_allow_quote`	boolean	Override workspace PO import-from-quote when set.
`project_number`	string	Optional internal project number or code.
`project_type`	string	* `new_build` - New Build * `conversion` - Significant Conversion * `renovation` - Renovation * `extension` - Extension * `maintenance` - Maintenance Options: new_build, conversion, renovation, extension, maintenance,
`site_address`	Address
`site_working_hours`	string	e.g. Mon-Fri 8am-6pm, Sat 8am-1pm
`start_date_actual`	date
`start_date_planned`	date
`status` *	string	Core system status of the project, derived from the custom status. * `planning` - Planning * `active` - Active * `on_hold` - On Hold * `completed` - Completed * `canceled` - Canceled Options: planning, active, on_hold, completed, canceled
`status_set_id`	uuid
`timesheet_identity_check_excluded`	boolean	Clock in and out on this job without a biometric or photo check.
`uk_details`	ProjectUKDetails
`us_details`	ProjectUSDetails
`variation_workflow`	string	Override workspace default_variation_workflow when set. * `simple` - Simple * `comprehensive` - Comprehensive Options: simple, comprehensive, ,
`warranty_provider`	uuid
`warranty_provider_name`	string
`workspace_currency` *	string
`zoning_or_planning_ref`	string	Approved planning permission or zoning reference.

ProjectCommercial

Field	Type	Details
`apply_retention`	boolean
`bespoke_contract_name`	string
`closed_at` *	date-time
`closed_by` *	uuid
`closeout_acknowledgements` *	JSON
`closeout_note` *	string
`commercial_status` *	string	* `open` - Open * `closed` - Closed Options: open, closed
`contract_administrator`	uuid
`contract_completion_date`	date
`contract_customer_type`	string	B2B vs B2C counterparty under the contract for this job. Must be chosen in contract setup. * `b2b` - Business to business (B2B) * `b2c` - Business to consumer (B2C) Options: b2b, b2c,
`contract_document`	uuid	Signed contract or governing document for this job.
`contract_document_detail`	JSON	Computed JSON value; may be null when access is restricted.
`contract_setup_confirmed_at`	date-time	Set when contract setup is confirmed via wizard or quote approval.
`contract_start_date`	date
`contract_type`	string	e.g., JCT Minor Works, AIA A101, CCDC 2
`contract_version`	string	Contract edition/version or internal reference.
`electronic_notices_accepted`	boolean	Whether the contract/parties accept SiteHut as a written-notice channel.
`electronic_signature_consent`	boolean	Whether online approvals/e-signatures are accepted for contract records.
`eot_approved_days_total`	integer
`eot_claimed_days_total`	integer
`eots`	EOTEntry[]
`governing_region`	string	Governing country, state, or region for contract administration.
`initial_contract_sum`	decimal	Manual baseline used when no main quote is selected and job basis is Contract.
`invoice_basis`	string	* `weekly` - Weekly * `fortnightly` - Fortnightly * `monthly` - Monthly * `on_completion` - On completion * `stage` - Stage payments Options: weekly, fortnightly, monthly, on_completion, stage,
`job_basis`	string	* `quote` - Quote / Estimate * `contract` - Contract Options: quote, contract
`lad_amount_per_day`	decimal
`lad_period`	string	Whether the LAD amount applies per day or per week. * `day` - Per day * `week` - Per week Options: day, week
`notice_recipient_member_ids`	JSON	Project participant user IDs who should receive formal contract notices.
`notice_recipient_roles`	string	Optional role labels for parties not on SiteHut, e.g. Client, CA, Architect.
`payment_period_days`	integer
`reopen_reason` *	string
`reopened_at` *	date-time
`reopened_by` *	uuid
`retention_rate`	decimal
`revised_completion_date`	date
`stage_payments_enabled`	boolean
`stages`	StagePayment[]
`statutory_prompt_payment_applies`	boolean	e.g., UK HGCRA, US Prompt Pay Acts
`variation_clauses`	string

ProjectCommercialRequest

Field	Type	Details
`apply_retention`	boolean
`bespoke_contract_name`	string
`contract_administrator`	uuid
`contract_completion_date`	date
`contract_customer_type`	string	B2B vs B2C counterparty under the contract for this job. Must be chosen in contract setup. * `b2b` - Business to business (B2B) * `b2c` - Business to consumer (B2C) Options: b2b, b2c,
`contract_document`	uuid	Signed contract or governing document for this job.
`contract_document_detail`	JSON	Computed JSON value; may be null when access is restricted.
`contract_setup_confirmed_at`	date-time	Set when contract setup is confirmed via wizard or quote approval.
`contract_start_date`	date
`contract_type`	string	e.g., JCT Minor Works, AIA A101, CCDC 2
`contract_version`	string	Contract edition/version or internal reference.
`electronic_notices_accepted`	boolean	Whether the contract/parties accept SiteHut as a written-notice channel.
`electronic_signature_consent`	boolean	Whether online approvals/e-signatures are accepted for contract records.
`eot_approved_days_total`	integer
`eot_claimed_days_total`	integer
`eots`	EOTEntryRequest[]
`governing_region`	string	Governing country, state, or region for contract administration.
`initial_contract_sum`	decimal	Manual baseline used when no main quote is selected and job basis is Contract.
`invoice_basis`	string	* `weekly` - Weekly * `fortnightly` - Fortnightly * `monthly` - Monthly * `on_completion` - On completion * `stage` - Stage payments Options: weekly, fortnightly, monthly, on_completion, stage,
`job_basis`	string	* `quote` - Quote / Estimate * `contract` - Contract Options: quote, contract
`lad_amount_per_day`	decimal
`lad_period`	string	Whether the LAD amount applies per day or per week. * `day` - Per day * `week` - Per week Options: day, week
`notice_recipient_member_ids`	JSON	Project participant user IDs who should receive formal contract notices.
`notice_recipient_roles`	string	Optional role labels for parties not on SiteHut, e.g. Client, CA, Architect.
`payment_period_days`	integer
`retention_rate`	decimal
`revised_completion_date`	date
`stage_payments_enabled`	boolean
`stages`	StagePaymentRequest[]
`statutory_prompt_payment_applies`	boolean	e.g., UK HGCRA, US Prompt Pay Acts
`variation_clauses`	string

ProjectRequest

Field	Type	Details
`allow_store_collection`	boolean	Override workspace store-collection toggle when set.
`archived_at`	date-time	Timestamp when the project was archived.
`budget`	decimal	Current agreed revenue budget visible to the client.
`commercial_summary`	JSON	Computed JSON value; may be null when access is restricted.
`cost_budget`	decimal	The internal cost budget, visible only to the builder's team.
`custom_status_id`	uuid
`customer_id`	uuid
`description`	string	Detailed description of the project.
`effective_estimating_enabled`	JSON	Computed JSON value; may be null when access is restricted.
`effective_variation_workflow`	JSON	Computed JSON value; may be null when access is restricted.
`enable_delivery_sign_off`	boolean	Override workspace delivery sign-off when set.
`enable_location_tagging`	boolean	Allow plot/location codes on purchase order lines.
`end_date_actual`	date
`end_date_planned`	date
`estimated_value`	decimal	Estimated value before a formal quote is issued.
`estimating_enabled`	boolean	Override workspace estimating_enabled when set.
`follow_up_date`	date
`initial_revenue_budget`	decimal	Snapshot of revenue at award (initial position), separate from current agreed budget.
`is_archived`	boolean
`is_location_unoccupied`	boolean	Will the work location be unoccupied during the project?
`local_restrictions`	string	Note any permit parking, delivery constraints, or noise restrictions.
`lost_reason`	string	Reason recorded when a job is marked lost or a quote is rejected.
`mandated_approver`	uuid	When set, all POs for this job require this approver.
`matching_mode`	string	two_way \| three_way; blank inherits workspace default.
`name` *	string	Name of the project.
`next_visit_on`	JSON	Computed JSON value; may be null when access is restricted.
`notice_to_start_days`	integer	The required notice period in days before work can begin.
`open_task_count`	JSON	Computed JSON value; may be null when access is restricted.
`permit_authority`	uuid	Local building control, city planning, or permit office.
`permit_authority_id`	uuid
`pipeline_source`	string	How this job was sourced (sales pipeline).
`plot_count`	JSON	Computed JSON value; may be null when access is restricted.
`po_import_allow_boq`	boolean	Override workspace PO import-from-BOQ when set.
`po_import_allow_estimate`	boolean	Override workspace PO import-from-estimate when set.
`po_import_allow_imported`	boolean	Override workspace PO import-from-imported-resources when set.
`po_import_allow_library`	boolean	Override workspace PO import-from-library when set.
`po_import_allow_quote`	boolean	Override workspace PO import-from-quote when set.
`project_number`	string	Optional internal project number or code.
`project_type`	string	* `new_build` - New Build * `conversion` - Significant Conversion * `renovation` - Renovation * `extension` - Extension * `maintenance` - Maintenance Options: new_build, conversion, renovation, extension, maintenance,
`site_address`	AddressRequest
`site_working_hours`	string	e.g. Mon-Fri 8am-6pm, Sat 8am-1pm
`start_date_actual`	date
`start_date_planned`	date
`status_set_id`	uuid
`timesheet_identity_check_excluded`	boolean	Clock in and out on this job without a biometric or photo check.
`variation_workflow`	string	Override workspace default_variation_workflow when set. * `simple` - Simple * `comprehensive` - Comprehensive Options: simple, comprehensive, ,
`warranty_provider`	uuid
`warranty_provider_id`	uuid
`zoning_or_planning_ref`	string	Approved planning permission or zoning reference.

ProjectUKDetails

Field	Type	Details
`cdm_notifiable`	boolean
`cdm_roles`	CDMDutyholder[]
`cis_applies`	boolean
`cis_deduction_rate`	decimal
`hse_f10_ref`	string
`jct_reference`	string
`party_wall_applicable`	boolean
`vat_reverse_charge_applies`	boolean

ProjectUKDetailsRequest

Field	Type	Details
`cdm_notifiable`	boolean
`cdm_roles`	CDMDutyholderRequest[]
`cis_applies`	boolean
`cis_deduction_rate`	decimal
`hse_f10_ref`	string
`jct_reference`	string
`party_wall_applicable`	boolean
`vat_reverse_charge_applies`	boolean

ProjectUSDetails

Field	Type	Details
`aia_doc_set`	string
`contract_form`	string	e.g. AIA, ConsensusDocs, custom
`contractor_license_number`	string
`license_state`	string	US state code, e.g. CA
`lien_waiver_required`	boolean
`manual_sales_tax_rate`	decimal	Manual sales tax rate % for this project (v1).
`notice_to_proceed_date`	date
`pay_application_format`	string	* `standard` - Standard invoice * `aia_g702` - AIA G702 / G703 Options: standard, aia_g702
`prevailing_wage_applies`	boolean
`sales_tax_applicable`	boolean
`substantial_completion_date`	date
`tax_exempt_certificate_ref`	string
`wage_determination_ref`	string

ProjectUSDetailsRequest

Field	Type	Details
`aia_doc_set`	string
`contract_form`	string	e.g. AIA, ConsensusDocs, custom
`contractor_license_number`	string
`license_state`	string	US state code, e.g. CA
`lien_waiver_required`	boolean
`manual_sales_tax_rate`	decimal	Manual sales tax rate % for this project (v1).
`notice_to_proceed_date`	date
`pay_application_format`	string	* `standard` - Standard invoice * `aia_g702` - AIA G702 / G703 Options: standard, aia_g702
`prevailing_wage_applies`	boolean
`sales_tax_applicable`	boolean
`substantial_completion_date`	date
`tax_exempt_certificate_ref`	string
`wage_determination_ref`	string

Property

Field	Type	Details
`created_at` *	date-time
`customer` *	uuid
`customer_name` *	string
`id` *	uuid
`name`	string
`notes`	string
`property_address`	Address
`updated_at` *	date-time
`workspace` *	uuid
`workspace_name` *	string

PropertyRequest

Field	Type	Details
`customer_id` *	uuid
`name`	string
`notes`	string
`property_address`	AddressRequest

PurchaseOrder

Field	Type	Details
`approval`	JSON	Computed JSON value; may be null when access is restricted.
`approved_at` *	date-time
`approved_by` *	uuid
`approved_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`cis_applies`	boolean
`cis_deduction_rate`	decimal
`created_at` *	date-time
`created_by` *	uuid
`created_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`delivery_address`	string	Required for material orders using site delivery (the default fulfilment method).
`delivery_instructions`	string
`description`	string
`fulfillment_method`	string	* `site_delivery` - Site delivery * `store_pickup` - Store pickup Options: site_delivery, store_pickup
`gross_amount`	object
`hire_calendar_override`	JSON
`id` *	uuid
`last_return_note`	JSON	Computed JSON value; may be null when access is restricted.
`lien_waiver_required`	boolean
`line_items`	PurchaseOrderLineItem[]
`needs_approval_for_current_user`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_amount`	object
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string
`off_hire_date`	date
`off_hire_reference`	string
`on_hire_date`	date
`order_number` *	string
`order_type`	string	* `material` - Material * `plant` - Plant * `subcontract` - Subcontract * `professional` - Professional services * `store_collection` - Store collection Options: material, plant, subcontract, professional, store_collection
`parent_order_id`	uuid
`partner` *	PurchaseOrderPartner
`partner_id`	uuid
`payment_terms`	string
`pickup_collected` *	boolean	Goods physically collected (may still await approval).
`pickup_collected_at` *	date-time
`pickup_paid_out_of_pocket`	boolean	Whether the store collection was paid personally or by company card.
`portal_actions`	JSON	Computed JSON value; may be null when access is restricted.
`project` *	uuid
`project_name` *	string
`project_number` *	string
`requested_approver`	uuid
`required_by_date`	date	Required for material orders using site delivery (the default fulfilment method).
`returns`	JSON	Computed JSON value; may be null when access is restricted.
`revision_number` *	integer
`sent_at` *	date-time
`source`	string	* `office` - Office * `material_request` - Material request * `pickup` - Pick-up order Options: office, material_request, pickup
`status` *	string	* `draft` - Draft * `pending_approval` - Pending Approval * `approved` - Approved * `sent` - Sent * `amendment_pending` - Amendment Pending * `partially_received` - Partially Received * `received` - Received * `closed` - Closed * `cancelled` - Cancelled Options: draft, pending_approval, approved, sent, amendment_pending, partially_received, received, closed, cancelled
`submitted_at` *	date-time
`supplier_quote_ref`	string
`tax_amount`	object
`tax_exempt`	boolean
`tax_treatment`	string	* `standard` - Standard * `reverse_charge` - Domestic reverse charge * `zero` - Zero rated * `reduced` - Reduced rated * `exempt` - Exempt * `use_tax` - Use tax Options: standard, reverse_charge, zero, reduced, exempt, use_tax
`ticket_file_ids`	uuid[]
`ticket_files`	JSON	Computed JSON value; may be null when access is restricted.
`updated_at` *	date-time
`vendor_name` *	string

PurchaseOrderLineItem

Field	Type	Details
`boq_item`	uuid
`calculated_duration` *	decimal
`call_off_ceiling`	JSON	Computed JSON value; may be null when access is restricted.
`call_off_enforced`	JSON	Computed JSON value; may be null when access is restricted.
`call_off_remaining`	JSON	Computed JSON value; may be null when access is restricted.
`category`	string	* `materials` - Materials * `labour` - Labour * `plant` - Plant * `subcontract` - Subcontract * `overhead` - Overhead * `other` - Other Options: materials, labour, plant, subcontract, overhead, other
`cost_code`	integer
`description` *	string
`estimate_location`	uuid	Optional plot this line is tagged to.
`estimated_quantity`	decimal	For rate-only lines: used for committed cost when qty is unknown.
`gantt_activity_id`	string
`hire_summary`	JSON	Computed JSON value; may be null when access is restricted.
`id`	uuid
`includes_driver`	boolean
`line_gross`	object
`line_net`	object
`line_tax`	object
`line_type`	string	* `standard` - Standard * `rate_only` - Rate only * `lump_sum` - Lump sum * `text_heading` - Text heading * `text_note` - Text note Options: standard, rate_only, lump_sum, text_heading, text_note
`location`	uuid
`needs_coding`	boolean
`on_hire_date`	date
`planned_off_hire_date`	date
`quantity`	decimal
`quantity_invoiced`	decimal	Cumulative quantity invoiced against this PO line.
`quantity_received`	decimal
`rate_unit`	uuid
`resource`	integer
`sort_order`	integer
`source_estimate_resource` *	uuid
`source_estimate_work_item` *	uuid
`source_handoff_key` *	string
`source_snapshot` *	JSON
`tax_rate`	decimal
`unit`	uuid
`unit_of_measure`	string
`unit_price` *	object

PurchaseOrderLineItemRequest

Field	Type	Details
`boq_item`	uuid
`call_off_ceiling`	JSON	Computed JSON value; may be null when access is restricted.
`call_off_enforced`	JSON	Computed JSON value; may be null when access is restricted.
`call_off_remaining`	JSON	Computed JSON value; may be null when access is restricted.
`category`	string	* `materials` - Materials * `labour` - Labour * `plant` - Plant * `subcontract` - Subcontract * `overhead` - Overhead * `other` - Other Options: materials, labour, plant, subcontract, overhead, other
`cost_code`	integer
`description` *	string
`estimate_location`	uuid	Optional plot this line is tagged to.
`estimated_quantity`	decimal	For rate-only lines: used for committed cost when qty is unknown.
`gantt_activity_id`	string
`hire_summary`	JSON	Computed JSON value; may be null when access is restricted.
`id`	uuid
`includes_driver`	boolean
`line_gross`	string or number or object
`line_net`	string or number or object
`line_tax`	string or number or object
`line_type`	string	* `standard` - Standard * `rate_only` - Rate only * `lump_sum` - Lump sum * `text_heading` - Text heading * `text_note` - Text note Options: standard, rate_only, lump_sum, text_heading, text_note
`location`	uuid
`needs_coding`	boolean
`on_hire_date`	date
`planned_off_hire_date`	date
`quantity`	decimal
`quantity_invoiced`	decimal	Cumulative quantity invoiced against this PO line.
`quantity_received`	decimal
`rate_unit`	uuid
`resource`	integer
`sort_order`	integer
`tax_rate`	decimal
`unit`	uuid
`unit_of_measure`	string
`unit_price` *	string or number or object

PurchaseOrderPartner

Field	Type	Details
`id` *	uuid
`name` *	string	The partner's name or company name.
`tax_id`	string	VAT number, EIN, UTR, or other tax identifier.

PurchaseOrderPartnerRequest

Field	Type	Details
`name` *	string	The partner's name or company name.
`tax_id`	string	VAT number, EIN, UTR, or other tax identifier.

PurchaseOrderRequest

Field	Type	Details
`approval`	JSON	Computed JSON value; may be null when access is restricted.
`approved_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`cis_applies`	boolean
`cis_deduction_rate`	decimal
`created_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`delivery_address`	string	Required for material orders using site delivery (the default fulfilment method).
`delivery_instructions`	string
`description`	string
`fulfillment_method`	string	* `site_delivery` - Site delivery * `store_pickup` - Store pickup Options: site_delivery, store_pickup
`gross_amount`	string or number or object
`hire_calendar_override`	JSON
`last_return_note`	JSON	Computed JSON value; may be null when access is restricted.
`lien_waiver_required`	boolean
`line_items`	PurchaseOrderLineItemRequest[]
`needs_approval_for_current_user`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`net_amount`	string or number or object
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string
`off_hire_date`	date
`off_hire_reference`	string
`on_hire_date`	date
`order_type`	string	* `material` - Material * `plant` - Plant * `subcontract` - Subcontract * `professional` - Professional services * `store_collection` - Store collection Options: material, plant, subcontract, professional, store_collection
`parent_order_id`	uuid
`partner_id`	uuid
`payment_terms`	string
`pickup_paid_out_of_pocket`	boolean	Whether the store collection was paid personally or by company card.
`portal_actions`	JSON	Computed JSON value; may be null when access is restricted.
`requested_approver`	uuid
`required_by_date`	date	Required for material orders using site delivery (the default fulfilment method).
`returns`	JSON	Computed JSON value; may be null when access is restricted.
`source`	string	* `office` - Office * `material_request` - Material request * `pickup` - Pick-up order Options: office, material_request, pickup
`supplier_quote_ref`	string
`tax_amount`	string or number or object
`tax_exempt`	boolean
`tax_treatment`	string	* `standard` - Standard * `reverse_charge` - Domestic reverse charge * `zero` - Zero rated * `reduced` - Reduced rated * `exempt` - Exempt * `use_tax` - Use tax Options: standard, reverse_charge, zero, reduced, exempt, use_tax
`ticket_file_ids`	uuid[]
`ticket_files`	JSON	Computed JSON value; may be null when access is restricted.
`vendor_name` *	string

PurchaseOrderSendInputRequest

Field	Type	Details
`requested_approver`	uuid

Quote

Field	Type	Details
`actioned_by_ip_address` *	string	IP address of the user who approved/rejected the request.
`approval_method` *	string	How the request was actioned, e.g., 'in_app', 'email_link'.
`approved_at` *	date-time
`assumption_items`	JSON	Structured assumption/exclusion items with optional client ack flags.
`assumptions`	string	Assumptions made for this quote.
`attached_files`	uuid[]
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`base_quote`	JSON	Computed JSON value; may be null when access is restricted.
`brief_snapshot_id`	uuid
`client_action_note` *	string	Note added by the client when they approved or rejected.
`created_at` *	date-time
`created_by` *	uuid
`customer_name`	string
`delivery_status` *	string
`document_type`	string	* `quote` - Quotation * `estimate` - Estimate * `variation` - Variation Options: quote, estimate, variation
`estimate_approved_at` *	date-time
`estimate_id`	JSON	Computed JSON value; may be null when access is restricted.
`estimate_is_approved` *	boolean
`estimate_last_synced_at` *	date-time
`estimate_source_quote_version` *	integer
`id` *	uuid
`is_main_quote`	boolean	Exactly one quote per project may be marked main; baseline for final account / linked flows.
`last_updated_at`	JSON	Computed JSON value; may be null when access is restricted.
`latest_variation_id`	JSON	Computed JSON value; may be null when access is restricted.
`linked_invoice_count`	JSON	Computed JSON value; may be null when access is restricted.
`linked_quote`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string	Private notes for the builder.
`pricing_mode`	string	* `quick` - Quick quote * `estimate` - Linked estimate * `external` - External contract Options: quick, estimate, external
`primary_estimate`	uuid
`primary_estimate_quote_id`	JSON	Computed JSON value; may be null when access is restricted.
`project` *	uuid
`project_address`	JSON	Computed JSON value; may be null when access is restricted.
`project_id` *	uuid
`project_name` *	string
`quote_number` *	string	Workspace-unique quote number (e.g., QUO-001).
`rejected_at` *	date-time
`revised_total`	JSON	Computed JSON value; may be null when access is restricted.
`sent_at` *	date-time
`source_change_request_id`	JSON	Computed JSON value; may be null when access is restricted.
`source_change_request_register_number`	JSON	Computed JSON value; may be null when access is restricted.
`source_change_request_title`	JSON	Computed JSON value; may be null when access is restricted.
`status` *	string	* `draft` - Draft * `sent` - Sent * `approved` - Approved * `rejected` - Rejected * `superseded` - Superseded * `locked` - Locked (linked to quote) * `archived` - Archived Options: draft, sent, approved, rejected, superseded, locked, archived
`subtotal`	JSON	Computed JSON value; may be null when access is restricted.
`tax_amount`	JSON	Computed JSON value; may be null when access is restricted.
`tax_breakdown`	JSON	Computed JSON value; may be null when access is restricted.
`tax_name`	string	The name of the tax applied (VAT, Sales Tax, ...).
`tax_rate`	decimal	The tax rate (e.g., 20.00 for 20%). Null means 'not explicitly set' and falls back to the workspace default; 0 means explicitly tax-exempt.
`terms_and_conditions`	string	Client-facing terms and conditions.
`title`	string	'Quotation for Kitchen Renovation'
`total`	JSON	Computed JSON value; may be null when access is restricted.
`updated_at` *	date-time
`variation_count`	JSON	Computed JSON value; may be null when access is restricted.
`version` *	integer	Highest version number in QuoteVersion for this series.
`workspace_business_address`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_company_name` *	string
`workspace_currency`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_daywork_defaults`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_default_tax_rate` *	decimal
`workspace_default_terms` *	string
`workspace_language` *	string
`workspace_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_market_code`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_name` *	string
`workspace_tax_id` *	string
`workspace_tax_label`	JSON	Computed JSON value; may be null when access is restricted.

QuoteApprovalInputRequest

Field	Type	Details
`confirm_contract_setup`	boolean
`note`	string

QuoteLineItem

Field	Type	Details
`cost_category`	string	* `labour` - Labour * `materials` - Materials * `plant` - Plant * `subcontract` - Subcontract * `overhead` - Overhead * `other` - Other * `professional` - Professional Options: labour, materials, plant, subcontract, overhead, other, professional
`cost_code`	integer
`cost_code_category`	JSON	Computed JSON value; may be null when access is restricted.
`description` *	string
`effective_tax_rate`	JSON	Computed JSON value; may be null when access is restricted.
`id` *	uuid
`is_provisional`	boolean
`line_total`	decimal
`order`	integer
`payment_stage` *	PaymentStage
`payment_stage_id`	uuid
`plot`	uuid	Optional plot this quoted work is tagged to.
`plot_name`	string
`quantity`	decimal
`quote` *	uuid
`resource`	integer	If set, description/UoM defaults from Resource; price from current rate.
`resource_type`	JSON	Computed JSON value; may be null when access is restricted.
`resources`	JSON	Computed JSON value; may be null when access is restricted.
`section`	string
`show_resource_breakdown`	boolean
`tax_rate`	decimal	Line tax rate (e.g. 20.00 for 20%). Null inherits the quote/workspace default; 0 means this line is tax-exempt.
`unit_of_measure`	string
`unit_price`	decimal

QuoteLineItemRequest

Field	Type	Details
`cost_category`	string	* `labour` - Labour * `materials` - Materials * `plant` - Plant * `subcontract` - Subcontract * `overhead` - Overhead * `other` - Other * `professional` - Professional Options: labour, materials, plant, subcontract, overhead, other, professional
`cost_code`	integer
`cost_code_category`	JSON	Computed JSON value; may be null when access is restricted.
`description` *	string
`effective_tax_rate`	JSON	Computed JSON value; may be null when access is restricted.
`is_provisional`	boolean
`order`	integer
`payment_stage_id`	uuid
`plot`	uuid	Optional plot this quoted work is tagged to.
`quantity`	decimal
`resource`	integer	If set, description/UoM defaults from Resource; price from current rate.
`resource_type`	JSON	Computed JSON value; may be null when access is restricted.
`resources`	JSON	Computed JSON value; may be null when access is restricted.
`section`	string
`show_resource_breakdown`	boolean
`tax_rate`	decimal	Line tax rate (e.g. 20.00 for 20%). Null inherits the quote/workspace default; 0 means this line is tax-exempt.
`unit_of_measure`	string
`unit_price`	decimal

QuoteRequest

Field	Type	Details
`assumption_items`	JSON	Structured assumption/exclusion items with optional client ack flags.
`assumptions`	string	Assumptions made for this quote.
`attached_files`	uuid[]
`attention_reasons`	JSON	Computed JSON value; may be null when access is restricted.
`available_actions`	JSON	Computed JSON value; may be null when access is restricted.
`base_quote`	JSON	Computed JSON value; may be null when access is restricted.
`brief_snapshot_id`	uuid
`document_type`	string	* `quote` - Quotation * `estimate` - Estimate * `variation` - Variation Options: quote, estimate, variation
`estimate_id`	JSON	Computed JSON value; may be null when access is restricted.
`is_main_quote`	boolean	Exactly one quote per project may be marked main; baseline for final account / linked flows.
`last_updated_at`	JSON	Computed JSON value; may be null when access is restricted.
`latest_variation_id`	JSON	Computed JSON value; may be null when access is restricted.
`linked_invoice_count`	JSON	Computed JSON value; may be null when access is restricted.
`linked_quote`	JSON	Computed JSON value; may be null when access is restricted.
`needs_attention`	JSON	Computed JSON value; may be null when access is restricted.
`next_action`	JSON	Computed JSON value; may be null when access is restricted.
`notes`	string	Private notes for the builder.
`pricing_mode`	string	* `quick` - Quick quote * `estimate` - Linked estimate * `external` - External contract Options: quick, estimate, external
`primary_estimate`	uuid
`primary_estimate_quote_id`	JSON	Computed JSON value; may be null when access is restricted.
`project_address`	JSON	Computed JSON value; may be null when access is restricted.
`revised_total`	JSON	Computed JSON value; may be null when access is restricted.
`source_change_request_id`	JSON	Computed JSON value; may be null when access is restricted.
`source_change_request_register_number`	JSON	Computed JSON value; may be null when access is restricted.
`source_change_request_title`	JSON	Computed JSON value; may be null when access is restricted.
`subtotal`	JSON	Computed JSON value; may be null when access is restricted.
`tax_amount`	JSON	Computed JSON value; may be null when access is restricted.
`tax_breakdown`	JSON	Computed JSON value; may be null when access is restricted.
`tax_name`	string	The name of the tax applied (VAT, Sales Tax, ...).
`tax_rate`	decimal	The tax rate (e.g., 20.00 for 20%). Null means 'not explicitly set' and falls back to the workspace default; 0 means explicitly tax-exempt.
`template_id`	uuid
`terms_and_conditions`	string	Client-facing terms and conditions.
`title`	string	'Quotation for Kitchen Renovation'
`total`	JSON	Computed JSON value; may be null when access is restricted.
`variation_count`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_business_address`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_currency`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_daywork_defaults`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_market_code`	JSON	Computed JSON value; may be null when access is restricted.
`workspace_tax_label`	JSON	Computed JSON value; may be null when access is restricted.

QuoteSection

Field	Type	Details
`content`	JSON	Block-specific settings and content payload.
`created_at` *	date-time
`custom_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`footer_text`	string	Optional footer text shown below this section.
`header_text`	string	Optional header text shown above this section.
`id` *	uuid
`order`	integer	Display order within the quote builder.
`quote` *	uuid
`title`	string	Optional internal title/label for this section.
`type` *	string	Kind of section/block, e.g. 'cover', 'items_table', 'dayworks'. * `cover` - Cover page * `header` - Page header * `intro` - Introduction * `items_table` - Items table * `summary` - Summary * `totals` - Totals & breakdown * `assumptions` - Assumptions * `terms` - Terms & conditions * `signature` - Signature block * `free_text` - Free text block * `dayworks` - Dayworks * `attendances` - Attendances * `variation_details` - Variation Details * `payment_schedule` - Payment Schedule Options: cover, header, intro, items_table, summary, totals, assumptions, terms, signature, free_text, dayworks, attendances, variation_details, payment_schedule
`updated_at` *	date-time

QuoteSectionRequest

Field	Type	Details
`content`	JSON	Block-specific settings and content payload.
`custom_logo_url`	JSON	Computed JSON value; may be null when access is restricted.
`footer_text`	string	Optional footer text shown below this section.
`header_text`	string	Optional header text shown above this section.
`order`	integer	Display order within the quote builder.
`title`	string	Optional internal title/label for this section.
`type` *	string	Kind of section/block, e.g. 'cover', 'items_table', 'dayworks'. * `cover` - Cover page * `header` - Page header * `intro` - Introduction * `items_table` - Items table * `summary` - Summary * `totals` - Totals & breakdown * `assumptions` - Assumptions * `terms` - Terms & conditions * `signature` - Signature block * `free_text` - Free text block * `dayworks` - Dayworks * `attendances` - Attendances * `variation_details` - Variation Details * `payment_schedule` - Payment Schedule Options: cover, header, intro, items_table, summary, totals, assumptions, terms, signature, free_text, dayworks, attendances, variation_details, payment_schedule

RFI

Field	Type	Details
`attachment_count`	JSON	Computed JSON value; may be null when access is restricted.
`attachments` *	FileDetail[]
`closed_at` *	date-time
`completion_policy`	string	* `none` - No evidence required * `note` - Note required * `file` - Photo or file required * `note_or_file` - Note or photo/file required * `note_and_file` - Note and photo/file required Options: none, note, file, note_or_file, note_and_file, ,
`created_at` *	date-time
`description`	string
`discipline`	string
`doer`	JSON	Computed JSON value; may be null when access is restricted.
`drawing_refs`	string	Drawing or spec references.
`due_date`	date
`estimate_location_id`	uuid
`estimate_location_name`	string
`id` *	uuid
`managed_by` *	UserPublic
`number` *	string
`project` *	uuid	The job this RFI belongs to.
`project_name` *	string
`raised_by` *	UserPublic
`resolved_completion_policy`	JSON	Computed JSON value; may be null when access is restricted.
`responded_at` *	date-time	When the RFI first reached Responded status.
`show_on_calendar`	boolean	If True, this RFI appears on calendars when it has a due date.
`show_on_gantt`	boolean	If True, this RFI appears on the project Gantt chart when it has a due date.
`source_timeline_entry_id`	uuid	Optional source timeline entry when this RFI was created from a message.
`status`	string	* `draft` - Draft * `issued` - Issued * `responded` - Responded * `closed` - Closed Options: draft, issued, responded, closed
`subject` *	string
`updated_at` *	date-time

RFIRequest

Field	Type	Details
`attachment_count`	JSON	Computed JSON value; may be null when access is restricted.
`attachment_ids`	uuid[]
`completion_policy`	string	* `none` - No evidence required * `note` - Note required * `file` - Photo or file required * `note_or_file` - Note or photo/file required * `note_and_file` - Note and photo/file required Options: none, note, file, note_or_file, note_and_file, ,
`description`	string
`discipline`	string
`doer`	JSON	Computed JSON value; may be null when access is restricted.
`doer_email`	email
`doer_partner_contact_id`	uuid
`doer_partner_id`	uuid
`doer_user_id`	uuid
`drawing_refs`	string	Drawing or spec references.
`due_date`	date
`estimate_location_id`	uuid
`managed_by_id`	uuid
`resolved_completion_policy`	JSON	Computed JSON value; may be null when access is restricted.
`show_on_calendar`	boolean	If True, this RFI appears on calendars when it has a due date.
`show_on_gantt`	boolean	If True, this RFI appears on the project Gantt chart when it has a due date.
`source_timeline_entry_id`	uuid	Optional source timeline entry when this RFI was created from a message.
`status`	string	* `draft` - Draft * `issued` - Issued * `responded` - Responded * `closed` - Closed Options: draft, issued, responded, closed
`subject` *	string

RFITransitionRequest

Field	Type	Details
`status` *	string	* `draft` - Draft * `issued` - Issued * `responded` - Responded * `closed` - Closed Options: draft, issued, responded, closed

RequisitionItem

Field	Type	Details
`batch` *	uuid
`batch_summary`	JSON	Computed JSON value; may be null when access is restricted.
`boq_item`	uuid
`converted_order` *	uuid
`converted_order_line` *	uuid
`cost_code`	integer
`created_at` *	date-time
`delivery_instructions`	string
`description` *	string
`estimate_location`	uuid	Optional plot this line is tagged to.
`estimated_unit_rate`	decimal
`id` *	uuid
`is_pending_coding`	boolean
`lead_in_days`	integer
`lead_in_warning`	JSON	Computed JSON value; may be null when access is restricted.
`location`	uuid
`note`	string
`order_type`	string	* `material` - Material * `plant` - Plant * `subcontract` - Subcontract * `professional` - Professional services Options: material, plant, subcontract, professional
`priority`	string	* `normal` - Normal * `high` - High Options: normal, high
`progress`	JSON	Computed JSON value; may be null when access is restricted.
`project` *	uuid
`project_name` *	string
`quantity_needed`	decimal
`rejection_reason` *	string
`requested_by` *	uuid
`requested_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`required_on_site_date`	date
`resource`	integer
`resource_name`	string
`source`	string	* `workspace_library` - Workspace library * `personal_library` - Personal library * `job_boq` - Job BOQ * `freehand` - Freehand Options: workspace_library, personal_library, job_boq, freehand
`source_estimate_resource`	uuid
`source_estimate_work_item`	uuid
`source_snapshot` *	JSON
`status` *	string	* `needed` - Needed * `requested` - Requested * `converted` - Converted * `rejected` - Rejected Options: needed, requested, converted, rejected
`suggested_partner`	uuid
`unit`	uuid
`unit_of_measure`	string
`updated_at` *	date-time
`version` *	integer

RequisitionItemRequest

Field	Type	Details
`batch_summary`	JSON	Computed JSON value; may be null when access is restricted.
`boq_item`	uuid
`cost_code`	integer
`delivery_instructions`	string
`description` *	string
`estimate_location`	uuid	Optional plot this line is tagged to.
`estimated_unit_rate`	decimal
`is_pending_coding`	boolean
`lead_in_warning`	JSON	Computed JSON value; may be null when access is restricted.
`location`	uuid
`note`	string
`order_type`	string	* `material` - Material * `plant` - Plant * `subcontract` - Subcontract * `professional` - Professional services Options: material, plant, subcontract, professional
`priority`	string	* `normal` - Normal * `high` - High Options: normal, high
`progress`	JSON	Computed JSON value; may be null when access is restricted.
`quantity_needed` *	decimal
`requested_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`required_on_site_date` *	date
`resource`	integer
`save_to_personal_library`	boolean
`source`	string	* `workspace_library` - Workspace library * `personal_library` - Personal library * `job_boq` - Job BOQ * `freehand` - Freehand Options: workspace_library, personal_library, job_boq, freehand
`source_estimate_resource`	uuid
`source_estimate_work_item`	uuid
`suggested_partner`	uuid
`unit` *	uuid
`unit_of_measure`	string

Resource

Field	Type	Details
`base_cost`	decimal
`budget_group`	uuid	Commercial reporting group; falls back to resource group when null.
`budget_group_name`	string
`code`	string
`cost_code`	integer
`cost_code_category`	JSON	Computed JSON value; may be null when access is restricted.
`cost_code_code`	string
`cost_code_name`	string
`created_at` *	date-time
`default_supplier`	JSON	Computed JSON value; may be null when access is restricted.
`default_supplier_price`	JSON	Computed JSON value; may be null when access is restricted.
`default_unit`	uuid
`default_waste_pct`	decimal
`description`	string
`effective_rate` *	object
`external_url`	uri
`extras_cost`	decimal
`general_price`	JSON	Computed JSON value; may be null when access is restricted.
`group` *	integer
`group_name`	string
`id` *	integer
`is_active`	boolean
`job`	uuid	Set for Source B (job resource / BOQ list).
`labour_cost`	decimal
`last_reviewed_at`	date
`lead_in_days`	integer
`materials_cost`	decimal
`name` *	string
`notes_internal`	string
`owner_user` *	uuid
`rate_valid_from`	JSON	Computed JSON value; may be null when access is restricted.
`resource_type`	string	* `material` - Material * `labour` - Labour * `plant` - Plant * `subcontract` - Subcontract Options: material, labour, plant, subcontract
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived
`safety_url`	uri
`source_type`	string	* `WORKSPACE_A` - Workspace library * `JOB_B` - Job resource list * `USER_C` - Personal user library Options: WORKSPACE_A, JOB_B, USER_C
`supplier_listing_count`	JSON	Computed JSON value; may be null when access is restricted.
`supplier_listings` *	ResourceSupplierListing[]
`supplier_price_count`	JSON	Computed JSON value; may be null when access is restricted.
`unit_of_measure`	string
`updated_at` *	date-time
`waste_percent`	decimal

ResourceGroup

Field	Type	Details
`id` *	integer
`name` *	string

ResourceGroupRequest

Field	Type	Details
`name` *	string

ResourceNote

Field	Type	Details
`author_name`	JSON	Computed JSON value; may be null when access is restricted.
`body` *	string
`created_at` *	date-time
`id` *	integer
`resource` *	integer

ResourceNoteRequest

Field	Type	Details
`author_name`	JSON	Computed JSON value; may be null when access is restricted.
`body` *	string
`resource` *	integer

ResourcePrice

Field	Type	Details
`id` *	integer
`is_default`	boolean	Use this supplier price by default when the resource is added to an estimate.
`notes`	string
`partner`	uuid
`partner_name`	string
`price_type`	string	* `general` - General * `partner` - Partner Options: general, partner
`rate`	decimal
`resource` *	integer
`resource_name` *	string
`supplier_code`	string
`supplier_description`	string
`supplier_listing` *	integer
`updated_at` *	date-time
`updated_by` *	uuid
`updated_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`valid_from`	date
`valid_to`	date
`workspace` *	uuid

ResourcePriceRequest

Field	Type	Details
`is_default`	boolean	Use this supplier price by default when the resource is added to an estimate.
`notes`	string
`partner`	uuid
`price_type`	string	* `general` - General * `partner` - Partner Options: general, partner
`rate` *	decimal
`resource` *	integer
`supplier_code`	string
`supplier_description`	string
`updated_by_name`	JSON	Computed JSON value; may be null when access is restricted.
`valid_from`	date
`valid_to`	date

ResourceRequest

Field	Type	Details
`base_cost_input`	string
`budget_group`	uuid	Commercial reporting group; falls back to resource group when null.
`code`	string
`cost_code`	integer
`cost_code_category`	JSON	Computed JSON value; may be null when access is restricted.
`default_supplier`	JSON	Computed JSON value; may be null when access is restricted.
`default_supplier_price`	JSON	Computed JSON value; may be null when access is restricted.
`default_unit`	uuid
`default_waste_pct`	decimal
`description`	string
`external_url`	uri
`extras_cost_input`	string
`general_price`	JSON	Computed JSON value; may be null when access is restricted.
`group` *	integer
`initial_supplier`	uuid
`initial_supplier_code`	string
`initial_supplier_description`	string
`initial_supplier_name`	string
`initial_supplier_price`	decimal
`initial_supplier_price_valid_from`	date
`initial_supplier_product_url`	uri
`is_active`	boolean
`job`	uuid	Set for Source B (job resource / BOQ list).
`labour_cost_input`	string
`last_reviewed_at`	date
`lead_in_days`	integer
`materials_cost_input`	string
`name` *	string
`notes_internal`	string
`rate_valid_from`	JSON	Computed JSON value; may be null when access is restricted.
`resource_type`	string	* `material` - Material * `labour` - Labour * `plant` - Plant * `subcontract` - Subcontract Options: material, labour, plant, subcontract
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived
`safety_url`	uri
`source_type`	string	* `WORKSPACE_A` - Workspace library * `JOB_B` - Job resource list * `USER_C` - Personal user library Options: WORKSPACE_A, JOB_B, USER_C
`supplier_listing_count`	JSON	Computed JSON value; may be null when access is restricted.
`supplier_price_count`	JSON	Computed JSON value; may be null when access is restricted.
`unit_of_measure`	string
`waste_percent`	decimal

ResourceSupplierListing

Field	Type	Details
`created_at` *	date-time
`id` *	integer
`is_default`	boolean
`partner` *	uuid
`partner_name` *	string
`product_url`	uri
`resource` *	integer
`resource_name` *	string
`supplier_code`	string
`supplier_description`	string
`updated_at` *	date-time
`workspace` *	uuid

ResourceSupplierListingRequest

Field	Type	Details
`is_default`	boolean
`partner` *	uuid
`product_url`	uri
`resource` *	integer
`supplier_code`	string
`supplier_description`	string

ScheduleDependency

Field	Type	Details
`dependency_type`	string	* `FS` - Finish-to-Start * `SS` - Start-to-Start * `FF` - Finish-to-Finish * `SF` - Start-to-Finish Options: FS, SS, FF, SF
`gate_status`	string	RFI milestone required before the successor can proceed. * `responded` - Responded * `closed` - Closed Options: responded, closed
`id` *	uuid
`is_satisfied`	JSON	Computed JSON value; may be null when access is restricted.
`lag_days`	integer
`rfi`	JSON	Computed JSON value; may be null when access is restricted.
`successor` *	TaskSimple

ScheduleDependencyRequest

Field	Type	Details
`dependency_type`	string	* `FS` - Finish-to-Start * `SS` - Start-to-Start * `FF` - Finish-to-Finish * `SF` - Start-to-Finish Options: FS, SS, FF, SF
`gate_status`	string	RFI milestone required before the successor can proceed. * `responded` - Responded * `closed` - Closed Options: responded, closed
`is_satisfied`	JSON	Computed JSON value; may be null when access is restricted.
`lag_days`	integer
`rfi`	JSON	Computed JSON value; may be null when access is restricted.
`rfi_id`	uuid
`successor_id`	uuid

SiteLog

Field	Type	Details
`amendments` *	SiteLogAmendment[]
`attached_files`	uuid[]
`author` *	uuid
`author_avatar_color`	string
`author_avatar_mode`	string
`author_avatar_url`	uri
`author_name`	string
`client_summary`	string	Short client-facing summary used when preparing client updates.
`cost_impact_type`	string	* `none` - No cost impact noted * `estimate` - Estimated cost impact * `tbd` - Cost impact to be determined Options: none, estimate, tbd
`created_at` *	date-time
`delay_days`	integer	Estimated delay in days caused by the logged issue.
`deliveries_notes`	string
`equipment_on_site`	string
`estimated_cost_amount`	decimal	Optional estimated cost impact amount.
`estimated_cost_currency`	string	ISO currency code for the estimated cost amount.
`id` *	uuid
`internal_notes`	string	Private notes for the project team. Not included in client reports.
`is_locked` *	boolean
`issues_notes`	string
`locks_at`	JSON	Computed JSON value; may be null when access is restricted.
`log_date` *	date
`progress_notes`	string
`project` *	uuid
`recommendation`	string
`responsible_party`	string	* `client` - Client * `builder` - Builder * `third_party` - Third party * `unknown` - Unknown Options: client, builder, third_party, unknown
`risk_level`	string	* `low` - Low * `medium` - Medium * `high` - High Options: low, medium, high
`safety_observations`	string
`staff_on_site`	integer
`updated_at` *	date-time
`visitors`	string
`weather`	string

SiteLogAmendment

Field	Type	Details
`author` *	uuid
`author_name`	string
`created_at` *	date-time
`id` *	uuid
`notes` *	string
`site_log` *	uuid

SiteLogAmendmentRequest

Field	Type	Details
`notes` *	string
`site_log` *	uuid

SiteLogRequest

Field	Type	Details
`attached_files`	uuid[]
`client_summary`	string	Short client-facing summary used when preparing client updates.
`cost_impact_type`	string	* `none` - No cost impact noted * `estimate` - Estimated cost impact * `tbd` - Cost impact to be determined Options: none, estimate, tbd
`delay_days`	integer	Estimated delay in days caused by the logged issue.
`deliveries_notes`	string
`equipment_on_site`	string
`estimated_cost_amount`	decimal	Optional estimated cost impact amount.
`estimated_cost_currency`	string	ISO currency code for the estimated cost amount.
`internal_notes`	string	Private notes for the project team. Not included in client reports.
`issues_notes`	string
`locks_at`	JSON	Computed JSON value; may be null when access is restricted.
`log_date` *	date
`progress_notes`	string
`recommendation`	string
`responsible_party`	string	* `client` - Client * `builder` - Builder * `third_party` - Third party * `unknown` - Unknown Options: client, builder, third_party, unknown
`risk_level`	string	* `low` - Low * `medium` - Medium * `high` - High Options: low, medium, high
`safety_observations`	string
`staff_on_site`	integer
`visitors`	string
`weather`	string

Snag

Field	Type	Details
`attachment_count`	JSON	Computed JSON value; may be null when access is restricted.
`attachments` *	FileDetail[]
`closed_at` *	date-time
`completion_policy`	string	* `none` - No evidence required * `note` - Note required * `file` - Photo or file required * `note_or_file` - Note or photo/file required * `note_and_file` - Note and photo/file required Options: none, note, file, note_or_file, note_and_file, ,
`created_at` *	date-time
`daywork_applicable`	string	* `yes` - Yes * `no` - No * `tbc` - TBC Options: yes, no, tbc
`description`	string
`doer`	JSON	Computed JSON value; may be null when access is restricted.
`due_date`	date
`estimate_location_id`	uuid
`estimate_location_name`	string
`id` *	uuid
`location`	string
`managed_by` *	UserPublic
`number` *	string
`priority`	string	* `low` - Low * `medium` - Medium * `high` - High * `urgent` - Urgent Options: low, medium, high, urgent
`project` *	uuid	The job this snag belongs to.
`project_name` *	string
`raised_by` *	UserPublic
`resolved_completion_policy`	JSON	Computed JSON value; may be null when access is restricted.
`show_on_calendar`	boolean	If True, this snag appears on calendars when it has a due date.
`show_on_gantt`	boolean	If True, this snag appears on the project Gantt chart when it has a due date.
`source_timeline_entry_id`	uuid	Optional source timeline entry id when this snag was created from a message.
`status`	string	* `open` - Open * `in_progress` - In progress * `ready_for_inspection` - Ready for inspection * `rejected` - Rejected * `closed` - Closed Options: open, in_progress, ready_for_inspection, rejected, closed
`title` *	string
`updated_at` *	date-time

SnagRequest

Field	Type	Details
`attachment_count`	JSON	Computed JSON value; may be null when access is restricted.
`attachment_ids`	uuid[]
`completion_policy`	string	* `none` - No evidence required * `note` - Note required * `file` - Photo or file required * `note_or_file` - Note or photo/file required * `note_and_file` - Note and photo/file required Options: none, note, file, note_or_file, note_and_file, ,
`daywork_applicable`	string	* `yes` - Yes * `no` - No * `tbc` - TBC Options: yes, no, tbc
`description`	string
`doer`	JSON	Computed JSON value; may be null when access is restricted.
`doer_email`	email
`doer_partner_contact_id`	uuid
`doer_partner_id`	uuid
`doer_user_id`	uuid
`due_date`	date
`estimate_location_id`	uuid
`location`	string
`managed_by_id`	uuid
`priority`	string	* `low` - Low * `medium` - Medium * `high` - High * `urgent` - Urgent Options: low, medium, high, urgent
`resolved_completion_policy`	JSON	Computed JSON value; may be null when access is restricted.
`show_on_calendar`	boolean	If True, this snag appears on calendars when it has a due date.
`show_on_gantt`	boolean	If True, this snag appears on the project Gantt chart when it has a due date.
`source_timeline_entry_id`	uuid	Optional source timeline entry id when this snag was created from a message.
`status`	string	* `open` - Open * `in_progress` - In progress * `ready_for_inspection` - Ready for inspection * `rejected` - Rejected * `closed` - Closed Options: open, in_progress, ready_for_inspection, rejected, closed
`title` *	string

SnagTransitionRequest

Field	Type	Details
`status` *	string	* `open` - Open * `in_progress` - In progress * `ready_for_inspection` - Ready for inspection * `rejected` - Rejected * `closed` - Closed Options: open, in_progress, ready_for_inspection, rejected, closed

StagePayment

Field	Type	Details
`amount`	decimal
`id`	integer
`is_invoiced`	boolean
`name` *	string
`notes`	string
`order` *	integer
`percentage`	decimal

StagePaymentRequest

Field	Type	Details
`amount`	decimal
`id`	integer
`is_invoiced`	boolean
`name` *	string
`notes`	string
`order` *	integer
`percentage`	decimal

SubTask

Field	Type	Details
`assignees` *	UserPublic[]
`end_date`	date
`id` *	uuid
`name` *	string
`progress`	integer	Manual completion percentage (0-100). Null means auto.
`status`	string	* `todo` - To Do * `in_progress` - In Progress * `done` - Done * `on_hold` - On Hold * `overdue` - Overdue * `blocked` - Blocked Options: todo, in_progress, done, on_hold, overdue, blocked

SubTaskRequest

Field	Type	Details
`end_date`	date
`name` *	string
`progress`	integer	Manual completion percentage (0-100). Null means auto.
`status`	string	* `todo` - To Do * `in_progress` - In Progress * `done` - Done * `on_hold` - On Hold * `overdue` - Overdue * `blocked` - Blocked Options: todo, in_progress, done, on_hold, overdue, blocked

Task

Field	Type	Details
`actual_end_date`	date
`actual_start_date`	date
`all_day`	boolean
`assignees` *	UserPublic[]
`attached_files` *	FileDetail[]
`audience_type`	string	* `builder_internal` - Builder staff * `builder_team` - Builder side * `builder_client` - Builder and client teams * `client_team` - Client team * `everyone` - Everyone on this job * `selected_people` - Selected people Options: builder_internal, builder_team, builder_client, client_team, everyone, selected_people
`checklist_items`	JSON	A list of simple checklist sub-items for this task.
`completed_at` *	date-time
`completion_policy`	string	Leave blank to use the workspace default. * `none` - No evidence required * `note` - Note required * `file` - Photo or file required * `note_or_file` - Note or photo/file required * `note_and_file` - Note and photo/file required Options: none, note, file, note_or_file, note_and_file, ,
`constraint_date`	date
`constraint_type`	string	* `as_soon_as_possible` - As soon as possible * `as_late_as_possible` - As late as possible * `must_start_on` - Must start on * `must_finish_on` - Must finish on * `start_no_earlier_than` - Start no earlier than * `finish_no_later_than` - Finish no later than Options: as_soon_as_possible, as_late_as_possible, must_start_on, must_finish_on, start_no_earlier_than, finish_no_later_than, ,
`created_at` *	date-time
`created_by` *	uuid
`deleted_at` *	date-time
`deleted_by` *	uuid
`dependency_predecessors` *	TaskDependency[]
`dependency_successors` *	TaskDependency[]
`description`	string
`due_date`	date
`duration_days`	integer
`end_date`	date
`end_time`	time
`estimate_location_id`	uuid
`estimate_location_name`	string
`id` *	uuid
`is_date_locked`	boolean	If True, this task's dates will not be automatically adjusted by dependencies.
`is_deleted` *	boolean
`is_milestone`	boolean	If True, this task is a major project milestone.
`is_private`	boolean
`name` *	string
`order`	integer	The order of the task in a list view.
`parent` *	ParentTask
`progress`	integer
`project` *	uuid
`resolved_completion_policy`	JSON	Computed JSON value; may be null when access is restricted.
`schedule_predecessors` *	ScheduleDependency[]
`selected_user_ids`	JSON
`show_on_calendar`	boolean	If True, this task appears on the user and project calendars.
`show_on_gantt`	boolean	If True, this task appears on the project Gantt chart.
`source_quote_line_item`	uuid
`source_quote_number`	JSON	Computed JSON value; may be null when access is restricted.
`source_timeline_entry_id`	uuid
`start_date`	date
`start_time`	time
`status`	string	* `todo` - To Do * `in_progress` - In Progress * `done` - Done * `on_hold` - On Hold * `overdue` - Overdue * `blocked` - Blocked Options: todo, in_progress, done, on_hold, overdue, blocked
`sub_tasks` *	SubTask[]
`task_type` *	TaskType
`updated_at` *	date-time
`value`	decimal

TaskDependency

Field	Type	Details
`dependency_type`	string	* `FS` - Finish-to-Start * `SS` - Start-to-Start * `FF` - Finish-to-Finish * `SF` - Start-to-Finish Options: FS, SS, FF, SF
`id` *	uuid
`lag_days`	integer
`predecessor` *	TaskSimple
`successor` *	TaskSimple

TaskDependencyRequest

Field	Type	Details
`dependency_type`	string	* `FS` - Finish-to-Start * `SS` - Start-to-Start * `FF` - Finish-to-Finish * `SF` - Start-to-Finish Options: FS, SS, FF, SF
`lag_days`	integer
`predecessor_id`	uuid
`successor_id`	uuid

TaskList

Field	Type	Details
`actual_end_date`	date
`actual_start_date`	date
`all_day` *	boolean
`assignees` *	UserPublic[]
`audience_type` *	string	* `builder_internal` - Builder staff * `builder_team` - Builder side * `builder_client` - Builder and client teams * `client_team` - Client team * `everyone` - Everyone on this job * `selected_people` - Selected people Options: builder_internal, builder_team, builder_client, client_team, everyone, selected_people
`checklist_done`	JSON	Computed JSON value; may be null when access is restricted.
`checklist_total`	JSON	Computed JSON value; may be null when access is restricted.
`completed_at` *	date-time
`completion_policy` *	string	Leave blank to use the workspace default. * `none` - No evidence required * `note` - Note required * `file` - Photo or file required * `note_or_file` - Note or photo/file required * `note_and_file` - Note and photo/file required Options: none, note, file, note_or_file, note_and_file,
`constraint_date`	date
`constraint_type` *	string	* `as_soon_as_possible` - As soon as possible * `as_late_as_possible` - As late as possible * `must_start_on` - Must start on * `must_finish_on` - Must finish on * `start_no_earlier_than` - Start no earlier than * `finish_no_later_than` - Finish no later than Options: as_soon_as_possible, as_late_as_possible, must_start_on, must_finish_on, start_no_earlier_than, finish_no_later_than,
`created_at` *	date-time
`deleted_at` *	date-time
`deleted_by` *	uuid
`dependency_predecessors` *	TaskDependency[]
`due_date` *	date
`duration_days` *	integer
`end_date`	date
`end_time` *	time
`estimate_location_id` *	uuid	Optional plot this task is tagged to.
`id` *	uuid
`is_date_locked` *	boolean	If True, this task's dates will not be automatically adjusted by dependencies.
`is_deleted` *	boolean
`is_milestone` *	boolean	If True, this task is a major project milestone.
`is_private` *	boolean
`name` *	string
`order` *	integer	The order of the task in a list view.
`parent` *	ParentTask
`progress`	integer
`project` *	uuid
`resolved_completion_policy`	JSON	Computed JSON value; may be null when access is restricted.
`schedule_predecessors` *	ScheduleDependency[]
`selected_user_ids` *	JSON
`show_on_calendar` *	boolean	If True, this task appears on the user and project calendars.
`show_on_gantt` *	boolean	If True, this task appears on the project Gantt chart.
`start_date`	date
`start_time` *	time
`status` *	string	* `todo` - To Do * `in_progress` - In Progress * `done` - Done * `on_hold` - On Hold * `overdue` - Overdue * `blocked` - Blocked Options: todo, in_progress, done, on_hold, overdue, blocked
`task_type` *	TaskType
`value`	decimal

TaskRequest

Field	Type	Details
`actual_end_date`	date
`actual_start_date`	date
`all_day`	boolean
`assignee_ids`	uuid[]
`audience_type`	string	* `builder_internal` - Builder staff * `builder_team` - Builder side * `builder_client` - Builder and client teams * `client_team` - Client team * `everyone` - Everyone on this job * `selected_people` - Selected people Options: builder_internal, builder_team, builder_client, client_team, everyone, selected_people
`checklist_items`	JSON	A list of simple checklist sub-items for this task.
`completion_policy`	string	Leave blank to use the workspace default. * `none` - No evidence required * `note` - Note required * `file` - Photo or file required * `note_or_file` - Note or photo/file required * `note_and_file` - Note and photo/file required Options: none, note, file, note_or_file, note_and_file, ,
`constraint_date`	date
`constraint_type`	string	* `as_soon_as_possible` - As soon as possible * `as_late_as_possible` - As late as possible * `must_start_on` - Must start on * `must_finish_on` - Must finish on * `start_no_earlier_than` - Start no earlier than * `finish_no_later_than` - Finish no later than Options: as_soon_as_possible, as_late_as_possible, must_start_on, must_finish_on, start_no_earlier_than, finish_no_later_than, ,
`description`	string
`due_date`	date
`duration_days`	integer
`end_date`	date
`end_time`	time
`estimate_location_id`	uuid
`file_ids`	uuid[]	Set the attached files for this task
`is_date_locked`	boolean	If True, this task's dates will not be automatically adjusted by dependencies.
`is_milestone`	boolean	If True, this task is a major project milestone.
`is_private`	boolean
`name` *	string
`order`	integer	The order of the task in a list view.
`parent_id`	uuid
`predecessors`	PredecessorInputRequest[]
`progress`	integer
`resolved_completion_policy`	JSON	Computed JSON value; may be null when access is restricted.
`selected_user_ids`	JSON
`show_on_calendar`	boolean	If True, this task appears on the user and project calendars.
`show_on_gantt`	boolean	If True, this task appears on the project Gantt chart.
`source_quote_line_item`	uuid
`source_quote_number`	JSON	Computed JSON value; may be null when access is restricted.
`source_timeline_entry_id`	uuid
`start_date`	date
`start_time`	time
`status`	string	* `todo` - To Do * `in_progress` - In Progress * `done` - Done * `on_hold` - On Hold * `overdue` - Overdue * `blocked` - Blocked Options: todo, in_progress, done, on_hold, overdue, blocked
`task_type_id`	uuid
`value`	decimal

TaskSimple

Field	Type	Details
`id` *	uuid
`name` *	string

TaskSimpleRequest

Field	Type	Details
`name` *	string

TaskType

Field	Type	Details
`icon_name`	string	Optional icon name for the frontend.
`id` *	uuid
`name` *	string
`parent_id`	uuid
`workspace` *	uuid

TaskTypeRequest

Field	Type	Details
`icon_name`	string	Optional icon name for the frontend.
`name` *	string
`parent_id`	uuid

Timesheet

Field	Type	Details
`approval`	JSON	Computed JSON value; may be null when access is restricted.
`approved_at` *	date-time
`can_edit`	JSON	Computed JSON value; may be null when access is restricted.
`can_submit`	JSON	Computed JSON value; may be null when access is restricted.
`can_unsubmit`	JSON	Computed JSON value; may be null when access is restricted.
`created_at` *	date-time
`entries` *	TimesheetEntry[]
`id` *	uuid
`status` *	string	* `draft` - Draft * `submitted` - Submitted * `approved` - Approved * `rejected` - Rejected Options: draft, submitted, approved, rejected
`submitted_at` *	date-time
`total_hours`	JSON	Computed JSON value; may be null when access is restricted.
`updated_at` *	date-time
`user_id` *	uuid
`user_name`	JSON	Computed JSON value; may be null when access is restricted.
`warnings`	JSON	Computed JSON value; may be null when access is restricted.
`week_end` *	date
`week_start` *	date

TimesheetEntry

Field	Type	Details
`clock_details`	JSON	Computed JSON value; may be null when access is restricted.
`entry_date` *	date
`hours`	decimal
`id` *	uuid
`is_billable`	boolean
`notes`	string
`project_id` *	uuid
`project_name` *	string
`project_number` *	string
`source_id`	uuid
`source_label`	JSON	Computed JSON value; may be null when access is restricted.
`source_type`	string	* `manual` - Manual * `task` - Task * `event` - Event * `snag` - Snag * `rfi` - RFI * `clock` - Clocked time Options: manual, task, event, snag, rfi, clock
`task_id` *	uuid
`task_is_milestone`	JSON	Computed JSON value; may be null when access is restricted.
`task_is_subtask`	JSON	Computed JSON value; may be null when access is restricted.
`task_name`	JSON	Computed JSON value; may be null when access is restricted.
`task_parent_name`	JSON	Computed JSON value; may be null when access is restricted.

Unit

Field	Type	Details
`code` *	string
`id` *	uuid
`is_active`	boolean
`is_time_unit`	boolean
`name` *	string
`symbol` *	string
`time_basis`	string	* `hour` - Hour * `day` - Day * `week` - Week Options: hour, day, week,

UserPublic

Field	Type	Details
`avatar_color`	string	Hex color code for avatar fallback, generated from name.
`avatar_mode`	string	Avatar rendering mode: auto, color, or image. * `auto` - Auto * `color` - Custom colour * `image` - Image Options: auto, color, image
`avatar_url`	uri	URL for the user's profile picture.
`email` *	email
`first_name`	string
`id` *	uuid
`last_name`	string

UserPublicRequest

Field	Type	Details
`avatar_color`	string	Hex color code for avatar fallback, generated from name.
`avatar_mode`	string	Avatar rendering mode: auto, color, or image. * `auto` - Auto * `color` - Custom colour * `image` - Image Options: auto, color, image
`avatar_url`	uri	URL for the user's profile picture.
`email` *	email
`first_name`	string
`last_name`	string

WorkItem

Field	Type	Details
`boq_path`	JSON	Computed JSON value; may be null when access is restricted.
`code`	string
`created_at` *	date-time
`default_waste_pct`	decimal
`description`	string
`group` *	integer
`group_name`	string
`id` *	integer
`is_active`	boolean
`is_unit_price`	boolean
`items`	WorkItemItem[]
`last_reviewed_at`	date
`lib_line`	uuid
`name` *	string
`notes_internal`	string
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived
`unit_of_measure`	string
`updated_at` *	date-time

WorkItemGroup

Field	Type	Details
`id` *	integer
`name` *	string

WorkItemGroupRequest

Field	Type	Details
`name` *	string

WorkItemItem

Field	Type	Details
`effective_rate`	JSON	Computed JSON value; may be null when access is restricted.
`id` *	integer
`quantity`	decimal
`resource` *	integer
`resource_name` *	string
`unit` *	string
`unit_rate_override`	decimal
`uom`	string

WorkItemItemRequest

Field	Type	Details
`effective_rate`	JSON	Computed JSON value; may be null when access is restricted.
`quantity`	decimal
`resource` *	integer
`unit_rate_override`	decimal
`uom`	string

WorkItemRequest

Field	Type	Details
`boq_path`	JSON	Computed JSON value; may be null when access is restricted.
`code`	string
`default_waste_pct`	decimal
`description`	string
`group` *	integer
`is_active`	boolean
`is_unit_price`	boolean
`items`	WorkItemItemRequest[]
`last_reviewed_at`	date
`lib_line`	uuid
`name` *	string
`notes_internal`	string
`review_status`	string	* `needs_review` - Needs review * `reviewed` - Reviewed * `starter` - Starter data * `archived` - Archived Options: needs_review, reviewed, starter, archived
`unit_of_measure`	string