> ## 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.

# Listar itens em aberto

> Retorna uma lista paginada por cursor de entradas de ledger residuais de item-em-aberto para um contexto de reconciliação — as obrigações carregadas, parcialmente preenchidas e envelhecidas que o contexto carrega adiante entre execuções de correspondência. Estas são estruturalmente distintas de transações nunca correspondidas (UNMATCHED). Opcionalmente restringida por status do ciclo de vida. A listagem é legível independentemente do status do contexto.



## OpenAPI

````yaml pt/openapi/v3-current/matcher.yaml get /v1/matching/contexts/{contextId}/open-items
openapi: 3.1.0
info:
  title: Matcher APIs
  description: >-
    Referência completa de API para o motor de conciliação Matcher, que fornece
    conciliação automática de transações entre o Midaz Ledger e sistemas
    externos.
  version: 4.1.0
  license:
    name: Elastic License 2.0
    url: https://www.elastic.co/licensing/elastic-license
servers:
  - url: https://matcher.sandbox.lerian.net
security: []
paths:
  /v1/matching/contexts/{contextId}/open-items:
    get:
      tags:
        - Matching
      summary: Listar itens em aberto
      description: >-
        Retorna uma lista paginada por cursor de entradas de ledger residuais de
        item-em-aberto para um contexto de reconciliação — as obrigações
        carregadas, parcialmente preenchidas e envelhecidas que o contexto
        carrega adiante entre execuções de correspondência. Estas são
        estruturalmente distintas de transações nunca correspondidas
        (UNMATCHED). Opcionalmente restringida por status do ciclo de vida. A
        listagem é legível independentemente do status do contexto.
      operationId: listOpenItems
      parameters:
        - description: Reconciliation context ID
          in: path
          name: contextId
          required: true
          schema:
            description: ID do contexto de reconciliação
            format: uuid
            type: string
        - description: Filter by open-item lifecycle status
          explode: false
          in: query
          name: status
          schema:
            description: Filtrar por status do ciclo de vida do item em aberto
            enum:
              - OPEN
              - PARTIALLY_CLEARED
              - CLEARED
              - AGED
            type: string
        - description: Maximum number of records to return
          explode: false
          in: query
          name: limit
          schema:
            default: 20
            description: Número máximo de registros a retornar
            format: int64
            maximum: 200
            minimum: 1
            type: integer
        - description: Opaque pagination cursor
          explode: false
          in: query
          name: cursor
          schema:
            description: Cursor de paginação opaco
            type: string
        - description: >-
            Field to sort by. Defaults to id (stable insertion order). ageDays
            sorts by aging anchor (oldest residuals first when descending)
          explode: false
          in: query
          name: sort_by
          schema:
            description: >-
              Campo pelo qual classificar. Assume id (ordem de inserção
              estável). ageDays classifica pela âncora de aging (residuais mais
              antigos primeiro em ordem decrescente)
            enum:
              - ageDays
              - runningBalance
              - obligationDate
            type: string
        - description: Sort order
          explode: false
          in: query
          name: sort_order
          schema:
            description: Ordem de classificação
            enum:
              - asc
              - desc
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListOpenItemsResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Erro
      security:
        - BearerAuth: []
