{
 "openapi": "3.1.0",
 "info": {
  "title": "Checklist Template Tasks (Employee Self Service)",
  "version": "20261030b",
  "description": "The tasks an onboarding or offboarding checklist is raised with: who does each, and when, relative to the start or last day."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "checklist-steps": {
    "type": "object",
    "required": [
     "template_id",
     "sequence_no",
     "title"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "template_id": {
      "type": "string",
      "format": "uuid",
      "description": "Template"
     },
     "sequence_no": {
      "type": "integer",
      "description": "Order"
     },
     "title": {
      "type": "string",
      "description": "Task"
     },
     "description": {
      "type": "string",
      "description": "Description"
     },
     "owner_role": {
      "type": "string",
      "description": "Who does it",
      "enum": [
       "employee",
       "manager",
       "hr",
       "it",
       "facilities",
       "payroll",
       "security",
       "finance"
      ]
     },
     "category": {
      "type": "string",
      "description": "Category"
     },
     "due_offset_days": {
      "type": "integer",
      "description": "Days from the start or last day"
     },
     "is_mandatory": {
      "type": "boolean",
      "description": "Mandatory"
     },
     "blocks_start": {
      "type": "boolean",
      "description": "Blocks the start date"
     },
     "document_type_code": {
      "type": "string",
      "description": "Document it asks for"
     },
     "tax_form_code": {
      "type": "string",
      "description": "Form it raises",
      "enum": [
       "W-4",
       "I-9",
       "W-9"
      ]
     },
     "requires_signature": {
      "type": "boolean",
      "description": "The employee acknowledges it"
     },
     "xf_text_1": {
      "type": "string",
      "description": "Xf text 1",
      "readOnly": true
     },
     "xf_text_2": {
      "type": "string",
      "description": "Xf text 2",
      "readOnly": true
     },
     "xf_text_3": {
      "type": "string",
      "description": "Xf text 3",
      "readOnly": true
     },
     "xf_text_4": {
      "type": "string",
      "description": "Xf text 4",
      "readOnly": true
     },
     "xf_text_5": {
      "type": "string",
      "description": "Xf text 5",
      "readOnly": true
     },
     "xf_num_1": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 1",
      "readOnly": true
     },
     "xf_num_2": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 2",
      "readOnly": true
     },
     "xf_num_3": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 3",
      "readOnly": true
     },
     "xf_date_1": {
      "type": "string",
      "format": "date",
      "description": "Xf date 1",
      "readOnly": true
     },
     "xf_date_2": {
      "type": "string",
      "format": "date",
      "description": "Xf date 2",
      "readOnly": true
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Created at",
      "readOnly": true
     },
     "created_by": {
      "type": "string",
      "format": "uuid",
      "description": "Created by",
      "readOnly": true
     },
     "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Updated at",
      "readOnly": true
     },
     "updated_by": {
      "type": "string",
      "format": "uuid",
      "description": "Updated by",
      "readOnly": true
     },
     "department": {
      "type": "string",
      "description": "Department"
     },
     "department_unit_id": {
      "type": "string",
      "format": "uuid",
      "description": "Department org unit"
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/ess/checklist-steps": {
   "get": {
    "summary": "list checklist-steps",
    "operationId": "list_checklist_steps_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create checklist-steps",
    "operationId": "create_checklist_steps_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ess/checklist-steps/{id}": {
   "get": {
    "summary": "get checklist-steps",
    "operationId": "get_checklist_steps_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change checklist-steps",
    "operationId": "change_checklist_steps_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete checklist-steps",
    "operationId": "delete_checklist_steps_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "patch": {
    "summary": "Patch checklist template tasks",
    "operationId": "action_checklist_steps_3_5",
    "description": "Body keys: tax_form_code",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ess/checklist-steps/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_checklist_steps_0_6",
    "description": "Body keys: overrides, preview, withLines",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  }
 }
}