Get Family Pay Claim
The claim view: eligibility, the frozen average weekly earnings figure with its source, and the weekly entitlement schedule.
This GET has a WRITE side effect: it materialises the claim if it does not already exist (taking the employee’s absence lock to do so), so what is returned is always the exact claim the payroll run will use rather than a preview of one. A claim that already exists is read without locking.
Authorizations
Get token from Auth0 and paste it here
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.
The six statutory family-pay regimes a claim or assignment can cover.
SMP, SPP, SAP, SHPP, SPBP, SNCP Typed eligibility outcome for a family-pay claim (services enforce; plan c).
ELIGIBLE, INELIGIBLE_SERVICE, INELIGIBLE_LEL, INELIGIBLE_NO_EARNINGS, AWAITING_EVIDENCE, CANCELLED ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$Which source is operative for a claim's AWE: engine-computed or a manual override.
COMPUTED, MANUAL