Accounting · Financial Controls
Deficiencies
The three levels are not synonyms: a material weakness has to be disclosed. A finding with no owner and no date is a finding that reappears next year.
/api/accounting/control-deficienciesPublished as /api/v1/control-deficienciesOverview
| 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 › Deficiencies 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.control_deficiencies · 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/control-deficienciesList deficiencies
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",
"deficiency_no": "DEF-000001",
"control_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"test_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"title": "Example",
"severity": "text",
"source": "internal_test",
"identified_at": "2026-10-30",
"description": "text",
"root_cause": "text",
"potential_impact": "text",
"impact_amount": "1250.00",
"remediation_plan": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/accounting/control-deficiencies?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/control-deficiencies/{id}Read one control deficiency
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",
"deficiency_no": "DEF-000001",
"control_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"test_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"title": "Example",
"severity": "text",
"source": "internal_test",
"identified_at": "2026-10-30",
"description": "text",
"root_cause": "text",
"potential_impact": "text",
"impact_amount": "1250.00",
"remediation_plan": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/accounting/control-deficiencies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/control-deficienciesCreate a control deficiency
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
control_id | uuid | No | Control |
test_id | uuid | No | Test id |
title | text | Yes | Title |
severity | text | No | Severity |
source | text | No | Source Allowed: internal_test internal_audit external_audit self_reported incident regulator continuous_monitoring |
identified_at | date | No | Identified |
description | text | No | Description |
root_cause | text | No | Root cause |
potential_impact | text | No | Potential impact |
impact_amount | numeric | No | Impact amount |
remediation_plan | text | No | Remediation plan |
owner_employee_id | uuid | No | Owner |
target_date | date | No | Target date |
compensating_control_id | uuid | No | Compensating control — What makes a deficiency survivable until it is fixed, and naming it is part of the assessment. |
remediated_at | date | No | Remediated on |
validated_by | uuid | No | Validated by |
notes | text | No | Notes |
Sample body
{
"title": "Example",
"control_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"test_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"severity": "text",
"source": "internal_test"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"deficiency_no": "DEF-000001",
"control_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"test_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"title": "Example",
"severity": "text",
"source": "internal_test",
"identified_at": "2026-10-30",
"description": "text",
"root_cause": "text",
"potential_impact": "text",
"impact_amount": "1250.00",
"remediation_plan": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/control-deficiencies" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"Example","control_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","test_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","severity":"text","source":"internal_test"}'PUT/api/accounting/control-deficiencies/{id}Change a control deficiency
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 |
|---|---|---|---|
control_id | uuid | No | Control |
test_id | uuid | No | Test id |
title | text | Yes | Title |
severity | text | No | Severity |
source | text | No | Source Allowed: internal_test internal_audit external_audit self_reported incident regulator continuous_monitoring |
identified_at | date | No | Identified |
description | text | No | Description |
root_cause | text | No | Root cause |
potential_impact | text | No | Potential impact |
impact_amount | numeric | No | Impact amount |
remediation_plan | text | No | Remediation plan |
owner_employee_id | uuid | No | Owner |
target_date | date | No | Target date |
compensating_control_id | uuid | No | Compensating control — What makes a deficiency survivable until it is fixed, and naming it is part of the assessment. |
remediated_at | date | No | Remediated on |
validated_by | uuid | No | Validated by |
notes | text | No | Notes |
Sample body
{
"title": "Example",
"control_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"deficiency_no": "DEF-000001",
"control_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"test_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"title": "Example",
"severity": "text",
"source": "internal_test",
"identified_at": "2026-10-30",
"description": "text",
"root_cause": "text",
"potential_impact": "text",
"impact_amount": "1250.00",
"remediation_plan": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/control-deficiencies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"Example","control_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/accounting/control-deficiencies/{id}Delete a control deficiency
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/control-deficiencies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/control-deficiencies/{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/control-deficiencies/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 control deficiency, 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 |
deficiency_no | text | read only | Deficiency no |
control_id | uuid | read, write | Control |
test_id | uuid | read, write | Test id |
title | text | read, write | Title |
severity | text | read, write | Severity |
source | text | read, write | Source Allowed: internal_test internal_audit external_audit self_reported incident regulator continuous_monitoring |
identified_at | date | read, write | Identified |
description | text | read, write | Description |
root_cause | text | read, write | Root cause |
potential_impact | text | read, write | Potential impact |
impact_amount | numeric | read, write | Impact amount |
remediation_plan | text | read, write | Remediation plan |
owner_employee_id | uuid | read, write | Owner |
target_date | date | read, write | Target date |
compensating_control_id | uuid | read, write | Compensating control — What makes a deficiency survivable until it is fixed, and naming it is part of the assessment. |
status | text | read only | Status |
remediated_at | date | read, write | Remediated on |
validated_by | uuid | read, write | Validated by |
validated_at | timestamp with time zone | read only | Validated at |
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 › Deficiencies 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.