> ## 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 Treatment Editions

> The resolved timeline, ordered by `valid_from`: oldest slice first, or latest first with `order=desc`.



## OpenAPI

````yaml /api-reference/preview.json get /gb/organizations/{organization_id}/wage-types/{wage_type_id}/treatment/editions
openapi: 3.2.0
info:
  description: Intermezzo's global payroll apis, organized by country
  summary: Global Payroll Platform
  title: Intermezzo Global Payroll
  version: '2026-11-18'
  x-logo:
    url: /static/icon.svg
servers:
  - description: Preview
    url: https://preview.intermezzo.ai
security: []
paths:
  /gb/organizations/{organization_id}/wage-types/{wage_type_id}/treatment/editions:
    get:
      tags:
        - Great Britain
        - Wage Types
        - Treatment
      summary: Get Treatment Editions
      description: >-
        The resolved timeline, ordered by `valid_from`: oldest slice first, or
        latest first with `order=desc`.
      operationId: gb_wage_type_treatment_editions
      parameters:
        - in: path
          name: organization_id
          required: true
          schema:
            title: Organization Id
            type: string
        - in: path
          name: wage_type_id
          required: true
          schema:
            title: Wage Type Id
            type: string
        - description: Number of items per page
          in: query
          name: limit
          required: false
          schema:
            default: 10
            description: Number of items per page
            maximum: 100
            minimum: 1
            title: Limit
            type: integer
        - description: '`pagination.next_cursor` of the previous page; omit for the first'
          in: query
          name: cursor
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: '`pagination.next_cursor` of the previous page; omit for the first'
            title: Cursor
        - description: >-
            `asc` for oldest first, `desc` for newest first. Keep it the same
            while following a cursor.
          in: query
          name: order
          required: false
          schema:
            $ref: '#/components/schemas/SortOrder'
            default: ASC
            description: >-
              `asc` for oldest first, `desc` for newest first. Keep it the same
              while following a cursor.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaginatedResponse_GBWageTypeTreatmentSatellite_
          description: Successful Response
        '404':
          content:
            application/json:
              examples:
                HUB_NOT_FOUND:
                  summary: >-
                    Raised when a hub does not exist under the parent named in
                    the path.
                  value:
                    errors:
                      - code: HUB_NOT_FOUND
                        message: >-
                          Raised when a hub does not exist under the parent
                          named in the path.
              schema:
                properties:
                  errors:
                    items:
                      additionalProperties: false
                      description: >-
                        Represents an error that occurred during processing.


                        Designed for client-side i18n:

                        - code: Use this to look up translation (e.g.,
                        "HUB_NOT_FOUND")

                        - message: English fallback if translation not available

                        - field: Field name for form validation highlighting

                        - params: Dynamic values for translation interpolation
                      properties:
                        code:
                          description: Unique error code for i18n lookup
                          enum:
                            - HUB_NOT_FOUND
                          title: Code
                          type: string
                        field:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Field that caused the error
                          title: Field
                        message:
                          description: English fallback error message
                          title: Message
                          type: string
                        params:
                          anyOf:
                            - additionalProperties: true
                              type: object
                            - type: 'null'
                          description: Parameters for translation interpolation
                          title: Params
                      required:
                        - code
                        - message
                      title: ErrorDetail
                      type: object
                    type: array
                required:
                  - errors
                title: ErrorResponse
                type: object
          description: >-
            - `HUB_NOT_FOUND`: Raised when a hub does not exist under the parent
            named in the path.
        '422':
          content:
            application/json:
              examples:
                INVALID_CURSOR:
                  summary: >-
                    Raised when `cursor` is not one this list issued, or was
                    issued for the other `order`.
                  value:
                    errors:
                      - code: INVALID_CURSOR
                        message: >-
                          Raised when `cursor` is not one this list issued, or
                          was issued for the other `order`.
              schema:
                properties:
                  errors:
                    items:
                      additionalProperties: false
                      description: >-
                        Represents an error that occurred during processing.


                        Designed for client-side i18n:

                        - code: Use this to look up translation (e.g.,
                        "HUB_NOT_FOUND")

                        - message: English fallback if translation not available

                        - field: Field name for form validation highlighting

                        - params: Dynamic values for translation interpolation
                      properties:
                        code:
                          description: Unique error code for i18n lookup
                          enum:
                            - INVALID_CURSOR
                            - FIELD_REQUIRED
                            - FIELD_INVALID_TYPE_STRING
                            - FIELD_INVALID_TYPE_INT
                            - FIELD_INVALID_TYPE_FLOAT
                            - FIELD_INVALID_TYPE_BOOL
                            - FIELD_INVALID_TYPE_DICT
                            - FIELD_INVALID_TYPE_LIST
                            - FIELD_STRING_TOO_SHORT
                            - FIELD_STRING_TOO_LONG
                            - FIELD_STRING_PATTERN_MISMATCH
                            - FIELD_VALUE_TOO_SMALL
                            - FIELD_VALUE_TOO_LARGE
                            - FIELD_INVALID_DATE
                            - FIELD_INVALID_DATETIME
                            - FIELD_INVALID_TIME
                            - FIELD_INVALID_DATE_FORMAT
                            - FIELD_INVALID_DATETIME_FORMAT
                            - FIELD_INVALID_ENUM_VALUE
                            - FIELD_INVALID_EMAIL
                            - FIELD_INVALID_URL
                            - FIELD_LIST_TOO_SHORT
                            - FIELD_LIST_TOO_LONG
                            - FIELD_UNKNOWN
                            - FIELD_VALIDATION_ERROR
                          title: Code
                          type: string
                        field:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Field that caused the error
                          title: Field
                        message:
                          description: English fallback error message
                          title: Message
                          type: string
                        params:
                          anyOf:
                            - additionalProperties: true
                              type: object
                            - type: 'null'
                          description: Parameters for translation interpolation
                          title: Params
                      required:
                        - code
                        - message
                      title: ErrorDetail
                      type: object
                    type: array
                required:
                  - errors
                title: ErrorResponse
                type: object
          description: >-
            The request failed validation. Type and format errors use the
            generic FIELD_* codes.

            - `INVALID_CURSOR`: Raised when `cursor` is not one this list
            issued, or was issued for the other `order`.
      security:
        - BearerToken: []
