Pular para o conteúdo principal

Documentation de gerador-boleto

Générez en ligne des boletos conformes à FEBRABAN avec une ligne saisissable et un code-barres.

La @box4dev/gerador-boleto est une bibliothèque open source légère pour l'écosystème Node.js, spécialement conçue pour la génération dynamique de données boleto bancaires au standard FEBRABAN.

NPM versionNPM downloads

Commencer

À propos du générateur Boleto

Générateur de boleto au standard FEBRABAN : ligne typable et code barre.

Pas de rendu HTML, PDF ou graphique – juste des données prêtes pour JSON.

Idéal pour la génération de masse pour les tests automatisés.

Installation

Installez le package dans votre projet à l'aide de l'une des commandes ci-dessous.

NPM

Shell
npm install @box4dev/gerador-boleto

Yarn

Shell
fil ajouter @box4dev/gerador-boleto

PNPM

Shell
pnpm ajouter @box4dev/gerador-boleto

Importer

Importez le générateur de boleto à l'aide de la syntaxe ESM ou CommonJS.

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

Usage

Tous les champs sont facultatifs. Si aucun paramètre n'est fourni, le package choisit une banque aléatoire et des valeurs de boleto valides.

Sans paramètres

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.'
} 
*/

Seul paramètre de banque

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' }));

Paramètres boleto utiles

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',
  })
);

Paramètres boleto utiles

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',
  })
);

Banques prises en charge

Générez des boletos pour ces banques prises en charge et leurs codes bancaires correspondants.

Limace de banqueDescription
santanderSantander (033)
bradescoBradesco (237)
caixaCaixa SIGCB (104)
itauItau (341)

Contribution

Les contributions sont les bienvenues. Problèmes ouverts ou demandes d'extraction dans le référentiel ci-dessous.

Dépôt GitHub

Licence

Distribué sous licence MIT.

Sécurité

Signalez les problèmes de sécurité via la politique de sécurité du package sur GitHub.

Foire aux questions