Omitir yendo al contenido principal

Documentación @box4dev/gerador-boleto

Generador de boleto estándar FEBRABAN con línea digitable y código de barras.

El @box4dev/gerador-boleto es una biblioteca open-source ligera para el ecosistema Node.js, diseñada específicamente para la generación dinámica de datos de boletos bancarios en el estándar FEBRABAN.

NPM versionNPM downloads

Primeros Pasos

Sobre el Generador de Boleto

Generador de Boleto en el estándar FEBRABAN: Línea Digitable y Código de Barras.

Sin HTML, PDF o renderización gráfica — solo datos listos para JSON.

Ideal para generación masiva para pruebas automatizadas.

Instalación

Instale la biblioteca utilizando su administrador de paquetes preferido:

NPM

Shell
Instalar vía NPM

Yarn

Shell
Instalar vía Yarn

PNPM

Shell
Instalar vía PNPM

Importación

Importe las funciones de la biblioteca en su proyecto TypeScript o JavaScript:

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

Uso

Genere datos completos de boletos fácilmente usando valores predeterminados o personalizados.

Uso Básico con Datos Aleatorios

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

Ejemplos por Banco

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

Parámetros de Uso

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

Parámetros de Uso

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

Bancos soportados

Actualmente la biblioteca admite oficialmente los siguientes bancos:

BancoDescripción
santanderBanco Santander (Código 033)
bradescoBanco Bradesco (Código 237)
caixaCaixa Econômica Federal (Código 104)
itauBanco Itaú Unibanco (Código 341)

Contribución

¡Las contribuciones son bienvenidas! Consulte la guía de contribución en GitHub:

Repositorio GitHub de @box4dev/gerador-boleto

Licencia

Distribuido bajo la licencia MIT. Libre para uso personal y comercial.

Seguridad

Los boletos generados son puramente computacionales y destinados a pruebas. No se recopila ni envía información bancaria confidencial a servidores externos.

Preguntas Frecuentes