TRANXACT.AI Help

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.

Type REST20 operationsBase path /api/scm/contractsPublished as /api/v1/contracts

Download specification (OpenAPI 3.1) Screen: Contracts

Overview

PackageSupply Chain
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tablescm.contracts · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
supplier_iduuidNoSupplier — Required. Left empty on a contract raised from a sourcing event, it is the supplier the event was awarded to.
template_iduuidNoTemplate
rfx_iduuidNoFrom sourcing event
parent_iduuidNoUnder contract — A statement of work sits under its master agreement.
titletextYesTitle
contract_typetextNoType
currencytextNoCurrency — Leave empty for the company's own currency. The list is kept under Accounting > Ledger > Ledgers & Principles > Currencies.
total_valuenumericNoTotal value
start_datedateNoStarts
end_datedateNoEnds
auto_renewbooleanNoRenews automatically
renewal_monthsintegerNoRenewal term (months)
notice_daysintegerNoNotice period (days)
bodytextNoBody
owner_iduuidNoOwner
cost_center_iduuidNoCost 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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
supplier_iduuidNoSupplier — Required. Left empty on a contract raised from a sourcing event, it is the supplier the event was awarded to.
template_iduuidNoTemplate
rfx_iduuidNoFrom sourcing event
parent_iduuidNoUnder contract — A statement of work sits under its master agreement.
titletextYesTitle
contract_typetextNoType
currencytextNoCurrency — Leave empty for the company's own currency. The list is kept under Accounting > Ledger > Ledgers & Principles > Currencies.
total_valuenumericNoTotal value
start_datedateNoStarts
end_datedateNoEnds
auto_renewbooleanNoRenews automatically
renewal_monthsintegerNoRenewal term (months)
notice_daysintegerNoNotice period (days)
bodytextNoBody
owner_iduuidNoOwner
cost_center_iduuidNoCost 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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

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/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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

values

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/author" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"values":"value"}'
POST/api/scm/contracts/{id}/signSign

Path parameters

NameTypeDescription
idstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
contract_notextread onlyContract no
supplier_iduuidread, writeSupplier — Required. Left empty on a contract raised from a sourcing event, it is the supplier the event was awarded to.
template_iduuidread, writeTemplate
rfx_iduuidread, writeFrom sourcing event
parent_iduuidread, writeUnder contract — A statement of work sits under its master agreement.
titletextread, writeTitle
contract_typetextread, writeType
currencytextread, writeCurrency — Leave empty for the company's own currency. The list is kept under Accounting > Ledger > Ledgers & Principles > Currencies.
total_valuenumericread, writeTotal value
committed_valuenumericread onlyCommitted value
start_datedateread, writeStarts
end_datedateread, writeEnds
auto_renewbooleanread, writeRenews automatically
renewal_monthsintegerread, writeRenewal term (months)
notice_daysintegerread, writeNotice period (days)
bodytextread, writeBody
statustextread onlyStatus
owner_iduuidread, writeOwner
cost_center_iduuidread, writeCost center
signed_attimestamp with time zoneread onlySigned at
signed_bytextread onlySigned by
terminated_attimestamp with time zoneread onlyTerminated at
termination_reasontextread onlyTermination reason
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Supply Chain › Contracts for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.