Accounting · Contract Costing
Job Contracts
Fixed price, progress by cost-to-cost, retention held back, and the full expected loss taken the moment it is foreseen — the one asymmetry in the standard and the one most often missed.
/api/accounting/job-contractsPublished as /api/v1/job-contractsOverview
| Package | Accounting |
|---|---|
| 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 Accounting › Job 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 | acct.job_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
14 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/accounting/job-contractsList job 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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contract_no": "CON-000001",
"name": "Example",
"project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rev_contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contract_type": "text",
"start_date": "2026-10-30",
"end_date": "2026-10-30",
"currency": "USD",
"contract_value": "1250.00",
"variation_value": "1250.00",
"revised_value": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/accounting/job-contracts?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/job-contracts/{id}Read one job contract
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",
"contract_no": "CON-000001",
"name": "Example",
"project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rev_contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contract_type": "text",
"start_date": "2026-10-30",
"end_date": "2026-10-30",
"currency": "USD",
"contract_value": "1250.00",
"variation_value": "1250.00",
"revised_value": "1250.00"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/accounting/job-contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/job-contractsCreate a job contract
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
name | text | Yes | Name |
project_id | uuid | No | Project |
account_id | uuid | No | Customer |
rev_contract_id | uuid | No | Revenue contract |
contract_type | text | No | Type |
start_date | date | No | Start |
end_date | date | No | End |
currency | text | No | Currency |
contract_value | numeric | No | Contract value |
variation_value | numeric | No | Variations — The reality of construction, and what makes the original value meaningless by month four. |
estimated_cost | numeric | No | Estimated total cost |
retention_pct | numeric | No | Retention % |
retention_held | numeric | No | Retention held |
retention_release_date | date | No | Retention released on |
advance_payment | numeric | No | Advance payment |
advance_recovered | numeric | No | Advance recovered |
performance_bond | numeric | No | Performance bond |
liquidated_damages_rate | numeric | No | Liquidated damages rate |
progress_method | text | No | Progress method Allowed: Cost to cost Effort (hours) Milestones Units completed Physical progress Entered by hand |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rev_contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contract_type": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contract_no": "CON-000001",
"name": "Example",
"project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rev_contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contract_type": "text",
"start_date": "2026-10-30",
"end_date": "2026-10-30",
"currency": "USD",
"contract_value": "1250.00",
"variation_value": "1250.00",
"revised_value": "1250.00"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/job-contracts" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","project_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","rev_contract_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","contract_type":"text"}'PUT/api/accounting/job-contracts/{id}Change a job contract
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 |
|---|---|---|---|
name | text | Yes | Name |
project_id | uuid | No | Project |
account_id | uuid | No | Customer |
rev_contract_id | uuid | No | Revenue contract |
contract_type | text | No | Type |
start_date | date | No | Start |
end_date | date | No | End |
currency | text | No | Currency |
contract_value | numeric | No | Contract value |
variation_value | numeric | No | Variations — The reality of construction, and what makes the original value meaningless by month four. |
estimated_cost | numeric | No | Estimated total cost |
retention_pct | numeric | No | Retention % |
retention_held | numeric | No | Retention held |
retention_release_date | date | No | Retention released on |
advance_payment | numeric | No | Advance payment |
advance_recovered | numeric | No | Advance recovered |
performance_bond | numeric | No | Performance bond |
liquidated_damages_rate | numeric | No | Liquidated damages rate |
progress_method | text | No | Progress method Allowed: Cost to cost Effort (hours) Milestones Units completed Physical progress Entered by hand |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contract_no": "CON-000001",
"name": "Example",
"project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rev_contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contract_type": "text",
"start_date": "2026-10-30",
"end_date": "2026-10-30",
"currency": "USD",
"contract_value": "1250.00",
"variation_value": "1250.00",
"revised_value": "1250.00"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/job-contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","project_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/accounting/job-contracts/{id}Delete a job contract
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/accounting/job-contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/job-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/accounting/job-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/accounting/job-contracts/{id}/awardAward
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, 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/accounting/job-contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/award" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/job-contracts/{id}/activateActivate
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, 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/accounting/job-contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/activate" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/job-contracts/{id}/suspendSuspend
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):
reasonResponse
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/accounting/job-contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/suspend" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'POST/api/accounting/job-contracts/{id}/practical-completionPractical completion
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, 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/accounting/job-contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/practical-completion" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/job-contracts/{id}/defects-liabilityDefects liability
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, 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/accounting/job-contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/defects-liability" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/job-contracts/{id}/completeComplete
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, 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/accounting/job-contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/complete" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/job-contracts/{id}/closeClose
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, 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/accounting/job-contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/close" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/job-contracts/{id}/terminateTerminate
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):
reasonResponse
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/accounting/job-contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/terminate" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'Data model
Every field of a job contract, 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 |
contract_no | text | read only | Contract no |
name | text | read, write | Name |
project_id | uuid | read, write | Project |
account_id | uuid | read, write | Customer |
rev_contract_id | uuid | read, write | Revenue contract |
contract_type | text | read, write | Type |
start_date | date | read, write | Start |
end_date | date | read, write | End |
currency | text | read, write | Currency |
contract_value | numeric | read, write | Contract value |
variation_value | numeric | read, write | Variations — The reality of construction, and what makes the original value meaningless by month four. |
revised_value | numeric | read only | Revised value |
estimated_cost | numeric | read, write | Estimated total cost |
retention_pct | numeric | read, write | Retention % |
retention_held | numeric | read, write | Retention held |
retention_release_date | date | read, write | Retention released on |
advance_payment | numeric | read, write | Advance payment |
advance_recovered | numeric | read, write | Advance recovered |
performance_bond | numeric | read, write | Performance bond |
liquidated_damages_rate | numeric | read, write | Liquidated damages rate |
progress_method | text | read, write | Progress method Allowed: Cost to cost Effort (hours) Milestones Units completed Physical progress Entered by hand |
status | text | read only | Status |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
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 |
awarded_at | timestamp with time zone | read only | Awarded at |
status_reason | text | read only | Status reason |
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 Accounting › Job 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.