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

# Poll a payslip bundle

> Return the current status of a previously requested bundle.  ``download_url`` is a presigned GCS link; it is ``null`` until ``status`` is ``READY``.



## OpenAPI

````yaml /api-reference/preview.json get /gb/organizations/{organization_id}/payrolls/payslips/bundles/{bundle_id}
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}/payrolls/payslips/bundles/{bundle_id}:
    get:
      tags:
        - Great Britain
        - Payroll
      summary: Poll a payslip bundle
      description: >-
        Return the current status of a previously requested bundle. 
        ``download_url`` is a presigned GCS link; it is ``null`` until
        ``status`` is ``READY``.
      operationId: >-
        get_payslip_bundle_gb_organizations__organization_id__payrolls_payslips_bundles__bundle_id__get
      parameters:
        - in: path
          name: organization_id
          required: true
          schema:
            title: Organization Id
            type: string
        - in: path
          name: bundle_id
          required: true
          schema:
            title: Bundle Id
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayslipBundleResponse'
          description: Successful Response
        '404':
          content:
            application/json:
              examples:
                GB_BUNDLE_NOT_FOUND:
                  summary: >-
                    Raised when the requested bundle id does not exist or
                    belongs to another org.
                  value:
                    errors:
                      - code: GB_BUNDLE_NOT_FOUND
                        message: >-
                          Raised when the requested bundle id does not exist or
                          belongs to another org.
              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:
                            - GB_BUNDLE_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: >-
            - `GB_BUNDLE_NOT_FOUND`: Raised when the requested bundle id does
            not exist or belongs to another org.
        '422':
          content:
            application/json:
              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:
                            - 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.
      security:
        - BearerToken: []
components:
  schemas:
    PayslipBundleResponse:
      additionalProperties: false
      description: >-
        POST 202 and GET 200 response.


        ``download_url`` is a presigned GCS link; it is ``None`` until
        ``status`` reaches

        ``READY``.  The client polls GET with the ``bundle_id`` it received from
        POST.
      properties:
        bundle_id:
          title: Bundle Id
          type: string
        download_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Download Url
        payrun_ids:
          items:
            type: string
          title: Payrun Ids
          type: array
        status:
          $ref: '#/components/schemas/ReportStatus'
      required:
        - bundle_id
        - status
        - payrun_ids
      title: PayslipBundleResponse
      type: object
    ReportStatus:
      description: Report lifecycle, independent of the underlying Document's status.
      enum:
        - PENDING
        - GENERATING
        - READY
        - FAILED
      title: ReportStatus
      type: string
  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.