TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/accounting/control-deficienciesPublished as /api/v1/control-deficiencies

Download specification (OpenAPI 3.1) Screen: Deficiencies

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 › 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.
Tableacct.control_deficiencies · 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/control-deficienciesList deficiencies

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",
      "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

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",
  "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.

FieldTypeRequiredDescription
control_iduuidNoControl
test_iduuidNoTest id
titletextYesTitle
severitytextNoSeverity
sourcetextNoSource
Allowed: internal_test internal_audit external_audit self_reported incident regulator continuous_monitoring
identified_atdateNoIdentified
descriptiontextNoDescription
root_causetextNoRoot cause
potential_impacttextNoPotential impact
impact_amountnumericNoImpact amount
remediation_plantextNoRemediation plan
owner_employee_iduuidNoOwner
target_datedateNoTarget date
compensating_control_iduuidNoCompensating control — What makes a deficiency survivable until it is fixed, and naming it is part of the assessment.
remediated_atdateNoRemediated on
validated_byuuidNoValidated by
notestextNoNotes

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

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
control_iduuidNoControl
test_iduuidNoTest id
titletextYesTitle
severitytextNoSeverity
sourcetextNoSource
Allowed: internal_test internal_audit external_audit self_reported incident regulator continuous_monitoring
identified_atdateNoIdentified
descriptiontextNoDescription
root_causetextNoRoot cause
potential_impacttextNoPotential impact
impact_amountnumericNoImpact amount
remediation_plantextNoRemediation plan
owner_employee_iduuidNoOwner
target_datedateNoTarget date
compensating_control_iduuidNoCompensating control — What makes a deficiency survivable until it is fixed, and naming it is part of the assessment.
remediated_atdateNoRemediated on
validated_byuuidNoValidated by
notestextNoNotes

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

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/control-deficiencies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/control-deficiencies/{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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
deficiency_notextread onlyDeficiency no
control_iduuidread, writeControl
test_iduuidread, writeTest id
titletextread, writeTitle
severitytextread, writeSeverity
sourcetextread, writeSource
Allowed: internal_test internal_audit external_audit self_reported incident regulator continuous_monitoring
identified_atdateread, writeIdentified
descriptiontextread, writeDescription
root_causetextread, writeRoot cause
potential_impacttextread, writePotential impact
impact_amountnumericread, writeImpact amount
remediation_plantextread, writeRemediation plan
owner_employee_iduuidread, writeOwner
target_datedateread, writeTarget date
compensating_control_iduuidread, writeCompensating control — What makes a deficiency survivable until it is fixed, and naming it is part of the assessment.
statustextread onlyStatus
remediated_atdateread, writeRemediated on
validated_byuuidread, writeValidated by
validated_attimestamp with time zoneread onlyValidated at
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 › Deficiencies 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.