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

# List All Reconciliation Jobs

> Use this endpoint to list all reconciliation jobs with optional filters.
Returns empty array [] if no jobs match the criteria.



## OpenAPI

````yaml /es/openapi/v3-current/indirect-pix.yaml get /v1/dict/reconciliation
openapi: 3.1.0
info:
  description: >-
    API for Pix Indirect via BTG. It covers DICT keys and claims; MED infraction
    reports, fraud markers, refund requests, and funds recoveries; DICT
    statistics and reconciliation; Pix transfers, refunds, and schedules; static
    QR codes and QR code decoding; immediate and due-date collections; Pix
    Automático for the payer; transaction reports and TemposTransacoes
    statistics; and inbound and outbound webhook records.
  title: Plugin BR Pix Indirect - Complete API
  version: 1.10.0
servers:
  - url: https://plugin-pix-indirect.api.lerian.net
security:
  - BearerAuth: []
paths:
  /v1/dict/reconciliation:
    get:
      tags:
        - Reconciliation
      summary: List All Reconciliation Jobs
      description: |-
        Use this endpoint to list all reconciliation jobs with optional filters.
        Returns empty array [] if no jobs match the criteria.
      operationId: dict-get-all-reconciliation-jobs
      parameters:
        - description: 'Page number for pagination (default: 1, minimum: 1)'
          explode: false
          in: query
          name: page
          schema:
            default: 1
            description: 'Page number for pagination (default: 1, minimum: 1)'
            format: int64
            type: integer
        - description: 'Maximum number of items per page (default: 10, range: 1-100)'
          explode: false
          in: query
          name: limit
          schema:
            default: 10
            description: 'Maximum number of items per page (default: 10, range: 1-100)'
            format: int64
            type: integer
        - description: 'Filter by key type: CPF, CNPJ, EMAIL, PHONE, EVP'
          explode: false
          in: query
          name: key_type
          schema:
            description: 'Filter by key type: CPF, CNPJ, EMAIL, PHONE, EVP'
            type: string
        - description: 'Filter by job type: EVENT_SYNC, FULL_RECONCILIATION'
          explode: false
          in: query
          name: job_type
          schema:
            description: 'Filter by job type: EVENT_SYNC, FULL_RECONCILIATION'
            type: string
        - description: >-
            Filter by status (comma-separated, OR-matched): WAITING_FILE,
            PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED
          explode: false
          in: query
          name: status
          schema:
            description: >-
              Filter by status (comma-separated, OR-matched): WAITING_FILE,
              PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED
            items:
              type: string
            type: array
        - description: 'Sort direction: asc or desc (default: desc - newest first)'
          explode: false
          in: query
          name: sort_order
          schema:
            description: 'Sort direction: asc or desc (default: desc - newest first)'
            type: string
        - description: Filter from date (YYYY-MM-DD)
          explode: false
          in: query
          name: start_date
          schema:
            description: Filter from date (YYYY-MM-DD)
            type: string
        - description: Filter to date (YYYY-MM-DD)
          explode: false
          in: query
          name: end_date
          schema:
            description: Filter to date (YYYY-MM-DD)
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllReconciliationJobsOutput'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Bad Request
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Internal Server Error
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Error
components:
  schemas:
    GetAllReconciliationJobsOutput:
      additionalProperties: false
      properties:
        items:
          description: Array of reconciliation jobs for the current page
          items:
            $ref: '#/components/schemas/ReconciliationJobOutput'
          type: array
        limit:
          description: Number of items per page
          examples:
            - 10
          format: int64
          type: integer
        page:
          description: Current page number
          examples:
            - 1
          format: int64
          type: integer
        total:
          description: Total number of reconciliation jobs matching the filters
          examples:
            - 25
          format: int64
          type: integer
      required:
        - items
        - page
        - limit
        - total
      type: object
    LegacyErrorBody:
      additionalProperties: false
      properties:
        fields:
          additionalProperties:
            type: string
          type: object
        headers:
          additionalProperties:
            type: string
          type: object
        message:
          type: string
        paths:
          additionalProperties:
            type: string
          type: object
        queryParams:
          additionalProperties:
            type: string
          type: object
        raw:
          type: string
        code:
          type: string
        title:
          type: string
      required:
        - code
        - title
        - message
      type: object
    ReconciliationJobOutput:
      additionalProperties: false
      properties:
        completedAt:
          description: >-
            When the job finished - success, failure, or cancellation (ISO 8601
            UTC)
          examples:
            - '2024-01-15T11:30:00Z'
          format: date-time
          type: string
        createdAt:
          description: When this reconciliation job was created (ISO 8601 UTC)
          examples:
            - '2024-01-15T10:30:00Z'
          format: date-time
          type: string
        entriesAdded:
          description: Number of entries created locally during reconciliation
          examples:
            - 10
          format: int64
          type: integer
        entriesRemoved:
          description: Number of entries soft-deleted locally during reconciliation
          examples:
            - 5
          format: int64
          type: integer
        errorMessage:
          description: Error details when status is FAILED
          examples:
            - File download failed
          type: string
        expiresAt:
          description: Expiration timestamp for WAITING_FILE jobs (ISO 8601 UTC)
          examples:
            - '2024-01-15T12:30:00Z'
          format: date-time
          type: string
        fileId:
          description: BTG file ID for FULL_RECONCILIATION jobs
          examples:
            - file-123456
          type: string
        id:
          description: Unique identifier for this reconciliation job (UUID v7)
          examples:
            - 0192c3a4-5b6d-7e8f-9a0b-1c2d3e4f5a6b
          type: string
        jobType:
          description: Type of reconciliation job
          examples:
            - FULL_RECONCILIATION
          type: string
        keyType:
          description: PIX key type for this reconciliation job
          examples:
            - CPF
          type: string
        orphanEntries:
          description: Number of entries without holder in CRM
          examples:
            - 2
          format: int64
          type: integer
        processedItems:
          description: Number of CIDs/events processed
          examples:
            - 850
          format: int64
          type: integer
        reason:
          description: Reason for job creation
          examples:
            - Manual reconciliation requested
          type: string
        startedAt:
          description: When processing started (ISO 8601 UTC)
          examples:
            - '2024-01-15T10:30:00Z'
          format: date-time
          type: string
        status:
          description: Current status of the reconciliation job
          examples:
            - COMPLETED
          type: string
        syncFrom:
          description: Start date for EVENT_SYNC jobs (ISO 8601 UTC)
          examples:
            - '2024-01-15T10:30:00Z'
          format: date-time
          type: string
        totalItems:
          description: Total number of CIDs/events to process
          examples:
            - 1000
          format: int64
          type: integer
        updatedAt:
          description: When this reconciliation job was last updated (ISO 8601 UTC)
          examples:
            - '2024-01-15T11:30:00Z'
          format: date-time
          type: string
      required:
        - id
        - keyType
        - jobType
        - status
        - processedItems
        - entriesAdded
        - entriesRemoved
        - orphanEntries
        - createdAt
        - updatedAt
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````

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