Estrutura da cobrança

2. Estrutura da Requisição

A requisição deve conter os seguintes campos:

Campo	Tipo	Descrição	Obrigatório
clientid	Integer	Identificador do cliente que gera o boleto.	Sim
customer	Object	Dados do cliente pagador (nome, CPF/CNPJ, endereço, etc.).	Sim
dueDate	String	Data de vencimento do boleto (formato ISO 8601).	Sim
comments	String	Comentários adicionais no boleto.	Não
fineDate	String	Data a partir da qual será cobrada a multa.	Não
fineValue	Number	Valor fixo da multa.	Não
finePercent	Number	Percentual da multa sobre o valor total.	Não
interestDate	String	Data a partir da qual serão cobrados juros.	Não
interestValue	Number	Valor fixo dos juros.	Não
interestPercent	Number	Percentual dos juros sobre o valor total.	Não
discount	Object	Estrutura de descontos aplicáveis ao boleto.	Não
rebateValue	Number	Valor do abatimento sobre o boleto.	Não
rateValue	Number	Valor da taxa aplicada ao boleto.	Não
rateSent	Boolean	Indica se a taxa foi enviada.	Não
tags	Array	Lista de tags associadas ao boleto.	Não
totalValue	Number	Valor total do boleto.	Sim

Dados do pagadorcustomer

Nesse objeto deve ser preenchido os dados conpletos do pagador (sacado)

Campo	Tipo	Descrição	Obrigatório
customerName	String	Nome do cliente.	Sim
customerTaxNumber	String	CPF/CNPJ do cliente.	Sim
customerMail	String	E-mail do cliente.	Sim
customerPhone	String	Telefone do cliente.	Sim
customerTradingName	String	Nome fantasia do cliente.	Não
addressLine1	String	Endereço do cliente.	Sim
addressLine2	String	Complemento do endereço.	Não
neighborhood	String	Bairro do cliente.	Sim
city	String	Cidade do cliente.	Sim
state	String	Estado do cliente.	Sim
zipCode	String	CEP do cliente.	Sim

Descontos por antecipaçãodiscount

Nesse objeto pode ser concedido descontos de acordo com a data de pagamentos.

Por exemplo, se for dado R$20,00 de desconto para pagamento até o dia do vencimento, deve preencher discountDate com a mesma data do vencimento (dueDate ) e o valor do desconto em discountValue.

É possivel adicionar outras duas datas adicionais de desconto para, por exemplo, inscentivar o pagamento antecipado do boleto.

Campo	Tipo	Descrição	Obrigatório
discountDate	String	Data do primeiro desconto (ISO 8601).	Não
discountValue	Number	Valor do primeiro desconto.	Não
discountDate2	String	Data do segundo desconto (ISO 8601).	Não
discountValue2	Number	Valor do segundo desconto.	Não
discountDate3	String	Data do terceiro desconto (ISO 8601).	Não
discountValue3	Number	Valor do terceiro desconto.	Não

---

Exemplo de requisição

JSON

{
  "clientid": 1001,
  "customer": {
    "customerName": "João Silva",
    "customerTaxNumber": "123.456.789-00",
    "customerMail": "[email protected]",
    "customerPhone": "11999999999",
    "addressLine1": "Rua Exemplo, 123",
    "city": "São Paulo",
    "state": "SP",
    "zipCode": "01000-000"
  },
  "dueDate": "2025-02-20T23:59:59",
  "totalValue": 500.00,
  "discount": {
    "discountDate": "2025-02-20T23:59:59",
    "discountValue": 50.00
  }
}

3. Estrutura da Resposta

A resposta para uma requisição bem-sucedida terá o seguinte formato:

JSON

{
  "documentNumber": 123456789,
  "url": "https://example.com/boleto/123456789.pdf"
}

Exemplo de Retorno

A resposta da API inclui o link para o boleto gerado em PDF, pronto para ser utilizado ou enviado ao pagador. O cliente pode armazenar ou exibir o boleto conforme sua necessidade.