Accounting · Finance Intelligence
Risk Cases
A person’s queue, with an outcome. The outcome is what closes the loop: confirmed fraud and dismissed noise are both training data, and a system that does not record which cannot improve.
/api/accounting/risk-casesPublished as /api/v1/risk-casesOverview
| 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 Cases 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_cases · 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
10 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/accounting/risk-casesList risk cases
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",
"case_no": "CAS-000001",
"title": "Example",
"domain": "text",
"case_type": "text",
"severity": "critical",
"priority": 10,
"amount_at_risk": "1250.00",
"currency": "USD",
"subject_type": "text",
"subject_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/accounting/risk-cases?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/risk-cases/{id}Read one risk case
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",
"case_no": "CAS-000001",
"title": "Example",
"domain": "text",
"case_type": "text",
"severity": "critical",
"priority": 10,
"amount_at_risk": "1250.00",
"currency": "USD",
"subject_type": "text",
"subject_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_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/risk-cases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/risk-casesCreate a risk case
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
title | text | Yes | Title |
domain | text | No | Domain |
case_type | text | No | Type |
severity | text | No | Severity Allowed: critical high medium low info |
priority | integer | No | Priority |
amount_at_risk | numeric | No | Amount at risk |
currency | text | No | Currency |
subject_type | text | No | Subject type |
subject_id | uuid | No | Subject id |
supplier_id | uuid | No | Supplier |
account_id | uuid | No | Customer |
employee_id | uuid | No | Employee |
assigned_to | uuid | No | Assigned to |
due_date | date | No | Due |
outcome | text | No | Outcome |
outcome_notes | text | No | Outcome notes |
recovered_amount | numeric | No | Recovered amount |
loss_amount | numeric | No | Loss amount |
remediation | text | No | Remediation |
deficiency_id | uuid | No | Deficiency id |
reported_externally | boolean | No | Reported externally |
reported_to | text | No | Reported to |
Sample body
{
"title": "Example",
"domain": "text",
"case_type": "text",
"severity": "critical",
"priority": 10
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"case_no": "CAS-000001",
"title": "Example",
"domain": "text",
"case_type": "text",
"severity": "critical",
"priority": 10,
"amount_at_risk": "1250.00",
"currency": "USD",
"subject_type": "text",
"subject_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/risk-cases" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"Example","domain":"text","case_type":"text","severity":"critical","priority":10}'PUT/api/accounting/risk-cases/{id}Change a risk case
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 |
|---|---|---|---|
title | text | Yes | Title |
domain | text | No | Domain |
case_type | text | No | Type |
severity | text | No | Severity Allowed: critical high medium low info |
priority | integer | No | Priority |
amount_at_risk | numeric | No | Amount at risk |
currency | text | No | Currency |
subject_type | text | No | Subject type |
subject_id | uuid | No | Subject id |
supplier_id | uuid | No | Supplier |
account_id | uuid | No | Customer |
employee_id | uuid | No | Employee |
assigned_to | uuid | No | Assigned to |
due_date | date | No | Due |
outcome | text | No | Outcome |
outcome_notes | text | No | Outcome notes |
recovered_amount | numeric | No | Recovered amount |
loss_amount | numeric | No | Loss amount |
remediation | text | No | Remediation |
deficiency_id | uuid | No | Deficiency id |
reported_externally | boolean | No | Reported externally |
reported_to | text | No | Reported to |
Sample body
{
"title": "Example",
"domain": "text"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"case_no": "CAS-000001",
"title": "Example",
"domain": "text",
"case_type": "text",
"severity": "critical",
"priority": 10,
"amount_at_risk": "1250.00",
"currency": "USD",
"subject_type": "text",
"subject_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/risk-cases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"Example","domain":"text"}'DELETE/api/accounting/risk-cases/{id}Delete a risk case
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-cases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/risk-cases/{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-cases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'GET/api/accounting/risk-cases/{parentId}/actionsActions
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/accounting/risk-cases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/actions" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/risk-cases/{parentId}/actionsActions
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, 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/risk-cases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/actions" \
-H "Authorization: Bearer $TOKEN"PUT/api/accounting/risk-cases/{parentId}/actions/{lineId}Actions
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, 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 PUT "https://demo.tranxact.ai/api/accounting/risk-cases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/actions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/accounting/risk-cases/{parentId}/actions/{lineId}Actions
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, 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 DELETE "https://demo.tranxact.ai/api/accounting/risk-cases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/actions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a risk case, 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 |
case_no | text | read only | Case no |
title | text | read, write | Title |
domain | text | read, write | Domain |
case_type | text | read, write | Type |
severity | text | read, write | Severity Allowed: critical high medium low info |
priority | integer | read, write | Priority |
amount_at_risk | numeric | read, write | Amount at risk |
currency | text | read, write | Currency |
subject_type | text | read, write | Subject type |
subject_id | uuid | read, write | Subject id |
supplier_id | uuid | read, write | Supplier |
account_id | uuid | read, write | Customer |
employee_id | uuid | read, write | Employee |
assigned_to | uuid | read, write | Assigned to |
assigned_at | timestamp with time zone | read only | Assigned at |
due_date | date | read, write | Due |
status | text | read only | Status |
outcome | text | read, write | Outcome |
outcome_notes | text | read, write | Outcome notes |
recovered_amount | numeric | read, write | Recovered amount |
loss_amount | numeric | read, write | Loss amount |
remediation | text | read, write | Remediation |
deficiency_id | uuid | read, write | Deficiency id |
reported_externally | boolean | read, write | Reported externally |
reported_to | text | read, write | Reported to |
opened_at | timestamp with time zone | read only | Opened at |
resolved_at | timestamp with time zone | read only | Resolved at |
closed_at | timestamp with time zone | read only | Closed at |
closed_by | uuid | read only | Closed by |
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 Cases 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.