TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/hrms/offboardingPublished as /api/v1/offboarding

Download specification (OpenAPI 3.1) Screen: Offboarding

Overview

PackageHRMS
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 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.
Tablehr.offboarding · kept per company (and organisational unit where it has one)
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/hrms/offboardingList offboarding

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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
employee_iduuidYesEmployee
work_relationship_iduuidNoWork relationship id
leaving_typetextYesHow it is ending
Allowed: resignation dismissal redundancy retirement end_of_contract death mutual transfer tupe
reasontextNoReason
is_retirementbooleanNoRetirement
retirement_typetextNoRetirement type
Allowed: normal early ill_health phased deferred
pension_schemetextNoPension scheme
pension_start_datedateNoPension starts
is_phasedbooleanNoPhased
phased_hours_pctnumericNoPhased hours %
notified_ondateNoNotified on
last_working_daydateNoLast working day
termination_datedateYesTermination date
notice_workedbooleanNoNotice worked
notice_paid_in_lieubooleanNoPaid in lieu of notice
garden_leavebooleanNoGarden leave
exit_interview_ondateNoExit interview
exit_interview_byuuidNoExit interview by
exit_reason_categorytextNoExit reason category
would_recommendbooleanNoWould recommend us
would_returnbooleanNoWould return
exit_feedbacktextNoExit feedback
final_pay_calculatedbooleanNoFinal pay calculated
final_pay_datedateNoFinal pay date
accrued_leave_daysnumericNoAccrued leave (days)
accrued_leave_paidbooleanNoAccrued leave paid
severance_amountnumericNoSeverance
assets_returnedbooleanNoAssets returned
assets_outstandingtextNoAssets outstanding
system_access_revokedbooleanNoSystem access revoked
access_revoked_ontimestamp with time zoneNoAccess revoked on
building_access_revokedbooleanNoBuilding access revoked
knowledge_transfer_donebooleanNoKnowledge transfer done
handover_to_iduuidNoHanded over to
reference_policytextNoReference policy
has_restrictive_covenantbooleanNoRestrictive covenant
covenant_monthsintegerNoCovenant months
is_rehire_eligiblebooleanNoEligible for rehire
checklist_iduuidNoChecklist id
statustextNoStatus — Completing it ends the employment and the work relationship together.
Allowed: initiated in_progress pending_final_pay completed cancelled
completed_ondateNoCompleted 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

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
employee_iduuidYesEmployee
work_relationship_iduuidNoWork relationship id
leaving_typetextYesHow it is ending
Allowed: resignation dismissal redundancy retirement end_of_contract death mutual transfer tupe
reasontextNoReason
is_retirementbooleanNoRetirement
retirement_typetextNoRetirement type
Allowed: normal early ill_health phased deferred
pension_schemetextNoPension scheme
pension_start_datedateNoPension starts
is_phasedbooleanNoPhased
phased_hours_pctnumericNoPhased hours %
notified_ondateNoNotified on
last_working_daydateNoLast working day
termination_datedateYesTermination date
notice_workedbooleanNoNotice worked
notice_paid_in_lieubooleanNoPaid in lieu of notice
garden_leavebooleanNoGarden leave
exit_interview_ondateNoExit interview
exit_interview_byuuidNoExit interview by
exit_reason_categorytextNoExit reason category
would_recommendbooleanNoWould recommend us
would_returnbooleanNoWould return
exit_feedbacktextNoExit feedback
final_pay_calculatedbooleanNoFinal pay calculated
final_pay_datedateNoFinal pay date
accrued_leave_daysnumericNoAccrued leave (days)
accrued_leave_paidbooleanNoAccrued leave paid
severance_amountnumericNoSeverance
assets_returnedbooleanNoAssets returned
assets_outstandingtextNoAssets outstanding
system_access_revokedbooleanNoSystem access revoked
access_revoked_ontimestamp with time zoneNoAccess revoked on
building_access_revokedbooleanNoBuilding access revoked
knowledge_transfer_donebooleanNoKnowledge transfer done
handover_to_iduuidNoHanded over to
reference_policytextNoReference policy
has_restrictive_covenantbooleanNoRestrictive covenant
covenant_monthsintegerNoCovenant months
is_rehire_eligiblebooleanNoEligible for rehire
checklist_iduuidNoChecklist id
statustextNoStatus — Completing it ends the employment and the work relationship together.
Allowed: initiated in_progress pending_final_pay completed cancelled
completed_ondateNoCompleted 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

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/hrms/offboarding/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/offboarding/{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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
employee_iduuidread, writeEmployee
work_relationship_iduuidread, writeWork relationship id
offboarding_notextread onlyOffboarding no
leaving_typetextread, writeHow it is ending
Allowed: resignation dismissal redundancy retirement end_of_contract death mutual transfer tupe
reasontextread, writeReason
is_retirementbooleanread, writeRetirement
retirement_typetextread, writeRetirement type
Allowed: normal early ill_health phased deferred
pension_schemetextread, writePension scheme
pension_start_datedateread, writePension starts
is_phasedbooleanread, writePhased
phased_hours_pctnumericread, writePhased hours %
notified_ondateread, writeNotified on
last_working_daydateread, writeLast working day
termination_datedateread, writeTermination date
notice_workedbooleanread, writeNotice worked
notice_paid_in_lieubooleanread, writePaid in lieu of notice
garden_leavebooleanread, writeGarden leave
exit_interview_ondateread, writeExit interview
exit_interview_byuuidread, writeExit interview by
exit_reason_categorytextread, writeExit reason category
would_recommendbooleanread, writeWould recommend us
would_returnbooleanread, writeWould return
exit_feedbacktextread, writeExit feedback
final_pay_calculatedbooleanread, writeFinal pay calculated
final_pay_datedateread, writeFinal pay date
accrued_leave_daysnumericread, writeAccrued leave (days)
accrued_leave_paidbooleanread, writeAccrued leave paid
severance_amountnumericread, writeSeverance
assets_returnedbooleanread, writeAssets returned
assets_outstandingtextread, writeAssets outstanding
system_access_revokedbooleanread, writeSystem access revoked
access_revoked_ontimestamp with time zoneread, writeAccess revoked on
building_access_revokedbooleanread, writeBuilding access revoked
knowledge_transfer_donebooleanread, writeKnowledge transfer done
handover_to_iduuidread, writeHanded over to
reference_policytextread, writeReference policy
has_restrictive_covenantbooleanread, writeRestrictive covenant
covenant_monthsintegerread, writeCovenant months
is_rehire_eligiblebooleanread, writeEligible for rehire
checklist_iduuidread, writeChecklist id
statustextread, writeStatus — Completing it ends the employment and the work relationship together.
Allowed: initiated in_progress pending_final_pay completed cancelled
completed_ondateread, writeCompleted on
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
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_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 HRMS › Offboarding 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.