> ## 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 resumo de impacto financeiro

> Use este endpoint para recuperar um resumo de impacto financeiro mostrando a exposição financeira total não conciliada. Inclui detalhamentos por moeda e por faixa de idade para ajudar a priorizar os esforços de resolução.



## OpenAPI

````yaml pt/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/dashboard/cash-impact
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: Lerian Studio General License
servers:
  - url: https://matcher.sandbox.lerian.net
security: []
paths:
  /v1/reports/contexts/{contextId}/dashboard/cash-impact:
    get:
      tags:
        - Reporting
      summary: Obter resumo de impacto financeiro
      description: >-
        Use este endpoint para recuperar um resumo de impacto financeiro
        mostrando a exposição financeira total não conciliada. Inclui
        detalhamentos por moeda e por faixa de idade para ajudar a priorizar os
        esforços de resolução.
      operationId: getCashImpactSummary
      parameters:
        - description: A unique identifier for tracing the request across services.
          in: header
          name: X-Request-Id
          schema:
            type: string
        - description: The unique identifier of the reconciliation context.
          in: path
          name: contextId
          required: true
          schema:
            type: string
        - description: Start date (YYYY-MM-DD)
          in: query
          name: date_from
          required: true
          schema:
            type: string
        - description: End date (YYYY-MM-DD)
          in: query
          name: date_to
          required: true
          schema:
            type: string
        - description: Source ID filter
          in: query
          name: source_id
          schema:
            type: string
      responses:
        '200':
          description: >-
            Resumo de impacto financeiro com detalhamentos por moeda e faixa de
            idade
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CashImpactSummaryResponse'
        '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'
              examples:
                ErrorM0201:
                  $ref: '#/components/examples/ErrorM0201'
        '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:
    CashImpactSummaryResponse:
      description: Resumo do impacto financeiro mostrando a exposição não conciliada
      type: object
      properties:
        totalUnmatchedAmount:
          type: string
          description: Valor total não conciliado em todas as moedas (string decimal)
        byCurrency:
          type: array
          items:
            $ref: '#/components/schemas/CurrencyExposureResponse'
          description: Detalhamento por moeda
        byAge:
          type: array
          items:
            $ref: '#/components/schemas/AgeExposureResponse'
          description: Detalhamento por faixa de idade
    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
    CurrencyExposureResponse:
      description: Exposição não conciliada para uma única moeda
      type: object
      properties:
        currency:
          type: string
          description: Código da moeda
          example: USD
        amount:
          type: string
          description: Valor não conciliado nesta moeda (string decimal)
        transactionCount:
          type: integer
          format: int64
          description: Número de transações não conciliadas nesta moeda
    AgeExposureResponse:
      description: Exposição não conciliada para uma faixa de idade específica
      type: object
      properties:
        bucket:
          type: string
          description: Rótulo da faixa de idade
          example: 0-24h
        amount:
          type: string
          description: Valor não conciliado nesta faixa de idade (string decimal)
        transactionCount:
          type: integer
          format: int64
          description: Número de transações não conciliadas nesta faixa de idade
  examples:
    ErrorM0201:
      summary: Context Not Found
      value:
        code: MTCH-0110
        title: Not Found
        message: context not found
    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}")'

````