Talent & Contingent Workforce · Workers on Assignment
Statements of Work
The other half of contingent spend: not people by the hour but an outcome for a price, delivered against milestones.
/api/ats/statements-of-workPublished as /api/v1/statements-of-workDownload specification (OpenAPI 3.1) Screen: Statements of Work
Overview
| Package | Talent & Contingent Workforce |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Talent & Contingent Workforce › Statements of Work on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | ats.statements_of_work · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
11 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/ats/statements-of-workList statements of work
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sow_no": "SOW-000001",
"title": "Example",
"client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"msp_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sow_type": "text",
"start_date": "2026-10-30",
"end_date": "2026-10-30",
"currency": "USD",
"contract_value": "1250.00",
"invoiced_to_date": "1250.00",
"cost_to_date": "1250.00",
"status": "draft"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/ats/statements-of-work?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/ats/statements-of-work/{id}Read one statement of work
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sow_no": "SOW-000001",
"title": "Example",
"client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"msp_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sow_type": "text",
"start_date": "2026-10-30",
"end_date": "2026-10-30",
"currency": "USD",
"contract_value": "1250.00",
"invoiced_to_date": "1250.00",
"cost_to_date": "1250.00",
"status": "draft"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/ats/statements-of-work/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ats/statements-of-workCreate a statement of work
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
title | text | Yes | Title |
client_id | uuid | Yes | Client |
msp_program_id | uuid | No | Programme |
sow_type | text | No | Type |
start_date | date | No | From |
end_date | date | No | To |
currency | text | No | Currency |
contract_value | numeric | No | Contract value |
status | text | No | Status Allowed: draft submitted approved active on_hold completed closed cancelled |
owner_user_id | uuid | No | Owner |
cost_center_id | uuid | No | Cost center |
po_number | text | No | PO number |
scope | text | No | Scope |
acceptance_criteria | text | No | Acceptance criteria |
external_ref | text | No | Reference over there |
notes | text | No | Notes |
Sample body
{
"title": "Example",
"client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"msp_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sow_type": "text",
"start_date": "2026-10-30",
"end_date": "2026-10-30"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sow_no": "SOW-000001",
"title": "Example",
"client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"msp_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sow_type": "text",
"start_date": "2026-10-30",
"end_date": "2026-10-30",
"currency": "USD",
"contract_value": "1250.00",
"invoiced_to_date": "1250.00",
"cost_to_date": "1250.00",
"status": "draft"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/ats/statements-of-work" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"Example","client_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","msp_program_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","sow_type":"text","start_date":"2026-10-30","end_date":"2026-10-30"}'PUT/api/ats/statements-of-work/{id}Change a statement of work
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
title | text | Yes | Title |
client_id | uuid | Yes | Client |
msp_program_id | uuid | No | Programme |
sow_type | text | No | Type |
start_date | date | No | From |
end_date | date | No | To |
currency | text | No | Currency |
contract_value | numeric | No | Contract value |
status | text | No | Status Allowed: draft submitted approved active on_hold completed closed cancelled |
owner_user_id | uuid | No | Owner |
cost_center_id | uuid | No | Cost center |
po_number | text | No | PO number |
scope | text | No | Scope |
acceptance_criteria | text | No | Acceptance criteria |
external_ref | text | No | Reference over there |
notes | text | No | Notes |
Sample body
{
"title": "Example",
"client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sow_no": "SOW-000001",
"title": "Example",
"client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"msp_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sow_type": "text",
"start_date": "2026-10-30",
"end_date": "2026-10-30",
"currency": "USD",
"contract_value": "1250.00",
"invoiced_to_date": "1250.00",
"cost_to_date": "1250.00",
"status": "draft"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/ats/statements-of-work/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"Example","client_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/ats/statements-of-work/{id}Delete a statement of work
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/ats/statements-of-work/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ats/statements-of-work/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/ats/statements-of-work/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'GET/api/ats/statements-of-work/{parentId}/milestonesMilestones
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/ats/statements-of-work/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/milestones" \
-H "Authorization: Bearer $TOKEN"POST/api/ats/statements-of-work/{parentId}/milestonesMilestones
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/ats/statements-of-work/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/milestones" \
-H "Authorization: Bearer $TOKEN"PUT/api/ats/statements-of-work/{parentId}/milestones/{lineId}Milestones
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/ats/statements-of-work/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/milestones/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/ats/statements-of-work/{parentId}/milestones/{lineId}Milestones
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/ats/statements-of-work/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/milestones/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ats/statements-of-work/{id}/invoice-milestoneInvoice milestone
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
invoiceDate, milestoneId*Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/ats/statements-of-work/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/invoice-milestone" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"invoiceDate":"value","milestoneId":"value"}'Data model
Every field of a statement of work, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
sow_no | text | read only | Sow no |
title | text | read, write | Title |
client_id | uuid | read, write | Client |
msp_program_id | uuid | read, write | Programme |
sow_type | text | read, write | Type |
start_date | date | read, write | From |
end_date | date | read, write | To |
currency | text | read, write | Currency |
contract_value | numeric | read, write | Contract value |
invoiced_to_date | numeric | read only | Invoiced to date |
cost_to_date | numeric | read only | Cost to date |
status | text | read, write | Status Allowed: draft submitted approved active on_hold completed closed cancelled |
owner_user_id | uuid | read, write | Owner |
cost_center_id | uuid | read, write | Cost center |
po_number | text | read, write | PO number |
scope | text | read, write | Scope |
acceptance_criteria | text | read, write | Acceptance criteria |
external_ref | text | read, write | Reference over there |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Talent & Contingent Workforce › Statements of Work for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.