HRMS · Reachable by link
Offboarding
Leaving, including retirement — the exit conversation, the final pay, the assets, the access, and the obligations that outlive the employment.
/api/hrms/offboardingPublished as /api/v1/offboardingOverview
| Package | HRMS |
|---|---|
| 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 HRMS › Offboarding 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.offboarding · kept per company (and organisational unit where it has one) |
| 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
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/offboardingList offboarding
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",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_relationship_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"offboarding_no": "OFF-000001",
"leaving_type": "resignation",
"reason": "text",
"is_retirement": true,
"retirement_type": "normal",
"pension_scheme": "text",
"pension_start_date": "2026-10-30",
"is_phased": true,
"phased_hours_pct": "1250.00",
"notified_on": "2026-10-30",
"last_working_day": "2026-10-30"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/offboarding?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/offboarding/{id}Read one offboarding
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",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_relationship_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"offboarding_no": "OFF-000001",
"leaving_type": "resignation",
"reason": "text",
"is_retirement": true,
"retirement_type": "normal",
"pension_scheme": "text",
"pension_start_date": "2026-10-30",
"is_phased": true,
"phased_hours_pct": "1250.00",
"notified_on": "2026-10-30",
"last_working_day": "2026-10-30"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/offboarding/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/offboardingCreate a offboarding
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
employee_id | uuid | Yes | Employee |
work_relationship_id | uuid | No | Work relationship id |
leaving_type | text | Yes | How it is ending Allowed: resignation dismissal redundancy retirement end_of_contract death mutual transfer tupe |
reason | text | No | Reason |
is_retirement | boolean | No | Retirement |
retirement_type | text | No | Retirement type Allowed: normal early ill_health phased deferred |
pension_scheme | text | No | Pension scheme |
pension_start_date | date | No | Pension starts |
is_phased | boolean | No | Phased |
phased_hours_pct | numeric | No | Phased hours % |
notified_on | date | No | Notified on |
last_working_day | date | No | Last working day |
termination_date | date | Yes | Termination date |
notice_worked | boolean | No | Notice worked |
notice_paid_in_lieu | boolean | No | Paid in lieu of notice |
garden_leave | boolean | No | Garden leave |
exit_interview_on | date | No | Exit interview |
exit_interview_by | uuid | No | Exit interview by |
exit_reason_category | text | No | Exit reason category |
would_recommend | boolean | No | Would recommend us |
would_return | boolean | No | Would return |
exit_feedback | text | No | Exit feedback |
final_pay_calculated | boolean | No | Final pay calculated |
final_pay_date | date | No | Final pay date |
accrued_leave_days | numeric | No | Accrued leave (days) |
accrued_leave_paid | boolean | No | Accrued leave paid |
severance_amount | numeric | No | Severance |
assets_returned | boolean | No | Assets returned |
assets_outstanding | text | No | Assets outstanding |
system_access_revoked | boolean | No | System access revoked |
access_revoked_on | timestamp with time zone | No | Access revoked on |
building_access_revoked | boolean | No | Building access revoked |
knowledge_transfer_done | boolean | No | Knowledge transfer done |
handover_to_id | uuid | No | Handed over to |
reference_policy | text | No | Reference policy |
has_restrictive_covenant | boolean | No | Restrictive covenant |
covenant_months | integer | No | Covenant months |
is_rehire_eligible | boolean | No | Eligible for rehire |
checklist_id | uuid | No | Checklist id |
status | text | No | Status — Completing it ends the employment and the work relationship together. Allowed: initiated in_progress pending_final_pay completed cancelled |
completed_on | date | No | Completed on |
Sample body
{
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"leaving_type": "resignation",
"termination_date": "2026-10-30",
"work_relationship_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reason": "text",
"is_retirement": true,
"retirement_type": "normal"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_relationship_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"offboarding_no": "OFF-000001",
"leaving_type": "resignation",
"reason": "text",
"is_retirement": true,
"retirement_type": "normal",
"pension_scheme": "text",
"pension_start_date": "2026-10-30",
"is_phased": true,
"phased_hours_pct": "1250.00",
"notified_on": "2026-10-30",
"last_working_day": "2026-10-30"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/offboarding" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","leaving_type":"resignation","termination_date":"2026-10-30","work_relationship_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","reason":"text","is_retirement":true,"retirement_type":"normal"}'PUT/api/hrms/offboarding/{id}Change a offboarding
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 |
|---|---|---|---|
employee_id | uuid | Yes | Employee |
work_relationship_id | uuid | No | Work relationship id |
leaving_type | text | Yes | How it is ending Allowed: resignation dismissal redundancy retirement end_of_contract death mutual transfer tupe |
reason | text | No | Reason |
is_retirement | boolean | No | Retirement |
retirement_type | text | No | Retirement type Allowed: normal early ill_health phased deferred |
pension_scheme | text | No | Pension scheme |
pension_start_date | date | No | Pension starts |
is_phased | boolean | No | Phased |
phased_hours_pct | numeric | No | Phased hours % |
notified_on | date | No | Notified on |
last_working_day | date | No | Last working day |
termination_date | date | Yes | Termination date |
notice_worked | boolean | No | Notice worked |
notice_paid_in_lieu | boolean | No | Paid in lieu of notice |
garden_leave | boolean | No | Garden leave |
exit_interview_on | date | No | Exit interview |
exit_interview_by | uuid | No | Exit interview by |
exit_reason_category | text | No | Exit reason category |
would_recommend | boolean | No | Would recommend us |
would_return | boolean | No | Would return |
exit_feedback | text | No | Exit feedback |
final_pay_calculated | boolean | No | Final pay calculated |
final_pay_date | date | No | Final pay date |
accrued_leave_days | numeric | No | Accrued leave (days) |
accrued_leave_paid | boolean | No | Accrued leave paid |
severance_amount | numeric | No | Severance |
assets_returned | boolean | No | Assets returned |
assets_outstanding | text | No | Assets outstanding |
system_access_revoked | boolean | No | System access revoked |
access_revoked_on | timestamp with time zone | No | Access revoked on |
building_access_revoked | boolean | No | Building access revoked |
knowledge_transfer_done | boolean | No | Knowledge transfer done |
handover_to_id | uuid | No | Handed over to |
reference_policy | text | No | Reference policy |
has_restrictive_covenant | boolean | No | Restrictive covenant |
covenant_months | integer | No | Covenant months |
is_rehire_eligible | boolean | No | Eligible for rehire |
checklist_id | uuid | No | Checklist id |
status | text | No | Status — Completing it ends the employment and the work relationship together. Allowed: initiated in_progress pending_final_pay completed cancelled |
completed_on | date | No | Completed on |
Sample body
{
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"leaving_type": "resignation"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_relationship_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"offboarding_no": "OFF-000001",
"leaving_type": "resignation",
"reason": "text",
"is_retirement": true,
"retirement_type": "normal",
"pension_scheme": "text",
"pension_start_date": "2026-10-30",
"is_phased": true,
"phased_hours_pct": "1250.00",
"notified_on": "2026-10-30",
"last_working_day": "2026-10-30"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/offboarding/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","leaving_type":"resignation"}'DELETE/api/hrms/offboarding/{id}Delete a offboarding
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/hrms/offboarding/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/offboarding/{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/hrms/offboarding/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 offboarding, 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 |
org_id | uuid | read only | Org id |
employee_id | uuid | read, write | Employee |
work_relationship_id | uuid | read, write | Work relationship id |
offboarding_no | text | read only | Offboarding no |
leaving_type | text | read, write | How it is ending Allowed: resignation dismissal redundancy retirement end_of_contract death mutual transfer tupe |
reason | text | read, write | Reason |
is_retirement | boolean | read, write | Retirement |
retirement_type | text | read, write | Retirement type Allowed: normal early ill_health phased deferred |
pension_scheme | text | read, write | Pension scheme |
pension_start_date | date | read, write | Pension starts |
is_phased | boolean | read, write | Phased |
phased_hours_pct | numeric | read, write | Phased hours % |
notified_on | date | read, write | Notified on |
last_working_day | date | read, write | Last working day |
termination_date | date | read, write | Termination date |
notice_worked | boolean | read, write | Notice worked |
notice_paid_in_lieu | boolean | read, write | Paid in lieu of notice |
garden_leave | boolean | read, write | Garden leave |
exit_interview_on | date | read, write | Exit interview |
exit_interview_by | uuid | read, write | Exit interview by |
exit_reason_category | text | read, write | Exit reason category |
would_recommend | boolean | read, write | Would recommend us |
would_return | boolean | read, write | Would return |
exit_feedback | text | read, write | Exit feedback |
final_pay_calculated | boolean | read, write | Final pay calculated |
final_pay_date | date | read, write | Final pay date |
accrued_leave_days | numeric | read, write | Accrued leave (days) |
accrued_leave_paid | boolean | read, write | Accrued leave paid |
severance_amount | numeric | read, write | Severance |
assets_returned | boolean | read, write | Assets returned |
assets_outstanding | text | read, write | Assets outstanding |
system_access_revoked | boolean | read, write | System access revoked |
access_revoked_on | timestamp with time zone | read, write | Access revoked on |
building_access_revoked | boolean | read, write | Building access revoked |
knowledge_transfer_done | boolean | read, write | Knowledge transfer done |
handover_to_id | uuid | read, write | Handed over to |
reference_policy | text | read, write | Reference policy |
has_restrictive_covenant | boolean | read, write | Restrictive covenant |
covenant_months | integer | read, write | Covenant months |
is_rehire_eligible | boolean | read, write | Eligible for rehire |
checklist_id | uuid | read, write | Checklist id |
status | text | read, write | Status — Completing it ends the employment and the work relationship together. Allowed: initiated in_progress pending_final_pay completed cancelled |
completed_on | date | read, write | Completed on |
created_at | timestamp with time zone | read only | Created at |
org_unit_id | uuid | read only | Org unit id |
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_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
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 HRMS › Offboarding 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.