> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flowpayroll.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Cancel leaver details for many employees in one call

> Clears the leaver status for each employee in the request body. The response always returns 200 with a structured envelope of succeeded and failed identifiers so callers can render a partial-results UI. Employees whose leaver has already been reported to HMRC via an FPS submission land in `failed` with reason `leaver_reported_to_hmrc`. Unknown employee ids land in `failed` with reason `not_found`. Employees with no leaver_details are no-ops and counted as succeeded.




## OpenAPI

````yaml /api-reference/specs/pay-api.yaml delete /employees/leaver/bulk
openapi: 3.0.3
info:
  title: FlowPayroll API
  description: >-
    API for payroll management, including payroll upload, lock, HMRC submission,
    employee management
  version: 0.1.0
servers:
  - url: https://api.sandbox.flowpayroll.ai/v1
security:
  - XAuthToken: []
    XOrgId: []
tags:
  - name: Employees
    description: >-
      Create, retrieve, update, and delete employee records, and look them up by
      NI number or payroll ID.
  - name: Starters & leavers
    description: Set and clear starter and leaver details, individually or in bulk.
  - name: Tax codes
    description: >-
      Manage employee tax codes and query the effective tax code and NI category
      on a given date.
  - name: NI & identifiers
    description: Manage NI categories, National Insurance numbers, and payroll IDs.
  - name: Student loans
    description: Start and end student and postgraduate loans.
  - name: Payroll setup
    description: Assign an employee's payroll config and set opening balances.
  - name: Payroll
  - name: Payroll lines
  - name: PayrollConfig
  - name: Pay Elements
  - name: Calculator
  - name: Payslip
  - name: RTI
  - name: YearEnd
  - name: Organisation
paths:
  /employees/leaver/bulk:
    delete:
      tags:
        - Starters & leavers
      summary: Cancel leaver details for many employees in one call
      description: >
        Clears the leaver status for each employee in the request body. The
        response always returns 200 with a structured envelope of succeeded and
        failed identifiers so callers can render a partial-results UI. Employees
        whose leaver has already been reported to HMRC via an FPS submission
        land in `failed` with reason `leaver_reported_to_hmrc`. Unknown employee
        ids land in `failed` with reason `not_found`. Employees with no
        leaver_details are no-ops and counted as succeeded.
      operationId: CancelLeaverDetailsBulk
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkCancelLeaverDetailsDto'
      responses:
        '200':
          description: Bulk cancel completed; inspect succeeded/failed
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/ResponseBody'
                  - properties:
                      content:
                        type: object
                        properties:
                          data:
                            $ref: >-
                              #/components/schemas/BulkCancelLeaverDetailsResultDto
        '400':
          description: Invalid request body or empty employeeIds list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBody'
        '500':
          description: An internal server error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBody'
components:
  schemas:
    BulkCancelLeaverDetailsDto:
      type: object
      required:
        - employeeIds
      properties:
        employeeIds:
          type: array
          description: >-
            Identifiers of the employees whose leaver status should be cleared.
            Duplicates are deduped server-side before processing.
          items:
            type: string
          example:
            - emp_12345
            - emp_67890
    ResponseBody:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        content:
          type: object
          properties:
            data:
              type: object
              nullable: true
            metadata:
              type: object
              nullable: true
              properties:
                dateFormat:
                  type: string
                  default: yyyy-MM-dd
                dateTimeFormat:
                  type: string
                  default: yyyy-MM-ddTHH:mm:ss.fffZ
                paginationToken:
                  type: string
                  nullable: true
        validationIssues:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssue'
        messageToken:
          type: string
    BulkCancelLeaverDetailsResultDto:
      type: object
      required:
        - succeeded
        - failed
      properties:
        succeeded:
          type: array
          description: >-
            Employee ids whose leaver status was cleared. Also includes
            employees who had no leaver status to begin with (idempotent no-op).
          items:
            type: string
        failed:
          type: array
          items:
            $ref: '#/components/schemas/BulkLeaverFailureDto'
    MessageWithTokenResponse:
      type: object
      properties:
        text:
          type: string
        token:
          type: string
        tokenArguments:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
    ValidationIssue:
      type: object
      description: >
        Field validation item. `reasonToken` is a stable snake_case key for i18n
        or custom client messages; `reason` is the default English text from the
        API.
      properties:
        field:
          type: string
          description: Dot-path of the field (e.g. name.firstName, address.line1).
        reason:
          type: string
          description: Default human-readable message.
        reasonToken:
          type: string
          description: Machine-readable error identifier (snake_case).
        reasonTokenArguments:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
    BulkLeaverFailureDto:
      type: object
      required:
        - employeeId
        - reason
      properties:
        employeeId:
          type: string
          example: emp_67890
        reason:
          type: string
          description: >-
            Stable snake_case token identifying the failure mode. Frontends can
            branch on this value.
          example: leaver_reported_to_hmrc
    ValidationIssueArgument:
      type: object
      properties:
        name:
          type: string
        value:
          type: string
  securitySchemes:
    XAuthToken:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: Access token obtained from OAuth2 client credentials flow
    XOrgId:
      type: apiKey
      in: header
      name: X-Org-Id
      description: >-
        Organisation to scope the request to. Required when the principal can
        access more than one organisation; optional for single-organisation
        principals (the authorizer resolves it automatically).

````