Laravel Boleto

To create a boleto for Caixa Econômica Federal, use the Eduardokum\LaravelBoleto\Boleto\Banco\Caixa class. This bank requires specific mandatory fields: numero (Bill number, size 15), agencia (Account keeping agency, size 4), and codigoCliente (Recipient number, size 6).

You can instantiate the object using a fluent setter pattern or by passing a configuration array to the constructor.

$caixa = new Eduardokum\LaravelBoleto\Boleto\Banco\Caixa;
$caixa->setLogo('/path/to/logo.png')
    ->setDataVencimento('1997-10-07')
    ->setValor('100')
    ->setNumero(1)
    ->setNumeroDocumento(1)
    ->setPagador($pagador)
    ->setBeneficiario($beneficiario)
    ->setCarteira('RG')
    ->setAgencia(1111)
    ->setCodigoCliente(222222)
    ->setDescricaoDemonstrativo(['demonstrativo 1', 'demonstrativo 2', 'demonstrativo 3'])
    ->setInstrucoes(['instrucao 1', 'instrucao 2', 'instrucao 3']);

To create a Bradesco boleto, you can use the Eduardokum\LaravelBoleto\Boleto\Banco\Bradesco class. You can initialize it using a fluent setter pattern or by passing a configuration array to the constructor.

Mandatory Fields

• numero: Bill number (size: 11).
• agencia: Account keeping agency (size: 4).
• conta: Account number (size: 7).
• cip: Code used to identify specific messages to the recipient (size: 3, defaults to 000).

Available Bank Contracts (carteira)

• 09: Com Registro
• 21: Com Registro - Pagável somente no Bradesco
• 26: Com Registro – Emissão na Internet

$bradesco = new Eduardokum\LaravelBoleto\Boleto\Banco\Bradesco;
$bradesco->setLogo('/path/to/logo.png')
    ->setDataVencimento('1997-10-07')
    ->setValor('100')
    ->setNumero(1)
    ->setNumeroDocumento(1)
    ->setPagador($pagador)
    ->setBeneficiario($beneficiario)
    ->setCarteira('09')
    ->setAgencia(1111)
    ->setConta(2222222)
    ->setDescricaoDemonstrativo(['demonstrativo 1', 'demonstrativo 2', 'demonstrativo 3'])
    ->setInstrucoes(['instrucao 1', 'instrucao 2', 'instrucao 3']);

To generate a CNAB remessa file for Sicredi, use the Eduardokum\LaravelBoleto\Cnab\Remessa classes. You can choose between the Cnab400 format or the Cnab240 format depending on your bank's requirements.

Mandatory fields for Sicredi include:

• idremessa: Sequence number of the send (size: 7).
• agencia: Account keeping agency (size: 4).
• conta: Account number (size: 5).
• codigoCliente: Customer/Beneficiary code with the banking institution (size: 5). Note: This is often the account number without the check digit, but may vary.

You can instantiate the class using either a fluent setter pattern or by passing an associative array to the constructor.

// Using Cnab400
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab400\Banco\Sicredi;
$send->setBeneficiario($beneficiario)
    ->setIdremessa(1)
    ->setCarteira(1)
    ->setAgencia(1111)
    ->setConta(22222)
    ->setCodigoCliente(12345);

// Using Cnab240
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab240\Banco\Sicredi;
$send->setBeneficiario($beneficiario)
    ->setIdremessa(1)
    ->setCarteira(1)
    ->setAgencia(1111)
    ->setConta(22222)
    ->setCodigoCliente(12345);

All banks share common methods for file generation, regardless of whether they use 240 or 400 positions. To generate a file, you must first add Boleto instances to a Remessa object.

Common operations include:

• Adding a single boleto: addBoleto(Boleto $boleto)
• Adding multiple boletos: addBoletos(array $boletos)
• Generating the file content as a string: gerar()
• Saving the file to a specific disk path: save($path)
• Forcing a file download in a web context: download($filename = null)

// Add a single bill to a send object. Here need a instance of Boleto.
$send->addBoleto(Boleto $detalhe);

// Add multiples bill to a send object. Here need a array of instances of Boleto.
$send->addBoletos(Boleto[] $boletos);

// Return a string of file.
// It depends on the instance, 240 or 400 positions.
$send->gerar();

// Saves the string to a file on the disk whose path was passed in $path argument.
$send->save($path);

// Force file download.
// If you pass the $filename argument it overwrites the name in the download.
$send->download($filename = null);

In laravel-boleto, a Pagador (the person receiving the charge) is represented by an instance of the \Eduardokum\LaravelBoleto\Pessoa class. You can instantiate it using fluent setter methods or by passing an associative array to the constructor.

Note that a bill requires an instance of Pagador to function correctly.

// Option 1: Using fluent setter methods
$pagador = new \Eduardokum\LaravelBoleto\Pessoa;
$pagador->setDocumento('00.000.000/0000-00')
    ->setNome('Company co.')
    ->setCep('00000-000')
    ->setEndereco('Street name, 123')
    ->setBairro('district')
    ->setUf('UF')
    ->setCidade('City');

// Option 2: Using the constructor with an array
$pagador = new \Eduardokum\LaravelBoleto\Pessoa([
    'documento' => '00.000.000/0000-00',
    'nome'      => 'Company co.',
    'cep'       => '00000-000',
    'endereco'  => 'Street name, 123',
    'bairro'    => 'district',
    'uf'        => 'UF',
    'cidade'    => 'City',
]);