Exemplo prático

Como exemplo prático, segue a estrutura possivel para a combranca do boleto de mensalidade escolar.

A requisição foi estruturada para gerar um boleto bancário no valor de R$ 1.200,00 referente à mensalidade do mês de Maio de 2025, com vencimento em 05/05/2025 com descontos por pagamento antecipado e multa por atraso. Abaixo está a explicação detalhada dos campos utilizados:

1. Identificação do integrador

clientid: Representa o ID do integrador que está gerando o boleto.

2. Dados do Cliente Cobrado (`customer`)

Inclui informações essenciais do pagador, como:
- Nome: Carlos Souza
- CPF/CNPJ: 000.123.000-00
- E-mail: [email protected]
- Telefone: 11 99999 - 7777
- Endereço: Avenida Paulista, 1000, São Paulo - SP

3. Informações do Boleto

dueDate: Define a data de vencimento do boleto como 05/05/2025.
totalValue: Define o valor original do boleto como R$ 1.200,00.
comments: Campo de observação informando que o boleto é referente à mensalidade do mês de Maio de 2025.

4. Aplicação de Descontos

discount:
- R$ 200,00 se pago até 30/04/2025 (discountDate e discountValue).
- R$ 150,00 se pago até 05/05/2025 (discountDate2 e discountValue2).

5. Penalidades por Atraso

Multa fixa (fineValue):
- Caso o pagamento ocorra após 05/05/2025, será aplicada uma multa fixa de R$ 50,00.
Juros por dia de atraso (interestValue):
- A partir de 06/05/2025, será cobrado um juros diário de R$ 2,50.

6. Resumo da Estrutura

A estrutura JSON foi montada para garantir que o boleto seja gerado corretamente, aplicando:

Os descontos conforme a data de pagamento.
A multa fixa e juros diários em caso de atraso.
Informações completas do cliente e da transação.

{
  "clientid": 1001,
  "customer": {
    "customerName": "Carlos Souza",
    "customerTaxNumber": "987.654.321-00",
    "customerMail": "[email protected]",
    "customerPhone": "11988887777",
    "addressLine1": "Avenida Paulista, 1000",
    "city": "São Paulo",
    "state": "SP",
    "zipCode": "01310-000"
  },
  "dueDate": "2025-05-05T23:59:59",
  "totalValue": 1200.00,
  "comments": "Mensalidade referente ao mês de Maio de 2025.",
  "discount": {
    "discountDate": "2025-04-30T23:59:59",
    "discountValue": 200.00,
    "discountDate2": "2025-05-05T23:59:59",
    "discountValue2": 150.00
  },
  "fineDate": "2025-05-06T00:00:00",
  "fineValue": 50.00,
  "interestDate": "2025-05-06T00:00:00",
  "interestValue": 2.50
}