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

# List Reports

> Existing reports for an org+type+tax period, one entry per format already
generated. A format with no entry has not been generated yet — the client
offers to generate it directly rather than seeing an empty row.

`employee_id` (repeatable) scopes to one or more employees' reports (YTD, whose
period is always the tax year, optionally capped at `tax_month`'s end — mirrors
the period math in `ytd.generate_ytd_report`). Omitted, this is org-wide (GTN,
variance), with `tax_month` as a single-month window.

`report_type` and `employee_id` must agree on scope — an employee-scoped type
(YTD) without `employee_id`, or an org-wide type with one, is rejected rather
than silently returning `[]` (indistinguishable from "nothing generated yet").



## OpenAPI

````yaml /api-reference/preview.json get /gb/organizations/{organization_id}/reports
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}/reports:
    get:
      tags:
        - Great Britain
        - Reports
      summary: List Reports
      description: >-
        Existing reports for an org+type+tax period, one entry per format
        already

        generated. A format with no entry has not been generated yet — the
        client

        offers to generate it directly rather than seeing an empty row.


        `employee_id` (repeatable) scopes to one or more employees' reports
        (YTD, whose

        period is always the tax year, optionally capped at `tax_month`'s end —
        mirrors

        the period math in `ytd.generate_ytd_report`). Omitted, this is org-wide
        (GTN,

        variance), with `tax_month` as a single-month window.


        `report_type` and `employee_id` must agree on scope — an employee-scoped
        type

        (YTD) without `employee_id`, or an org-wide type with one, is rejected
        rather

        than silently returning `[]` (indistinguishable from "nothing generated
        yet").
      operationId: list_reports_gb_organizations__organization_id__reports_get
      parameters:
        - name: organization_id
          in: path
          required: true
          schema:
            type: string
            title: Organization Id
        - name: report_type
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/ReportType'
        - name: tax_year
          in: query
          required: true
          schema:
            type: integer
            maximum: 2100
            minimum: 1901
            title: Tax Year
        - name: tax_month
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                maximum: 12
                minimum: 1
              - type: 'null'
            title: Tax Month
        - name: employee_id
          in: query
          required: false
          schema:
            anyOf:
              - type: array
                items:
                  type: string
                maxItems: 100
              - type: 'null'
            description: >-
              Employee-scoped reports only (YTD). Repeat to batch the check
              across several employees in one call (e.g. one page of an employee
              table) instead of one request per employee.
            title: Employee Id
          description: >-
            Employee-scoped reports only (YTD). Repeat to batch the check across
            several employees in one call (e.g. one page of an employee table)
            instead of one request per employee.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReportListItem'
                title: >-
                  Response List Reports Gb Organizations  Organization Id 
                  Reports Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerToken: []
components:
  schemas:
    ReportType:
      type: string
      enum:
        - gtn_gb
        - gtn_ae
        - variance_gb
        - p45_leavers_gb
        - p60_gb
        - wps_ae
        - ytd_gb
        - p11d_gb
        - pension_gb
        - fps_summary_gb
        - high_earners_gb
        - payroll_liability_gb
        - p32_gb
        - pension_variance_gb
        - ae_assessment_gb
        - statutory_payments_gb
        - eps_gb
        - paye_ni_details_gb
        - paye_ni_summary_gb
        - bank_detail_change_audit_gb
      title: ReportType
      description: Business report types. Grows here — never in DocumentType.
    ReportListItem:
      properties:
        format:
          type: string
          title: Format
        report_id:
          type: string
          title: Report Id
        status:
          $ref: '#/components/schemas/ReportStatus'
        regenerable:
          type: boolean
          title: Regenerable
        employee_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Employee Id
      additionalProperties: false
      type: object
      required:
        - format
        - report_id
        - status
        - regenerable
      title: ReportListItem
      description: >-
        One existing report row for a given org+type+period, returned by the
        list

        endpoint — one entry per format that has already been generated (formats
        with

        no report yet are simply absent; the client offers to generate those).


        `employee_id` is set only when the list was scoped to one or more
        employees

        (YTD, ...) — it identifies which employee this row belongs to when a
        single

        call batches the check across several employees at once (e.g. one page
        of an

        employee table), so the client can group results without firing one
        request

        per row.
    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

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.