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

# 2 - Consultar Detalhes

Exibe as informações essenciais de um contrato para a proposta informada, bem como: parcelas, boletos, lançamentos realizados e situação do registro do boleto.

<Note>Por padrão, o campo `dtExpiracao` presente no retorno dessa requisição vem com valor `null`. No entanto, ele vem preenchido com uma data caso o boleto tenha uma data limite para pagamento ou caso esse boleto já esteja pago.</Note>

<Expandable title="Tabelas">
  <Expandable title="Retorno de Situação de Parcelas">
    Tabela de descrição do retorno do parâmetro `situacao`, do objeto `parcelas`:

    | Código | Descrição |
    | ------ | --------- |
    | 0      | Em aberto |
    | 1      | Pago      |
    | 2      | Cancelado |
    | 10     | A vencer  |
    | 11     | Vencido   |
  </Expandable>
</Expandable>


## OpenAPI

````yaml post /AgendaRecebivel/ConsultarDetalhes
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/ConsultarDetalhes:
    post:
      tags:
        - AgendaRecebivel
      parameters:
        - name: IdempotencyKey
          in: header
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgendaRecebivelConsultaDetalhesCommand'
          text/json:
            schema:
              $ref: '#/components/schemas/AgendaRecebivelConsultaDetalhesCommand'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AgendaRecebivelConsultaDetalhesCommand'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AgendaRecebivelConsultaDetalhesResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/AgendaRecebivelConsultaDetalhesResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/AgendaRecebivelConsultaDetalhesResponse'
        '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:
    AgendaRecebivelConsultaDetalhesCommand:
      type: object
      properties:
        dto:
          $ref: '#/components/schemas/FindAgendaRecebivelParcelasDTO'
        dtoConsultaDetalhes:
          $ref: '#/components/schemas/AgendaRecebivelConsultaDetalhesDTO'
      additionalProperties: false
    AgendaRecebivelConsultaDetalhesResponse:
      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
        numeroProposta:
          type: integer
          format: int64
        dtInclusao:
          type: string
          format: date-time
        dtCancelamento:
          type: string
          format: date-time
          nullable: true
        dtLiquidacao:
          type: string
          format: date-time
          nullable: true
        situacaoAgenda:
          $ref: '#/components/schemas/SituacaoAgendaRecebivelEnum'
        descricaoSituacaoAgenda:
          type: string
          nullable: true
        documentoFederalCliente:
          type: string
          nullable: true
        nomeCliente:
          type: string
          nullable: true
        nomeEmpresa:
          type: string
          nullable: true
        ecCliente:
          type: string
          nullable: true
        vlrFinanciado:
          type: number
          format: double
        vlrRetencaoDiarioAprox:
          type: number
          format: double
          nullable: true
        vlrTotalPago:
          type: number
          format: double
        qtdeParcelas:
          type: integer
          format: int32
        situacaoProposta:
          type: integer
          format: int32
          nullable: true
        descricaoTipoContrato:
          type: string
          nullable: true
        parcelas:
          type: array
          items:
            $ref: '#/components/schemas/Parcela'
          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
    FindAgendaRecebivelParcelasDTO:
      required:
        - nroParcelas
      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
        nroParcelas:
          type: array
          items:
            type: integer
            format: int32
          description: Array contendo o número das parcelas a serem consultadas.
          nullable: true
      additionalProperties: false
    AgendaRecebivelConsultaDetalhesDTO:
      type: object
      properties:
        trazerBoleto:
          type: boolean
          description: >-
            Indica se a consulta deve retornar as informações sobre os boletos
            presentes na agenda.
          nullable: true
        trazerAgendaDetalhada:
          type: boolean
          description: >-
            Indica se a consulta deve retornar a agenda detalhada, ou seja, com
            as informações sobre os lançamentos.
          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
    SituacaoAgendaRecebivelEnum:
      enum:
        - 0
        - 1
        - 2
      type: integer
      format: int32
    Parcela:
      type: object
      properties:
        codigoParcela:
          type: string
          format: uuid
        nroParcela:
          type: integer
          format: int64
        situacao:
          type: integer
          format: int32
        dtVencimento:
          type: string
          format: date-time
        vlrParcela:
          type: number
          format: double
        nroOrdemPagamento:
          type: string
          nullable: true
        vlrSaldoAtual:
          type: number
          format: double
        vlrTotalPago:
          type: number
          format: double
        vlrDesconto:
          type: number
          format: double
        dtVencimentoAtual:
          type: string
          format: date-time
        boletos:
          type: array
          items:
            $ref: '#/components/schemas/BoletoGerado'
          nullable: true
        pix:
          type: array
          items:
            $ref: '#/components/schemas/PixGerado'
          nullable: true
        lancamentos:
          type: array
          items:
            $ref: '#/components/schemas/Lancamento'
          nullable: true
      additionalProperties: false
    ErrorType:
      enum:
        - 1
        - 2
        - 3
      type: integer
      format: int32
    BoletoGerado:
      type: object
      properties:
        numeroBoleto:
          type: integer
          format: int64
          nullable: true
        liquidacao:
          type: boolean
          nullable: true
        dtCredito:
          type: string
          format: date-time
          nullable: true
        dtExpiracao:
          type: string
          format: date-time
          nullable: true
        linhaDigitavel:
          type: string
          nullable: true
        operacaoBoletoRegistro:
          type: integer
          format: int32
          nullable: true
        situacaoBoletoRegistro:
          type: integer
          format: int32
          nullable: true
        descricaoBoletoRegistro:
          type: string
          nullable: true
        urlImpressao:
          type: string
          nullable: true
        qrCode:
          $ref: '#/components/schemas/DadosQRCode'
      additionalProperties: false
    PixGerado:
      type: object
      properties:
        liquidacao:
          type: boolean
        dtCredito:
          type: string
          format: date-time
          nullable: true
        dtVencimento:
          type: string
          format: date-time
          nullable: true
        dtExpiracao:
          type: string
          format: date-time
          nullable: true
        emv:
          type: string
          nullable: true
        imagem:
          type: string
          nullable: true
      additionalProperties: false
    Lancamento:
      type: object
      properties:
        dtVencimento:
          type: string
          format: date-time
        dtLancamento:
          type: string
          format: date-time
        vlrParcela:
          type: number
          format: double
        vlrMulta:
          type: number
          format: double
        vlrJuros:
          type: number
          format: double
        vlrMora:
          type: number
          format: double
        vlrIOF:
          type: number
          format: double
        vlrTarifas:
          type: number
          format: double
        vlrAbatimento:
          type: number
          format: double
        vlrParcelaAtualizado:
          type: number
          format: double
        vlrPagamento:
          type: number
          format: double
        vlrSaldoParcela:
          type: number
          format: double
        vlrDesconto:
          type: number
          format: double
        informarFundo:
          type: boolean
        descLancamento:
          type: string
          nullable: true
        viaBoleto:
          type: boolean
      additionalProperties: false
    DadosQRCode:
      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

````