> ## 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 FPS submission details



## OpenAPI

````yaml /api-reference/preview.json get /gb/organizations/{organization_id}/payrolls/{payroll_status_id}/fps
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}/payrolls/{payroll_status_id}/fps:
    get:
      tags:
        - Great Britain
        - Payroll
        - Post Payroll
        - HMRC Filing
      summary: Get FPS submission details
      operationId: >-
        get_fps_submission_gb_organizations__organization_id__payrolls__payroll_status_id__fps_get
      parameters:
        - name: organization_id
          in: path
          required: true
          schema:
            type: string
            title: Organization Id
        - name: payroll_status_id
          in: path
          required: true
          schema:
            type: string
            title: Payroll Status Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GBFpsSubmissionResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerToken: []
components:
  schemas:
    GBFpsSubmissionResponse:
      properties:
        sm_id:
          type: string
          title: Sm Id
        state:
          $ref: '#/components/schemas/FPSSMState'
        fps_kind:
          type: string
          enum:
            - FPS
            - FPS-TIL
          title: Fps Kind
          description: FPS-TIL for a test-in-live submission, FPS for a live one
        tax_year:
          type: integer
          title: Tax Year
        tax_month:
          type: integer
          title: Tax Month
        created_at:
          type: string
          format: date-time
          title: Created At
        submitted_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Submitted At
          description: SUBMITTED transition
        acknowledged_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Acknowledged At
          description: >-
            First ACKNOWLEDGED transition: when polling found HMRC still
            processing. Depends on polling frequency; null if HMRC answered
            finally on the first poll.
        completed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Completed At
          description: SUCCESS or ERROR transition
        fps_document:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Fps Document
          description: >-
            The validated FPS document, keyed by field name; null before it's
            validated
        hmrc_response:
          anyOf:
            - type: string
            - type: 'null'
          title: Hmrc Response
          description: >-
            HMRC's terminal response (success or rejection) as XML; null until
            HMRC has given one
      additionalProperties: false
      type: object
      required:
        - sm_id
        - state
        - fps_kind
        - tax_year
        - tax_month
        - created_at
      title: GBFpsSubmissionResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    FPSSMState:
      type: string
      enum:
        - CREATED
        - VALIDATED
        - SUBMITTED
        - ACKNOWLEDGED
        - SUCCESS
        - DELETED
        - ERROR
        - ARCHIVED
      title: FPSSMState
    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.