TRANXACT.AI Help

Accounting · Financial Close

Close Tasks

What has to happen, in what order, by whom. A task that is not ready refuses to start with the names of what it is waiting for.

Type REST6 operationsBase path /api/accounting/close-tasksPublished as /api/v1/close-tasks

Download specification (OpenAPI 3.1) Screen: Close Tasks

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 › Close Tasks 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.close_tasks · 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/close-tasksList close tasks

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",
      "run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "template_task_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "seq_no": 10,
      "code": "COD-000001",
      "name": "Example",
      "phase": "text",
      "module": "text",
      "task_type": "text",
      "action_key": "text",
      "action_params": {},
      "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "reviewer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/accounting/close-tasks?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/accounting/close-tasks/{id}Read one close task

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",
  "run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "template_task_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "seq_no": 10,
  "code": "COD-000001",
  "name": "Example",
  "phase": "text",
  "module": "text",
  "task_type": "text",
  "action_key": "text",
  "action_params": {},
  "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "reviewer_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/close-tasks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/close-tasksCreate a close task

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
owner_iduuidNoOwner
reviewer_iduuidNoReviewer
due_datedateNoDue
instructionstextNoInstructions
notestextNoNotes

Sample body

{
  "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "reviewer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "due_date": "2026-10-30",
  "instructions": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "template_task_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "seq_no": 10,
  "code": "COD-000001",
  "name": "Example",
  "phase": "text",
  "module": "text",
  "task_type": "text",
  "action_key": "text",
  "action_params": {},
  "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "reviewer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/close-tasks" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"owner_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","reviewer_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","due_date":"2026-10-30","instructions":"text"}'
PUT/api/accounting/close-tasks/{id}Change a close task

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
owner_iduuidNoOwner
reviewer_iduuidNoReviewer
due_datedateNoDue
instructionstextNoInstructions
notestextNoNotes

Sample body

{
  "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "reviewer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "template_task_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "seq_no": 10,
  "code": "COD-000001",
  "name": "Example",
  "phase": "text",
  "module": "text",
  "task_type": "text",
  "action_key": "text",
  "action_params": {},
  "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "reviewer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/close-tasks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"owner_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","reviewer_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
DELETE/api/accounting/close-tasks/{id}Delete a close task

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/close-tasks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/close-tasks/{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/close-tasks/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 close task, 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
run_iduuidread onlyRun id
template_task_iduuidread onlyTemplate task id
seq_nointegerread onlySeq no
codetextread onlyCode
nametextread onlyName
phasetextread onlyPhase
moduletextread onlyModule
task_typetextread onlyTask type
action_keytextread onlyAction key
action_paramsjsonbread onlyAction params
owner_iduuidread, writeOwner
reviewer_iduuidread, writeReviewer
due_datedateread, writeDue
statustextread onlyStatus
is_mandatorybooleanread onlyIs mandatory
is_blockingbooleanread onlyIs blocking
requires_evidencebooleanread onlyRequires evidence
requires_approvalbooleanread onlyRequires approval
started_attimestamp with time zoneread onlyStarted at
completed_attimestamp with time zoneread onlyCompleted at
completed_byuuidread onlyCompleted by
approved_byuuidread onlyApproved by
approved_attimestamp with time zoneread onlyApproved at
resultjsonbread onlyResult
result_amountnumericread onlyResult amount
journal_iduuidread onlyJournal id
error_messagetextread onlyError message
skip_reasontextread onlySkip reason
duration_minutesintegerread onlyDuration minutes
instructionstextread, writeInstructions
notestextread, writeNotes
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_attimestamp with time zoneread onlyCreated at
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 › Close Tasks 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.