Pular para o conteúdo principal
Gera uma nova cobrança (boleto/Pix) para quitação de parcelas.
curl --request POST \
  --url https://api.example.com/contrato/parcela/gerar-cobranca \
  --header 'Content-Type: application/json' \
  --data '
{
  "NumeroContrato": 123,
  "NroParcelas": [
    123
  ],
  "DataVencimento": "2023-11-07T05:31:56Z",
  "DataExpiracao": "2023-11-07T05:31:56Z",
  "Liquidacao": true,
  "DescricaoLiquidacao": "<string>",
  "PagamentoViaBoleto": true,
  "PagamentoViaPIX": true,
  "ValorLiquidacao": 123,
  "ValorDesconto": 123,
  "PermiteDescapitalizacao": true,
  "TipoRegistro": 123
}
'
{
  "cobrancas": [
    {
      "codigoLiquidacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "parcelas": [
        {}
      ]
    }
  ]
}

Corpo

application/json
NumeroContrato
integer<int64>
obrigatório

Número do contrato.

NroParcelas
integer<int32>[]
obrigatório

Lista de parcelas a serem cobradas.

DataVencimento
string<date-time>
obrigatório

Data de vencimento da cobrança.

DataExpiracao
string<date-time>
obrigatório

Data de expiração da cobrança.

Liquidacao
boolean
obrigatório

Indica se é quitação total do contrato (true = liquidar contrato).

DescricaoLiquidacao
string
obrigatório

Descrição da liquidação (opcional, usado em caso de quitação total).

PagamentoViaBoleto
boolean

Gerar cobrança via Boleto (true/false).

PagamentoViaPIX
boolean

Gerar cobrança via PIX (true/false).

ValorLiquidacao
number<double>

Valor da liquidação (opcional, valor total a liquidar se diferente do calculado).

ValorDesconto
number<double>

Valor do desconto aplicado (opcional).

PermiteDescapitalizacao
boolean

Indica se permite descapitalização (opcional).

TipoRegistro
integer<int32>

Tipo de registro/cobrança (código interno, opcional).

Resposta

OK

cobrancas
object[]
obrigatório

Lista de cobranças geradas.