TRANXACT.AI Help

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.

Type REST14 operationsBase path /api/accounting/job-contractsPublished as /api/v1/job-contracts

Download specification (OpenAPI 3.1) Screen: Job Contracts

Overview

PackageAccounting
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 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.
Tableacct.job_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

14 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/accounting/job-contractsList job 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",
      "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

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

FieldTypeRequiredDescription
nametextYesName
project_iduuidNoProject
account_iduuidNoCustomer
rev_contract_iduuidNoRevenue contract
contract_typetextNoType
start_datedateNoStart
end_datedateNoEnd
currencytextNoCurrency
contract_valuenumericNoContract value
variation_valuenumericNoVariations — The reality of construction, and what makes the original value meaningless by month four.
estimated_costnumericNoEstimated total cost
retention_pctnumericNoRetention %
retention_heldnumericNoRetention held
retention_release_datedateNoRetention released on
advance_paymentnumericNoAdvance payment
advance_recoverednumericNoAdvance recovered
performance_bondnumericNoPerformance bond
liquidated_damages_ratenumericNoLiquidated damages rate
progress_methodtextNoProgress method
Allowed: Cost to cost Effort (hours) Milestones Units completed Physical progress Entered by hand
notestextNoNotes

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

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
nametextYesName
project_iduuidNoProject
account_iduuidNoCustomer
rev_contract_iduuidNoRevenue contract
contract_typetextNoType
start_datedateNoStart
end_datedateNoEnd
currencytextNoCurrency
contract_valuenumericNoContract value
variation_valuenumericNoVariations — The reality of construction, and what makes the original value meaningless by month four.
estimated_costnumericNoEstimated total cost
retention_pctnumericNoRetention %
retention_heldnumericNoRetention held
retention_release_datedateNoRetention released on
advance_paymentnumericNoAdvance payment
advance_recoverednumericNoAdvance recovered
performance_bondnumericNoPerformance bond
liquidated_damages_ratenumericNoLiquidated damages rate
progress_methodtextNoProgress method
Allowed: Cost to cost Effort (hours) Milestones Units completed Physical progress Entered by hand
notestextNoNotes

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

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/accounting/job-contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/job-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/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

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

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

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):

reason

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/suspend" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"value"}'
POST/api/accounting/job-contracts/{id}/practical-completionPractical completion

Path parameters

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

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

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

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

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):

reason

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
contract_notextread onlyContract no
nametextread, writeName
project_iduuidread, writeProject
account_iduuidread, writeCustomer
rev_contract_iduuidread, writeRevenue contract
contract_typetextread, writeType
start_datedateread, writeStart
end_datedateread, writeEnd
currencytextread, writeCurrency
contract_valuenumericread, writeContract value
variation_valuenumericread, writeVariations — The reality of construction, and what makes the original value meaningless by month four.
revised_valuenumericread onlyRevised value
estimated_costnumericread, writeEstimated total cost
retention_pctnumericread, writeRetention %
retention_heldnumericread, writeRetention held
retention_release_datedateread, writeRetention released on
advance_paymentnumericread, writeAdvance payment
advance_recoverednumericread, writeAdvance recovered
performance_bondnumericread, writePerformance bond
liquidated_damages_ratenumericread, writeLiquidated damages rate
progress_methodtextread, writeProgress method
Allowed: Cost to cost Effort (hours) Milestones Units completed Physical progress Entered by hand
statustextread onlyStatus
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
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
awarded_attimestamp with time zoneread onlyAwarded at
status_reasontextread onlyStatus reason

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 Accounting › Job 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.