v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB

CobrancaCarne

Cria cobrança do tipo carnê

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

Requisição

Campo	Tipo	Descrição	Obrigatório
ClienteId	GUID	ID do pagador já cadastrado	Sim
Descricao	Texto	Descrição do carnê	Não
Valor	Numérico	Valor individual de cada parcela do carnê	Sim
QuantidadeParcelas	Numérico	Quantidade de parcelas do carnê (mínimo de duas parcelas)	Sim
Vencimento	Data	Data de vencimento do carnê	Sim
NaoReceberDepoisDe	Data	Data definida para o cliente não receber a cobrança após ela	Não
Multa	Numérico	Valor da multa a ser aplicado na cobrança	Não
MultaCorrecao	Texto	Tipo da multa a ser aplicada	Não
JurosMes	Numérico	Juros mensais aplicados sobre o valor da cobrança	Não
JurosCorrecao	Texto	Tipo do juros a ser aplicado	Não
DescontoAteVencimento	Numérico	Desconto aplicado até a data do vencimento	Não
DescontoCorrecao	Texto	Tipo do desconto a ser aplicado	Não

Resposta

Campo	Tipo	Descrição
CarneId	GUID	Identificador único do carnê gerado
Estado	Texto	Estado que o carnê se encontra
ImgBase64	Texto	Base64 do PDF completo do carnê
Parcelas	CarneParcelas	Lista com o detalhamento de cada parcela
CobrancaId	GUID	Identificador único da Cobrança gerada
Estado	Texto	Estado da cobrança
Valor	Numérico	Valor da parcela
Vencimento	Data	Data de vencimento da parcela
NossoNumero	Texto	Nosso Número do boleto gerado
LinhaDigitavel	Texto	Linha digitável do boleto gerado
CodigoBarras	Texto	Código de Barras do boleto gerado
QRCodeTexto	Texto	Copia e cola do pix (se for gerado como Boleto Híbrido)
QRCodeImagem	Texto	Imagem do QRCode do pix (se for gerado como Boleto Híbrido)

post/api/CobrancaCarne/InsereCarne

Headers

Aeskeystring required

Request body

ClienteIdstring uuid

Descricaostring

Valornumber double

QuantidadeParcelasinteger

Vencimentostring date-time

NaoReceberDepoisDestring date-time

Multanumber double

MultaCorrecao'Percentual' | 'Valor' | 'Diario' | 'Isento'

JurosMesnumber double

JurosCorrecao'Percentual' | 'Valor' | 'Diario' | 'Isento'

DescontoAteVencimentonumber double

DescontoCorrecao'Percentual' | 'Valor' | 'Diario' | 'Isento'

Instrucao1string

Instrucao2string

Instrucao3string

Instrucao4string

Example request

{
  "ClienteId": "cceba7ee-35b6-44e4-ae16-4a42d68b2835",
  "Descricao": "Cobrança do Tipo Carnê",
  "Valor": 125,
  "QuantidadeParcelas": 4,
  "Vencimento": "2026-06-05T10:45:47.481608-03:00",
  "NaoReceberDepoisDe": "2026-06-20T10:45:47.481608-03:00",
  "Multa": 2.5,
  "MultaCorrecao": "Valor",
  "JurosMes": 0.5,
  "JurosCorrecao": "Valor",
  "DescontoAteVencimento": 11.55,
  "DescontoCorrecao": "Percentual",
  "Instrucao1": "",
  "Instrucao2": "",
  "Instrucao3": "",
  "Instrucao4": ""
}

Response

Cobrança do tipo carnê criada com sucesso.

CarneIdstring uuid

Estado'Todos' | 'EmDia' | 'Finalizada' | 'Cancelada' | 'GerandoCarne'

ImgBase64string

Example response

{
  "CarneId": "00000000-0000-0000-0000-000000000000",
  "Parcelas": [
    {
      "CobrancaId": "00000000-0000-0000-0000-000000000000"
    }
  ]
}