> ## 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 Tax 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}/employees/{employee_id}/tax/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}/employees/{employee_id}/tax/editions:
    get:
      tags:
        - Great Britain
        - Employees
        - Tax
      summary: Get Tax Editions
      description: >-
        The resolved timeline, ordered by `valid_from`: oldest slice first, or
        latest first with `order=desc`.
      operationId: gb_employee_tax_editions
      parameters:
        - in: path
          name: organization_id
          required: true
          schema:
            title: Organization Id
            type: string
        - in: path
          name: employee_id
          required: true
          schema:
            title: Employee 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_GBEmployeeTaxSatellite_'
          description: Successful Response
        '400':
          content:
            application/json:
              examples:
                ORG_BELONGS_TO_A_DIFFERENT_COUNTRY:
                  summary: >-
                    Raised when an organization belongs to a different country
                    than the one in the path.
                  value:
                    errors:
                      - code: ORG_BELONGS_TO_A_DIFFERENT_COUNTRY
                        message: >-
                          Raised when an organization belongs to a different
                          country than the one 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:
                            - ORG_BELONGS_TO_A_DIFFERENT_COUNTRY
                          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: >-
            - `ORG_BELONGS_TO_A_DIFFERENT_COUNTRY`: Raised when an organization
            belongs to a different country than the one in the path.
        '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.

            - `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_GBEmployeeTaxSatellite_:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/GBEmployeeTaxSatellite'
          title: Items
          type: array
        pagination:
          $ref: '#/components/schemas/PaginationMeta'
      required:
        - items
        - pagination
      title: PaginatedResponse[GBEmployeeTaxSatellite]
      type: object
    GBEmployeeTaxSatellite:
      additionalProperties: false
      properties:
        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
        edition:
          readOnly: true
          title: Edition
          type: integer
        p45_gross_pay:
          anyOf:
            - type: string
            - type: 'null'
          default: '0.00'
          description: P45 gross pay
          title: P45 Gross Pay
        p45_tax_amount:
          anyOf:
            - type: string
            - type: 'null'
          default: '0.00'
          description: P45 tax amount
          title: P45 Tax Amount
        postgraduate_loan:
          default: false
          description: Postgraduate loan?
          title: Postgraduate Loan
          type: boolean
        rti_id:
          anyOf:
            - type: string
            - type: 'null'
          description: RTI Payroll ID
          title: Rti Id
        starter_details:
          description: >-
            How the employee started, filed to HMRC on the employee's first FPS.
            Used only until HMRC accepts that FPS: later changes are stored but
            never sent, and a correction is the employer's matter with HMRC. The
            declaration does not set tax_code. EXISTING_EMPLOYMENT applies only
            under the same PAYE reference (a TUPE transfer is a new employee)
            and needs rti_id to be the payroll ID the previous provider
            reported.
          discriminator:
            mapping:
              DECLARATION: '#/components/schemas/StarterDetailsDeclaration'
              EXISTING_EMPLOYMENT: '#/components/schemas/StarterDetailsExistingEmployment'
              SECONDED: '#/components/schemas/StarterDetailsSeconded'
            propertyName: basis
          oneOf:
            - $ref: '#/components/schemas/StarterDetailsDeclaration'
            - $ref: '#/components/schemas/StarterDetailsSeconded'
            - $ref: '#/components/schemas/StarterDetailsExistingEmployment'
          title: Starter Details
        student_loan_type:
          anyOf:
            - $ref: '#/components/schemas/StudentLoanPlanType'
            - type: 'null'
          description: Student loan type
        tax_code:
          anyOf:
            - type: string
            - type: 'null'
        valid_from:
          format: date
          title: Valid From
          type: string
        valid_to:
          format: date
          title: Valid To
          type: string
      required:
        - starter_details
        - edition
        - valid_from
        - valid_to
        - created_at
        - created_by
      title: GBEmployeeTaxSatellite
      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
    StarterDetailsDeclaration:
      additionalProperties: false
      description: A new employee who completed the starter checklist.
      properties:
        basis:
          const: DECLARATION
          title: Basis
          type: string
        declaration:
          $ref: '#/components/schemas/StarterDeclaration'
          description: Starter checklist statement A, B or C
      required:
        - basis
        - declaration
      title: StarterDetailsDeclaration
      type: object
    StarterDetailsExistingEmployment:
      additionalProperties: false
      description: >-
        An employee already employed under this PAYE reference, moved from
        another

        payroll provider: HMRC already has the employment, so no starter block
        is filed.
      properties:
        basis:
          const: EXISTING_EMPLOYMENT
          title: Basis
          type: string
      required:
        - basis
      title: StarterDetailsExistingEmployment
      type: object
    StarterDetailsSeconded:
      additionalProperties: false
      description: >-
        An employee seconded to work in the UK, who completed the expatriate
        checklist.
      properties:
        basis:
          const: SECONDED
          title: Basis
          type: string
        declaration:
          anyOf:
            - $ref: '#/components/schemas/StarterDeclaration'
            - type: 'null'
          description: Starter checklist statement; required without a stay, null with one
        eea_citizen:
          description: EEA citizen; only with a stay
          title: Eea Citizen
          type: boolean
        epm6:
          description: In HMRC's modified PAYE scheme for tax-equalised expatriates
          title: Epm6
          type: boolean
        stay:
          anyOf:
            - $ref: '#/components/schemas/SecondedStay'
            - type: 'null'
          description: >-
            How long the employee intends to stay; null when not known, which
            needs epm6 and a declaration
      required:
        - basis
        - stay
        - eea_citizen
        - epm6
        - declaration
      title: StarterDetailsSeconded
      type: object
    StudentLoanPlanType:
      description: Types of student loan plans
      enum:
        - PLAN_1
        - PLAN_2
        - PLAN_4
        - PLAN_5
      title: StudentLoanPlanType
      type: string
    StarterDeclaration:
      description: The new employee's statement on HMRC's starter checklist.
      enum:
        - A
        - B
        - C
      title: StarterDeclaration
      type: string
    SecondedStay:
      enum:
        - STAY_183_DAYS_OR_MORE
        - STAY_LESS_THAN_183_DAYS
        - IN_AND_OUT_OF_UK
      title: SecondedStay
      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.