Skip to main content
PUT
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).

Path Parameters

employeeId
string
required
statutoryPayId
string
required

Body

application/json
startDate
string | null
endDate
string | null
qualifyingEventDate
string | null
averageEarningsOverride
number<double> | null
clearAverageEarningsOverride
boolean
isReceivingStatutoryMaternityPay
boolean | null
previousSicknessPeriods
object[] | null
isPrimaryParent
boolean | null
previousPrimaryPayWeeks
integer<int32> | null
otherParentShppWeeks
integer<int32> | null
neonatalCareStartDate
string | null
neonatalCareEndDate
string | null

Response

OK

message
object
content
object
validationIssues
object[] | null