Skip to main content
POST
Close Employee

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
string
required
employee_id
string
required

Response

Successful Response

The employee with every satellite as it reads on one date. A satellite with no slice on an explicit date is absent.

id
string
required
external_ref
string | null
required
created_at
string<date-time>
required
read-only
created_by
string
required
read-only

Who created the hub: the acting user (X-Acting-User, else the access credential), system for our own writes, or <authority>:<notice> for a write on an authority's behalf, e.g. hmrc:P6.

deleted_at
string<date-time> | null
required

When the hub was closed

organization_id
string
required
status
GBEmployeeStatus · object
required

The read-only status satellite. It carries no fields; it exists so that every employee read has a status object.

core
GBEmployeeCoreSatellite · object | null
address
GBEmployeeAddressSatellite · object | null
job
GBEmployeeJobSatellite · object | null
tax
GBEmployeeTaxSatellite · object | null
insurance
GBEmployeeInsuranceSatellite · object | null
compensation
GBEmployeeCompensationSatellite · object | null
bank
GBEmployeeBankSatellite · object | null