Cria cobrança do tipo carnê

Esta API permite cadastrar uma cobrança do tipo carnê.

Requisição

CampoTipoDescriçãoObrigatório
ClienteIdGUIDID do pagador já cadastradoSim
DescricaoTextoDescrição do carnêNão
ValorNuméricoValor individual de cada parcela do carnêSim
QuantidadeParcelasNuméricoQuantidade de parcelas do carnê (mínimo de duas parcelas)Sim
VencimentoDataData de vencimento do carnêSim
NaoReceberDepoisDeDataData definida para o cliente não receber a cobrança após elaNão
MultaNuméricoValor da multa a ser aplicado na cobrançaNão
MultaCorrecaoTextoTipo da multa a ser aplicada, podendo ser: Isento, Valor, PercentualNão
JurosMesNuméricoJuros mensais aplicados sobre o valor da cobrançaNão
JurosCorrecaoTextoTipo do juros a ser aplicado, podendo ser: Isento, Valor, PercentualNão
DescontoAteVencimentoNuméricoDesconto aplicado até a data do vencimentoNão
DescontoCorrecaoTextoTipo do desconto a ser aplicado, podendo ser: Isento, Valor, PercentualNão

Resposta

CampoTipoDescrição
CarneIdGUIDIdentificador único do carnê gerado.
EstadoTextoEstado que o carnê se encontra
ImgBase64TextoBase64 do PDF completo do carnê
ParcelasCarneParcelasLista com o detalhamento de cada parcela
CobrancaIdGUIDIdentificador único da Cobrança gerada
EstadoTextoEstado da cobrança
ValorNuméricoValor da parcela
VencimentoDataData de vencimento da parcela
NossoNumeroTextoNosso Número do boleto gerado
LinhaDigitavelTextoLinha digitável do boleto gerado
CodigoBarrasTextoCódigo de Barras do boleto gerado
QRCodeTextoTextoCopia e cola do pix (se for gerado como Boleto Híbrido)
QRCodeImagemTextoImagem do QRCode do pix (se for gerado como Boleto Híbrido)
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!