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

# List Earnings History

> Raw earnings-history rows over a pay-date range.

The client-side valuation escape hatch: lets a Positive Pay Input client
compute deemed (Alabaster-uplifted) AWE itself and, later, its 52-week
holiday arithmetic.



## OpenAPI

````yaml /api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/earnings-history
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}/earnings-history:
    get:
      tags:
        - Great Britain
        - AWE
      summary: List Earnings History
      description: |-
        Raw earnings-history rows over a pay-date range.

        The client-side valuation escape hatch: lets a Positive Pay Input client
        compute deemed (Alabaster-uplifted) AWE itself and, later, its 52-week
        holiday arithmetic.
      operationId: >-
        list_earnings_history_gb_organizations__organization_id__employees__employee_id__earnings_history_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: from_date
          in: query
          required: true
          schema:
            type: string
            format: date
            description: Earliest pay date included
            title: From Date
          description: Earliest pay date included
        - name: to_date
          in: query
          required: true
          schema:
            type: string
            format: date
            description: Latest pay date included
            title: To Date
          description: Latest pay date included
        - 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_EarningsHistoryRowSchema_
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerToken: []
components:
  schemas:
    PaginatedResponse_EarningsHistoryRowSchema_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/EarningsHistoryRowSchema'
          type: array
          title: Items
        pagination:
          $ref: '#/components/schemas/PaginationMeta'
      additionalProperties: false
      type: object
      required:
        - items
        - pagination
      title: PaginatedResponse[EarningsHistoryRowSchema]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    EarningsHistoryRowSchema:
      properties:
        id:
          type: integer
          title: Id
        pay_date:
          type: string
          format: date
          title: Pay Date
        is_normal_pay_day:
          type: boolean
          title: Is Normal Pay Day
        frequency:
          $ref: '#/components/schemas/PayCycle'
        period_start:
          type: string
          format: date
          title: Period Start
        period_end:
          type: string
          format: date
          title: Period End
        gross:
          type: string
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Gross
        taxable:
          type: string
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Taxable
        niable:
          type: string
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Niable
        statutory_pay:
          type: string
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Statutory Pay
        source:
          type: string
          enum:
            - MIGRATED
            - NATIVE
          title: Source
      type: object
      required:
        - id
        - pay_date
        - is_normal_pay_day
        - frequency
        - period_start
        - period_end
        - gross
        - taxable
        - niable
        - statutory_pay
        - source
      title: EarningsHistoryRowSchema
      description: >-
        One raw store row, for the earnings-history listing endpoint.


        `source` is derived from payrun_id null-ness; it is never stored. `id`
        is

        the register row's PK: cursor pagination's default sort field is "id"

        (`PaginationParams.sort`), and `create_cursor_from_record` builds the

        cursor from this schema's dump, not the underlying ORM row, so the field

        must be present here or paging past page 1 raises KeyError.
    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: false
      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
    PayCycle:
      type: string
      enum:
        - YEAR
        - MONTH
        - WEEK
        - TWO_WEEK
        - FOUR_WEEK
        - QUARTER
        - BIANNUAL
      title: PayCycle
      description: >-
        Employee pay cadence (WEEK, MONTH, etc.).


        The `UpperStrEnum` base keeps members equal to their upper-case names,
        so

        stored payloads and API strings round-trip.
  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.