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

> Lista boletos com filtros opcionais por status, type, kind, datas e paginação.



## OpenAPI

````yaml pt/openapi/v3-current/payments.yaml get /v1/boletos
openapi: 3.0.3
info:
  title: Payments — via BTG API
  description: >-
    API da interface de Pagamentos da Lerian via BTG. Cobre a emissão,
    cancelamento, parcelas e consultas de boletos; o pagamento de contas
    (boleto, concessionárias e DARF), seu cancelamento e consultas; painéis
    agregados de boletos e pagamentos; a conexão do provedor e a configuração de
    webhooks de saída; e o receptor de webhooks do provedor para eventos de
    liquidação.
  version: v1.0.0
servers:
  - url: https://payments.sandbox.lerian.net
security: []
tags:
  - name: Health
    description: Endpoints de saúde e prontidão do serviço
  - name: Boletos
    description: Emissão, cancelamento, parcelas e consultas de boletos
  - name: Payments
    description: >-
      Pagamentos de contas (boleto, concessionárias, DARF), cancelamento e
      consultas
  - name: Dashboards
    description: Métricas agregadas e painéis de boletos e pagamentos
  - name: Admin
    description: Endpoints administrativos para configuração de webhooks
  - name: Webhooks
    description: Receptor de webhooks do provedor para eventos de liquidação
paths:
  /v1/boletos:
    get:
      tags:
        - Boletos
      summary: Listar boletos
      description: >-
        Lista boletos com filtros opcionais por status, type, kind, datas e
        paginação.
      parameters:
        - description: Tenant organization ID
          in: header
          name: X-Organization-Id
          required: true
          schema:
            type: string
        - description: 'Page number (default: 1)'
          in: query
          name: page
          schema:
            type: integer
        - description: 'Items per page (default: 20, max: 100)'
          in: query
          name: limit
          schema:
            type: integer
        - description: Status filter
          in: query
          name: status
          schema:
            type: string
            enum:
              - PENDING
              - CREATED
              - SETTLED
              - CANCELED
              - INACTIVATED
              - FAILED
        - description: Boleto type filter
          in: query
          name: type
          schema:
            type: string
            enum:
              - TRADITIONAL
              - QR_CODE
              - HYBRID
        - description: Boleto kind filter
          in: query
          name: kind
          schema:
            type: string
            enum:
              - SINGLE
              - INSTALLMENT
        - 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
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http.ListBoletosResponse'
        '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.ListBoletosResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/http.GetBoletoResponse'
          type: array
        limit:
          type: integer
        page:
          type: integer
        total:
          type: integer
      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
    http.GetBoletoResponse:
      properties:
        amount:
          type: string
        barcode:
          type: string
        canceledAt:
          type: string
        cancellationReason:
          type: string
        createdAt:
          type: string
        digitableLine:
          type: string
        discount:
          $ref: '#/components/schemas/http.DiscountResponse'
        dueDate:
          type: string
        errorMessage:
          type: string
        failedAt:
          type: string
        fine:
          $ref: '#/components/schemas/http.FineResponse'
        guarantor:
          $ref: '#/components/schemas/http.GuarantorResponse'
        id:
          type: string
        inactivatedAt:
          type: string
        installmentLabel:
          type: string
        instructions:
          type: string
        interest:
          $ref: '#/components/schemas/http.InterestResponse'
        kind:
          type: string
        payer:
          $ref: '#/components/schemas/http.PayerResponse'
        providerId:
          type: string
        qrCode:
          type: string
        seriesId:
          type: string
        settledAmount:
          type: string
        settledAt:
          type: string
        status:
          type: string
        type:
          type: string
        updatedAt:
          type: string
      type: object
    http.DiscountResponse:
      properties:
        amount:
          type: string
        limitDate:
          type: string
        type:
          type: string
      type: object
    http.FineResponse:
      properties:
        amount:
          type: string
        type:
          type: string
      type: object
    http.GuarantorResponse:
      properties:
        address:
          $ref: '#/components/schemas/http.AddressResponse'
        document:
          type: string
        name:
          type: string
      type: object
    http.InterestResponse:
      properties:
        amount:
          type: string
        type:
          type: string
      type: object
    http.PayerResponse:
      properties:
        address:
          $ref: '#/components/schemas/http.AddressResponse'
        document:
          type: string
        name:
          type: string
      type: object
    http.AddressResponse:
      properties:
        city:
          type: string
        complement:
          type: string
        neighborhood:
          type: string
        number:
          type: string
        state:
          type: string
        street:
          type: string
        zipCode:
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      description: 'Bearer token authentication (format: "Bearer {token}")'
      in: header
      name: Authorization
      type: apiKey

````