Passer au contenu principal
Passer au contenu principal

Documentation de @box4dev/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

Premiers pas

À 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 la bibliothèque à l'aide de votre gestionnaire de paquets préféré :

NPM

Shell
Installer via NPM

Yarn

Shell
Installer via Yarn

PNPM

Shell
Installer via PNPM

Importer

Importez les fonctions de la bibliothèque dans votre projet TypeScript ou JavaScript :

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

Usage

Générez facilement des données complètes de bordereau bancaire à l’aide de valeurs par défaut ou personnalisées.

Utilisation de base avec des données aléatoires

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

Exemples par 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 d'utilisation

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 d'utilisation

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

Actuellement, la bibliothèque prend officiellement en charge les banques suivantes :

BanqueDescription
santanderBanco Santander (Code 033)
bradescoBanco Bradesco (Code 237)
caixaCaixa Econômica Federal (Code 104)
itauBanco Itaú Unibanco (Code 341)

Contribution

Les contributions sont les bienvenues ! Consultez le guide de contribution sur GitHub :

Dépôt GitHub @box4dev/gerador-boleto

Licence

Distribué sous licence MIT. Libre pour une utilisation personnelle et commerciale.

Sécurité

Les bordereaux générés sont purement informatiques et destinés à des tests. Aucune donnée bancaire sensible n’est collectée ni envoyée à des serveurs externes.

Foire aux questions