> ## 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.

# Explain Wage Type Computation

> The type's `computation` as it reads on `valid_at`, in words.



## OpenAPI

````yaml /api-reference/preview.json get /gb/organizations/{organization_id}/wage-types/{wage_type_id}/explain
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}/explain:
    get:
      tags:
        - Great Britain
        - Wage Types
      summary: Explain Wage Type Computation
      description: The type's `computation` as it reads on `valid_at`, in words.
      operationId: gb_wage_type_explain
      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: >-
            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/WageTypeExplainResponse'
          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.
                SATELLITE_NOT_FOUND:
                  summary: >-
                    Raised on a read of a satellite that was never written:
                    neither sent when its hub was created nor written by a PUT
                    since.
                  value:
                    errors:
                      - code: SATELLITE_NOT_FOUND
                        message: >-
                          Raised on a read of a satellite that was never
                          written: neither sent when its hub was created nor
                          written by a PUT since.
              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
                            - SATELLITE_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.

            - `SATELLITE_NOT_FOUND`: Raised on a read of a satellite that was
            never written: neither sent when its hub was created nor written by
            a PUT since.
        '422':
          content:
            application/json:
              examples:
                VALUE_OUT_OF_RANGE:
                  summary: Raised when a date lies outside the satellite's coverage.
                  value:
                    errors:
                      - code: VALUE_OUT_OF_RANGE
                        message: >-
                          Raised when a date lies outside the satellite's
                          coverage.
              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:
                            - VALUE_OUT_OF_RANGE
                            - 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.

            - `VALUE_OUT_OF_RANGE`: Raised when a date lies outside the
            satellite's coverage.
      security:
        - BearerToken: []
components:
  schemas:
    WageTypeExplainResponse:
      properties:
        code:
          title: Code
          type: string
        explanation:
          title: Explanation
          type: string
        name:
          title: Name
          type: string
      required:
        - code
        - name
        - explanation
      title: WageTypeExplainResponse
      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.