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).

Path Parameters

employeeId
string
required

Query Parameters

source
string

Body

application/json
statutoryType
string
startDate
string
averageWeeklyEarnings
number<double>
endDate
string | null
paidUntilDate
string | null
paidWeeks
number<double> | null
qualifyingEventDate
string | null
requestedStartDate
string | null
isReceivingStatutoryMaternityPay
boolean
previousSicknessPeriods
object[] | null
workingDays
object
isPrimaryParent
boolean
previousPrimaryPayWeeks
integer<int32> | null
otherParentShppWeeks
integer<int32> | null
neonatalCareStartDate
string | null
neonatalCareEndDate
string | null
higherRateWeeks
integer<int32> | null
higherRateAmount
number<double> | null
standardRateWeeks
integer<int32> | null
standardRateAmount
number<double> | null

Response

OK

message
object
content
object
validationIssues
object[] | null