> ## Documentation Index > Fetch the complete documentation index at: https://docs.intermezzo.ai/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml /api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/absences/{absence_id}/claim openapi: 3.2.0 info: title: Intermezzo Global Payroll summary: Global Payroll Platform description: Intermezzo's global payroll apis, organized by country version: '2026-10-07' x-logo: url: /static/icon.svg servers: - url: https://preview.intermezzo.ai description: Preview security: [] paths: /gb/organizations/{organization_id}/employees/{employee_id}/absences/{absence_id}/claim: get: tags: - Great Britain - Absences summary: Get Family Pay Claim description: >- 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. operationId: >- get_family_pay_claim_gb_organizations__organization_id__employees__employee_id__absences__absence_id__claim_get parameters: - name: organization_id in: path required: true schema: type: string title: Organization Id - name: employee_id in: path required: true schema: type: string title: Employee Id - name: absence_id in: path required: true schema: type: string title: Absence Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GBFamilyPayClaimResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - BearerToken: [] components: schemas: GBFamilyPayClaimResponse: properties: absence_id: type: string title: Absence Id regime: $ref: '#/components/schemas/FamilyPayRegime' eligibility: $ref: '#/components/schemas/FamilyPayEligibility' awe: anyOf: - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ - type: 'null' title: Awe awe_provenance: anyOf: - $ref: '#/components/schemas/AWEProvenance' - type: 'null' awe_method: anyOf: - type: string - type: 'null' title: Awe Method relevant_period_start: anyOf: - type: string format: date - type: 'null' title: Relevant Period Start relevant_period_end: anyOf: - type: string format: date - type: 'null' title: Relevant Period End qualifying_week_ending: type: string format: date title: Qualifying Week Ending mpp_start: type: string format: date title: Mpp Start schedule: items: $ref: '#/components/schemas/StatutoryPayWeek' type: array title: Schedule override_actor: anyOf: - type: string - type: 'null' title: Override Actor override_at: anyOf: - type: string format: date-time - type: 'null' title: Override At override_reason: anyOf: - type: string - type: 'null' title: Override Reason additionalProperties: false type: object required: - absence_id - regime - eligibility - qualifying_week_ending - mpp_start - schedule title: GBFamilyPayClaimResponse description: |- 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. HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError FamilyPayRegime: type: string enum: - SMP - SPP - SAP - SHPP - SPBP - SNCP title: FamilyPayRegime description: The six statutory family-pay regimes a claim or assignment can cover. FamilyPayEligibility: type: string enum: - ELIGIBLE - INELIGIBLE_SERVICE - INELIGIBLE_LEL - INELIGIBLE_NO_EARNINGS - AWAITING_EVIDENCE - CANCELLED title: FamilyPayEligibility description: >- Typed eligibility outcome for a family-pay claim (services enforce; plan c). AWEProvenance: type: string enum: - COMPUTED - MANUAL title: AWEProvenance description: >- Which source is operative for a claim's AWE: engine-computed or a manual override. StatutoryPayWeek: properties: week_number: type: integer title: Week Number week_start: type: string format: date title: Week Start week_ending: type: string format: date title: Week Ending amount: type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Amount payable: type: boolean title: Payable additionalProperties: false type: object required: - week_number - week_start - week_ending - amount - payable title: StatutoryPayWeek description: One week of the claim's entitlement schedule (client-facing). ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError securitySchemes: BearerToken: type: http scheme: bearer bearerFormat: JWT description: Get token from Auth0 and paste it here ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.