Accounting · Settlement & Allocation
Settlement Rules
Where cost on a collector goes, and in what proportion. A period closed over unsettled orders leaves cost stranded forever.
/api/accounting/settlement-rulesPublished as /api/v1/settlement-rulesDownload specification (OpenAPI 3.1) Screen: Settlement Rules
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 › Settlement Rules 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.settlement_rules · 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
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/accounting/settlement-rulesList settlement rules
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",
"source_type": "production_order",
"source_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"line_no": 10,
"receiver_type": "cost_center",
"receiver_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"receiver_code": "REC-000001",
"basis": "percentage",
"percentage": "1250.00",
"equivalence": "1250.00",
"fixed_amount": "1250.00",
"cost_element_group": "text",
"settlement_type": "periodic"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/accounting/settlement-rules?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/settlement-rules/{id}Read one settlement rule
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",
"source_type": "production_order",
"source_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"line_no": 10,
"receiver_type": "cost_center",
"receiver_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"receiver_code": "REC-000001",
"basis": "percentage",
"percentage": "1250.00",
"equivalence": "1250.00",
"fixed_amount": "1250.00",
"cost_element_group": "text",
"settlement_type": "periodic"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/accounting/settlement-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/settlement-rulesCreate a settlement rule
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
source_type | text | Yes | Collector type Allowed: production_order internal_order project wbs_element work_order maintenance_order cost_center asset_under_construction |
source_id | uuid | Yes | Collector |
line_no | integer | No | Line |
receiver_type | text | Yes | Receiver type Allowed: cost_center profit_center gl_account asset project wbs_element profitability_segment order inventory customer |
receiver_id | uuid | No | Receiver |
receiver_code | text | No | Receiver code |
basis | text | No | Basis Allowed: percentage equivalence fixed_amount by_cost_element full |
percentage | numeric | No | Percentage |
equivalence | numeric | No | Equivalence number |
fixed_amount | numeric | No | Fixed amount |
cost_element_group | text | No | Cost element group |
settlement_type | text | No | Settlement type Allowed: periodic full partial final |
valid_from | date | No | From |
valid_to | date | No | To |
is_active | boolean | No | Active |
notes | text | No | Notes |
Sample body
{
"source_type": "production_order",
"source_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"receiver_type": "cost_center",
"line_no": 10,
"receiver_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"receiver_code": "REC-000001",
"basis": "percentage"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"source_type": "production_order",
"source_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"line_no": 10,
"receiver_type": "cost_center",
"receiver_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"receiver_code": "REC-000001",
"basis": "percentage",
"percentage": "1250.00",
"equivalence": "1250.00",
"fixed_amount": "1250.00",
"cost_element_group": "text",
"settlement_type": "periodic"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/settlement-rules" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"source_type":"production_order","source_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","receiver_type":"cost_center","line_no":10,"receiver_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","receiver_code":"REC-000001","basis":"percentage"}'PUT/api/accounting/settlement-rules/{id}Change a settlement rule
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 |
|---|---|---|---|
source_type | text | Yes | Collector type Allowed: production_order internal_order project wbs_element work_order maintenance_order cost_center asset_under_construction |
source_id | uuid | Yes | Collector |
line_no | integer | No | Line |
receiver_type | text | Yes | Receiver type Allowed: cost_center profit_center gl_account asset project wbs_element profitability_segment order inventory customer |
receiver_id | uuid | No | Receiver |
receiver_code | text | No | Receiver code |
basis | text | No | Basis Allowed: percentage equivalence fixed_amount by_cost_element full |
percentage | numeric | No | Percentage |
equivalence | numeric | No | Equivalence number |
fixed_amount | numeric | No | Fixed amount |
cost_element_group | text | No | Cost element group |
settlement_type | text | No | Settlement type Allowed: periodic full partial final |
valid_from | date | No | From |
valid_to | date | No | To |
is_active | boolean | No | Active |
notes | text | No | Notes |
Sample body
{
"source_type": "production_order",
"source_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"source_type": "production_order",
"source_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"line_no": 10,
"receiver_type": "cost_center",
"receiver_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"receiver_code": "REC-000001",
"basis": "percentage",
"percentage": "1250.00",
"equivalence": "1250.00",
"fixed_amount": "1250.00",
"cost_element_group": "text",
"settlement_type": "periodic"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/settlement-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"source_type":"production_order","source_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/accounting/settlement-rules/{id}Delete a settlement rule
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/settlement-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/settlement-rules/{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/settlement-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a settlement rule, 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 |
source_type | text | read, write | Collector type Allowed: production_order internal_order project wbs_element work_order maintenance_order cost_center asset_under_construction |
source_id | uuid | read, write | Collector |
line_no | integer | read, write | Line |
receiver_type | text | read, write | Receiver type Allowed: cost_center profit_center gl_account asset project wbs_element profitability_segment order inventory customer |
receiver_id | uuid | read, write | Receiver |
receiver_code | text | read, write | Receiver code |
basis | text | read, write | Basis Allowed: percentage equivalence fixed_amount by_cost_element full |
percentage | numeric | read, write | Percentage |
equivalence | numeric | read, write | Equivalence number |
fixed_amount | numeric | read, write | Fixed amount |
cost_element_group | text | read, write | Cost element group |
settlement_type | text | read, write | Settlement type Allowed: periodic full partial final |
valid_from | date | read, write | From |
valid_to | date | read, write | To |
is_active | boolean | read, write | Active |
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 |
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 › Settlement Rules 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.