Skip to main content
POST
Create Wage Types

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
GBWageTypeCore · object
required

What the wage type is called and which block of the payslip it belongs to.

treatment
GBWageTypeTreatment · object
required

The statutory treatment of amounts paid under the code.

valid_from
string<date>
required

The first day every satellite's data is valid at

wage_type_code
string
required

Business key, unique within the organization; not in the UK- namespace

computation
WageTypeComputationSpec · object | null

How the amount paid under the code is computed: a wagekit spec, the codes it reads, and how its result is rounded.

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._~-]+$

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
GBWageTypeHubResponse · object[]

Successfully processed records

errors
GBWageTypeHubResponseItemError · object[]

Failed records with error details