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

> Compute AWE at the supplied anchor (SI 1986/1960 reg 21).

Full-precision result; the caller applies 90%, prescribed caps, and HMRC
rounding. NO_EARNINGS (a starter with no elapsed pay day) is a 200 with
awe=null, not an error; an earnings-history data gap is a structured
error (GB_EARNINGS_HISTORY_GAP).



## OpenAPI

````yaml /api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/awe
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}/awe:
    get:
      tags:
        - Great Britain
        - AWE
      summary: Get Awe
      description: |-
        Compute AWE at the supplied anchor (SI 1986/1960 reg 21).

        Full-precision result; the caller applies 90%, prescribed caps, and HMRC
        rounding. NO_EARNINGS (a starter with no elapsed pay day) is a 200 with
        awe=null, not an error; an earnings-history data gap is a structured
        error (GB_EARNINGS_HISTORY_GAP).
      operationId: >-
        get_awe_gb_organizations__organization_id__employees__employee_id__awe_get
      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: relevant_period_end
          in: query
          required: true
          schema:
            type: string
            format: date
            description: >-
              Regime-derived relevant-period-end anchor (e.g. Saturday of the
              qualifying week)
            title: Relevant Period End
          description: >-
            Regime-derived relevant-period-end anchor (e.g. Saturday of the
            qualifying week)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AWEResult'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerToken: []
components:
  schemas:
    AWEResult:
      properties:
        outcome:
          $ref: '#/components/schemas/AWEOutcome'
        awe:
          anyOf:
            - type: string
              pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
            - type: 'null'
          title: Awe
        method:
          anyOf:
            - $ref: '#/components/schemas/DivisionMethod'
            - type: 'null'
        divisor:
          anyOf:
            - type: string
              pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
            - type: 'null'
          title: Divisor
        total_niable:
          type: string
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Total Niable
        relevant_period_start:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Relevant Period Start
        relevant_period_end:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Relevant Period End
        included_pay_dates:
          items:
            $ref: '#/components/schemas/IncludedPayment'
          type: array
          title: Included Pay Dates
        insufficient_history:
          type: boolean
          title: Insufficient History
        employed_from:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Employed From
      type: object
      required:
        - outcome
        - awe
        - method
        - divisor
        - total_niable
        - relevant_period_start
        - relevant_period_end
        - included_pay_dates
        - insufficient_history
      title: AWEResult
      description: |-
        Output of the AWE computation. Full precision; regimes apply 90%,
        prescribed caps, and HMRC rounding. NO_EARNINGS carries awe=None: a
        starter with no elapsed pay day, never a data defect (that raises).
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AWEOutcome:
      type: string
      enum:
        - COMPUTED
        - NO_EARNINGS
      title: AWEOutcome
    DivisionMethod:
      type: string
      enum:
        - WEEKLY
        - MONTHLY
        - OTHER
        - PATTERN_CHANGE
      title: DivisionMethod
    IncludedPayment:
      properties:
        pay_date:
          type: string
          format: date
          title: Pay Date
        niable:
          type: string
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Niable
        is_normal_pay_day:
          type: boolean
          title: Is Normal Pay Day
      type: object
      required:
        - pay_date
        - niable
        - is_normal_pay_day
      title: IncludedPayment
      description: >-
        One pay day that entered the AWE total, with the provenance a caller

        needs to explain the figure (design doc 06): what it carried, and
        whether

        it was a NORMAL pay day (anchors the window and its span divides) or an

        off-cycle payment (adds earnings, never time).
    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
  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.