Accounting · Revenue Recognition
Performance Obligations
A promise that is distinct. Three lines on an order can be one obligation, and one line can be three — and the allocation moves money between them.
/api/accounting/rev-obligationsPublished as /api/v1/rev-obligationsDownload specification (OpenAPI 3.1) Screen: Performance Obligations
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 › Performance Obligations 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_obligations · 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
7 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/accounting/rev-obligationsList performance obligations
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_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"line_no": 10,
"name": "Example",
"template_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"obligation_type": "text",
"quantity": "12.0000",
"contract_price": "1250.00",
"ssp_unit": "1250.00",
"ssp_total": "1250.00",
"ssp_method": "text",
"timing": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/accounting/rev-obligations?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/rev-obligations/{id}Read one performance obligation
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_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"line_no": 10,
"name": "Example",
"template_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"obligation_type": "text",
"quantity": "12.0000",
"contract_price": "1250.00",
"ssp_unit": "1250.00",
"ssp_total": "1250.00",
"ssp_method": "text",
"timing": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/accounting/rev-obligations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/rev-obligationsCreate a performance obligation
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
contract_id | uuid | Yes | Contract |
line_no | integer | No | Line |
name | text | Yes | Name |
template_id | uuid | No | Template |
item_id | uuid | No | Item |
obligation_type | text | No | Type |
quantity | numeric | No | Quantity |
contract_price | numeric | No | Price on the order |
ssp_unit | numeric | No | Standalone price per unit |
ssp_total | numeric | No | Standalone price total |
ssp_method | text | No | Ssp method |
timing | text | No | Timing |
measure | text | No | Progress measure |
start_date | date | No | Start |
end_date | date | No | End |
term_months | integer | No | Term (months) |
estimated_cost | numeric | No | Estimated cost |
actual_cost | numeric | No | Actual cost |
units_total | numeric | No | Units total |
units_delivered | numeric | No | Units delivered |
percent_complete | numeric | No | Percent complete |
satisfied_date | date | No | Satisfied on |
revenue_account_id | uuid | No | Revenue account |
deferred_account_id | uuid | No | Deferred revenue account |
cost_center_id | uuid | No | Cost center |
is_distinct | boolean | No | Distinct |
combined_with_id | uuid | No | Combined with id |
notes | text | No | Notes |
Sample body
{
"contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"name": "Example",
"line_no": 10,
"template_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"obligation_type": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"line_no": 10,
"name": "Example",
"template_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"obligation_type": "text",
"quantity": "12.0000",
"contract_price": "1250.00",
"ssp_unit": "1250.00",
"ssp_total": "1250.00",
"ssp_method": "text",
"timing": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/rev-obligations" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"contract_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","name":"Example","line_no":10,"template_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","obligation_type":"text"}'PUT/api/accounting/rev-obligations/{id}Change a performance obligation
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 |
|---|---|---|---|
contract_id | uuid | Yes | Contract |
line_no | integer | No | Line |
name | text | Yes | Name |
template_id | uuid | No | Template |
item_id | uuid | No | Item |
obligation_type | text | No | Type |
quantity | numeric | No | Quantity |
contract_price | numeric | No | Price on the order |
ssp_unit | numeric | No | Standalone price per unit |
ssp_total | numeric | No | Standalone price total |
ssp_method | text | No | Ssp method |
timing | text | No | Timing |
measure | text | No | Progress measure |
start_date | date | No | Start |
end_date | date | No | End |
term_months | integer | No | Term (months) |
estimated_cost | numeric | No | Estimated cost |
actual_cost | numeric | No | Actual cost |
units_total | numeric | No | Units total |
units_delivered | numeric | No | Units delivered |
percent_complete | numeric | No | Percent complete |
satisfied_date | date | No | Satisfied on |
revenue_account_id | uuid | No | Revenue account |
deferred_account_id | uuid | No | Deferred revenue account |
cost_center_id | uuid | No | Cost center |
is_distinct | boolean | No | Distinct |
combined_with_id | uuid | No | Combined with id |
notes | text | No | Notes |
Sample body
{
"contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"line_no": 10,
"name": "Example",
"template_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"obligation_type": "text",
"quantity": "12.0000",
"contract_price": "1250.00",
"ssp_unit": "1250.00",
"ssp_total": "1250.00",
"ssp_method": "text",
"timing": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/rev-obligations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"contract_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","name":"Example"}'DELETE/api/accounting/rev-obligations/{id}Delete a performance obligation
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-obligations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/rev-obligations/{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-obligations/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-obligations/{id}/satisfySatisfy
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-obligations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/satisfy" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a performance obligation, 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_id | uuid | read, write | Contract |
line_no | integer | read, write | Line |
name | text | read, write | Name |
template_id | uuid | read, write | Template |
item_id | uuid | read, write | Item |
obligation_type | text | read, write | Type |
quantity | numeric | read, write | Quantity |
contract_price | numeric | read, write | Price on the order |
ssp_unit | numeric | read, write | Standalone price per unit |
ssp_total | numeric | read, write | Standalone price total |
ssp_method | text | read, write | Ssp method |
timing | text | read, write | Timing |
measure | text | read, write | Progress measure |
start_date | date | read, write | Start |
end_date | date | read, write | End |
term_months | integer | read, write | Term (months) |
estimated_cost | numeric | read, write | Estimated cost |
actual_cost | numeric | read, write | Actual cost |
units_total | numeric | read, write | Units total |
units_delivered | numeric | read, write | Units delivered |
percent_complete | numeric | read, write | Percent complete |
satisfied_date | date | read, write | Satisfied on |
revenue_account_id | uuid | read, write | Revenue account |
deferred_account_id | uuid | read, write | Deferred revenue account |
cost_center_id | uuid | read, write | Cost center |
status | text | read only | Status |
is_distinct | boolean | read, write | Distinct |
combined_with_id | uuid | read, write | Combined with id |
notes | text | read, write | Notes |
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_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
satisfied_by | uuid | read only | Satisfied by |
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 › Performance Obligations 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.