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

# Obter relatório de resumo de conciliação

> Use este endpoint para recuperar um resumo de conciliação agregado para um contexto e intervalo de datas específicos, incluindo contagens e valores conciliados e não conciliados.



## OpenAPI

````yaml pt/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/summary
openapi: 3.1.0
info:
  title: APIs do Matcher
  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: 3.0.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/reports/contexts/{contextId}/summary:
    get:
      tags:
        - Reporting
      summary: Obter relatório de resumo de conciliação
      description: >-
        Use este endpoint para recuperar um resumo de conciliação agregado para
        um contexto e intervalo de datas específicos, incluindo contagens e
        valores conciliados e não conciliados.
      operationId: getSummaryReport
      parameters:
        - description: Um identificador único para rastrear a requisição entre os serviços.
          in: header
          name: X-Request-Id
          schema:
            type: string
        - description: O identificador único do contexto de conciliação.
          in: path
          name: contextId
          required: true
          schema:
            type: string
            format: uuid
        - description: Data de início (YYYY-MM-DD)
          in: query
          name: date_from
          required: true
          schema:
            type: string
            format: date
        - description: Data de fim (YYYY-MM-DD)
          in: query
          name: date_to
          required: true
          schema:
            type: string
            format: date
        - description: Filtro de ID de fonte
          in: query
          name: source_id
          schema:
            type: string
      responses:
        '200':
          description: Resumo de conciliação agregado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SummaryReportResponse'
        '400':
          description: A requisição contém parâmetros ou payload inválidos.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: A requisição não contém credenciais de autenticação válidas.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Você não tem permissão para acessar este recurso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: O recurso solicitado não foi encontrado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Ocorreu um erro inesperado no servidor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ErrorM0002:
                  $ref: '#/components/examples/ErrorM0002'
      security:
        - BearerAuth: []
components:
  schemas:
    SummaryReportResponse:
      description: Relatório de resumo agregado de conciliação
      type: object
      properties:
        matchedCount:
          type: integer
          description: Número total de transações conciliadas
        unmatchedCount:
          type: integer
          description: Número total de transações não conciliadas
        totalAmount:
          type: string
          description: Valor total de todas as transações
        matchedAmount:
          type: string
          description: Valor total das transações conciliadas
        unmatchedAmount:
          type: string
          description: Valor total das transações não conciliadas
    ErrorResponse:
      description: Resposta de erro padrão retornada por todos os endpoints da API
      type: object
      required:
        - code
        - title
        - message
      properties:
        code:
          type: string
          description: Código de erro de aplicação estável.
          example: MTCH-0001
        title:
          type: string
          description: Título de erro legível por humanos.
          example: Bad Request
        message:
          type: string
          description: Mensagem de erro legível com detalhes.
          example: context not found
        error:
          type: string
          description: Descontinuado. Mensagem de erro para compatibilidade retroativa.
          deprecated: true
        details:
          description: Contexto adicional do erro como pares chave-valor
          additionalProperties: {}
          type: object
  examples:
    ErrorM0002:
      summary: Internal Server Error
      value:
        code: MTCH-0002
        title: Internal Server Error
        message: internal server error
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Autenticação por Bearer token (formato: "Bearer {token}")'

````