> ## 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 Compensation Protocol

> Every edition ever written, cancellations included, ordered by `edition`: the order they were written in, or newest first with `order=desc`.



## OpenAPI

````yaml /api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/compensation/protocol
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}/compensation/protocol:
    get:
      tags:
        - Great Britain
        - Employees
        - Compensation
      summary: Get Compensation Protocol
      description: >-
        Every edition ever written, cancellations included, ordered by
        `edition`: the order they were written in, or newest first with
        `order=desc`.
      operationId: gb_employee_compensation_protocol
      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: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Number of items per page
            default: 10
            title: Limit
          description: Number of items per page
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: '`pagination.next_cursor` of the previous page; omit for the first'
            title: Cursor
          description: '`pagination.next_cursor` of the previous page; omit for the first'
        - name: order
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/SortOrder'
            description: >-
              `asc` for oldest first, `desc` for newest first. Keep it the same
              while following a cursor.
            default: asc
          description: >-
            `asc` for oldest first, `desc` for newest first. Keep it the same
            while following a cursor.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaginatedResponse_GBEmployeeCompensationProtocolEntry_
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerToken: []
components:
  schemas:
    SortOrder:
      type: string
      enum:
        - asc
        - desc
      title: SortOrder
    PaginatedResponse_GBEmployeeCompensationProtocolEntry_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/GBEmployeeCompensationProtocolEntry'
          type: array
          title: Items
        pagination:
          $ref: '#/components/schemas/PaginationMeta'
      additionalProperties: false
      type: object
      required:
        - items
        - pagination
      title: PaginatedResponse[GBEmployeeCompensationProtocolEntry]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    GBEmployeeCompensationProtocolEntry:
      properties:
        pay_group_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Pay Group Id
          description: The pay group the employee is paid in
        earnings:
          anyOf:
            - items:
                $ref: '#/components/schemas/AmountEarnings-Output'
              type: array
            - type: 'null'
          title: Earnings
        benefits:
          anyOf:
            - items:
                $ref: '#/components/schemas/Benefits-Output'
              type: array
            - type: 'null'
          title: Benefits
        deductions:
          anyOf:
            - items:
                $ref: '#/components/schemas/Deductions-Output'
              type: array
            - type: 'null'
          title: Deductions
        reimbursements:
          anyOf:
            - items:
                $ref: '#/components/schemas/Reimbursement-Output'
              type: array
            - type: 'null'
          title: Reimbursements
        edition:
          type: integer
          title: Edition
          readOnly: true
        valid_from:
          type: string
          format: date
          title: Valid From
        valid_to:
          type: string
          format: date
          title: Valid To
        created_at:
          type: string
          format: date-time
          title: Created At
          readOnly: true
        created_by:
          type: string
          title: 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
        cancels_edition:
          anyOf:
            - type: integer
            - type: 'null'
          title: Cancels Edition
          readOnly: true
      additionalProperties: false
      type: object
      required:
        - edition
        - valid_from
        - valid_to
        - created_at
        - created_by
      title: GBEmployeeCompensationProtocolEntry
    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
    AmountEarnings-Output:
      properties:
        external_ref:
          anyOf:
            - type: string
            - type: 'null'
          title: External Ref
          description: >-
            Caller-owned line key, scoped to (payrun, employee, wage_type).
            Re-send with the same value to patch that line in place. Omit for
            the single default line of the wage type (also patched in place on
            re-send). Use distinct values to carry multiple lines of one wage
            type.
        earning_type:
          type: string
          const: AMOUNT
          title: Earning Type
          default: AMOUNT
        wage_type_code:
          type: string
          title: Wage Type Code
          description: Wage type code from catalog (e.g. UK-E-001)
        amount:
          type: string
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Amount
          description: >-
            Earnings amount (negative values represent period adjustments, e.g.
            leave reductions)
        earning_frequency:
          anyOf:
            - $ref: '#/components/schemas/PayCycle'
            - type: 'null'
          description: If recurring, specify the frequency
          default: MONTH
        is_lumpsum:
          type: boolean
          title: Is Lumpsum
          description: True if onetime. Defaults to False
          default: false
        sacrificed_amount:
          anyOf:
            - type: string
              pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
            - type: 'null'
          title: Sacrificed Amount
          description: >-
            Amount of this earning the employee has sacrificed (Type A OpRA).
            Pre-tax. Must be > 0 when set. Wage type must have
            is_salary_sacrifice_allowed=True
      additionalProperties: false
      type: object
      required:
        - wage_type_code
        - amount
      title: AmountEarnings
      description: Fixed-amount earnings (salary, bonus, allowance). Amount + frequency.
    Benefits-Output:
      properties:
        external_ref:
          anyOf:
            - type: string
            - type: 'null'
          title: External Ref
          description: >-
            Caller-owned line key, scoped to (payrun, employee, wage_type).
            Re-send with the same value to patch that line in place. Omit for
            the single default line of the wage type (also patched in place on
            re-send). Use distinct values to carry multiple lines of one wage
            type.
        wage_type_code:
          type: string
          title: Wage Type Code
          description: Wage type code from catalog (e.g. UK-B-001)
        amount:
          anyOf:
            - type: string
              pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
            - type: 'null'
          title: Amount
          description: Amount of benefit
          default: '0.00'
        make_good_amount:
          anyOf:
            - type: string
              pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
            - type: 'null'
          title: Make Good Amount
          description: Amount paid by employee for the benefit
          default: '0.00'
        foregone_amount:
          anyOf:
            - type: string
              pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
            - type: 'null'
          title: Foregone Amount
          description: If subject to OpRa, amount foregone
          default: '0.00'
        cash_alternative_amount:
          anyOf:
            - type: string
              pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
            - type: 'null'
          title: Cash Alternative Amount
          description: >-
            Cash alternative the employee declined in favour of this benefit
            (Type B OpRA). Contributes to BIK higher-of valuation only; does NOT
            reduce gross. Requires is_salary_sacrifice_allowed=True on the wage
            type.
          default: '0.00'
      additionalProperties: false
      type: object
      required:
        - wage_type_code
      title: Benefits
    Deductions-Output:
      properties:
        external_ref:
          anyOf:
            - type: string
            - type: 'null'
          title: External Ref
          description: >-
            Caller-owned line key, scoped to (payrun, employee, wage_type).
            Re-send with the same value to patch that line in place. Omit for
            the single default line of the wage type (also patched in place on
            re-send). Use distinct values to carry multiple lines of one wage
            type.
        wage_type_code:
          type: string
          title: Wage Type Code
          description: Wage type code from catalog (e.g. UK-D-001)
        amount:
          type: string
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Amount
        sacrificed_amount:
          anyOf:
            - type: string
              pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
            - type: 'null'
          title: Sacrificed Amount
          description: >-
            Portion of this deduction that is pre-tax salary sacrifice (Type A
            OpRA). Must be > 0 and <= amount when set. Wage type must have
            is_salary_sacrifice_allowed=True (validated at service layer).
      additionalProperties: false
      type: object
      required:
        - wage_type_code
        - amount
      title: Deductions
    Reimbursement-Output:
      properties:
        external_ref:
          anyOf:
            - type: string
            - type: 'null'
          title: External Ref
          description: >-
            Caller-owned line key, scoped to (payrun, employee, wage_type).
            Re-send with the same value to patch that line in place. Omit for
            the single default line of the wage type (also patched in place on
            re-send). Use distinct values to carry multiple lines of one wage
            type.
        wage_type_code:
          type: string
          title: Wage Type Code
          description: Wage type code from catalog (e.g. UK-R-001)
        amount:
          type: string
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Amount
      additionalProperties: false
      type: object
      required:
        - wage_type_code
        - amount
      title: Reimbursement
    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.