TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/accounting/financial-controlsPublished as /api/v1/financial-controls

Download specification (OpenAPI 3.1) Screen: Control Register

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 › 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.
Tableacct.financial_controls · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
nametextYesName
framework_iduuidNoFramework
framework_reftextNoFramework reference
processtextNoProcess
control_typetextNoType — A framework made entirely of detective controls finds everything and prevents nothing.
naturetextNoNature — Automated controls are tested once and rely on change management; manual ones on a sample every period.
Allowed: manual automated it_dependent hybrid
frequencytextNoFrequency
Allowed: continuous daily weekly monthly quarterly annual event_driven ad_hoc
is_keybooleanNoKey control — Its failure could cause a material misstatement. Marking everything key is how a framework becomes untestable.
risk_addressedtextNoRisk addressed
assertiontextNoAssertion — Existence, completeness, valuation, rights, presentation.
owner_employee_iduuidNoOwner
performer_employee_iduuidNoPerformed by
reviewer_employee_iduuidNoReviewed by
owner_roletextNoOwner role
moduletextNoModule
resourcetextNoScreen
system_ruletextNoSystem rule
enforced_bytextNoEnforced 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_descriptiontextNoDesign
operation_descriptiontextNoHow it operates
evidence_requiredtextNoEvidence required
effectivenesstextNoEffectiveness
last_tested_atdateNoLast tested at
next_test_duedateNoNext test due
notestextNoNotes

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

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

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
nametextYesName
framework_iduuidNoFramework
framework_reftextNoFramework reference
processtextNoProcess
control_typetextNoType — A framework made entirely of detective controls finds everything and prevents nothing.
naturetextNoNature — Automated controls are tested once and rely on change management; manual ones on a sample every period.
Allowed: manual automated it_dependent hybrid
frequencytextNoFrequency
Allowed: continuous daily weekly monthly quarterly annual event_driven ad_hoc
is_keybooleanNoKey control — Its failure could cause a material misstatement. Marking everything key is how a framework becomes untestable.
risk_addressedtextNoRisk addressed
assertiontextNoAssertion — Existence, completeness, valuation, rights, presentation.
owner_employee_iduuidNoOwner
performer_employee_iduuidNoPerformed by
reviewer_employee_iduuidNoReviewed by
owner_roletextNoOwner role
moduletextNoModule
resourcetextNoScreen
system_ruletextNoSystem rule
enforced_bytextNoEnforced 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_descriptiontextNoDesign
operation_descriptiontextNoHow it operates
evidence_requiredtextNoEvidence required
effectivenesstextNoEffectiveness
last_tested_atdateNoLast tested at
next_test_duedateNoNext test due
notestextNoNotes

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

NameTypeDescription
idstring (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

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):

overrides, preview, withLines

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
control_notextread onlyControl no
nametextread, writeName
framework_iduuidread, writeFramework
framework_reftextread, writeFramework reference
processtextread, writeProcess
control_typetextread, writeType — A framework made entirely of detective controls finds everything and prevents nothing.
naturetextread, writeNature — Automated controls are tested once and rely on change management; manual ones on a sample every period.
Allowed: manual automated it_dependent hybrid
frequencytextread, writeFrequency
Allowed: continuous daily weekly monthly quarterly annual event_driven ad_hoc
is_keybooleanread, writeKey control — Its failure could cause a material misstatement. Marking everything key is how a framework becomes untestable.
risk_addressedtextread, writeRisk addressed
assertiontextread, writeAssertion — Existence, completeness, valuation, rights, presentation.
owner_employee_iduuidread, writeOwner
performer_employee_iduuidread, writePerformed by
reviewer_employee_iduuidread, writeReviewed by
owner_roletextread, writeOwner role
moduletextread, writeModule
resourcetextread, writeScreen
system_ruletextread, writeSystem rule
enforced_bytextread, writeEnforced 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_descriptiontextread, writeDesign
operation_descriptiontextread, writeHow it operates
evidence_requiredtextread, writeEvidence required
effectivenesstextread, writeEffectiveness
last_tested_atdateread, writeLast tested at
next_test_duedateread, writeNext test due
statustextread onlyStatus
is_systembooleanread onlyIs system
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

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 › Control Register 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.