TRANXACT.AI Help

Accounting · Services and actions

Risk

The risk service of Accounting: 7 operation(s).

Type REST7 operationsBase path /api/accounting/risk

Download specification (OpenAPI 3.1)

Overview

PackageAccounting
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Accounting › Risk 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.
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

7 operations. Open one for its parameters, bodies, responses and a sample request.

POST/api/accounting/risk/scanScan

Request body

The keys this action reads (* = required; "one of" lists the only values):

domain, detectorCode; domain one of payables|receivables|expenses|payroll|journals|banking|procurement|master_data|close|tax|treasury

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/scan" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"domain":"value","detectorCode;":"value"}'
POST/api/accounting/risk/screenScreen

Request body

The keys this action reads (* = required; "one of" lists the only values):

documentType, supplierId, accountId, employeeId, amount, currency, supplierInvoiceNo, invoiceDate

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/screen" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"documentType":"value","supplierId":"value","accountId":"value","employeeId":"value","amount":"value","currency":"value"}'
POST/api/accounting/risk/signals/{id}/caseSignals case

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

title, domain, caseType, severity, priority, assignedTo, dueDate; caseType one of anomaly|suspected_fraud|error|policy_breach|duplicate|control_failure|compliance|investigation; severity one of critical|high|medium|low|info

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/signals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/case" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"value","domain":"value","caseType":"value","severity":"value","priority":"value","assignedTo":"value"}'
POST/api/accounting/risk/signals/{id}/dismissSignals dismiss

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

reason*

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/signals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/dismiss" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"value"}'
POST/api/accounting/risk/cases/{id}/closeCases close

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

outcome, notes, recoveredAmount, lossAmount, remediation, raiseDeficiency; outcome one of confirmed_fraud|confirmed_error|policy_breach|process_gap|false_positive|no_issue|inconclusive

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/close" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"outcome":"value","notes":"value","recoveredAmount":"value","lossAmount":"value","remediation":"value","raiseDeficiency;":"value"}'
POST/api/accounting/risk/detectors/scoreDetectors score

Request body

The keys this action reads (* = required; "one of" lists the only values):

periodCode

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/detectors/score" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"periodCode":"value"}'
GET/api/accounting/risk/summarySummary

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/accounting/risk/summary" \
  -H "Authorization: Bearer $TOKEN"

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Accounting › Risk for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.