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

# Annuler un lot

> Arrête le lot : les documents non traités passent `canceled` et ne sont jamais comptés ; les analyses déjà rendues restent acquises. Les fichiers en attente sont supprimés.



## OpenAPI

````yaml /openapi.json post /api/v1/batches/{id}/cancel
openapi: 3.1.0
info:
  title: API Resocom
  version: 1.0.0
  description: >-
    Créer des vérifications d'identité, analyser directement les documents que
    vous détenez déjà, et relire les résultats depuis votre système
    d'information.
servers:
  - url: https://pro.resocom.com
security:
  - cleApi: []
paths:
  /api/v1/batches/{id}/cancel:
    post:
      summary: Annuler un lot
      description: >-
        Arrête le lot : les documents non traités passent `canceled` et ne sont
        jamais comptés ; les analyses déjà rendues restent acquises. Les
        fichiers en attente sont supprimés.
      operationId: annulerLot
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Lot annulé.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Lot'
        '404':
          description: Lot inconnu.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Erreur'
        '409':
          description: Lot déjà terminé ou annulé.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Erreur'
components:
  schemas:
    Lot:
      type: object
      description: Lot d'analyses différées.
      properties:
        id:
          type: string
          example: BAT-1CBEA150-E475
        status:
          type: string
          enum:
            - open
            - in_progress
            - ended
            - canceled
          description: >-
            open : en cours de remplissage · in_progress : clôturé, en
            traitement · ended : terminé · canceled : annulé.
        externalRef:
          type:
            - string
            - 'null'
          description: Votre référence de lot.
        counts:
          type: object
          description: Compteurs par état de document.
          properties:
            total:
              type: integer
            pending:
              type: integer
              description: En attente ou en cours.
            succeeded:
              type: integer
              description: Analysés — les seuls actes comptés.
            errored:
              type: integer
            canceled:
              type: integer
            expired:
              type: integer
        submittedAt:
          type:
            - string
            - 'null'
          format: date-time
        expiresAt:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Fin de la fenêtre de complétion : les résultats sont rendus avant
            cette date.
        endedAt:
          type:
            - string
            - 'null'
          format: date-time
        createdAt:
          type: string
          format: date-time
    Erreur:
      type: object
      properties:
        error:
          type: string
          description: Code d'erreur machine.
          example: invalid_api_key
  securitySchemes:
    cleApi:
      type: http
      scheme: bearer
      bearerFormat: rsk_live_…
      description: >-
        Clé API créée dans Administration → Entreprise → Clés API (licence
        Groupe).

````