TRANXACT.AI Help

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.

Type REST15 operationsBase path /api/accounting/rev-contractsPublished as /api/v1/rev-contracts

Download specification (OpenAPI 3.1) Screen: Revenue 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 › 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.
Tableacct.rev_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

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

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

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",
  "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.

FieldTypeRequiredDescription
nametextYesName
account_iduuidNoCustomer
opportunity_iduuidNoOpportunity
sales_order_iduuidNoSales order id
project_iduuidNoProject
contract_datedateNoContract date
start_datedateNoStart
end_datedateNoEnd
term_monthsintegerNoTerm (months)
currencytextNoCurrency
contract_valuenumericNoContract value
variable_considerationnumericNoVariable consideration — Included only to the extent it is highly probable.
constraint_amountnumericNoConstrained amount
refund_liabilitynumericNoExpected refunds
has_financing_componentbooleanNoSignificant financing component — Money received a year before delivery carries interest, and the standard separates it from revenue.
financing_rate_pctnumericNoFinancing rate %
commission_amountnumericNoCommission (cost to obtain)
fulfilment_costnumericNoFulfilment cost
principle_iduuidNoAccounting principle
notestextNoNotes

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

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
account_iduuidNoCustomer
opportunity_iduuidNoOpportunity
sales_order_iduuidNoSales order id
project_iduuidNoProject
contract_datedateNoContract date
start_datedateNoStart
end_datedateNoEnd
term_monthsintegerNoTerm (months)
currencytextNoCurrency
contract_valuenumericNoContract value
variable_considerationnumericNoVariable consideration — Included only to the extent it is highly probable.
constraint_amountnumericNoConstrained amount
refund_liabilitynumericNoExpected refunds
has_financing_componentbooleanNoSignificant financing component — Money received a year before delivery carries interest, and the standard separates it from revenue.
financing_rate_pctnumericNoFinancing rate %
commission_amountnumericNoCommission (cost to obtain)
fulfilment_costnumericNoFulfilment cost
principle_iduuidNoAccounting principle
notestextNoNotes

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

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

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

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

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

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/accounting/rev-contracts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/billings" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/accounting/rev-contracts/{parentId}/billings/{lineId}Billings

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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
contract_notextread onlyContract no
nametextread, writeName
account_iduuidread, writeCustomer
opportunity_iduuidread, writeOpportunity
sales_order_iduuidread, writeSales order id
project_iduuidread, writeProject
contract_datedateread, writeContract date
start_datedateread, writeStart
end_datedateread, writeEnd
term_monthsintegerread, writeTerm (months)
currencytextread, writeCurrency
contract_valuenumericread, writeContract value
variable_considerationnumericread, writeVariable consideration — Included only to the extent it is highly probable.
constraint_amountnumericread, writeConstrained amount
refund_liabilitynumericread, writeExpected refunds
transaction_pricenumericread onlyTransaction price
has_financing_componentbooleanread, writeSignificant financing component — Money received a year before delivery carries interest, and the standard separates it from revenue.
financing_rate_pctnumericread, writeFinancing rate %
commission_amountnumericread, writeCommission (cost to obtain)
fulfilment_costnumericread, writeFulfilment cost
modifies_contract_iduuidread onlyModifies contract id
modification_typetextread onlyModification type
versionintegerread onlyVersion
statustextread onlyStatus
allocated_attimestamp with time zoneread onlyAllocated at
allocated_byuuidread onlyAllocated by
principle_iduuidread, writeAccounting principle
notestextread, writeNotes
created_byuuidread onlyCreated by
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
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
completed_byuuidread onlyCompleted by
completed_attimestamp with time zoneread onlyCompleted at

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 › Revenue 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.