Accounting · Financial Controls
Control Register
Which controls we operate, who owns each, when it was last tested and what we are doing about the ones that failed. A different shape from an audit log, which records changes rather than assurance.
/api/accounting/financial-controlsPublished as /api/v1/financial-controlsDownload specification (OpenAPI 3.1) Screen: Control Register
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 › Control Register 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.financial_controls · 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/financial-controlsList control register
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",
"control_no": "CON-000001",
"name": "Example",
"framework_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"framework_ref": "text",
"process": "text",
"control_type": "text",
"nature": "manual",
"frequency": "continuous",
"is_key": true,
"risk_addressed": "text",
"assertion": "text",
"owner_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/accounting/financial-controls?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/financial-controls/{id}Read one financial control
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",
"control_no": "CON-000001",
"name": "Example",
"framework_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"framework_ref": "text",
"process": "text",
"control_type": "text",
"nature": "manual",
"frequency": "continuous",
"is_key": true,
"risk_addressed": "text",
"assertion": "text",
"owner_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/accounting/financial-controls/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/financial-controlsCreate a financial control
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
name | text | Yes | Name |
framework_id | uuid | No | Framework |
framework_ref | text | No | Framework reference |
process | text | No | Process |
control_type | text | No | Type — A framework made entirely of detective controls finds everything and prevents nothing. |
nature | text | No | Nature — Automated controls are tested once and rely on change management; manual ones on a sample every period. Allowed: manual automated it_dependent hybrid |
frequency | text | No | Frequency Allowed: continuous daily weekly monthly quarterly annual event_driven ad_hoc |
is_key | boolean | No | Key control — Its failure could cause a material misstatement. Marking everything key is how a framework becomes untestable. |
risk_addressed | text | No | Risk addressed |
assertion | text | No | Assertion — Existence, completeness, valuation, rights, presentation. |
owner_employee_id | uuid | No | Owner |
performer_employee_id | uuid | No | Performed by |
reviewer_employee_id | uuid | No | Reviewed by |
owner_role | text | No | Owner role |
module | text | No | Module |
resource | text | No | Screen |
system_rule | text | No | System rule |
enforced_by | text | No | Enforced in code by — Where the product itself refuses the thing, a test becomes "does that check still exist" rather than a sample of forty. |
design_description | text | No | Design |
operation_description | text | No | How it operates |
evidence_required | text | No | Evidence required |
effectiveness | text | No | Effectiveness |
last_tested_at | date | No | Last tested at |
next_test_due | date | No | Next test due |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"framework_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"framework_ref": "text",
"process": "text",
"control_type": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"control_no": "CON-000001",
"name": "Example",
"framework_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"framework_ref": "text",
"process": "text",
"control_type": "text",
"nature": "manual",
"frequency": "continuous",
"is_key": true,
"risk_addressed": "text",
"assertion": "text",
"owner_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/financial-controls" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","framework_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","framework_ref":"text","process":"text","control_type":"text"}'PUT/api/accounting/financial-controls/{id}Change a financial control
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 |
framework_id | uuid | No | Framework |
framework_ref | text | No | Framework reference |
process | text | No | Process |
control_type | text | No | Type — A framework made entirely of detective controls finds everything and prevents nothing. |
nature | text | No | Nature — Automated controls are tested once and rely on change management; manual ones on a sample every period. Allowed: manual automated it_dependent hybrid |
frequency | text | No | Frequency Allowed: continuous daily weekly monthly quarterly annual event_driven ad_hoc |
is_key | boolean | No | Key control — Its failure could cause a material misstatement. Marking everything key is how a framework becomes untestable. |
risk_addressed | text | No | Risk addressed |
assertion | text | No | Assertion — Existence, completeness, valuation, rights, presentation. |
owner_employee_id | uuid | No | Owner |
performer_employee_id | uuid | No | Performed by |
reviewer_employee_id | uuid | No | Reviewed by |
owner_role | text | No | Owner role |
module | text | No | Module |
resource | text | No | Screen |
system_rule | text | No | System rule |
enforced_by | text | No | Enforced in code by — Where the product itself refuses the thing, a test becomes "does that check still exist" rather than a sample of forty. |
design_description | text | No | Design |
operation_description | text | No | How it operates |
evidence_required | text | No | Evidence required |
effectiveness | text | No | Effectiveness |
last_tested_at | date | No | Last tested at |
next_test_due | date | No | Next test due |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"framework_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"control_no": "CON-000001",
"name": "Example",
"framework_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"framework_ref": "text",
"process": "text",
"control_type": "text",
"nature": "manual",
"frequency": "continuous",
"is_key": true,
"risk_addressed": "text",
"assertion": "text",
"owner_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/financial-controls/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","framework_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/accounting/financial-controls/{id}Delete a financial control
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/financial-controls/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/financial-controls/{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/financial-controls/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 financial control, 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 |
control_no | text | read only | Control no |
name | text | read, write | Name |
framework_id | uuid | read, write | Framework |
framework_ref | text | read, write | Framework reference |
process | text | read, write | Process |
control_type | text | read, write | Type — A framework made entirely of detective controls finds everything and prevents nothing. |
nature | text | read, write | Nature — Automated controls are tested once and rely on change management; manual ones on a sample every period. Allowed: manual automated it_dependent hybrid |
frequency | text | read, write | Frequency Allowed: continuous daily weekly monthly quarterly annual event_driven ad_hoc |
is_key | boolean | read, write | Key control — Its failure could cause a material misstatement. Marking everything key is how a framework becomes untestable. |
risk_addressed | text | read, write | Risk addressed |
assertion | text | read, write | Assertion — Existence, completeness, valuation, rights, presentation. |
owner_employee_id | uuid | read, write | Owner |
performer_employee_id | uuid | read, write | Performed by |
reviewer_employee_id | uuid | read, write | Reviewed by |
owner_role | text | read, write | Owner role |
module | text | read, write | Module |
resource | text | read, write | Screen |
system_rule | text | read, write | System rule |
enforced_by | text | read, write | Enforced in code by — Where the product itself refuses the thing, a test becomes "does that check still exist" rather than a sample of forty. |
design_description | text | read, write | Design |
operation_description | text | read, write | How it operates |
evidence_required | text | read, write | Evidence required |
effectiveness | text | read, write | Effectiveness |
last_tested_at | date | read, write | Last tested at |
next_test_due | date | read, write | Next test due |
status | text | read only | Status |
is_system | boolean | read only | Is system |
notes | text | read, write | Notes |
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 |
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 › Control Register 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.