Skip to main content
POST
cURL

Authorizations

X-Auth-Token
string
header
required

Authentication token for API access

X-Org-Id
string
header
required

Organisation to scope the request to. Required when the principal can access more than one organisation; optional for single-organisation principals (the authorizer resolves it automatically).

Body

application/json
startDate
string
required
Minimum string length: 1
employmentStartDate
string
required
Minimum string length: 1
payFrequency
string
required
Minimum string length: 1
earnings
number<double>[]
required
endDate
string | null
qualifyingEventDate
string | null
workingDays
object
paidWeeks
number<double> | null
paidUntilDate
string | null
isReceivingStatutoryMaternityPay
boolean
previousSicknessPeriods
object[] | null

Response

OK

message
object
content
object
validationIssues
object[] | null