> ## 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 Pension Assessment Preview

> Pension assessment preview for a specific payroll calculation task.

Returns per-employee pension assessment results after calculation but before approval.
Includes all workers — both those assessed via the AE eligibility flow and those
on the skip path (ACTIVE members and OPTED_OUT workers).



## OpenAPI

````yaml /api-reference/preview.json get /gb/organizations/{organization_id}/payrolls/{payroll_status_id}/tasks/payroll-calculation/{task_id}/pension-preview
openapi: 3.1.0
info:
  title: Intermezzo Global Payroll
  summary: Global Payroll Platform
  description: Intermezzo's global payroll apis, organized by country
  version: '2026-08-18'
  x-logo:
    url: /static/icon.svg
servers: []
security: []
paths:
  /gb/organizations/{organization_id}/payrolls/{payroll_status_id}/tasks/payroll-calculation/{task_id}/pension-preview:
    get:
      tags:
        - Great Britain
        - Payroll
        - Run Payroll
        - Task Status & Results
      summary: Get Pension Assessment Preview
      description: >-
        Pension assessment preview for a specific payroll calculation task.


        Returns per-employee pension assessment results after calculation but
        before approval.

        Includes all workers — both those assessed via the AE eligibility flow
        and those

        on the skip path (ACTIVE members and OPTED_OUT workers).
      operationId: >-
        get_pension_assessment_preview_gb_organizations__organization_id__payrolls__payroll_status_id__tasks_payroll_calculation__task_id__pension_preview_get
      parameters:
        - name: organization_id
          in: path
          required: true
          schema:
            type: string
            title: Organization Id
        - name: payroll_status_id
          in: path
          required: true
          schema:
            type: string
            title: Payroll Status Id
        - name: task_id
          in: path
          required: true
          schema:
            type: string
            title: Task Id
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 10
            title: Limit
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Cursor
        - name: prev_cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Prev Cursor
        - name: sort
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
            default:
              - id
            title: Sort
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaginatedResponse_PensionAssessmentPreviewItem_
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerToken: []
components:
  schemas:
    PaginatedResponse_PensionAssessmentPreviewItem_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/PensionAssessmentPreviewItem'
          type: array
          title: Items
        pagination:
          $ref: '#/components/schemas/PaginationMeta'
      additionalProperties: true
      type: object
      required:
        - items
        - pagination
      title: PaginatedResponse[PensionAssessmentPreviewItem]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PensionAssessmentPreviewItem:
      properties:
        employee_id:
          type: string
          title: Employee Id
        action:
          $ref: '#/components/schemas/PensionPreviewAction'
        scheme_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Scheme Id
          description: >-
            UUID of the pension scheme used for this employee; null when no
            scheme is configured for the organisation
        worker_category:
          anyOf:
            - $ref: '#/components/schemas/WorkerCategory'
            - type: 'null'
          description: >-
            AE worker category; null for workers who were skipped (already
            enrolled)
        enrolment_required:
          type: boolean
          title: Enrolment Required
          description: True if this payrun will trigger auto-enrolment on approve
        qualifying_earnings:
          anyOf:
            - type: string
              pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
            - type: 'null'
          title: Qualifying Earnings
          description: >-
            Annualised qualifying earnings used for assessment; null for skip
            workers
        employee_contribution:
          type: string
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Employee Contribution
          description: Employee pension contribution for this pay period
        employer_contribution:
          type: string
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Employer Contribution
          description: Employer pension contribution for this pay period
        reason:
          type: string
          title: Reason
          description: Human-readable explanation of why this action was determined
      additionalProperties: true
      type: object
      required:
        - employee_id
        - action
        - enrolment_required
        - employee_contribution
        - employer_contribution
        - reason
      title: PensionAssessmentPreviewItem
      description: >-
        Per-employee pension assessment result visible after calc, before
        approve.
    PaginationMeta:
      properties:
        limit:
          type: integer
          title: Limit
        has_next:
          type: boolean
          title: Has Next
          default: false
        has_prev:
          type: boolean
          title: Has Prev
          default: false
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
        prev_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Prev Cursor
        total:
          type: integer
          title: Total
          default: 0
      additionalProperties: true
      type: object
      required:
        - limit
      title: PaginationMeta
    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
    PensionPreviewAction:
      type: string
      enum:
        - WILL_ENROL
        - POSTPONED
        - ALREADY_ACTIVE
        - OPTED_OUT
        - CEASED
        - NOT_ELIGIBLE
        - EXCLUDED
      title: PensionPreviewAction
    WorkerCategory:
      type: string
      enum:
        - ELIGIBLE_JOBHOLDER
        - NON_ELIGIBLE_JOBHOLDER
        - ENTITLED_WORKER
        - EXCLUDED
      title: WorkerCategory
  securitySchemes:
    BearerToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Get token from Auth0 and paste it here

````