Supply Chain · Contract Management
Contracts
Authored from a template, held in one place, and enforced: the prices a contract fixes are what a purchase is checked against.
/api/scm/contractsPublished as /api/v1/contractsOverview
| Package | Supply Chain |
|---|---|
| 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 Supply Chain › Contracts 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 | scm.contracts · 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
20 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/contractsList contracts
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",
"contract_no": "CON-000001",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"template_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rfx_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"title": "Example",
"contract_type": "text",
"currency": "USD",
"total_value": "1250.00",
"committed_value": "1250.00",
"start_date": "2026-10-30",
"end_date": "2026-10-30",
"auto_renew": true
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/contracts?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/contracts/{id}Read one contracts
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",
"contract_no": "CON-000001",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"template_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rfx_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"title": "Example",
"contract_type": "text",
"currency": "USD",
"total_value": "1250.00",
"committed_value": "1250.00",
"start_date": "2026-10-30",
"end_date": "2026-10-30",
"auto_renew": true
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/contractsCreate a contracts
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
supplier_id | uuid | No | Supplier — Required. Left empty on a contract raised from a sourcing event, it is the supplier the event was awarded to. |
template_id | uuid | No | Template |
rfx_id | uuid | No | From sourcing event |
parent_id | uuid | No | Under contract — A statement of work sits under its master agreement. |
title | text | Yes | Title |
contract_type | text | No | Type |
currency | text | No | Currency — Leave empty for the company's own currency. The list is kept under Accounting > Ledger > Ledgers & Principles > Currencies. |
total_value | numeric | No | Total value |
start_date | date | No | Starts |
end_date | date | No | Ends |
auto_renew | boolean | No | Renews automatically |
renewal_months | integer | No | Renewal term (months) |
notice_days | integer | No | Notice period (days) |
body | text | No | Body |
owner_id | uuid | No | Owner |
cost_center_id | uuid | No | Cost center |
Sample body
{
"title": "Example",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"template_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rfx_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contract_no": "CON-000001",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"template_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rfx_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"title": "Example",
"contract_type": "text",
"currency": "USD",
"total_value": "1250.00",
"committed_value": "1250.00",
"start_date": "2026-10-30",
"end_date": "2026-10-30",
"auto_renew": true
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/contracts" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"Example","supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","template_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","rfx_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","parent_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/scm/contracts/{id}Change a contracts
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 |
|---|---|---|---|
supplier_id | uuid | No | Supplier — Required. Left empty on a contract raised from a sourcing event, it is the supplier the event was awarded to. |
template_id | uuid | No | Template |
rfx_id | uuid | No | From sourcing event |
parent_id | uuid | No | Under contract — A statement of work sits under its master agreement. |
title | text | Yes | Title |
contract_type | text | No | Type |
currency | text | No | Currency — Leave empty for the company's own currency. The list is kept under Accounting > Ledger > Ledgers & Principles > Currencies. |
total_value | numeric | No | Total value |
start_date | date | No | Starts |
end_date | date | No | Ends |
auto_renew | boolean | No | Renews automatically |
renewal_months | integer | No | Renewal term (months) |
notice_days | integer | No | Notice period (days) |
body | text | No | Body |
owner_id | uuid | No | Owner |
cost_center_id | uuid | No | Cost center |
Sample body
{
"title": "Example",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contract_no": "CON-000001",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"template_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rfx_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"title": "Example",
"contract_type": "text",
"currency": "USD",
"total_value": "1250.00",
"committed_value": "1250.00",
"start_date": "2026-10-30",
"end_date": "2026-10-30",
"auto_renew": true
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"Example","supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/scm/contracts/{id}Delete a contracts
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/scm/contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/contracts/{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/scm/contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'POST/api/scm/contracts/{id}/authorAuthor
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):
valuesResponse
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/scm/contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/author" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"values":"value"}'POST/api/scm/contracts/{id}/signSign
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):
acceptDeviations, signedBy*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/scm/contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/sign" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"acceptDeviations":"value","signedBy":"value"}'GET/api/scm/contracts/{parentId}/clausesClauses
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/scm/contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/clauses" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/contracts/{parentId}/clausesClauses
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/scm/contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/clauses" \
-H "Authorization: Bearer $TOKEN"PUT/api/scm/contracts/{parentId}/clauses/{lineId}Clauses
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/scm/contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/clauses/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/scm/contracts/{parentId}/clauses/{lineId}Clauses
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/scm/contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/clauses/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/contracts/{parentId}/obligationsObligations
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/scm/contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/obligations" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/contracts/{parentId}/obligationsObligations
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/scm/contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/obligations" \
-H "Authorization: Bearer $TOKEN"PUT/api/scm/contracts/{parentId}/obligations/{lineId}Obligations
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/scm/contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/obligations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/scm/contracts/{parentId}/obligations/{lineId}Obligations
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/scm/contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/obligations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/contracts/{parentId}/pricesPrices
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/scm/contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/prices" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/contracts/{parentId}/pricesPrices
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/scm/contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/prices" \
-H "Authorization: Bearer $TOKEN"PUT/api/scm/contracts/{parentId}/prices/{lineId}Prices
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/scm/contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/prices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/scm/contracts/{parentId}/prices/{lineId}Prices
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/scm/contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/prices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a contracts, 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 |
contract_no | text | read only | Contract no |
supplier_id | uuid | read, write | Supplier — Required. Left empty on a contract raised from a sourcing event, it is the supplier the event was awarded to. |
template_id | uuid | read, write | Template |
rfx_id | uuid | read, write | From sourcing event |
parent_id | uuid | read, write | Under contract — A statement of work sits under its master agreement. |
title | text | read, write | Title |
contract_type | text | read, write | Type |
currency | text | read, write | Currency — Leave empty for the company's own currency. The list is kept under Accounting > Ledger > Ledgers & Principles > Currencies. |
total_value | numeric | read, write | Total value |
committed_value | numeric | read only | Committed value |
start_date | date | read, write | Starts |
end_date | date | read, write | Ends |
auto_renew | boolean | read, write | Renews automatically |
renewal_months | integer | read, write | Renewal term (months) |
notice_days | integer | read, write | Notice period (days) |
body | text | read, write | Body |
status | text | read only | Status |
owner_id | uuid | read, write | Owner |
cost_center_id | uuid | read, write | Cost center |
signed_at | timestamp with time zone | read only | Signed at |
signed_by | text | read only | Signed by |
terminated_at | timestamp with time zone | read only | Terminated at |
termination_reason | text | read only | Termination reason |
created_at | timestamp with time zone | read only | Created at |
org_unit_id | uuid | read only | Org unit id |
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 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
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 Supply Chain › Contracts 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.