2 - Consult Details

cURL

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 '
{
  "dtoConsultaDetalhes": {
    "trazerBoleto": true,
    "trazerAgendaDetalhada": true
  }
}
'

200

{
  "msg": "<string>",
  "hasError": true,
  "messages": [
    {
      "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",
  "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
        }
      ]
    }
  ]
}

Displays the essential information of a contract for the informed proposal, as well as:

• Installments;
• Bills;
• Entries made and status of the bill registration.

Authorizations

Authorization · string · header · required

Informe o token

Headers

IdempotencyKey · string · required

Body

application/jsontext/jsonapplication/*+json

dto · object

Show child attributes

dtoConsultaDetalhes · object

Show child attributes

Response

200

text/plain

OK

msg · string | null

hasError · boolean

messages · object[] | null

Show child attributes

numeroProposta · integer<int64>

dtInclusao · string<date-time>

dtCancelamento · string<date-time> | null

dtLiquidacao · string<date-time> | null

situacaoAgenda · enum<integer>

Available options: 0, 1, 2

descricaoSituacaoAgenda · string | null

documentoFederalCliente · string | null

nomeCliente · string | null

nomeEmpresa · string | null

ecCliente · string | null

vlrFinanciado · number<double>

vlrRetencaoDiarioAprox · number<double> | null

vlrTotalPago · number<double>

qtdeParcelas · integer<int32>

situacaoProposta · integer<int32> | null

descricaoTipoContrato · string | null

parcelas · object[] | null

Show child attributes