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

# Get boleto dashboard

> Returns aggregated counts, amounts, and breakdowns of boletos for the specified period.



## OpenAPI

````yaml en/openapi/v3-current/payments.yaml get /v1/dashboards/boletos
openapi: 3.0.3
info:
  title: Payments — via BTG API
  description: >-
    API for the Lerian Payments interface via BTG. It covers boleto issuance,
    cancellation, installments, and queries; bill payments (bankslip, utilities,
    and DARF), cancellation, and queries; aggregated boleto and payment
    dashboards; provider connection and outbound webhook configuration; and the
    provider webhook receiver for settlement events.
  version: v1.0.0
servers:
  - url: https://payments.sandbox.lerian.net
security: []
tags:
  - name: Health
    description: Service health and readiness endpoints
  - name: Boletos
    description: Boleto issuance, cancellation, installments, and queries
  - name: Payments
    description: Bill payments (bankslip, utilities, DARF), cancellation, and queries
  - name: Dashboards
    description: Aggregated metrics and dashboards for boletos and payments
  - name: Admin
    description: Administrative endpoints for webhook configuration
  - name: Webhooks
    description: Provider webhook receiver for settlement events
paths:
  /v1/dashboards/boletos:
    get:
      tags:
        - Dashboards
      summary: Get boleto dashboard
      description: >-
        Returns aggregated counts, amounts, and breakdowns of boletos for the
        specified period.
      parameters:
        - description: Tenant organization ID
          in: header
          name: X-Organization-Id
          required: true
          schema:
            type: string
        - description: Created from date (YYYY-MM-DD)
          in: query
          name: from
          schema:
            type: string
        - description: Created to date (YYYY-MM-DD)
          in: query
          name: to
          schema:
            type: string
        - description: Due date from (YYYY-MM-DD)
          in: query
          name: dueDateFrom
          schema:
            type: string
        - description: Due date to (YYYY-MM-DD)
          in: query
          name: dueDateTo
          schema:
            type: string
        - description: Boleto type filter
          in: query
          name: type
          schema:
            type: string
            enum:
              - TRADITIONAL
              - HYBRID
              - QR_CODE
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http.BoletoDashboardResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pluginerrors.ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pluginerrors.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pluginerrors.ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    http.BoletoDashboardResponse:
      properties:
        byStatus:
          additionalProperties:
            $ref: '#/components/schemas/boleto_adapters_http.TypeCountAmount'
          type: object
        byType:
          additionalProperties:
            $ref: '#/components/schemas/boleto_adapters_http.TypeCountAmount'
          type: object
        settlementRate:
          type: number
        totalAmount:
          type: string
        totalCanceled:
          type: integer
        totalFailed:
          type: integer
        totalInactivated:
          type: integer
        totalIssued:
          type: integer
        totalOverdue:
          type: integer
        totalOverdueAmount:
          type: string
        totalPending:
          type: integer
        totalSettled:
          type: integer
        totalSettledAmount:
          type: string
      type: object
    pluginerrors.ErrorResponse:
      properties:
        code:
          example: PBP-0001
          type: string
        details:
          additionalProperties: {}
          type: object
        message:
          example: dueDate must be in YYYY-MM-DD format
          type: string
        title:
          example: Bad Request
          type: string
      type: object
    boleto_adapters_http.TypeCountAmount:
      properties:
        amount:
          type: string
        count:
          type: integer
      type: object
  securitySchemes:
    BearerAuth:
      description: 'Bearer token authentication (format: "Bearer {token}")'
      in: header
      name: Authorization
      type: apiKey

````