TRANXACT.AI Help

Accounting · Financial Close

Close Checklist

One task in the template. The phase is what the wizard turns into a step, and an automated task names the run it performs.

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

Download specification (OpenAPI 3.1) Screen: Close Checklist

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 Checklist 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_template_tasks
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-template-tasksList close checklist

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",
      "template_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_role": "text",
      "reviewer_role": "text",
      "due_day": 10,
      "estimated_minutes": 10
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "template_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_role": "text",
  "reviewer_role": "text",
  "due_day": 10,
  "estimated_minutes": 10
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/accounting/close-template-tasks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/close-template-tasksCreate a close template task

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
template_iduuidYesTemplate
seq_nointegerYesSequence
codetextYesCode
nametextYesName
phasetextNoPhase
moduletextNoModule
task_typetextNoType
action_keytextNoAction key — ASSET-DEPR, LEASE-RUN, REV-RECOGNISE, ALLOC-CYCLE, ORDER-SETTLE, RECURRING-POST, FX-REVALUE, PERIOD-CLOSE.
action_paramsjsonbNoAction parameters
owner_roletextNoOwner role
reviewer_roletextNoReviewer role
due_dayintegerNoDue working day — Day 0 is the last day of the period; day 3 is three working days after it.
estimated_minutesintegerNoEstimated minutes
is_mandatorybooleanNoMandatory
is_blockingbooleanNoBlocks the phase — Marking everything blocking is how a close checklist stops being used.
requires_evidencebooleanNoRequires evidence
requires_approvalbooleanNoRequires approval
instructionstextNoInstructions
is_activebooleanNoActive

Sample body

{
  "template_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "seq_no": 10,
  "code": "COD-000001",
  "name": "Example",
  "phase": "text",
  "module": "text",
  "task_type": "text",
  "action_key": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "template_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_role": "text",
  "reviewer_role": "text",
  "due_day": 10,
  "estimated_minutes": 10
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/close-template-tasks" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"template_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","seq_no":10,"code":"COD-000001","name":"Example","phase":"text","module":"text","task_type":"text","action_key":"text"}'
PUT/api/accounting/close-template-tasks/{id}Change a close template 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
template_iduuidYesTemplate
seq_nointegerYesSequence
codetextYesCode
nametextYesName
phasetextNoPhase
moduletextNoModule
task_typetextNoType
action_keytextNoAction key — ASSET-DEPR, LEASE-RUN, REV-RECOGNISE, ALLOC-CYCLE, ORDER-SETTLE, RECURRING-POST, FX-REVALUE, PERIOD-CLOSE.
action_paramsjsonbNoAction parameters
owner_roletextNoOwner role
reviewer_roletextNoReviewer role
due_dayintegerNoDue working day — Day 0 is the last day of the period; day 3 is three working days after it.
estimated_minutesintegerNoEstimated minutes
is_mandatorybooleanNoMandatory
is_blockingbooleanNoBlocks the phase — Marking everything blocking is how a close checklist stops being used.
requires_evidencebooleanNoRequires evidence
requires_approvalbooleanNoRequires approval
instructionstextNoInstructions
is_activebooleanNoActive

Sample body

{
  "template_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "seq_no": 10
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "template_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_role": "text",
  "reviewer_role": "text",
  "due_day": 10,
  "estimated_minutes": 10
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/close-template-tasks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"template_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","seq_no":10}'
DELETE/api/accounting/close-template-tasks/{id}Delete a close template 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-template-tasks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/close-template-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-template-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 template 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
template_iduuidread, writeTemplate
seq_nointegerread, writeSequence
codetextread, writeCode
nametextread, writeName
phasetextread, writePhase
moduletextread, writeModule
task_typetextread, writeType
action_keytextread, writeAction key — ASSET-DEPR, LEASE-RUN, REV-RECOGNISE, ALLOC-CYCLE, ORDER-SETTLE, RECURRING-POST, FX-REVALUE, PERIOD-CLOSE.
action_paramsjsonbread, writeAction parameters
owner_roletextread, writeOwner role
reviewer_roletextread, writeReviewer role
due_dayintegerread, writeDue working day — Day 0 is the last day of the period; day 3 is three working days after it.
estimated_minutesintegerread, writeEstimated minutes
is_mandatorybooleanread, writeMandatory
is_blockingbooleanread, writeBlocks the phase — Marking everything blocking is how a close checklist stops being used.
requires_evidencebooleanread, writeRequires evidence
requires_approvalbooleanread, writeRequires approval
instructionstextread, writeInstructions
is_activebooleanread, writeActive
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 Checklist 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.