Skip to main content
GET
Get Family Pay Claim

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
string
required
employee_id
string
required
absence_id
string
required

Response

Successful Response

The claim view: eligibility, average weekly earnings (AWE) with its provenance, and the weekly entitlement schedule. Reading this view creates the claim if it does not exist yet, so what you read is always the claim the payroll run will use.

absence_id
string
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
eligibility
enum<string>
required

Typed eligibility outcome for a family-pay claim (services enforce; plan c).

Available options:
ELIGIBLE,
INELIGIBLE_SERVICE,
INELIGIBLE_LEL,
INELIGIBLE_NO_EARNINGS,
AWAITING_EVIDENCE,
CANCELLED
qualifying_week_ending
string<date>
required
mpp_start
string<date>
required
schedule
StatutoryPayWeek · object[]
required
awe
string | null
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
awe_provenance
enum<string> | null

Which source is operative for a claim's AWE: engine-computed or a manual override.

Available options:
COMPUTED,
MANUAL
awe_method
string | null
relevant_period_start
string<date> | null
relevant_period_end
string<date> | null
override_actor
string | null
override_at
string<date-time> | null
override_reason
string | null