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

# Generate Variance Report



## OpenAPI

````yaml /api-reference/preview.json post /gb/organizations/{organization_id}/reports/variance
openapi: 3.1.0
info:
  title: Intermezzo Global Payroll
  summary: Global Payroll Platform
  description: Intermezzo's global payroll apis, organized by country
  version: '2026-08-18'
  x-logo:
    url: /static/icon.svg
servers: []
security: []
paths:
  /gb/organizations/{organization_id}/reports/variance:
    post:
      tags:
        - Great Britain
        - Reports
      summary: Generate Variance Report
      operationId: >-
        generate_variance_report_gb_organizations__organization_id__reports_variance_post
      parameters:
        - name: organization_id
          in: path
          required: true
          schema:
            type: string
            title: Organization Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VarianceReportRequest'
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportGenerationResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerToken: []
components:
  schemas:
    VarianceReportRequest:
      properties:
        tax_year:
          type: integer
          maximum: 2100
          minimum: 1901
          title: Tax Year
        tax_month:
          anyOf:
            - type: integer
              maximum: 12
              minimum: 1
            - type: 'null'
          title: Tax Month
        format:
          type: string
          enum:
            - xlsx
            - csv
            - json
          title: Format
          default: xlsx
        threshold:
          anyOf:
            - type: number
              maximum: 100
              exclusiveMinimum: 0
            - type: string
              pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Threshold
          description: >-
            Net pay variance threshold percentage; rows within this band are
            suppressed. Default 10 %.
          default: '10'
      additionalProperties: true
      type: object
      required:
        - tax_year
      title: VarianceReportRequest
    ReportGenerationResponse:
      properties:
        report_id:
          type: string
          title: Report Id
        status:
          $ref: '#/components/schemas/ReportStatus'
      additionalProperties: true
      type: object
      required:
        - report_id
        - status
      title: ReportGenerationResponse
      description: Returned by the POST trigger — the handle the client polls on.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ReportStatus:
      type: string
      enum:
        - pending
        - generating
        - ready
        - failed
      title: ReportStatus
      description: Report lifecycle, independent of the underlying Document's status.
    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

````