> ## Documentation Index
> Fetch the complete documentation index at: https://bmpdocs.moneyp.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# 1 - Consult Slips

Allows the consultation of the bills generated for the informed proposal.


## OpenAPI

````yaml post /AgendaRecebivel/ConsultarBoletos
openapi: 3.0.1
info:
  title: BMPDigitalCore.ApiExterna.AgendaRecebivel.API
  version: '1.0'
servers:
  - url: https://api.bmpdigital.moneyp.dev.br/
    description: Localhost
security:
  - Bearer: []
paths:
  /AgendaRecebivel/ConsultarBoletos:
    post:
      tags:
        - AgendaRecebivel
      parameters:
        - name: IdempotencyKey
          in: header
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgendaRecebivelConsultaBoletosCommand'
          text/json:
            schema:
              $ref: '#/components/schemas/AgendaRecebivelConsultaBoletosCommand'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AgendaRecebivelConsultaBoletosCommand'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AgendaRecebivelConsultaBoletosResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/AgendaRecebivelConsultaBoletosResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/AgendaRecebivelConsultaBoletosResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ResponseBase'
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBase'
            text/json:
              schema:
                $ref: '#/components/schemas/ResponseBase'
components:
  schemas:
    AgendaRecebivelConsultaBoletosCommand:
      type: object
      properties:
        dto:
          $ref: '#/components/schemas/FindAgendaRecebivelDTO'
        dtoConsultaBoletos:
          $ref: '#/components/schemas/AgendaRecebivelConsultaBoletosDTO'
      additionalProperties: false
    AgendaRecebivelConsultaBoletosResponse:
      type: object
      properties:
        msg:
          type: string
          nullable: true
        result:
          type: boolean
          writeOnly: true
        hasError:
          type: boolean
        messages:
          type: array
          items:
            $ref: '#/components/schemas/Message'
          nullable: true
        boletos:
          type: array
          items:
            $ref: '#/components/schemas/Boleto'
          nullable: true
      additionalProperties: false
    ResponseBase:
      type: object
      properties:
        msg:
          type: string
          nullable: true
        result:
          type: boolean
          writeOnly: true
        hasError:
          type: boolean
        messages:
          type: array
          items:
            $ref: '#/components/schemas/Message'
          nullable: true
      additionalProperties: false
    FindAgendaRecebivelDTO:
      type: object
      properties:
        codigoProposta:
          type: string
          description: Código identificador da proposta na BMP.
          format: uuid
          nullable: true
        codigoOperacao:
          maxLength: 50
          minLength: 0
          type: string
          description: Código identificador da proposta (valor exclusivo do integrador).
          nullable: true
      additionalProperties: false
    AgendaRecebivelConsultaBoletosDTO:
      required:
        - numerosBoletos
      type: object
      properties:
        numerosBoletos:
          type: array
          items:
            type: integer
            format: int64
          description: Lista contendo os números dos boletos a serem consultados.
          nullable: true
        trazerBoletosCancelados:
          type: boolean
          description: Indica se a consulta deve retornar os boletos cancelados.
          nullable: true
      additionalProperties: false
    Message:
      type: object
      properties:
        messageType:
          $ref: '#/components/schemas/ErrorType'
        code:
          type: string
          nullable: true
        context:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        field:
          type: string
          nullable: true
      additionalProperties: false
    Boleto:
      type: object
      properties:
        numeroBoleto:
          type: integer
          format: int64
        numeroProposta:
          type: integer
          format: int64
        liquidacao:
          type: boolean
        parcelas:
          type: string
          nullable: true
        descricao:
          type: string
          nullable: true
        dtInclusao:
          type: string
          format: date-time
        dtVencimento:
          type: string
          format: date-time
        dtCancelamento:
          type: string
          format: date-time
          nullable: true
        dtExpiracao:
          type: string
          format: date-time
          nullable: true
        dtCredito:
          type: string
          format: date-time
          nullable: true
        valorBoleto:
          type: number
          format: double
        vlrPago:
          type: number
          format: double
          nullable: true
        impressao:
          type: string
          nullable: true
        linhaDigitavel:
          type: string
          nullable: true
        documentoFederalCliente:
          type: string
          nullable: true
        cliente:
          type: string
          nullable: true
        parceiro:
          type: string
          nullable: true
        qrCode:
          $ref: '#/components/schemas/DadosQRCodeConsultaBoletos'
      additionalProperties: false
    ErrorType:
      enum:
        - 1
        - 2
        - 3
      type: integer
      format: int32
    DadosQRCodeConsultaBoletos:
      type: object
      properties:
        emv:
          type: string
          nullable: true
        imagem:
          type: string
          nullable: true
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Informe o token
      name: Authorization
      in: header

````