Pular para o conteúdo principal
cURL
curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/ConsultarDetalhes \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '{
  "dto": {
    "codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "codigoOperacao": "<string>",
    "nroParcelas": [
      123
    ]
  },
  "dtoConsultaDetalhes": {
    "trazerBoleto": true,
    "trazerAgendaDetalhada": true
  }
}'
{
  "msg": "<string>",
  "hasError": true,
  "messages": [
    {
      "messageType": 1,
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "numeroProposta": 123,
  "dtInclusao": "2023-11-07T05:31:56Z",
  "dtCancelamento": "2023-11-07T05:31:56Z",
  "dtLiquidacao": "2023-11-07T05:31:56Z",
  "situacaoAgenda": 0,
  "descricaoSituacaoAgenda": "<string>",
  "documentoFederalCliente": "<string>",
  "nomeCliente": "<string>",
  "nomeEmpresa": "<string>",
  "ecCliente": "<string>",
  "vlrFinanciado": 123,
  "vlrRetencaoDiarioAprox": 123,
  "vlrTotalPago": 123,
  "qtdeParcelas": 123,
  "situacaoProposta": 123,
  "descricaoTipoContrato": "<string>",
  "parcelas": [
    {
      "codigoParcela": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "nroParcela": 123,
      "situacao": 123,
      "dtVencimento": "2023-11-07T05:31:56Z",
      "vlrParcela": 123,
      "nroOrdemPagamento": "<string>",
      "vlrSaldoAtual": 123,
      "vlrTotalPago": 123,
      "vlrDesconto": 123,
      "dtVencimentoAtual": "2023-11-07T05:31:56Z",
      "boletos": [
        {
          "numeroBoleto": 123,
          "liquidacao": true,
          "dtCredito": "2023-11-07T05:31:56Z",
          "dtExpiracao": "2023-11-07T05:31:56Z",
          "linhaDigitavel": "<string>",
          "operacaoBoletoRegistro": 123,
          "situacaoBoletoRegistro": 123,
          "descricaoBoletoRegistro": "<string>",
          "urlImpressao": "<string>",
          "qrCode": {
            "emv": "<string>",
            "imagem": "<string>"
          }
        }
      ],
      "pix": [
        {
          "liquidacao": true,
          "dtCredito": "2023-11-07T05:31:56Z",
          "dtVencimento": "2023-11-07T05:31:56Z",
          "dtExpiracao": "2023-11-07T05:31:56Z",
          "emv": "<string>",
          "imagem": "<string>"
        }
      ],
      "lancamentos": [
        {
          "dtVencimento": "2023-11-07T05:31:56Z",
          "dtLancamento": "2023-11-07T05:31:56Z",
          "vlrParcela": 123,
          "vlrMulta": 123,
          "vlrJuros": 123,
          "vlrMora": 123,
          "vlrIOF": 123,
          "vlrTarifas": 123,
          "vlrAbatimento": 123,
          "vlrParcelaAtualizado": 123,
          "vlrPagamento": 123,
          "vlrSaldoParcela": 123,
          "vlrDesconto": 123,
          "informarFundo": true,
          "descLancamento": "<string>",
          "viaBoleto": true
        }
      ]
    }
  ]
}
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.
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.

Authorizations

​
Authorization
string
header
required

Informe o token

Headers

​
IdempotencyKey
string
required

Body

​
dto
object
​
dtoConsultaDetalhes
object

Response

OK

​
msg
string | null
​
hasError
boolean
​
messages
object[] | null
​
numeroProposta
integer
​
dtInclusao
string<date-time>
​
dtCancelamento
string<date-time> | null
​
dtLiquidacao
string<date-time> | null
​
situacaoAgenda
enum<integer>
Opções disponíveis:
0,
1,
2
​
descricaoSituacaoAgenda
string | null
​
documentoFederalCliente
string | null
​
nomeCliente
string | null
​
nomeEmpresa
string | null
​
ecCliente
string | null
​
vlrFinanciado
number
​
vlrRetencaoDiarioAprox
number | null
​
vlrTotalPago
number
​
qtdeParcelas
integer
​
situacaoProposta
integer | null
​
descricaoTipoContrato
string | null
​
parcelas
object[] | null