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

# Acknowledge CODA files

> Confirms that you downloaded several files in one call.

Each file gets the same treatment and the same status as a single acknowledgement. It no
longer appears in `POST /coda-files` for this API key and user, unless `redownload` is
`true`.

The files themselves are not deleted.

Send up to 200 identifiers per call.

Once the request is valid, the response is always `200`, with one result per file. Check the
`status` of each result: one file can be acknowledged while another is not found.

**Required scope:** `files:read`

**See also:** [Acknowledge a CODA file](/api/endpoints/acknowledge-coda-file)




## OpenAPI

````yaml DELETE /coda-files
openapi: 3.1.0
info:
  title: Codaclean API
  version: '1.0'
  description: >
    The Codaclean external API lets partner software (accounting tools, practice
    management software, sync agents) integrate with Codaclean on behalf of an
    accounting firm: manage its customers, request CODA and CODB mandates, and
    retrieve the CODA and CODB files Codaclean receives for them.
servers:
  - url: https://api.codaclean.io/v1
    description: Production
  - url: https://api.test.codaclean.io/v1
    description: Staging
security:
  - apiKeyAuth: []
    bearerAuth: []
tags:
  - name: Authentication
    description: Obtain and refresh the ID token sent with every other call.
  - name: Utilities
    description: Connectivity check.
  - name: Customers
    description: The customers (client companies) managed by the accounting firm.
  - name: Bank accounts
    description: Bank accounts (IBANs) linked to a customer.
  - name: Customer payroll providers
    description: Payroll providers (social secretariats) linked to a customer.
  - name: Mandates
    description: CODA mandates (per bank account) and CODB mandates (per payroll provider).
  - name: Reference data
    description: Banks and payroll providers known to Codaclean.
  - name: CODA files
    description: Bank statement files in CODA format.
  - name: CODB files
    description: Payroll files in CODB format, delivered by payroll providers.
