Pular para o conteúdo principal

gerador-boleto Dokumentation

Generieren Sie online FEBRABAN-konforme Boletos mit typisierbarer Linie und Barcode.

@box4dev/gerador-boleto ist eine leichtgewichtige Open-Source-Bibliothek für das Node.js-Ökosystem, die speziell für die dynamische Generierung von Bank-Boleto-Daten im FEBRABAN-Standard entwickelt wurde.

NPM versionNPM downloads

Erste Schritte

Über den Boleto-Generator

Boleto-Generator im FEBRABAN-Standard: typierbare Zeile und Barcode.

Kein HTML-, PDF- oder Grafik-Rendering – nur JSON-fähige Daten.

Ideal für die Massengenerierung für automatisierte Tests.

Installation

Installieren Sie das Paket mit einem der folgenden Befehle in Ihrem Projekt.

NPM

Shell
npm install @box4dev/gerador-boleto

Yarn

Shell
Garn hinzufügen @box4dev/gerador-boleto

PNPM

Shell
pnpm @box4dev/gerador-boleto hinzufügen

Import

Importieren Sie den Boleto-Generator mithilfe der ESM- oder CommonJS-Syntax.

JS
import { gerarBoleto } from '@box4dev/gerador-boleto';
JS
const { gerarBoleto } = require('@box4dev/gerador-boleto');

Verwendung

Alle Felder sind optional. Wenn keine Parameter angegeben werden, wählt das Paket eine zufällige Bank und gültige Boleto-Werte aus.

Ohne Parameter

JS
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
const dados = gerarBoleto();
console.log(dados.codigoBarras);
// '03396145000000996689025708991834007174230101'
console.log(dados.linhaDigitavel);
// '03399.02579 08991.834006 71742.301014 6 14500000099668'
console.log(dados);
/* 
{
  codigoBarras: '03396145000000996689025708991834007174230101',
  linhaDigitavel: '03399.02579 08991.834006 71742.301014 6 14500000099668',
  banco: 'santander',
  codigoBanco: '033-7',
  dataEmissao: '2026-05-13T00:00:00.000Z',
  dataVencimento: '2026-05-18T00:00:00.000Z',
  valorDocumento: 99668,
  nossoNumero: 918340071742,
  nossoNumeroDv: 3,
  agencia: 1674,
  codigoCedente: 257089,
  carteira: '101',
  localPagamento: 'Até o vencimento, preferencialmente no Banco Santander',
  instrucoesPagamento: 'Sr. Caixa, cobrar multa de 2% após o vencimento. Receber até 10 dias após o vencimento.'
} 
*/

Nur Bankparameter

JS
1
2
3
4
5
6
7
console.log(gerarBoleto({ banco: 'bradesco' }));
console.log(gerarBoleto({ banco: 'caixa' }));
console.log(gerarBoleto({ banco: 'itau' }));
console.log(gerarBoleto({ banco: 'santander' }));

Nützliche Boleto-Parameter

JS
1
2
3
4
5
6
7
8
9
10
console.log(
  gerarBoleto({
    banco: 'bradesco',
    valorDocumento: 15990,
    nossoNumero: '12345678901',
    agencia: '1229',
    codigoCedente: '0000469',
    carteira: '9',
  })
);

Nützliche Boleto-Parameter

JS
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
console.log(
  gerarBoleto({
    banco: 'caixa',
    dataEmissao: new Date(),
    dataVencimento: vencimento,
    valorDocumento: 88800,
    nossoNumero: '12345678987654321',
    agencia: '1234',
    codigoCedente: '654321',
    carteira: '14',
    localPagamento: 'Local Teste',
    numeroDocumento: '999888',
    cedente: 'Empresa Teste LTDA',
    cedenteCnpj: '54811186000198',
    instrucoesPagamento: 'Instrução Teste',
    identificadorEmissao: '4',
  })
);

Unterstützte Banken

Generieren Sie Boletos für diese unterstützten Banken und ihre entsprechenden Bankleitzahlen.

BankschneckeBeschreibung
santanderSantander (033)
bradescoBradesco (237)
caixaCaixa SIGCB (104)
itauItaú (341)

Beitrag

Beiträge sind willkommen. Offene Issues oder Pull Requests im Repository unten.

GitHub-Repository

Lizenz

Wird unter der MIT-Lizenz vertrieben.

Sicherheit

Melden Sie Sicherheitsprobleme über die Paketsicherheitsrichtlinie auf GitHub.

Häufig gestellte Fragen