Accounting · Finance Intelligence
Risk Detectors
Each answers one question, is separately switchable and separately measured. A detector nobody can turn off is one that gets ignored wholesale the first time it is noisy.
/api/accounting/risk-detectorsPublished as /api/v1/risk-detectorsOverview
| 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 › Risk Detectors 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.risk_detectors · 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/risk-detectorsList risk detectors
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",
"code": "COD-000001",
"name": "Example",
"domain": "text",
"technique": "rule",
"execution": "realtime",
"runs_before_posting": true,
"action": "observe",
"severity_default": "critical",
"signal_threshold": "1250.00",
"case_threshold": "1250.00",
"amount_threshold": "1250.00",
"parameters": {}
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/accounting/risk-detectors?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/risk-detectors/{id}Read one risk detector
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",
"code": "COD-000001",
"name": "Example",
"domain": "text",
"technique": "rule",
"execution": "realtime",
"runs_before_posting": true,
"action": "observe",
"severity_default": "critical",
"signal_threshold": "1250.00",
"case_threshold": "1250.00",
"amount_threshold": "1250.00",
"parameters": {}
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/accounting/risk-detectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/risk-detectorsCreate a risk detector
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
domain | text | No | Domain |
technique | text | No | Technique Allowed: rule statistical benchmark pattern graph model llm ensemble |
execution | text | No | Execution Allowed: realtime near_realtime batch on_demand |
runs_before_posting | boolean | No | Runs before a posting |
action | text | No | May — Nothing above flag is enabled by default: a detector that blocks a payment on the day it is switched on is switched off the same afternoon. Allowed: observe flag warn hold block |
severity_default | text | No | Default severity Allowed: critical high medium low info |
signal_threshold | numeric | No | Raise a signal above |
case_threshold | numeric | No | Open a case above — Two thresholds, because most signals should never reach a person. |
amount_threshold | numeric | No | Amount threshold |
parameters | jsonb | No | Parameters |
rationale | text | No | What it looks for |
typical_cause | text | No | Typical cause |
suggested_action | text | No | Suggested action |
is_enabled | boolean | No | Enabled |
Sample body
{
"code": "COD-000001",
"name": "Example",
"domain": "text",
"technique": "rule",
"execution": "realtime",
"runs_before_posting": true
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"domain": "text",
"technique": "rule",
"execution": "realtime",
"runs_before_posting": true,
"action": "observe",
"severity_default": "critical",
"signal_threshold": "1250.00",
"case_threshold": "1250.00",
"amount_threshold": "1250.00",
"parameters": {}
}Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/risk-detectors" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","domain":"text","technique":"rule","execution":"realtime","runs_before_posting":true}'PUT/api/accounting/risk-detectors/{id}Change a risk detector
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 |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
domain | text | No | Domain |
technique | text | No | Technique Allowed: rule statistical benchmark pattern graph model llm ensemble |
execution | text | No | Execution Allowed: realtime near_realtime batch on_demand |
runs_before_posting | boolean | No | Runs before a posting |
action | text | No | May — Nothing above flag is enabled by default: a detector that blocks a payment on the day it is switched on is switched off the same afternoon. Allowed: observe flag warn hold block |
severity_default | text | No | Default severity Allowed: critical high medium low info |
signal_threshold | numeric | No | Raise a signal above |
case_threshold | numeric | No | Open a case above — Two thresholds, because most signals should never reach a person. |
amount_threshold | numeric | No | Amount threshold |
parameters | jsonb | No | Parameters |
rationale | text | No | What it looks for |
typical_cause | text | No | Typical cause |
suggested_action | text | No | Suggested action |
is_enabled | boolean | No | Enabled |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"domain": "text",
"technique": "rule",
"execution": "realtime",
"runs_before_posting": true,
"action": "observe",
"severity_default": "critical",
"signal_threshold": "1250.00",
"case_threshold": "1250.00",
"amount_threshold": "1250.00",
"parameters": {}
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/risk-detectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/accounting/risk-detectors/{id}Delete a risk detector
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/risk-detectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/risk-detectors/{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/risk-detectors/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 risk detector, 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 |
code | text | read, write | Code |
name | text | read, write | Name |
domain | text | read, write | Domain |
technique | text | read, write | Technique Allowed: rule statistical benchmark pattern graph model llm ensemble |
execution | text | read, write | Execution Allowed: realtime near_realtime batch on_demand |
runs_before_posting | boolean | read, write | Runs before a posting |
action | text | read, write | May — Nothing above flag is enabled by default: a detector that blocks a payment on the day it is switched on is switched off the same afternoon. Allowed: observe flag warn hold block |
severity_default | text | read, write | Default severity Allowed: critical high medium low info |
signal_threshold | numeric | read, write | Raise a signal above |
case_threshold | numeric | read, write | Open a case above — Two thresholds, because most signals should never reach a person. |
amount_threshold | numeric | read, write | Amount threshold |
parameters | jsonb | read, write | Parameters |
rationale | text | read, write | What it looks for |
typical_cause | text | read, write | Typical cause |
suggested_action | text | read, write | Suggested action |
signals_raised | integer | read only | Signals raised |
true_positives | integer | read only | True positives |
false_positives | integer | read only | False positives |
precision_pct | numeric | read only | Precision pct |
is_enabled | boolean | read, write | Enabled |
is_system | boolean | read only | Is system |
last_run_at | timestamp with time zone | read only | Last run at |
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 › Risk Detectors 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.