> ## 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 Catalog Wage Type



## OpenAPI

````yaml /api-reference/preview.json get /gb/wage-types/{wage_type_id}
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/wage-types/{wage_type_id}:
    get:
      tags:
        - Great Britain
        - Wage Types
      summary: Get Catalog Wage Type
      operationId: gb_catalog_wage_type_get
      parameters:
        - in: path
          name: wage_type_id
          required: true
          schema:
            title: Wage Type Id
            type: string
        - description: >-
            Valid-time date to read, past or future. Defaults to today, or to
            the first upcoming edition when nothing is valid yet.
          in: query
          name: valid_at
          required: false
          schema:
            anyOf:
              - format: date
                type: string
              - type: 'null'
            description: >-
              Valid-time date to read, past or future. Defaults to today, or to
              the first upcoming edition when nothing is valid yet.
            title: Valid At
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GBWageTypeHubResponse'
          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:
              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:
                            - 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.
      security:
        - BearerToken: []
components:
  schemas:
    GBWageTypeHubResponse:
      additionalProperties: false
      description: >-
        The wage type with every satellite as it reads on one date. A satellite
        with no

        slice on an explicit date is null.
      properties:
        computation:
          anyOf:
            - $ref: '#/components/schemas/WageTypeComputationSatellite'
            - type: 'null'
        core:
          anyOf:
            - $ref: '#/components/schemas/GBWageTypeCoreSatellite'
            - type: 'null'
        country_code:
          $ref: '#/components/schemas/CountryCode'
        created_at:
          format: date-time
          readOnly: true
          title: Created At
          type: string
        created_by:
          description: >-
            Who created the hub: 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
        deleted_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: When the hub was closed
          readOnly: true
          title: Deleted At
        external_ref:
          anyOf:
            - type: string
            - type: 'null'
          title: External Ref
        id:
          title: Id
          type: string
        lifecycle:
          anyOf:
            - $ref: '#/components/schemas/WageTypeLifecycleSatellite'
            - type: 'null'
        organization_id:
          anyOf:
            - type: string
            - type: 'null'
          description: The owning organization; null for the country catalog's own types
          title: Organization Id
        system_usage:
          anyOf:
            - $ref: '#/components/schemas/WageTypeSystemUsage'
            - type: 'null'
          description: >-
            On catalog types: how an organization may use it, e.g. as an input,
            or not submit it at all because the engine calculates it
        treatment:
          anyOf:
            - $ref: '#/components/schemas/GBWageTypeTreatmentSatellite'
            - type: 'null'
        wage_type_code:
          description: Business key, unique within its owner
          title: Wage Type Code
          type: string
      required:
        - id
        - external_ref
        - created_at
        - created_by
        - deleted_at
        - organization_id
        - country_code
        - wage_type_code
        - system_usage
      title: GBWageTypeHubResponse
      type: object
    WageTypeComputationSatellite:
      additionalProperties: false
      properties:
        computation:
          discriminator:
            mapping:
              capped: '#/components/schemas/CappedSpec-Output'
              conditional: '#/components/schemas/ConditionalSpec-Output'
              divide: '#/components/schemas/DivideSpec-Output'
              fixed: '#/components/schemas/FixedSpec-Output'
              lookup_param: '#/components/schemas/LookupParamSpec'
              max: '#/components/schemas/MaxSpec-Output'
              min: '#/components/schemas/MinSpec-Output'
              multiply: '#/components/schemas/MultiplySpec-Output'
              percent_of: '#/components/schemas/PercentOfSpec-Output'
              percent_of_param: '#/components/schemas/PercentOfParamSpec-Output'
              round: '#/components/schemas/RoundSpec-Output'
              subtract: '#/components/schemas/SubtractSpec-Output'
              sum: '#/components/schemas/SumSpec-Output'
              tiered: '#/components/schemas/TieredSpec-Output'
              wage_type_ref: '#/components/schemas/WageTypeRefSpec'
            propertyName: type
          oneOf:
            - $ref: '#/components/schemas/FixedSpec-Output'
            - $ref: '#/components/schemas/PercentOfSpec-Output'
            - $ref: '#/components/schemas/PercentOfParamSpec-Output'
            - $ref: '#/components/schemas/LookupParamSpec'
            - $ref: '#/components/schemas/WageTypeRefSpec'
            - $ref: '#/components/schemas/TieredSpec-Output'
            - $ref: '#/components/schemas/CappedSpec-Output'
            - $ref: '#/components/schemas/ConditionalSpec-Output'
            - $ref: '#/components/schemas/SumSpec-Output'
            - $ref: '#/components/schemas/SubtractSpec-Output'
            - $ref: '#/components/schemas/MultiplySpec-Output'
            - $ref: '#/components/schemas/DivideSpec-Output'
            - $ref: '#/components/schemas/MinSpec-Output'
            - $ref: '#/components/schemas/MaxSpec-Output'
            - $ref: '#/components/schemas/RoundSpec-Output'
          title: Computation
        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
        depends_on:
          description: Codes whose amounts the computation reads
          items:
            type: string
          title: Depends On
          type: array
        edition:
          readOnly: true
          title: Edition
          type: integer
        locked_fields:
          description: >-
            Paths into `computation` that a write may not change; `*` locks the
            whole computation and `depends_on`
          items:
            type: string
          readOnly: true
          title: Locked Fields
          type: array
        precision:
          anyOf:
            - maximum: 6
              minimum: 0
              type: integer
            - type: 'null'
          default: 2
          description: >-
            Decimal places the result is rounded to; null leaves rounding to the
            computation itself
          title: Precision
        rounding:
          $ref: '#/components/schemas/RoundingMode'
          default: HALF_UP
        valid_from:
          format: date
          title: Valid From
          type: string
        valid_to:
          format: date
          title: Valid To
          type: string
      required:
        - computation
        - edition
        - valid_from
        - valid_to
        - created_at
        - created_by
      title: WageTypeComputationSatellite
      type: object
    GBWageTypeCoreSatellite:
      additionalProperties: false
      properties:
        category:
          $ref: '#/components/schemas/GBWageTypeCategory'
          description: Wage type category
        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
        description:
          description: Description of the wage type
          title: Description
          type: string
        edition:
          readOnly: true
          title: Edition
          type: integer
        name:
          description: Display name
          title: Name
          type: string
        valid_from:
          format: date
          title: Valid From
          type: string
        valid_to:
          format: date
          title: Valid To
          type: string
      required:
        - name
        - description
        - category
        - edition
        - valid_from
        - valid_to
        - created_at
        - created_by
      title: GBWageTypeCoreSatellite
      type: object
    CountryCode:
      description: Enum for CountryAlpha2 codes
      enum:
        - IE
        - GB
        - AE
        - US
      title: CountryCode
      type: string
    WageTypeLifecycleSatellite:
      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
        state:
          $ref: '#/components/schemas/WageTypeState'
          description: Lifecycle state
        valid_from:
          format: date
          title: Valid From
          type: string
        valid_to:
          format: date
          title: Valid To
          type: string
      required:
        - state
        - edition
        - valid_from
        - valid_to
        - created_at
        - created_by
      title: WageTypeLifecycleSatellite
      type: object
    WageTypeSystemUsage:
      description: >-
        How a catalog (platform-owned) wage type may be used by organizations.


        Set only on catalog rows (organization_id IS NULL); NULL on an
        organization's rows.
      enum:
        - DERIVABLE
        - CALCULATED_ONLY
        - NON_DERIVABLE
        - TERMINATION
      title: WageTypeSystemUsage
      type: string
    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
    CappedSpec-Output:
      properties:
        annual_cap:
          anyOf:
            - type: string
            - type: 'null'
          title: Annual Cap
        inner:
          discriminator:
            mapping:
              capped: '#/components/schemas/CappedSpec-Output'
              conditional: '#/components/schemas/ConditionalSpec-Output'
              divide: '#/components/schemas/DivideSpec-Output'
              fixed: '#/components/schemas/FixedSpec-Output'
              lookup_param: '#/components/schemas/LookupParamSpec'
              max: '#/components/schemas/MaxSpec-Output'
              min: '#/components/schemas/MinSpec-Output'
              multiply: '#/components/schemas/MultiplySpec-Output'
              percent_of: '#/components/schemas/PercentOfSpec-Output'
              percent_of_param: '#/components/schemas/PercentOfParamSpec-Output'
              round: '#/components/schemas/RoundSpec-Output'
              subtract: '#/components/schemas/SubtractSpec-Output'
              sum: '#/components/schemas/SumSpec-Output'
              tiered: '#/components/schemas/TieredSpec-Output'
              wage_type_ref: '#/components/schemas/WageTypeRefSpec'
            propertyName: type
          oneOf:
            - $ref: '#/components/schemas/FixedSpec-Output'
            - $ref: '#/components/schemas/PercentOfSpec-Output'
            - $ref: '#/components/schemas/PercentOfParamSpec-Output'
            - $ref: '#/components/schemas/LookupParamSpec'
            - $ref: '#/components/schemas/WageTypeRefSpec'
            - $ref: '#/components/schemas/TieredSpec-Output'
            - $ref: '#/components/schemas/CappedSpec-Output'
            - $ref: '#/components/schemas/ConditionalSpec-Output'
            - $ref: '#/components/schemas/SumSpec-Output'
            - $ref: '#/components/schemas/SubtractSpec-Output'
            - $ref: '#/components/schemas/MultiplySpec-Output'
            - $ref: '#/components/schemas/DivideSpec-Output'
            - $ref: '#/components/schemas/MinSpec-Output'
            - $ref: '#/components/schemas/MaxSpec-Output'
            - $ref: '#/components/schemas/RoundSpec-Output'
          title: Inner
        max_value:
          anyOf:
            - type: string
            - type: 'null'
          title: Max Value
        type:
          const: capped
          default: capped
          title: Type
          type: string
        ytd_key:
          anyOf:
            - type: string
            - type: 'null'
          title: Ytd Key
      required:
        - inner
      title: CappedSpec
      type: object
    ConditionalSpec-Output:
      properties:
        attribute:
          title: Attribute
          type: string
        branches:
          additionalProperties:
            discriminator:
              mapping:
                capped: '#/components/schemas/CappedSpec-Output'
                conditional: '#/components/schemas/ConditionalSpec-Output'
                divide: '#/components/schemas/DivideSpec-Output'
                fixed: '#/components/schemas/FixedSpec-Output'
                lookup_param: '#/components/schemas/LookupParamSpec'
                max: '#/components/schemas/MaxSpec-Output'
                min: '#/components/schemas/MinSpec-Output'
                multiply: '#/components/schemas/MultiplySpec-Output'
                percent_of: '#/components/schemas/PercentOfSpec-Output'
                percent_of_param: '#/components/schemas/PercentOfParamSpec-Output'
                round: '#/components/schemas/RoundSpec-Output'
                subtract: '#/components/schemas/SubtractSpec-Output'
                sum: '#/components/schemas/SumSpec-Output'
                tiered: '#/components/schemas/TieredSpec-Output'
                wage_type_ref: '#/components/schemas/WageTypeRefSpec'
              propertyName: type
            oneOf:
              - $ref: '#/components/schemas/FixedSpec-Output'
              - $ref: '#/components/schemas/PercentOfSpec-Output'
              - $ref: '#/components/schemas/PercentOfParamSpec-Output'
              - $ref: '#/components/schemas/LookupParamSpec'
              - $ref: '#/components/schemas/WageTypeRefSpec'
              - $ref: '#/components/schemas/TieredSpec-Output'
              - $ref: '#/components/schemas/CappedSpec-Output'
              - $ref: '#/components/schemas/ConditionalSpec-Output'
              - $ref: '#/components/schemas/SumSpec-Output'
              - $ref: '#/components/schemas/SubtractSpec-Output'
              - $ref: '#/components/schemas/MultiplySpec-Output'
              - $ref: '#/components/schemas/DivideSpec-Output'
              - $ref: '#/components/schemas/MinSpec-Output'
              - $ref: '#/components/schemas/MaxSpec-Output'
              - $ref: '#/components/schemas/RoundSpec-Output'
          title: Branches
          type: object
        default:
          anyOf:
            - discriminator:
                mapping:
                  capped: '#/components/schemas/CappedSpec-Output'
                  conditional: '#/components/schemas/ConditionalSpec-Output'
                  divide: '#/components/schemas/DivideSpec-Output'
                  fixed: '#/components/schemas/FixedSpec-Output'
                  lookup_param: '#/components/schemas/LookupParamSpec'
                  max: '#/components/schemas/MaxSpec-Output'
                  min: '#/components/schemas/MinSpec-Output'
                  multiply: '#/components/schemas/MultiplySpec-Output'
                  percent_of: '#/components/schemas/PercentOfSpec-Output'
                  percent_of_param: '#/components/schemas/PercentOfParamSpec-Output'
                  round: '#/components/schemas/RoundSpec-Output'
                  subtract: '#/components/schemas/SubtractSpec-Output'
                  sum: '#/components/schemas/SumSpec-Output'
                  tiered: '#/components/schemas/TieredSpec-Output'
                  wage_type_ref: '#/components/schemas/WageTypeRefSpec'
                propertyName: type
              oneOf:
                - $ref: '#/components/schemas/FixedSpec-Output'
                - $ref: '#/components/schemas/PercentOfSpec-Output'
                - $ref: '#/components/schemas/PercentOfParamSpec-Output'
                - $ref: '#/components/schemas/LookupParamSpec'
                - $ref: '#/components/schemas/WageTypeRefSpec'
                - $ref: '#/components/schemas/TieredSpec-Output'
                - $ref: '#/components/schemas/CappedSpec-Output'
                - $ref: '#/components/schemas/ConditionalSpec-Output'
                - $ref: '#/components/schemas/SumSpec-Output'
                - $ref: '#/components/schemas/SubtractSpec-Output'
                - $ref: '#/components/schemas/MultiplySpec-Output'
                - $ref: '#/components/schemas/DivideSpec-Output'
                - $ref: '#/components/schemas/MinSpec-Output'
                - $ref: '#/components/schemas/MaxSpec-Output'
                - $ref: '#/components/schemas/RoundSpec-Output'
            - type: 'null'
          title: Default
        type:
          const: conditional
          default: conditional
          title: Type
          type: string
      required:
        - attribute
        - branches
      title: ConditionalSpec
      type: object
    DivideSpec-Output:
      properties:
        items:
          items:
            discriminator:
              mapping:
                capped: '#/components/schemas/CappedSpec-Output'
                conditional: '#/components/schemas/ConditionalSpec-Output'
                divide: '#/components/schemas/DivideSpec-Output'
                fixed: '#/components/schemas/FixedSpec-Output'
                lookup_param: '#/components/schemas/LookupParamSpec'
                max: '#/components/schemas/MaxSpec-Output'
                min: '#/components/schemas/MinSpec-Output'
                multiply: '#/components/schemas/MultiplySpec-Output'
                percent_of: '#/components/schemas/PercentOfSpec-Output'
                percent_of_param: '#/components/schemas/PercentOfParamSpec-Output'
                round: '#/components/schemas/RoundSpec-Output'
                subtract: '#/components/schemas/SubtractSpec-Output'
                sum: '#/components/schemas/SumSpec-Output'
                tiered: '#/components/schemas/TieredSpec-Output'
                wage_type_ref: '#/components/schemas/WageTypeRefSpec'
              propertyName: type
            oneOf:
              - $ref: '#/components/schemas/FixedSpec-Output'
              - $ref: '#/components/schemas/PercentOfSpec-Output'
              - $ref: '#/components/schemas/PercentOfParamSpec-Output'
              - $ref: '#/components/schemas/LookupParamSpec'
              - $ref: '#/components/schemas/WageTypeRefSpec'
              - $ref: '#/components/schemas/TieredSpec-Output'
              - $ref: '#/components/schemas/CappedSpec-Output'
              - $ref: '#/components/schemas/ConditionalSpec-Output'
              - $ref: '#/components/schemas/SumSpec-Output'
              - $ref: '#/components/schemas/SubtractSpec-Output'
              - $ref: '#/components/schemas/MultiplySpec-Output'
              - $ref: '#/components/schemas/DivideSpec-Output'
              - $ref: '#/components/schemas/MinSpec-Output'
              - $ref: '#/components/schemas/MaxSpec-Output'
              - $ref: '#/components/schemas/RoundSpec-Output'
          title: Items
          type: array
        precision:
          anyOf:
            - type: integer
            - type: 'null'
          title: Precision
        rounding:
          $ref: '#/components/schemas/RoundingMode'
          default: HALF_UP
        type:
          const: divide
          default: divide
          title: Type
          type: string
      required:
        - items
      title: DivideSpec
      type: object
    FixedSpec-Output:
      properties:
        amount:
          title: Amount
          type: string
        type:
          const: fixed
          default: fixed
          title: Type
          type: string
      required:
        - amount
      title: FixedSpec
      type: object
    LookupParamSpec:
      properties:
        param:
          title: Param
          type: string
        type:
          const: lookup_param
          default: lookup_param
          title: Type
          type: string
      required:
        - param
      title: LookupParamSpec
      type: object
    MaxSpec-Output:
      properties:
        items:
          items:
            discriminator:
              mapping:
                capped: '#/components/schemas/CappedSpec-Output'
                conditional: '#/components/schemas/ConditionalSpec-Output'
                divide: '#/components/schemas/DivideSpec-Output'
                fixed: '#/components/schemas/FixedSpec-Output'
                lookup_param: '#/components/schemas/LookupParamSpec'
                max: '#/components/schemas/MaxSpec-Output'
                min: '#/components/schemas/MinSpec-Output'
                multiply: '#/components/schemas/MultiplySpec-Output'
                percent_of: '#/components/schemas/PercentOfSpec-Output'
                percent_of_param: '#/components/schemas/PercentOfParamSpec-Output'
                round: '#/components/schemas/RoundSpec-Output'
                subtract: '#/components/schemas/SubtractSpec-Output'
                sum: '#/components/schemas/SumSpec-Output'
                tiered: '#/components/schemas/TieredSpec-Output'
                wage_type_ref: '#/components/schemas/WageTypeRefSpec'
              propertyName: type
            oneOf:
              - $ref: '#/components/schemas/FixedSpec-Output'
              - $ref: '#/components/schemas/PercentOfSpec-Output'
              - $ref: '#/components/schemas/PercentOfParamSpec-Output'
              - $ref: '#/components/schemas/LookupParamSpec'
              - $ref: '#/components/schemas/WageTypeRefSpec'
              - $ref: '#/components/schemas/TieredSpec-Output'
              - $ref: '#/components/schemas/CappedSpec-Output'
              - $ref: '#/components/schemas/ConditionalSpec-Output'
              - $ref: '#/components/schemas/SumSpec-Output'
              - $ref: '#/components/schemas/SubtractSpec-Output'
              - $ref: '#/components/schemas/MultiplySpec-Output'
              - $ref: '#/components/schemas/DivideSpec-Output'
              - $ref: '#/components/schemas/MinSpec-Output'
              - $ref: '#/components/schemas/MaxSpec-Output'
              - $ref: '#/components/schemas/RoundSpec-Output'
          title: Items
          type: array
        type:
          const: max
          default: max
          title: Type
          type: string
      required:
        - items
      title: MaxSpec
      type: object
    MinSpec-Output:
      properties:
        items:
          items:
            discriminator:
              mapping:
                capped: '#/components/schemas/CappedSpec-Output'
                conditional: '#/components/schemas/ConditionalSpec-Output'
                divide: '#/components/schemas/DivideSpec-Output'
                fixed: '#/components/schemas/FixedSpec-Output'
                lookup_param: '#/components/schemas/LookupParamSpec'
                max: '#/components/schemas/MaxSpec-Output'
                min: '#/components/schemas/MinSpec-Output'
                multiply: '#/components/schemas/MultiplySpec-Output'
                percent_of: '#/components/schemas/PercentOfSpec-Output'
                percent_of_param: '#/components/schemas/PercentOfParamSpec-Output'
                round: '#/components/schemas/RoundSpec-Output'
                subtract: '#/components/schemas/SubtractSpec-Output'
                sum: '#/components/schemas/SumSpec-Output'
                tiered: '#/components/schemas/TieredSpec-Output'
                wage_type_ref: '#/components/schemas/WageTypeRefSpec'
              propertyName: type
            oneOf:
              - $ref: '#/components/schemas/FixedSpec-Output'
              - $ref: '#/components/schemas/PercentOfSpec-Output'
              - $ref: '#/components/schemas/PercentOfParamSpec-Output'
              - $ref: '#/components/schemas/LookupParamSpec'
              - $ref: '#/components/schemas/WageTypeRefSpec'
              - $ref: '#/components/schemas/TieredSpec-Output'
              - $ref: '#/components/schemas/CappedSpec-Output'
              - $ref: '#/components/schemas/ConditionalSpec-Output'
              - $ref: '#/components/schemas/SumSpec-Output'
              - $ref: '#/components/schemas/SubtractSpec-Output'
              - $ref: '#/components/schemas/MultiplySpec-Output'
              - $ref: '#/components/schemas/DivideSpec-Output'
              - $ref: '#/components/schemas/MinSpec-Output'
              - $ref: '#/components/schemas/MaxSpec-Output'
              - $ref: '#/components/schemas/RoundSpec-Output'
          title: Items
          type: array
        type:
          const: min
          default: min
          title: Type
          type: string
      required:
        - items
      title: MinSpec
      type: object
    MultiplySpec-Output:
      properties:
        items:
          items:
            discriminator:
              mapping:
                capped: '#/components/schemas/CappedSpec-Output'
                conditional: '#/components/schemas/ConditionalSpec-Output'
                divide: '#/components/schemas/DivideSpec-Output'
                fixed: '#/components/schemas/FixedSpec-Output'
                lookup_param: '#/components/schemas/LookupParamSpec'
                max: '#/components/schemas/MaxSpec-Output'
                min: '#/components/schemas/MinSpec-Output'
                multiply: '#/components/schemas/MultiplySpec-Output'
                percent_of: '#/components/schemas/PercentOfSpec-Output'
                percent_of_param: '#/components/schemas/PercentOfParamSpec-Output'
                round: '#/components/schemas/RoundSpec-Output'
                subtract: '#/components/schemas/SubtractSpec-Output'
                sum: '#/components/schemas/SumSpec-Output'
                tiered: '#/components/schemas/TieredSpec-Output'
                wage_type_ref: '#/components/schemas/WageTypeRefSpec'
              propertyName: type
            oneOf:
              - $ref: '#/components/schemas/FixedSpec-Output'
              - $ref: '#/components/schemas/PercentOfSpec-Output'
              - $ref: '#/components/schemas/PercentOfParamSpec-Output'
              - $ref: '#/components/schemas/LookupParamSpec'
              - $ref: '#/components/schemas/WageTypeRefSpec'
              - $ref: '#/components/schemas/TieredSpec-Output'
              - $ref: '#/components/schemas/CappedSpec-Output'
              - $ref: '#/components/schemas/ConditionalSpec-Output'
              - $ref: '#/components/schemas/SumSpec-Output'
              - $ref: '#/components/schemas/SubtractSpec-Output'
              - $ref: '#/components/schemas/MultiplySpec-Output'
              - $ref: '#/components/schemas/DivideSpec-Output'
              - $ref: '#/components/schemas/MinSpec-Output'
              - $ref: '#/components/schemas/MaxSpec-Output'
              - $ref: '#/components/schemas/RoundSpec-Output'
          title: Items
          type: array
        type:
          const: multiply
          default: multiply
          title: Type
          type: string
      required:
        - items
      title: MultiplySpec
      type: object
    PercentOfSpec-Output:
      properties:
        base:
          title: Base
          type: string
        rate:
          title: Rate
          type: string
        type:
          const: percent_of
          default: percent_of
          title: Type
          type: string
      required:
        - base
        - rate
      title: PercentOfSpec
      type: object
    PercentOfParamSpec-Output:
      properties:
        param:
          title: Param
          type: string
        rate:
          title: Rate
          type: string
        type:
          const: percent_of_param
          default: percent_of_param
          title: Type
          type: string
      required:
        - param
        - rate
      title: PercentOfParamSpec
      type: object
    RoundSpec-Output:
      properties:
        inner:
          discriminator:
            mapping:
              capped: '#/components/schemas/CappedSpec-Output'
              conditional: '#/components/schemas/ConditionalSpec-Output'
              divide: '#/components/schemas/DivideSpec-Output'
              fixed: '#/components/schemas/FixedSpec-Output'
              lookup_param: '#/components/schemas/LookupParamSpec'
              max: '#/components/schemas/MaxSpec-Output'
              min: '#/components/schemas/MinSpec-Output'
              multiply: '#/components/schemas/MultiplySpec-Output'
              percent_of: '#/components/schemas/PercentOfSpec-Output'
              percent_of_param: '#/components/schemas/PercentOfParamSpec-Output'
              round: '#/components/schemas/RoundSpec-Output'
              subtract: '#/components/schemas/SubtractSpec-Output'
              sum: '#/components/schemas/SumSpec-Output'
              tiered: '#/components/schemas/TieredSpec-Output'
              wage_type_ref: '#/components/schemas/WageTypeRefSpec'
            propertyName: type
          oneOf:
            - $ref: '#/components/schemas/FixedSpec-Output'
            - $ref: '#/components/schemas/PercentOfSpec-Output'
            - $ref: '#/components/schemas/PercentOfParamSpec-Output'
            - $ref: '#/components/schemas/LookupParamSpec'
            - $ref: '#/components/schemas/WageTypeRefSpec'
            - $ref: '#/components/schemas/TieredSpec-Output'
            - $ref: '#/components/schemas/CappedSpec-Output'
            - $ref: '#/components/schemas/ConditionalSpec-Output'
            - $ref: '#/components/schemas/SumSpec-Output'
            - $ref: '#/components/schemas/SubtractSpec-Output'
            - $ref: '#/components/schemas/MultiplySpec-Output'
            - $ref: '#/components/schemas/DivideSpec-Output'
            - $ref: '#/components/schemas/MinSpec-Output'
            - $ref: '#/components/schemas/MaxSpec-Output'
            - $ref: '#/components/schemas/RoundSpec-Output'
          title: Inner
        precision:
          default: 2
          title: Precision
          type: integer
        rounding:
          $ref: '#/components/schemas/RoundingMode'
          default: HALF_UP
        type:
          const: round
          default: round
          title: Type
          type: string
      required:
        - inner
      title: RoundSpec
      type: object
    SubtractSpec-Output:
      properties:
        items:
          items:
            discriminator:
              mapping:
                capped: '#/components/schemas/CappedSpec-Output'
                conditional: '#/components/schemas/ConditionalSpec-Output'
                divide: '#/components/schemas/DivideSpec-Output'
                fixed: '#/components/schemas/FixedSpec-Output'
                lookup_param: '#/components/schemas/LookupParamSpec'
                max: '#/components/schemas/MaxSpec-Output'
                min: '#/components/schemas/MinSpec-Output'
                multiply: '#/components/schemas/MultiplySpec-Output'
                percent_of: '#/components/schemas/PercentOfSpec-Output'
                percent_of_param: '#/components/schemas/PercentOfParamSpec-Output'
                round: '#/components/schemas/RoundSpec-Output'
                subtract: '#/components/schemas/SubtractSpec-Output'
                sum: '#/components/schemas/SumSpec-Output'
                tiered: '#/components/schemas/TieredSpec-Output'
                wage_type_ref: '#/components/schemas/WageTypeRefSpec'
              propertyName: type
            oneOf:
              - $ref: '#/components/schemas/FixedSpec-Output'
              - $ref: '#/components/schemas/PercentOfSpec-Output'
              - $ref: '#/components/schemas/PercentOfParamSpec-Output'
              - $ref: '#/components/schemas/LookupParamSpec'
              - $ref: '#/components/schemas/WageTypeRefSpec'
              - $ref: '#/components/schemas/TieredSpec-Output'
              - $ref: '#/components/schemas/CappedSpec-Output'
              - $ref: '#/components/schemas/ConditionalSpec-Output'
              - $ref: '#/components/schemas/SumSpec-Output'
              - $ref: '#/components/schemas/SubtractSpec-Output'
              - $ref: '#/components/schemas/MultiplySpec-Output'
              - $ref: '#/components/schemas/DivideSpec-Output'
              - $ref: '#/components/schemas/MinSpec-Output'
              - $ref: '#/components/schemas/MaxSpec-Output'
              - $ref: '#/components/schemas/RoundSpec-Output'
          title: Items
          type: array
        type:
          const: subtract
          default: subtract
          title: Type
          type: string
      required:
        - items
      title: SubtractSpec
      type: object
    SumSpec-Output:
      properties:
        items:
          items:
            discriminator:
              mapping:
                capped: '#/components/schemas/CappedSpec-Output'
                conditional: '#/components/schemas/ConditionalSpec-Output'
                divide: '#/components/schemas/DivideSpec-Output'
                fixed: '#/components/schemas/FixedSpec-Output'
                lookup_param: '#/components/schemas/LookupParamSpec'
                max: '#/components/schemas/MaxSpec-Output'
                min: '#/components/schemas/MinSpec-Output'
                multiply: '#/components/schemas/MultiplySpec-Output'
                percent_of: '#/components/schemas/PercentOfSpec-Output'
                percent_of_param: '#/components/schemas/PercentOfParamSpec-Output'
                round: '#/components/schemas/RoundSpec-Output'
                subtract: '#/components/schemas/SubtractSpec-Output'
                sum: '#/components/schemas/SumSpec-Output'
                tiered: '#/components/schemas/TieredSpec-Output'
                wage_type_ref: '#/components/schemas/WageTypeRefSpec'
              propertyName: type
            oneOf:
              - $ref: '#/components/schemas/FixedSpec-Output'
              - $ref: '#/components/schemas/PercentOfSpec-Output'
              - $ref: '#/components/schemas/PercentOfParamSpec-Output'
              - $ref: '#/components/schemas/LookupParamSpec'
              - $ref: '#/components/schemas/WageTypeRefSpec'
              - $ref: '#/components/schemas/TieredSpec-Output'
              - $ref: '#/components/schemas/CappedSpec-Output'
              - $ref: '#/components/schemas/ConditionalSpec-Output'
              - $ref: '#/components/schemas/SumSpec-Output'
              - $ref: '#/components/schemas/SubtractSpec-Output'
              - $ref: '#/components/schemas/MultiplySpec-Output'
              - $ref: '#/components/schemas/DivideSpec-Output'
              - $ref: '#/components/schemas/MinSpec-Output'
              - $ref: '#/components/schemas/MaxSpec-Output'
              - $ref: '#/components/schemas/RoundSpec-Output'
          title: Items
          type: array
        type:
          const: sum
          default: sum
          title: Type
          type: string
      required:
        - items
      title: SumSpec
      type: object
    TieredSpec-Output:
      properties:
        base:
          title: Base
          type: string
        brackets:
          items:
            $ref: '#/components/schemas/BracketSpec-Output'
          title: Brackets
          type: array
        type:
          const: tiered
          default: tiered
          title: Type
          type: string
      required:
        - base
        - brackets
      title: TieredSpec
      type: object
    WageTypeRefSpec:
      properties:
        code:
          title: Code
          type: string
        type:
          const: wage_type_ref
          default: wage_type_ref
          title: Type
          type: string
      required:
        - code
      title: WageTypeRefSpec
      type: object
    RoundingMode:
      description: >-
        The eight rounding modes from Python's ``decimal`` module.


        A closed mathematical set: every value maps 1:1 to a ``decimal.ROUND_*``

        constant, exposed via :attr:`decimal_mode`. Exposing all eight once
        keeps

        the set stable — a country needing e.g. ``HALF_DOWN`` never forces a

        library release. (Nearest-multiple rounding — Swiss 0.05, Swedish öre —
        is

        *not* a ``decimal`` mode and needs a richer ``Round``, not a new
        member.)
      enum:
        - HALF_UP
        - HALF_DOWN
        - HALF_EVEN
        - UP
        - DOWN
        - CEILING
        - FLOOR
        - ZERO_FIVE_UP
      title: RoundingMode
      type: string
    GBWageTypeCategory:
      description: Category of GB wage type.
      enum:
        - EARNINGS
        - DEDUCTIONS
        - BENEFITS
        - STATUTORY
        - PENSION
        - CONTRIBUTIONS
        - ADJUSTMENTS
        - REIMBURSEMENTS
      title: GBWageTypeCategory
      type: string
    WageTypeState:
      description: >-
        Lifecycle state of a wage type (the `state` of its `lifecycle`
        satellite).
      enum:
        - DRAFT
        - APPROVED
        - DEPRECATED
      title: WageTypeState
      type: string
    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
    BracketSpec-Output:
      description: >-
        One tier of a :class:`TieredSpec`.


        Interval convention is ``(floor, ceiling]`` — floor exclusive (the prior

        bracket already took it), ceiling inclusive. A ``None`` ceiling means
        "open

        upward" and is only valid on the final bracket. The boundary is
        measure-zero

        for ``Decimal``, so exclusive/inclusive only matters at exact tier
        edges.
      properties:
        ceiling:
          anyOf:
            - type: string
            - type: 'null'
          title: Ceiling
        floor:
          title: Floor
          type: string
        rate:
          title: Rate
          type: string
      required:
        - floor
        - rate
      title: BracketSpec
      type: object
  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.