Skip to main content
POST
Create Employees

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Headers

X-Acting-User
string | null

The person acting through the access credential, recorded as created_by of what the request writes. Audit only: access is checked on the credential.

Required string length: 1 - 255

Path Parameters

organization_id
string
required

Body

application/json
Required array length: 1 - 100 elements
core
GBEmployeeCore · object
required

Identity of the person, as payroll and filing need it.

Each name field holds one name: a person with several middle names sends the one that should appear on HMRC returns. If only initials are known, they go one per field (first_name "J", middle_name "M"). An optional name the person does not have is null.

valid_from
string<date>
required

The first day every satellite's data is valid at

address
GBEmployeeAddress · object

The person's residence address, as filed to HMRC.

bank
GBEmployeeBank · object
compensation
GBEmployeeCompensation · object

Standing pay elements.

external_ref
string

The integrator's own key, unique within the parent and never changed. A path may name the hub as ext:{external_ref}.

Required string length: 1 - 255
Pattern: ^[A-Za-z0-9._~-]+$
insurance
GBEmployeeInsurance · object
job
GBEmployeeJob · object

The terms of the employment as a client writes them.

tax
GBEmployeeTax · object

Response

Successful Response

failed
integer
required
read-only

Number of failed records

succeeded
integer
required
read-only

Number of successfully processed records

total
integer
required

Total number of records in the request

unprocessed
integer
required
read-only

Number of records that passed validation but were not processed

data
GBEmployeeResponse · object[]

Successfully processed records

errors
GBEmployeeResponseItemError · object[]

Failed records with error details