paths:
  /coda-files:
    delete:
      tags:
        - CODA files
      summary: Acknowledge CODA files
      description: >
        Confirms that you downloaded several files in one call.


        Each file gets the same treatment and the same status as a single
        acknowledgement. It no

        longer appears in `POST /coda-files` for this API key and user, unless
        `redownload` is

        `true`.


        The files themselves are not deleted.


        Send up to 200 identifiers per call.


        Once the request is valid, the response is always `200`, with one result
        per file. Check the

        `status` of each result: one file can be acknowledged while another is
        not found.


        **Required scope:** `files:read`


        **See also:** [Acknowledge a CODA
        file](/api/endpoints/acknowledge-coda-file)
      operationId: acknowledgeCodaFiles
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileAcknowledgement'
            examples:
              several:
                summary: Several files
                value:
                  fileIds:
                    - 675b429a62c7a588e3e68af7
                    - 675b42981fbd2b49ba0c2c1a
                    - '000000000000000000000000'
              errors:
                summary: Malformed and unknown identifiers
                value:
                  fileIds:
                    - not-an-id
                    - '000000000000000000000000'
      responses:
        '200':
          description: Done. One result per file.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileAcknowledgementResults'
              examples:
                several:
                  summary: Acknowledged, already acknowledged and unknown
                  value:
                    results:
                      - fileId: 675b429a62c7a588e3e68af7
                        status: 200
                      - fileId: 675b42981fbd2b49ba0c2c1a
                        status: 409
                        message: File already confirmed
                      - fileId: '000000000000000000000000'
                        status: 404
                        message: File not found
                errors:
                  summary: Malformed and unknown identifiers
                  value:
                    results:
                      - fileId: not-an-id
                        status: 400
                        message: Invalid file identifier
                      - fileId: '000000000000000000000000'
                        status: 404
                        message: File not found
        '400':
          description: >-
            `invalidPayload` — the body is not a valid JSON object, or `fileIds`
            is missing, empty, longer than 200 or not a list of strings.
            `unknownField` — the body contains another field than `fileIds`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                invalidPayload:
                  summary: Empty fileIds
                  value:
                    message: >-
                      fileIds must be a non-empty array of at most 200 file
                      identifiers
                    code: invalidPayload
                unknownField:
                  summary: Unknown field
                  value:
                    message: 'Unknown field(s): redownload'
                    code: unknownField
                    fields:
                      - redownload
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Missing or invalid API key, or missing scope (`forbiddenScope`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                noApiKey:
                  summary: No API key
                  value:
                    message: Forbidden
                invalidApiKey:
                  summary: Invalid API key
                  value:
                    message: Forbidden
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    FileAcknowledgement:
      type: object
      required:
        - fileIds
      properties:
        fileIds:
          type: array
          minItems: 1
          maxItems: 200
          description: >
            Identifiers of the files to acknowledge, as returned in
            `files[].id`. A repeated identifier is acknowledged and reported
            once.
          items:
            type: string
    FileAcknowledgementResults:
      type: object
      required:
        - results
      properties:
        results:
          type: array
          description: One result per distinct identifier, in the order of the request.
          items:
            $ref: '#/components/schemas/FileAcknowledgementResult'
    Error:
      type: object
      description: >
        Error body. `code` is a stable, machine-readable error code, present on
        errors returned by the customers, mandates and reference-data endpoints.
        Some errors carry extra keys, such as `fields` or `candidates`.
      required:
        - message
      properties:
        message:
          type: string
          description: Human-readable description. Do not parse it.
        code:
          type: string
          description: |
            Machine-readable error code.

            **See also:** [Errors](/api/errors#error-codes)
        fields:
          type: array
          items:
            type: string
          description: >-
            Offending fields. Present with `unknownField` and
            `fieldNotUpdatable`.
        candidates:
          type: array
          description: Present with `connectorSelectionRequired`.
          items:
            $ref: '#/components/schemas/ConnectorCandidate'
    FileAcknowledgementResult:
      type: object
      required:
        - fileId
        - status
      properties:
        fileId:
          type: string
          description: The identifier, as sent.
        status:
          type: integer
          enum:
            - 200
            - 400
            - 403
            - 404
            - 409
          description: >
            The status a single acknowledgement of this file would return:


            - `200`: acknowledged by this call.

            - `400`: malformed identifier.

            - `403`: the user has no access to the file's customer (restricted
            user, or confidential
              customer and the user is not an Administrator).
            - `404`: unknown file, or its customer was not found.

            - `409`: already acknowledged with this API key and user.
        message:
          type: string
          description: >-
            Present when `status` is not `200`. Human-readable description. Do
            not parse it.
    ConnectorCandidate:
      type: object
      properties:
        connectorId:
          type: integer
        name:
          type: string
        bicCode:
          type: string
        available:
          type: boolean
    Message:
      type: object
      description: Confirmation returned by actions that do not return a resource.
      required:
        - message
      properties:
        message:
          type: string
  responses:
    Unauthorized:
      description: >-
        Missing, invalid or expired ID token, or user not allowed to use the
        API.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Message'
          examples:
            noToken:
              summary: No ID token
              value:
                message: Unauthorized
            invalidToken:
              summary: Invalid or expired ID token
              value:
                message: Unauthorized
    TooManyRequests:
      description: Rate limit or quota exceeded for this API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Message'
          examples:
            tooManyRequests:
              summary: Rate limit exceeded
              value:
                message: Too Many Requests
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            internalError:
              summary: Unexpected server error
              value:
                message: Internal server error
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Identifies the partner software. Issued by Codaclean. Required on every
        call, including `POST /token`.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT (Cognito ID token)
      description: >-
        Identifies the user and their accounting firm. Send the `idToken`
        returned by `POST /token` as `Authorization: Bearer <idToken>`. Valid
        for 1 hour.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.