Employee Self Service · HR Self Service
Checklist Template Tasks
The tasks an onboarding or offboarding checklist is raised with: who does each, and when, relative to the start or last day.
/api/ess/checklist-stepsPublished as /api/v1/checklist-stepsDownload specification (OpenAPI 3.1) Screen: Checklist Template Tasks
Overview
| Package | Employee Self Service |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Employee Self Service › Checklist Template 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. |
| Table | hr.checklist_template_tasks |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The 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.
GET/api/ess/checklist-stepsList checklist template tasks
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"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",
"sequence_no": 10,
"title": "Example",
"description": "text",
"owner_role": "employee",
"category": "text",
"due_offset_days": 10,
"is_mandatory": true,
"blocks_start": true,
"document_type_code": "DOC-000001",
"tax_form_code": "W-4",
"requires_signature": true,
"xf_text_1": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/ess/checklist-steps?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/ess/checklist-steps/{id}Read one checklist task
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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",
"sequence_no": 10,
"title": "Example",
"description": "text",
"owner_role": "employee",
"category": "text",
"due_offset_days": 10,
"is_mandatory": true,
"blocks_start": true,
"document_type_code": "DOC-000001",
"tax_form_code": "W-4",
"requires_signature": true,
"xf_text_1": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/ess/checklist-steps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ess/checklist-stepsCreate a checklist task
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
template_id | uuid | Yes | Template |
sequence_no | integer | Yes | Order |
title | text | Yes | Task |
description | text | No | Description |
owner_role | text | No | Who does it Allowed: employee manager hr it facilities payroll security finance |
category | text | No | Category |
due_offset_days | integer | No | Days from the start or last day — Negative is before it |
is_mandatory | boolean | No | Mandatory |
blocks_start | boolean | No | Blocks the start date |
document_type_code | text | No | Document it asks for |
tax_form_code | text | No | Form it raises — Opened for the new hire when the offer is accepted (My W-4, My I-9); signing it completes this task. US hires only. Allowed: W-4 I-9 W-9 |
requires_signature | boolean | No | The employee acknowledges it |
department | text | No | Department — Empty: the department its owner role maps to (HRMS > Task Departments). |
department_unit_id | uuid | No | Department org unit |
Sample body
{
"template_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sequence_no": 10,
"title": "Example",
"description": "text",
"owner_role": "employee",
"category": "text",
"due_offset_days": 10
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"template_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sequence_no": 10,
"title": "Example",
"description": "text",
"owner_role": "employee",
"category": "text",
"due_offset_days": 10,
"is_mandatory": true,
"blocks_start": true,
"document_type_code": "DOC-000001",
"tax_form_code": "W-4",
"requires_signature": true,
"xf_text_1": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/ess/checklist-steps" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"template_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","sequence_no":10,"title":"Example","description":"text","owner_role":"employee","category":"text","due_offset_days":10}'PUT/api/ess/checklist-steps/{id}Change a checklist task
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
template_id | uuid | Yes | Template |
sequence_no | integer | Yes | Order |
title | text | Yes | Task |
description | text | No | Description |
owner_role | text | No | Who does it Allowed: employee manager hr it facilities payroll security finance |
category | text | No | Category |
due_offset_days | integer | No | Days from the start or last day — Negative is before it |
is_mandatory | boolean | No | Mandatory |
blocks_start | boolean | No | Blocks the start date |
document_type_code | text | No | Document it asks for |
tax_form_code | text | No | Form it raises — Opened for the new hire when the offer is accepted (My W-4, My I-9); signing it completes this task. US hires only. Allowed: W-4 I-9 W-9 |
requires_signature | boolean | No | The employee acknowledges it |
department | text | No | Department — Empty: the department its owner role maps to (HRMS > Task Departments). |
department_unit_id | uuid | No | Department org unit |
Sample body
{
"template_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sequence_no": 10
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"template_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sequence_no": 10,
"title": "Example",
"description": "text",
"owner_role": "employee",
"category": "text",
"due_offset_days": 10,
"is_mandatory": true,
"blocks_start": true,
"document_type_code": "DOC-000001",
"tax_form_code": "W-4",
"requires_signature": true,
"xf_text_1": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/ess/checklist-steps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"template_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","sequence_no":10}'DELETE/api/ess/checklist-steps/{id}Delete a checklist task
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/ess/checklist-steps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"PATCH/api/ess/checklist-steps/{id}Patch checklist template tasks
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
tax_form_codeResponse
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 PATCH "https://demo.tranxact.ai/api/ess/checklist-steps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"tax_form_code":"value"}'POST/api/ess/checklist-steps/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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, withLinesResponse
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/ess/checklist-steps/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 checklist task, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
template_id | uuid | read, write | Template |
sequence_no | integer | read, write | Order |
title | text | read, write | Task |
description | text | read, write | Description |
owner_role | text | read, write | Who does it Allowed: employee manager hr it facilities payroll security finance |
category | text | read, write | Category |
due_offset_days | integer | read, write | Days from the start or last day — Negative is before it |
is_mandatory | boolean | read, write | Mandatory |
blocks_start | boolean | read, write | Blocks the start date |
document_type_code | text | read, write | Document it asks for |
tax_form_code | text | read, write | Form it raises — Opened for the new hire when the offer is accepted (My W-4, My I-9); signing it completes this task. US hires only. Allowed: W-4 I-9 W-9 |
requires_signature | boolean | read, write | The employee acknowledges it |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
department | text | read, write | Department — Empty: the department its owner role maps to (HRMS > Task Departments). |
department_unit_id | uuid | read, write | Department org unit |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Employee Self Service › Checklist Template Tasks for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused 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.