components:
  schemas:
    ListOpenItemsResponse:
      additionalProperties: false
      properties:
        hasMore:
          examples:
            - true
          type: boolean
        items:
          description: Página de itens em aberto
          items:
            $ref: '#/components/schemas/OpenItemResponse'
          maxItems: 200
          type:
            - array
            - 'null'
        limit:
          examples:
            - 20
          format: int64
          maximum: 200
          minimum: 1
          type: integer
        nextCursor:
          examples:
            - eyJpZCI6IjEyMyJ9
          type: string
        prevCursor:
          examples:
            - eyJpZCI6IjEyMiJ9
          type: string
      required:
        - items
        - limit
        - hasMore
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Código de erro de domínio estável e legível por máquina com escopo
            no serviço emissor (formato: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: >-
            Uma explicação legível por humanos específica para esta ocorrência
            do problema.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Lista opcional de detalhes de erro individuais
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            Uma referência URI que identifica a ocorrência específica do
            problema.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: Código de status HTTP
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            Um resumo curto e legível por humanos do tipo do problema. Este
            valor não deve mudar entre ocorrências do erro.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: >-
            Uma referência URI para documentação legível por humanos sobre o
            erro.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    OpenItemResponse:
      additionalProperties: false
      properties:
        ageDays:
          description: >-
            Dias inteiros que a obrigação está aberta, medidos a partir de sua
            âncora de aging (a data de negócio da obrigação, ou o horário de
            primeira vista como fallback)
          examples:
            - 12
          format: int64
          minimum: 0
          type: integer
        contextId:
          description: ID do contexto de reconciliação ao qual este item em aberto pertence
          examples:
            - 550e8400-e29b-41d4-a716-446655440000
          type: string
        createdAt:
          description: Timestamp de criação (RFC 3339)
          examples:
            - '2025-01-15T10:30:00Z'
          type: string
        currency:
          description: Código de moeda ISO 4217 do item em aberto
          examples:
            - USD
          type: string
        expectedBalance:
          description: >-
            Obrigação pendente original quando o item foi aberto pela primeira
            vez, como uma string decimal
          examples:
            - '1000.00'
          type: string
        firstSeenAt:
          description: >-
            Quando este item em aberto foi materializado pela primeira vez no
            ledger (RFC 3339)
          examples:
            - '2025-01-15T10:30:00Z'
          type: string
        id:
          description: Identificador único do item em aberto
          examples:
            - 550e8400-e29b-41d4-a716-446655440000
          type: string
        identityKey:
          description: >-
            Projeção de identidade cross-run determinística (chaves de
            correspondência compostas + moeda) sobre a qual a compensação
            carry-forward resolve
          examples:
            - invoice=INV-1001|currency=USD
          type: string
        lastActivityAt:
          description: Timestamp da perna ou transição mais recente (RFC 3339)
          examples:
            - '2025-01-20T09:00:00Z'
          type: string
        obligationDate:
          description: >-
            Data de negócio da obrigação originária (a âncora de aging, RFC
            3339); ausente quando nenhuma foi capturada
          examples:
            - '2025-01-10T00:00:00Z'
          type: string
        runId:
          description: >-
            Execução de correspondência que aplicou a perna de liquidação mais
            recente. Ausente para um residual recém-aberto que ainda não
            compensou nenhuma perna
          examples:
            - 550e8400-e29b-41d4-a716-446655440000
          type: string
        runningBalance:
          description: >-
            Valor pendente ainda a ser compensado, como uma string decimal;
            reduz em direção a zero conforme pernas de liquidação chegam
          examples:
            - '250.00'
          type: string
        status:
          description: >-
            Status do ciclo de vida: OPEN (residual novo), PARTIALLY_CLEARED
            (uma perna compensou mas resta um residual), CLEARED (compensado
            dentro da tolerância) ou AGED (excedeu seu limite de aging enquanto
            ainda aberto)
          examples:
            - PARTIALLY_CLEARED
          type: string
        transactionId:
          description: >-
            Transação na qual o item em aberto compensou mais recentemente (a
            perna de liquidação mais recente). Ausente para um residual
            recém-aberto que ainda não compensou nenhuma perna — detalhe na
            transação sobre a qual isto resolve
          examples:
            - 550e8400-e29b-41d4-a716-446655440000
          type: string
        updatedAt:
          description: Timestamp da última atualização (RFC 3339)
          examples:
            - '2025-01-20T09:00:00Z'
          type: string
      required:
        - id
        - contextId
        - identityKey
        - currency
        - expectedBalance
        - runningBalance
        - status
        - ageDays
        - firstSeenAt
        - lastActivityAt
        - createdAt
        - updatedAt
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: 'Onde o erro ocorreu, ex.: ''body.items[3].tags'' ou ''path.thing-id'''
          type: string
        message:
          description: Texto da mensagem de erro
          type: string
        value:
          description: O valor na localização informada
      type: object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Autenticação por Bearer token (formato: "Bearer {token}")'

````