Accounting · Revenue Recognition
Revenue Contracts
Invoicing and revenue are not the same event, and this is where the difference is held. Allocation is a decision; the schedule is its consequence.
/api/accounting/rev-contractsPublished as /api/v1/rev-contractsDownload specification (OpenAPI 3.1) Screen: Revenue Contracts
Overview
| 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 › Revenue 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.rev_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
15 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/accounting/rev-contractsList revenue 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",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contract_date": "2026-10-30",
"start_date": "2026-10-30",
"end_date": "2026-10-30",
"term_months": 10,
"currency": "USD",
"contract_value": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/accounting/rev-contracts?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/rev-contracts/{id}Read one revenue 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",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contract_date": "2026-10-30",
"start_date": "2026-10-30",
"end_date": "2026-10-30",
"term_months": 10,
"currency": "USD",
"contract_value": "1250.00"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/accounting/rev-contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/rev-contractsCreate a revenue contract
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
name | text | Yes | Name |
account_id | uuid | No | Customer |
opportunity_id | uuid | No | Opportunity |
sales_order_id | uuid | No | Sales order id |
project_id | uuid | No | Project |
contract_date | date | No | Contract date |
start_date | date | No | Start |
end_date | date | No | End |
term_months | integer | No | Term (months) |
currency | text | No | Currency |
contract_value | numeric | No | Contract value |
variable_consideration | numeric | No | Variable consideration — Included only to the extent it is highly probable. |
constraint_amount | numeric | No | Constrained amount |
refund_liability | numeric | No | Expected refunds |
has_financing_component | boolean | No | Significant financing component — Money received a year before delivery carries interest, and the standard separates it from revenue. |
financing_rate_pct | numeric | No | Financing rate % |
commission_amount | numeric | No | Commission (cost to obtain) |
fulfilment_cost | numeric | No | Fulfilment cost |
principle_id | uuid | No | Accounting principle |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contract_no": "CON-000001",
"name": "Example",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contract_date": "2026-10-30",
"start_date": "2026-10-30",
"end_date": "2026-10-30",
"term_months": 10,
"currency": "USD",
"contract_value": "1250.00"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/rev-contracts" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","opportunity_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","sales_order_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","project_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/accounting/rev-contracts/{id}Change a revenue 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 |
account_id | uuid | No | Customer |
opportunity_id | uuid | No | Opportunity |
sales_order_id | uuid | No | Sales order id |
project_id | uuid | No | Project |
contract_date | date | No | Contract date |
start_date | date | No | Start |
end_date | date | No | End |
term_months | integer | No | Term (months) |
currency | text | No | Currency |
contract_value | numeric | No | Contract value |
variable_consideration | numeric | No | Variable consideration — Included only to the extent it is highly probable. |
constraint_amount | numeric | No | Constrained amount |
refund_liability | numeric | No | Expected refunds |
has_financing_component | boolean | No | Significant financing component — Money received a year before delivery carries interest, and the standard separates it from revenue. |
financing_rate_pct | numeric | No | Financing rate % |
commission_amount | numeric | No | Commission (cost to obtain) |
fulfilment_cost | numeric | No | Fulfilment cost |
principle_id | uuid | No | Accounting principle |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"account_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",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contract_date": "2026-10-30",
"start_date": "2026-10-30",
"end_date": "2026-10-30",
"term_months": 10,
"currency": "USD",
"contract_value": "1250.00"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/rev-contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/accounting/rev-contracts/{id}Delete a revenue 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/rev-contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/rev-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/rev-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/rev-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/rev-contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/complete" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/rev-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/accounting/rev-contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/obligations" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/rev-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/accounting/rev-contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/obligations" \
-H "Authorization: Bearer $TOKEN"PUT/api/accounting/rev-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/accounting/rev-contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/obligations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/accounting/rev-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/accounting/rev-contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/obligations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/rev-contracts/{parentId}/billingsBillings
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/accounting/rev-contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/billings" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/rev-contracts/{parentId}/billingsBillings
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/accounting/rev-contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/billings" \
-H "Authorization: Bearer $TOKEN"PUT/api/accounting/rev-contracts/{parentId}/billings/{lineId}Billings
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/accounting/rev-contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/billings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/accounting/rev-contracts/{parentId}/billings/{lineId}Billings
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/accounting/rev-contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/billings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a revenue 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 |
account_id | uuid | read, write | Customer |
opportunity_id | uuid | read, write | Opportunity |
sales_order_id | uuid | read, write | Sales order id |
project_id | uuid | read, write | Project |
contract_date | date | read, write | Contract date |
start_date | date | read, write | Start |
end_date | date | read, write | End |
term_months | integer | read, write | Term (months) |
currency | text | read, write | Currency |
contract_value | numeric | read, write | Contract value |
variable_consideration | numeric | read, write | Variable consideration — Included only to the extent it is highly probable. |
constraint_amount | numeric | read, write | Constrained amount |
refund_liability | numeric | read, write | Expected refunds |
transaction_price | numeric | read only | Transaction price |
has_financing_component | boolean | read, write | Significant financing component — Money received a year before delivery carries interest, and the standard separates it from revenue. |
financing_rate_pct | numeric | read, write | Financing rate % |
commission_amount | numeric | read, write | Commission (cost to obtain) |
fulfilment_cost | numeric | read, write | Fulfilment cost |
modifies_contract_id | uuid | read only | Modifies contract id |
modification_type | text | read only | Modification type |
version | integer | read only | Version |
status | text | read only | Status |
allocated_at | timestamp with time zone | read only | Allocated at |
allocated_by | uuid | read only | Allocated by |
principle_id | uuid | read, write | Accounting principle |
notes | text | read, write | Notes |
created_by | uuid | read only | Created by |
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 |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
completed_by | uuid | read only | Completed by |
completed_at | timestamp with time zone | read only | Completed at |
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 › Revenue 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.