components:
  schemas:
    SortOrder:
      enum:
        - ASC
        - DESC
      title: SortOrder
      type: string
    PaginatedResponse_GBWageTypeTreatmentSatellite_:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/GBWageTypeTreatmentSatellite'
          title: Items
          type: array
        pagination:
          $ref: '#/components/schemas/PaginationMeta'
      required:
        - items
        - pagination
      title: PaginatedResponse[GBWageTypeTreatmentSatellite]
      type: object
    GBWageTypeTreatmentSatellite:
      additionalProperties: false
      properties:
        calculation_variants:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: Calculation method variants
          title: Calculation Variants
        created_at:
          format: date-time
          readOnly: true
          title: Created At
          type: string
        created_by:
          description: >-
            Who wrote the edition: the acting user (`X-Acting-User`, else the
            access credential), `system` for our own writes, or
            `<authority>:<notice>` for a write on an authority's behalf, e.g.
            `hmrc:P6`.
          readOnly: true
          title: Created By
          type: string
        deduction_tax_treatment:
          $ref: '#/components/schemas/DeductionTaxTreatment'
          default: POST_TAX
          description: How a deduction interacts with the tax/NIC bases
        edition:
          readOnly: true
          title: Edition
          type: integer
        is_ae_qualifying:
          default: false
          description: Counts towards AE qualifying earnings
          title: Is Ae Qualifying
          type: boolean
        is_class_1a_applicable:
          default: false
          description: Whether Class 1A NI applies
          title: Is Class 1A Applicable
          type: boolean
        is_gross_up:
          default: false
          description: Whether this wage type triggers gross-up calculation
          title: Is Gross Up
          type: boolean
        is_holiday_pay_included:
          default: false
          description: Include in holiday pay calculation
          title: Is Holiday Pay Included
          type: boolean
        is_notional:
          default: false
          description: Non-cash notional earning (RCA/RSU)
          title: Is Notional
          type: boolean
        is_proratable:
          default: false
          description: Prorate on partial-period presence or mid-period rate change
          title: Is Proratable
          type: boolean
        is_salary_sacrifice_allowed:
          default: false
          description: Can be salary sacrificed
          title: Is Salary Sacrifice Allowed
          type: boolean
        last_reviewed_at:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          description: Last review date
          title: Last Reviewed At
        legislative_source:
          anyOf:
            - type: string
            - type: 'null'
          description: Legislative reference
          title: Legislative Source
        ni_class:
          $ref: '#/components/schemas/NIClass'
          description: National Insurance class
        ni_employee_applies:
          default: true
          description: Whether employee NI applies
          title: Ni Employee Applies
          type: boolean
        ni_employer_treatment:
          anyOf:
            - $ref: '#/components/schemas/EmployerNITreatment'
            - type: 'null'
          description: Employer NI treatment
        nmw_treatment:
          $ref: '#/components/schemas/NMWTreatment'
          default: EXCLUDED
          description: NMW/NLW treatment for this wage type
        opra_rule:
          $ref: '#/components/schemas/OpraRule'
          default: NOT_APPLICABLE
          description: Optional Remuneration Arrangement rule
        owner:
          anyOf:
            - type: string
            - type: 'null'
          description: Responsible owner
          title: Owner
        p11d_reportable_status:
          $ref: '#/components/schemas/TaxableStatus'
          description: P11D reporting requirement
        payrolling_eligible_status:
          $ref: '#/components/schemas/TaxableStatus'
          description: Can be payrolled
        pension_status:
          $ref: '#/components/schemas/PensionStatus'
          description: Pension inclusion status
        regularity_threshold_periods:
          anyOf:
            - type: integer
            - type: 'null'
          description: Regularity threshold periods
          title: Regularity Threshold Periods
        regularity_window_weeks:
          anyOf:
            - type: integer
            - type: 'null'
          description: Regularity detection window in weeks
          title: Regularity Window Weeks
        reviewer:
          anyOf:
            - type: string
            - type: 'null'
          description: Compliance reviewer
          title: Reviewer
        rti_payment_type:
          anyOf:
            - type: string
            - type: 'null'
          description: RTI FPS payment type mapping
          title: Rti Payment Type
        tax_timing:
          $ref: '#/components/schemas/TaxTiming'
          description: When tax is applied
        taxable_status:
          $ref: '#/components/schemas/TaxableStatus'
          description: Whether taxable under PAYE
        thresholds:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          description: Applicable thresholds
          title: Thresholds
        uses_ae_bands:
          default: false
          description: Uses AE earnings bands
          title: Uses Ae Bands
          type: boolean
        uses_official_interest_rate:
          default: false
          description: Uses HMRC official interest rate
          title: Uses Official Interest Rate
          type: boolean
        valid_from:
          format: date
          title: Valid From
          type: string
        valid_to:
          format: date
          title: Valid To
          type: string
      required:
        - taxable_status
        - tax_timing
        - ni_class
        - p11d_reportable_status
        - pension_status
        - payrolling_eligible_status
        - edition
        - valid_from
        - valid_to
        - created_at
        - created_by
      title: GBWageTypeTreatmentSatellite
      type: object
    PaginationMeta:
      additionalProperties: false
      properties:
        has_next:
          default: false
          description: A page follows; fetch it with `next_cursor`
          title: Has Next
          type: boolean
        has_prev:
          default: false
          description: A page precedes; fetch it with `prev_cursor`
          title: Has Prev
          type: boolean
        limit:
          description: Items per page, as requested
          title: Limit
          type: integer
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          description: Pass as `cursor` to get the next page; null on the last page
          title: Next Cursor
        prev_cursor:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Pass as `prev_cursor` to get the previous page; null on the first
            page
          title: Prev Cursor
        total:
          default: 0
          description: Number of items across all pages
          title: Total
          type: integer
      required:
        - limit
      title: PaginationMeta
      type: object
    DeductionTaxTreatment:
      description: How a deduction interacts with the tax/NIC bases.
      enum:
        - POST_TAX
        - PAYROLL_GIVING
      title: DeductionTaxTreatment
      type: string
    NIClass:
      description: National Insurance class.
      enum:
        - CLASS_1
        - CLASS_1A
        - NONE
        - CONDITIONAL
      title: NIClass
      type: string
    EmployerNITreatment:
      description: Employer NI treatment.
      enum:
        - SECONDARY
        - CLASS_1A
        - NONE
      title: EmployerNITreatment
      type: string
    NMWTreatment:
      description: Classification of a wage type's contribution to NMW earnings.
      enum:
        - INCLUDED
        - EXCLUDED
        - REDUCES
        - ACCOMMODATION_OFFSET
      title: NMWTreatment
      type: string
    OpraRule:
      description: Optional Remuneration Arrangement rule.
      enum:
        - 'YES'
        - 'NO'
        - NOT_APPLICABLE
      title: OpraRule
      type: string
    TaxableStatus:
      description: Whether the wage type is taxable.
      enum:
        - 'YES'
        - 'NO'
        - CONDITIONAL
      title: TaxableStatus
      type: string
    PensionStatus:
      description: Pension inclusion status.
      enum:
        - SCHEME_DEFINED
        - 'YES'
        - 'NO'
      title: PensionStatus
      type: string
    TaxTiming:
      description: When tax is applied.
      enum:
        - ON_PAYMENT
        - ON_ACCRUAL
        - ON_EVENT
      title: TaxTiming
      type: string
  securitySchemes:
    BearerToken:
      bearerFormat: JWT
      description: Get token from Auth0 and paste it here
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.