> ## 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 en/openapi/v3-current/indirect-pix.yaml GET /v1/dict/reconciliation
openapi: 3.0.3
info:
  title: Plugin BR Pix Indirect - Complete API
  description: |
    Complete API for Brazilian Pix instant payment system including
    Pix key dictionary operations, QR code generation/decoding, transactions and
    transaction limits.
  version: 1.0.0
servers:
  - url: https://plugin-pix-indirect.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/dict/reconciliation:
    get:
      tags:
        - Reconciliation API
      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.
      parameters:
        - name: page
          in: query
          description: 'Page number for pagination (default: 1, minimum: 1)'
          schema:
            type: integer
        - name: limit
          in: query
          description: 'Maximum number of items per page (default: 10, range: 1-100)'
          schema:
            type: integer
        - name: key_type
          in: query
          description: 'Filter by key type: CPF, CNPJ, EMAIL, PHONE, EVP'
          schema:
            type: string
        - name: job_type
          in: query
          description: 'Filter by job type: EVENT_SYNC, FULL_RECONCILIATION'
          schema:
            type: string
        - name: status
          in: query
          description: >-
            Filter by status: WAITING_FILE, PENDING, PROCESSING, COMPLETED,
            FAILED, CANCELLED
          schema:
            type: string
        - name: sort_order
          in: query
          description: 'Sort direction: asc or desc (default: desc - newest first)'
          schema:
            type: string
        - name: start_date
          in: query
          description: Filter from date (YYYY-MM-DD)
          schema:
            type: string
        - name: end_date
          in: query
          description: Filter to date (YYYY-MM-DD)
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllReconciliationJobsOutput'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
      deprecated: false
      security:
        - bearerAuth: []
components:
  schemas:
    GetAllReconciliationJobsOutput:
      properties:
        items:
          description: Items is the array of reconciliation jobs for the current page
          items:
            $ref: '#/components/schemas/ReconciliationJobOutput'
          type: array
        limit:
          description: Limit is the number of items per page
          example: 10
          type: integer
        page:
          description: Page is the current page number
          example: 1
          type: integer
        total:
          description: >-
            Total is the total number of reconciliation jobs matching the
            filters
          example: 25
          type: integer
      type: object
    ErrorFormat:
      type: object
      description: The response message error.
      required:
        - code
        - title
        - message
      properties:
        code:
          type: string
          description: A unique, stable identifier for the error.
        title:
          type: string
          description: A brief summary of the issue.
        message:
          type: string
          description: Detailed guidance for resolving the error.
    ReconciliationJobOutput:
      properties:
        completedAt:
          description: |-
            CompletedAt is when job finished (success, failure, or cancellation)
            Format: ISO 8601 UTC timestamp with Z suffix
          example: '2024-01-15T11:30:00Z'
          type: string
        createdAt:
          description: |-
            CreatedAt is when this reconciliation job was created
            Format: ISO 8601 UTC timestamp with Z suffix
          example: '2024-01-15T10:30:00Z'
          type: string
        entriesAdded:
          description: >-
            EntriesAdded is the number of entries created locally during
            reconciliation
          example: 10
          type: integer
        entriesRemoved:
          description: >-
            EntriesRemoved is the number of entries soft-deleted locally during
            reconciliation
          example: 5
          type: integer
        errorMessage:
          description: ErrorMessage contains error details when status = FAILED
          example: File download failed
          type: string
        expiresAt:
          description: |-
            ExpiresAt is the expiration timestamp for WAITING_FILE jobs
            Format: ISO 8601 UTC timestamp with Z suffix
          example: '2024-01-15T12:30:00Z'
          type: string
        fileId:
          description: FileID is the BTG file ID for FULL_RECONCILIATION jobs
          example: file-123456
          type: string
        id:
          description: |-
            ID is the unique identifier for this reconciliation job
            Format: UUID v7
          example: 0192c3a4-5b6d-7e8f-9a0b-1c2d3e4f5a6b
          type: string
        jobType:
          description: |-
            JobType is the type of reconciliation job
            Valid values: EVENT_SYNC, FULL_RECONCILIATION
          example: FULL_RECONCILIATION
          type: string
        keyType:
          description: |-
            KeyType is the Pix key type for this reconciliation job
            Valid values: CPF, CNPJ, EMAIL, PHONE, EVP
          example: CPF
          type: string
        orphanEntries:
          description: OrphanEntries is the number of entries without holder in CRM
          example: 2
          type: integer
        processedItems:
          description: ProcessedItems is the number of CIDs/events processed
          example: 850
          type: integer
        reason:
          description: Reason is the reason for job creation
          example: Manual reconciliation requested
          type: string
        startedAt:
          description: |-
            StartedAt is when processing started
            Format: ISO 8601 UTC timestamp with Z suffix
          example: '2024-01-15T10:30:00Z'
          type: string
        status:
          description: >-
            Status is the current status of the reconciliation job

            Valid values: WAITING_FILE, PENDING, PROCESSING, COMPLETED, FAILED,
            CANCELLED
          example: COMPLETED
          type: string
        syncFrom:
          description: |-
            SyncFrom is the start date for EVENT_SYNC jobs
            Format: ISO 8601 UTC timestamp with Z suffix
          example: '2024-01-15T10:30:00Z'
          type: string
        totalItems:
          description: TotalItems is the total number of CIDs/events to process
          example: 1000
          type: integer
        updatedAt:
          description: |-
            UpdatedAt is when this reconciliation job was last updated
            Format: ISO 8601 UTC timestamp with Z suffix
          example: '2024-01-15T11:30:00Z'
          type: string
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````