Employers

Offboard an employer

Changed on

Immediately offboard an employer. The employer’s scheme will be terminated and all employees associated with the employer will be offboarded and have their insurance terminated. Employee offboarding cannot be cancelled if triggered via this call.

post/employers/{employer_id}/offboard

Request

  • Base URL
    https://test.api.kota.io
  • URL
    https://test.api.kota.io/employers/{employer_id}/offboard
  • Auth
    HTTP bearer

Path parameters

employer_idstring required
Example:er_3b1333d87d9d4fd6ad83ba7f6b0e951a

Headers

Idempotency-Keystring

Unique key to ensure idempotent requests. If the same key is used for multiple identical & successful requests, the same response will be returned. Read more here

Response

OK

idstring required
platform_idstring
status'pending' | 'active' | 'offboarding' | 'inactive' | 'restricted'
legal_namestring required
registration_numberstring nullable
offboard_onstring date-time nullable
earliest_benefits_start_datestring date nullable
applicable_collective_agreementstring nullable

Name of the collective agreement that applies to the employer's workforce, if any.

metadataobject nullable

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Maximum 25 keys. Individual keys can be up to 40 characters and values up to 500 characters.

objectstring

The object type

Example response

{
  "id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "platform_id": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "offboard_on": "2024-12-01T00:00:00Z",
  "earliest_benefits_start_date": "2024-12-01"
}

Changes