> ## 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 Absence Scheme Editions

> Every terms edition, oldest first. Editions are never rewritten, so a
superseded edition still reads `valid_to: null`; the next edition's
`valid_from` is where it stopped applying.



## OpenAPI

````yaml /api-reference/preview.json get /gb/organizations/{organization_id}/absence-schemes/{scheme_id}/editions
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}/absence-schemes/{scheme_id}/editions:
    get:
      tags:
        - Great Britain
        - Absence Schemes
      summary: List Absence Scheme Editions
      description: |-
        Every terms edition, oldest first. Editions are never rewritten, so a
        superseded edition still reads `valid_to: null`; the next edition's
        `valid_from` is where it stopped applying.
      operationId: >-
        list_absence_scheme_editions_gb_organizations__organization_id__absence_schemes__scheme_id__editions_get
      parameters:
        - name: organization_id
          in: path
          required: true
          schema:
            type: string
            title: Organization Id
        - name: scheme_id
          in: path
          required: true
          schema:
            type: string
            title: Scheme Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GBAbsenceSchemeResponse'
                title: >-
                  Response List Absence Scheme Editions Gb Organizations 
                  Organization Id  Absence Schemes  Scheme Id  Editions Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerToken: []
components:
  schemas:
    GBAbsenceSchemeResponse:
      properties:
        scheme_id:
          type: string
          title: Scheme Id
        edition_id:
          type: integer
          title: Edition Id
        name:
          type: string
          title: Name
        valid_from:
          type: string
          format: date
          title: Valid From
        valid_to:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Valid To
        terms:
          $ref: '#/components/schemas/GBSchemeTerms-Output'
        created_at:
          type: string
          format: date-time
          title: Created At
        effective_offset_mode:
          $ref: '#/components/schemas/SchemeOffsetMode'
          description: >-
            How the occupational top-up actually composes with the statutory
            line for these terms
          readOnly: true
      additionalProperties: false
      type: object
      required:
        - scheme_id
        - edition_id
        - name
        - valid_from
        - terms
        - created_at
        - effective_offset_mode
      title: GBAbsenceSchemeResponse
      description: |-
        One edition of a scheme's terms. `valid_to` is null while the edition
        is open-ended.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    GBSchemeTerms-Output:
      properties:
        content_schema_version:
          type: integer
          maximum: 1
          minimum: 1
          title: Content Schema Version
          description: >-
            Shape of the stored terms document; omit it and the current shape is
            assumed
          default: 1
        regime:
          $ref: '#/components/schemas/FamilyPayRegime'
        offset_mode:
          $ref: '#/components/schemas/SchemeOffsetMode'
        baseline:
          $ref: '#/components/schemas/SchemeBaseline'
          default: CONTRACTUAL_WEEKLY
        top_up_wage_type_code:
          type: string
          maxLength: 50
          minLength: 1
          title: Top Up Wage Type Code
          description: >-
            Catalog EARNINGS wage type the occupational top-up line is emitted
            under (validated against the catalog at scheme write)
        bands:
          items:
            $ref: '#/components/schemas/SchemeWeekBand-Output'
          type: array
          title: Bands
          description: >-
            Base band set; may be empty only when service_bands exist
            (short-service employees are then statutory-only)
        service_bands:
          anyOf:
            - items:
                $ref: '#/components/schemas/SchemeServiceBand-Output'
              type: array
            - type: 'null'
          title: Service Bands
      additionalProperties: false
      type: object
      required:
        - regime
        - offset_mode
        - top_up_wage_type_code
      title: GBSchemeTerms
      description: |-
        The occupational scheme terms: which statutory regime the scheme tops
        up, how the top-up composes with statutory pay, what it is measured
        against, and the week bands that set the occupational pay level.
    SchemeOffsetMode:
      type: string
      enum:
        - INCLUSIVE
        - ADDITIVE
        - SUBSTITUTIVE
      title: SchemeOffsetMode
      description: >-
        How occupational pay composes with the statutory line. SUBSTITUTIVE

        is an employer-facing alias that behaves as INCLUSIVE: statutory rights

        cannot be signed away. Consumers read
        `GBSchemeTerms.effective_offset_mode`,

        never the raw value.
    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
    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.
    SchemeBaseline:
      type: string
      enum:
        - CONTRACTUAL_WEEKLY
        - AWE
      title: SchemeBaseline
      description: What a band percentage is applied to.
    SchemeWeekBand-Output:
      properties:
        from_week:
          type: integer
          maximum: 52
          minimum: 1
          title: From Week
        to_week:
          type: integer
          maximum: 52
          minimum: 1
          title: To Week
        pay_level:
          $ref: '#/components/schemas/PercentOfBaselinePay-Output'
      additionalProperties: false
      type: object
      required:
        - from_week
        - to_week
        - pay_level
      title: SchemeWeekBand
      description: One band of leave weeks, 1-based, inclusive at both ends.
    SchemeServiceBand-Output:
      properties:
        min_service_months:
          type: integer
          minimum: 0
          title: Min Service Months
        bands:
          items:
            $ref: '#/components/schemas/SchemeWeekBand-Output'
          type: array
          minItems: 1
          title: Bands
      additionalProperties: false
      type: object
      required:
        - min_service_months
        - bands
      title: SchemeServiceBand
      description: |-
        A band set unlocked at a service threshold. It replaces the base
        `bands` for employees whose service is at least `min_service_months`
        (highest matching threshold wins; below every threshold the base `bands`
        apply).
    PercentOfBaselinePay-Output:
      properties:
        kind:
          type: string
          const: percent_of_baseline
          title: Kind
          default: percent_of_baseline
        percent:
          type: string
          pattern: ^(?!^[-+.]*$)[+-]?0*(?:\d{0,3}|(?=[\d.]{1,6}0*$)\d{0,3}\.\d{0,2}0*$)
          title: Percent
        statutory_floor:
          type: boolean
          title: Statutory Floor
          default: false
      additionalProperties: false
      type: object
      required:
        - percent
      title: PercentOfBaselinePay
      description: >-
        Occupational pay as a percentage of the scheme baseline.
        `statutory_floor`

        records the max(statutory, X% baseline) pattern; `statutory_floor` is
        stored

        for the valuer; it does not change validation.
  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.