> ## 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 Bank Detail Change Audit Report



## OpenAPI

````yaml /api-reference/preview.json post /gb/organizations/{organization_id}/reports/bank-detail-change-audit
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-16'
  x-logo:
    url: /static/icon.svg
servers:
  - url: https://preview.intermezzo.ai
    description: Preview
security: []
paths:
  /gb/organizations/{organization_id}/reports/bank-detail-change-audit:
    post:
      tags:
        - Great Britain
        - Reports
        - Great Britain
        - Reports
      summary: Generate Bank Detail Change Audit Report
      operationId: >-
        generate_bank_detail_change_audit_report_gb_organizations__organization_id__reports_bank_detail_change_audit_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/BankDetailChangeAuditReportRequest'
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportGenerationResponse'
        '400':
          description: >-
            - `ORG_BELONGS_TO_A_DIFFERENT_COUNTRY`: Raised when an organization
            belongs to a different country than the one in the path.
          content:
            application/json:
              schema:
                type: object
                title: ErrorResponse
                required:
                  - errors
                properties:
                  errors:
                    type: array
                    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.,
                        "ORG_NOT_FOUND")

                        - message: English fallback if translation not available

                        - field: Field name for form validation highlighting

                        - params: Dynamic values for translation interpolation
                      properties:
                        code:
                          type: string
                          enum:
                            - ORG_BELONGS_TO_A_DIFFERENT_COUNTRY
                          title: Code
                          description: Unique error code for i18n lookup
                        message:
                          type: string
                          title: Message
                          description: English fallback error message
                        field:
                          anyOf:
                            - type: string
                            - type: 'null'
                          title: Field
                          description: Field that caused the error
                        params:
                          anyOf:
                            - additionalProperties: true
                              type: object
                            - type: 'null'
                          title: Params
                          description: Parameters for translation interpolation
                      required:
                        - code
                        - message
                      title: ErrorDetail
                      type: object
              examples:
                ORG_BELONGS_TO_A_DIFFERENT_COUNTRY:
                  summary: >-
                    Raised when an organization belongs to a different country
                    than the one in the path.
                  value:
                    errors:
                      - code: ORG_BELONGS_TO_A_DIFFERENT_COUNTRY
                        message: >-
                          Raised when an organization belongs to a different
                          country than the one in the path.
        '404':
          description: '- `ORG_NOT_FOUND`: Raised when an organization is not found.'
          content:
            application/json:
              schema:
                type: object
                title: ErrorResponse
                required:
                  - errors
                properties:
                  errors:
                    type: array
                    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.,
                        "ORG_NOT_FOUND")

                        - message: English fallback if translation not available

                        - field: Field name for form validation highlighting

                        - params: Dynamic values for translation interpolation
                      properties:
                        code:
                          type: string
                          enum:
                            - ORG_NOT_FOUND
                          title: Code
                          description: Unique error code for i18n lookup
                        message:
                          type: string
                          title: Message
                          description: English fallback error message
                        field:
                          anyOf:
                            - type: string
                            - type: 'null'
                          title: Field
                          description: Field that caused the error
                        params:
                          anyOf:
                            - additionalProperties: true
                              type: object
                            - type: 'null'
                          title: Params
                          description: Parameters for translation interpolation
                      required:
                        - code
                        - message
                      title: ErrorDetail
                      type: object
              examples:
                ORG_NOT_FOUND:
                  summary: Raised when an organization is not found.
                  value:
                    errors:
                      - code: ORG_NOT_FOUND
                        message: Raised when an organization is not found.
        '409':
          description: >-
            - `REPORT_ALREADY_EXISTS`: Raised when a report of this type, period
            and format already exists or is still being generated;
            `params.report_id` names it.
          content:
            application/json:
              schema:
                type: object
                title: ErrorResponse
                required:
                  - errors
                properties:
                  errors:
                    type: array
                    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.,
                        "ORG_NOT_FOUND")

                        - message: English fallback if translation not available

                        - field: Field name for form validation highlighting

                        - params: Dynamic values for translation interpolation
                      properties:
                        code:
                          type: string
                          enum:
                            - REPORT_ALREADY_EXISTS
                          title: Code
                          description: Unique error code for i18n lookup
                        message:
                          type: string
                          title: Message
                          description: English fallback error message
                        field:
                          anyOf:
                            - type: string
                            - type: 'null'
                          title: Field
                          description: Field that caused the error
                        params:
                          anyOf:
                            - additionalProperties: true
                              type: object
                            - type: 'null'
                          title: Params
                          description: Parameters for translation interpolation
                      required:
                        - code
                        - message
                      title: ErrorDetail
                      type: object
              examples:
                REPORT_ALREADY_EXISTS:
                  summary: >-
                    Raised when a report of this type, period and format already
                    exists or is still being generated; `params.report_id` names
                    it.
                  value:
                    errors:
                      - code: REPORT_ALREADY_EXISTS
                        message: >-
                          Raised when a report of this type, period and format
                          already exists or is still being generated;
                          `params.report_id` names it.
        '422':
          description: >-
            The request failed validation. Type and format errors use the
            generic FIELD_* codes.
          content:
            application/json:
              schema:
                type: object
                title: ErrorResponse
                required:
                  - errors
                properties:
                  errors:
                    type: array
                    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.,
                        "ORG_NOT_FOUND")

                        - message: English fallback if translation not available

                        - field: Field name for form validation highlighting

                        - params: Dynamic values for translation interpolation
                      properties:
                        code:
                          type: string
                          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
                          description: Unique error code for i18n lookup
                        message:
                          type: string
                          title: Message
                          description: English fallback error message
                        field:
                          anyOf:
                            - type: string
                            - type: 'null'
                          title: Field
                          description: Field that caused the error
                        params:
                          anyOf:
                            - additionalProperties: true
                              type: object
                            - type: 'null'
                          title: Params
                          description: Parameters for translation interpolation
                      required:
                        - code
                        - message
                      title: ErrorDetail
                      type: object
      security:
        - BearerToken: []
components:
  schemas:
    BankDetailChangeAuditReportRequest:
      properties:
        date_from:
          type: string
          format: date
          title: Date From
        date_to:
          type: string
          format: date
          title: Date To
        format:
          type: string
          enum:
            - XLSX
            - CSV
            - JSON
          title: Format
          default: XLSX
      additionalProperties: false
      type: object
      required:
        - date_from
        - date_to
      title: BankDetailChangeAuditReportRequest
    ReportGenerationResponse:
      properties:
        report_id:
          type: string
          title: Report Id
        status:
          $ref: '#/components/schemas/ReportStatus'
      additionalProperties: false
      type: object
      required:
        - report_id
        - status
      title: ReportGenerationResponse
      description: Returned by the POST trigger — the handle the client polls on.
    ReportStatus:
      type: string
      enum:
        - PENDING
        - GENERATING
        - READY
        - FAILED
      title: ReportStatus
      description: Report lifecycle, independent of the underlying Document's status.
  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.