> ## 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 Pay Items

> List a payrun's DRAFT pay-items. Repeatable `employee_id` filters to those
employees; omit for all employees in the run. DRAFT is implicit.



## OpenAPI

````yaml /api-reference/preview.json get /gb/organizations/{organization_id}/payruns/{payrun_id}/pay-items
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}/payruns/{payrun_id}/pay-items:
    get:
      tags:
        - Great Britain
        - Pay Items
      summary: List Pay Items
      description: >-
        List a payrun's DRAFT pay-items. Repeatable `employee_id` filters to
        those

        employees; omit for all employees in the run. DRAFT is implicit.
      operationId: >-
        list_pay_items_gb_organizations__organization_id__payruns__payrun_id__pay_items_get
      parameters:
        - name: organization_id
          in: path
          required: true
          schema:
            type: string
            title: Organization Id
        - name: payrun_id
          in: path
          required: true
          schema:
            type: string
            title: Payrun Id
        - name: employee_id
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
            default: []
            title: Employee 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_PayItemResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerToken: []
components:
  schemas:
    PaginatedResponse_PayItemResponse_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/PayItemResponse'
          type: array
          title: Items
        pagination:
          $ref: '#/components/schemas/PaginationMeta'
      additionalProperties: true
      type: object
      required:
        - items
        - pagination
      title: PaginatedResponse[PayItemResponse]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PayItemResponse:
      properties:
        id:
          type: string
          title: Id
        employee_id:
          type: string
          title: Employee Id
        external_ref:
          anyOf:
            - type: string
            - type: 'null'
          title: External Ref
        wage_type_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Wage Type Code
        source:
          $ref: '#/components/schemas/PayElementSource'
        category:
          $ref: '#/components/schemas/PayElementCategory'
        amount:
          anyOf:
            - type: string
              pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
            - type: 'null'
          title: Amount
          description: >-
            The line's stored monetary amount, or null when the line is not yet
            valued. Fixed-amount earnings, benefits, deductions, reimbursements,
            and VALUED lines carry a concrete amount. Hours-based earnings store
            hours_worked/hourly_rate rather than an amount and are valued in the
            gross-to-net engine at calc time (gross = hours_worked *
            hourly_rate), so a raw hours-based line reads as null here. This is
            a raw-substrate view; it does not run valuation.
      additionalProperties: true
      type: object
      required:
        - id
        - employee_id
        - source
        - category
      title: PayItemResponse
      description: >-
        One DRAFT pay_elements line as seen by a caller (raw substrate, all
        sources).
    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
    PayElementSource:
      type: string
      enum:
        - STANDING
        - CALLER
        - RETRO_CORRECTION
        - ADMIN_ENTRY
        - VALUED
      title: PayElementSource
    PayElementCategory:
      type: string
      enum:
        - EARNING
        - BENEFIT
        - DEDUCTION
        - REIMBURSEMENT
      title: PayElementCategory
  securitySchemes:
    BearerToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Get token from Auth0 and paste it here

````