TRANXACT.AI Help

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.

Type REST7 operationsBase path /api/ess/checklist-stepsPublished as /api/v1/checklist-steps

Download specification (OpenAPI 3.1) Screen: Checklist Template Tasks

Overview

PackageEmployee Self Service
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 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.
Tablehr.checklist_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

7 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/ess/checklist-stepsList checklist template 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",
      "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

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

FieldTypeRequiredDescription
template_iduuidYesTemplate
sequence_nointegerYesOrder
titletextYesTask
descriptiontextNoDescription
owner_roletextNoWho does it
Allowed: employee manager hr it facilities payroll security finance
categorytextNoCategory
due_offset_daysintegerNoDays from the start or last day — Negative is before it
is_mandatorybooleanNoMandatory
blocks_startbooleanNoBlocks the start date
document_type_codetextNoDocument it asks for
tax_form_codetextNoForm 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_signaturebooleanNoThe employee acknowledges it
departmenttextNoDepartment — Empty: the department its owner role maps to (HRMS > Task Departments).
department_unit_iduuidNoDepartment 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

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
sequence_nointegerYesOrder
titletextYesTask
descriptiontextNoDescription
owner_roletextNoWho does it
Allowed: employee manager hr it facilities payroll security finance
categorytextNoCategory
due_offset_daysintegerNoDays from the start or last day — Negative is before it
is_mandatorybooleanNoMandatory
blocks_startbooleanNoBlocks the start date
document_type_codetextNoDocument it asks for
tax_form_codetextNoForm 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_signaturebooleanNoThe employee acknowledges it
departmenttextNoDepartment — Empty: the department its owner role maps to (HRMS > Task Departments).
department_unit_iduuidNoDepartment 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

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/ess/checklist-steps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
PATCH/api/ess/checklist-steps/{id}Patch checklist template tasks

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

tax_form_code

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

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

FieldTypeAccessDescription
iduuidread onlyId
template_iduuidread, writeTemplate
sequence_nointegerread, writeOrder
titletextread, writeTask
descriptiontextread, writeDescription
owner_roletextread, writeWho does it
Allowed: employee manager hr it facilities payroll security finance
categorytextread, writeCategory
due_offset_daysintegerread, writeDays from the start or last day — Negative is before it
is_mandatorybooleanread, writeMandatory
blocks_startbooleanread, writeBlocks the start date
document_type_codetextread, writeDocument it asks for
tax_form_codetextread, writeForm 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_signaturebooleanread, writeThe employee acknowledges it
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
departmenttextread, writeDepartment — Empty: the department its owner role maps to (HRMS > Task Departments).
department_unit_iduuidread, writeDepartment org unit

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 Employee Self Service › Checklist Template 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.