Skip to main content
number
obrigatório
Número do contrato que será gerada a cobrança.
number[]
obrigatório
Números das parcelas do contrato que serão incluídas na cobrança.
string<date>
obrigatório
Data de vencimento da cobrança em formato aaaa-mm-dd.
string<date>
obrigatório
Data de expiração da cobrança em formato aaaa-mm-dd.
boolean
obrigatório
Se verdadeiro, indica que é uma cobrança total e não há necessidade de preencher o campo ValorLiquidacao.
boolean
obrigatório
Indica se é um pagamento por boleto. Se a cobrança for boleto híbrido(com pix), apenas PagamentoViaBoleto deve estar com verdadeiro.
boolean
obrigatório
Indica se é um pagamento por pix cobrança. Se a cobrança for boleto híbrido(com pix), apenas PagamentoViaBoleto deve estar com verdadeiro.
string
obrigatório
Descrição que será preenchida quanto houver o pagamento na parcela.
number
Valor da cobrança. Não é necessário preencher este campo de liquidacao for verdadeiro.
number
Valor de desconto aplicado.
boolean
Indica se o cálculo das parcelas nesta consulta deve ser aplicado descapitalização e encargos.
number
Motivo que será preenchida a baixa da parcela.
  • 0 - Liquidação Parcial
  • 1 - Liquidação Total
  • 2 - Liquidação por Cancelamento
  • 3 - Liquidação por Fraude
  • 4 - Liquidação por Óbito
  • 5 - Liquidação por Pré-Pagamento/Antecipação FGTS
  • 6 - Liquidação por Renegociação
  • 7 - Liquidação por Recompra/Troca de titularidade/Alienação a Terceiros
  • 8 - Liquidação por Antecipação Parcial
  • 9 - Liquidação por Antecipação Total
object[]
Lista das cobranças.
string
Identificador da cobrança gerada.
number
Parcelas cobertas por essa cobrança.