Skip to main content
POST
Create Absence Scheme Assignment

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
string
required

Body

application/json

Exactly one of employee_id / pay_group_id, or neither for an organisation-level assignment; the level is derived, never sent.

regime
enum<string>
required

The six statutory family-pay regimes a claim or assignment can cover.

Available options:
SMP,
SPP,
SAP,
SHPP,
SPBP,
SNCP
scheme_id
string
required
valid_from
string<date>
required
employee_id
string | null
pay_group_id
string | null

Response

Successful Response

id
integer
required
regime
enum<string>
required

The six statutory family-pay regimes a claim or assignment can cover.

Available options:
SMP,
SPP,
SAP,
SHPP,
SPBP,
SNCP
scheme_id
string
required
level
enum<string>
required
Available options:
EMPLOYEE,
PAY_GROUP,
ORGANIZATION
valid_from
string<date>
required
created_at
string<date-time>
required
employee_id
string | null
pay_group_id
string | null
valid_to
string<date> | null