Laravel Boleto

https://laravel-boleto.readthedocs.io/en/latest/
Admin
Laravel Boleto is a Laravel package for generating and managing Brazilian bank boletos (payment...
Tokens:20,006
Snippets:106
Trust Score:8.3
Update:11 months ago
Show doc for...
Tokens:
Raw
### Instantiate and Process Banrisul Return Files with Laravel Boleto

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/retorno/index

Provides examples for directly creating and processing return files for Banrisul using Laravel Boleto. Covers both 400 and 240 position formats. The `processar()` method is essential for reading the file data.

```PHP
// 400 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab400\Banco\Banrisul($argument)

// 240 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab240\Banco\Banrisul($argument)

 // To process the file
$return->processar();
```

--------------------------------

### Instantiate and Process Santander Return Files with Laravel Boleto

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/retorno/index

Provides examples for creating and processing return files for Santander using Laravel Boleto. Covers both 400 and 240 position formats. The `processar()` method is called to parse the return file.

```PHP
// 400 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab400\Banco\Santander($argument)

// 240 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab240\Banco\Santander($argument)

 // To process the file
$return->processar();
```

--------------------------------

### Iterating Return Details (240 Positions) in PHP

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/retorno/index

Illustrates how to process bank return data for the 240-position format. It includes methods for getting details, headers, lotes, and trailers, and shows a loop to iterate over the detailed return items. The `$return` object should be pre-initialized.

```php
$return->getDetalhes();
$return->getHeader();
$return->getHeaderLote();
$return->getTrailer();
$return->getTrailerLote();

foreach($return->getDetalhes() as $object) {
    var_dump($object->toArray());
}
```

--------------------------------

### Instantiate Sicredi Boleto with Array Configuration - PHP

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/boleto/sicredi

Shows how to instantiate the Sicredi bank class and set all boleto properties at once by passing an associative array to the constructor. This method is useful for a more concise setup of multiple parameters, including optional fields like multa, juros, and jurosApos.

```php
$sicredi = new Eduardokum\LaravelBoleto\Boleto\Banco\Sicredi([
    'logo' => '/path/to/logo.png',
    'dataVencimento' => '1997-10-07',
    'valor' => 100,
    'numero' => 1,
    'numeroDocumento' => 1,
    'pagador' => $pagador,
    'beneficiario' => $beneficiario,
    'carteira' => 1,
    'posto' => 11,
    'byte' => 2,
    'agencia' => 1111,
    'conta' => 22222,
    'codigoCliente' => 12345,
    'multa' => 1, // 1% do valor do boleto após o vencimento
    'juros' => 1, // 1% ao mês do valor do boleto
    'jurosApos' => 0 // quant. de dias para começar a cobrança de juros,
    'descricaoDemonstrativo' => ['demonstrativo 1', 'demonstrativo 2', 'demonstrativo 3'],
    'instrucoes' => ['instrucao 1', 'instrucao 2', 'instrucao 3'],
]);

```

--------------------------------

### Initialize Itaú Remessa (PHP)

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/remessa/itau

This snippet demonstrates how to initialize the Itaú remessa generator for both 400 and 240 position formats. It shows setting beneficiary details, carteira, agency, and account number using either chained methods or an array constructor. Ensure the `LaravelBoleto` library is installed.

```php
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab400\Banco\Itau;

// Or, for 240 positions
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab240\Banco\Itau;

$send->setBeneficiario($beneficiario)
    ->setCarteira(109)
    ->setAgencia(1111)
    ->setConta(22222);
```

```php
$sendArray = [
    'beneficiario' => $beneficiario,
    'carteira' => 109,
    'agencia' => 1111,
    'conta' => 22222,
];

// for 400 positions
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab400\Banco\Itau($sendArray);

// Or, for 240 positions
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab240\Banco\Itau($sendArray);
```

--------------------------------

### Instantiate and Process Caixa Económica Federal Return Files with Laravel Boleto

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/retorno/index

Provides code examples for creating and processing return files for Caixa Económica Federal using Laravel Boleto. Covers both 400 and 240 position formats. The `processar()` method is used to parse the file content.

```PHP
// 400 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab400\Banco\Caixa($argument)

// 240 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab240\Banco\Caixa($argument)

 // To process the file
$return->processar();
```

--------------------------------

### Instantiate and Configure Caixa Boleto (PHP)

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/boleto/caixa

This snippet demonstrates how to create and configure a Caixa Econônica Federal boleto object using the Laravel Boleto package. It covers setting mandatory fields and optional parameters like 'logo', 'dataVencimento', 'valor', 'pagador', 'beneficiario', 'carteira', 'agencia', 'codigoCliente', 'descricaoDemonstrativo', and 'instrucoes'. The example shows both method chaining and array instantiation.

```php
$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']);

// You can add more ``Demonstrativos`` or ``Instrucoes`` on this way:

$caixa->addDescricaoDemonstrativo('demonstrativo 4');
$caixa->addInstrucoes('instrucao 2');
```

```php
$caixa = new Eduardokum\LaravelBoleto\Boleto\Banco\Caixa([
    'logo' => '/path/to/logo.png',
    'dataVencimento' => '1997-10-07',
    'valor' => 100,
    'numero' => 1,
    'numeroDocumento' => 1,
    'pagador' => $pagador,
    'beneficiario' => $beneficiario,
    'carteira' => 'RG',
    'agencia' => 1111,
    'codigoCliente' => 222222,
    'multa' => 1, // 1% do valor do boleto após o vencimento
    'juros' => 1, // 1% ao mês do valor do boleto
    'jurosApos' => 0 // quant. de dias para começar a cobrança de juros,
    'descricaoDemonstrativo' => ['demonstrativo 1', 'demonstrativo 2', 'demonstrativo 3'],
    'instrucoes' => ['instrucao 1', 'instrucao 2', 'instrucao 3'],
]);
```

--------------------------------

### Initialize Santander Remittance (Array Constructor) - PHP

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/remessa/santander

Initializes a Santander remittance object for either 400 or 240 positions using an array constructor. This method allows for bulk configuration of the remittance details including beneficiary, wallet, agency, client code, and account number upon instantiation. It simplifies the setup process by passing all required parameters at once.

```php
$sendArray = [
    'beneficiario' => $beneficiario,
    'carteira' => 101,
    'agencia' => 1111,
    'codigoCliente' => 2222222,
    'conta' => 22222222,
];

// for 400 positions
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab400\Banco\Santander($sendArray);

// Or, for 240 positions
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab240\Banco\Santander($sendArray);
```

--------------------------------

### Configure HSBC Boleto Object with Array in PHP

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/boleto/hsbc

This PHP code snippet demonstrates an alternative way to configure the HSBC boleto object by passing an associative array to the constructor. This method allows for setting multiple properties, including optional ones like 'multa' (fine), 'juros' (interest), and 'jurosApos' (days to start charging interest), in a single initialization step. It's a concise way to set up the boleto with all necessary details.

```php
$hsbc = new Eduardokum\LaravelBoleto\Boleto\Banco\Hsbc([
    'logo' => '/path/to/logo.png',
    'dataVencimento' => '1997-10-07',
    'valor' => 100,
    'numero' => 1,
    'numeroDocumento' => 1,
    'pagador' => $pagador,
    'beneficiario' => $beneficiario,
    'carteira' => 'CSB',
    'agencia' => 1111,
    'conta' => 222222,
    'contaDv' => 2,
    'range' => 99999,
    'multa' => 1, // 1% do valor do boleto após o vencimento
    'juros' => 1, // 1% ao mês do valor do boleto
    'jurosApos' => 0 // quant. de dias para começar a cobrança de juros,
    'descricaoDemonstrativo' => ['demonstrativo 1', 'demonstrativo 2', 'demonstrativo 3'],
    'instrucoes' => ['instrucao 1', 'instrucao 2', 'instrucao 3'],
]);
```

--------------------------------

### Configure Itaú Boleto Object in PHP

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/boleto/itau

This PHP code snippet demonstrates how to instantiate and configure an Itaú boleto object using the Laravel Boleto library. It shows setting various parameters such as logo, due date, value, payer, beneficiary, bank contract, agency, account, and instructions. It also shows how to add more demonstratives and instructions after initial setup.

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

// You can add more ``Demonstrativos`` or ``Instrucoes`` on this way:

$itau->addDescricaoDemonstrativo('demonstrativo 4');
$itau->addInstrucoes('instrucao 2');
```

--------------------------------

### Initialize Itaú Boleto Object with Array in PHP

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/boleto/itau

This PHP code snippet shows an alternative method to initialize and configure an Itaú boleto object by passing an associative array of configuration options directly to the constructor. This approach simplifies the setup by defining all parameters, including optional ones like multa (fine) and juros (interest), in a single array.

```php
$itau = new Eduardokum\LaravelBoleto\Boleto\Banco\Itau([
    'logo' => '/path/to/logo.png',
    'dataVencimento' => '1997-10-07',
    'valor' => 100,
    'numero' => 1,
    'numeroDocumento' => 1,
    'pagador' => $pagador,
    'beneficiario' => $beneficiario,
    'carteira' => 109,
    'agencia' => 1111,
    'conta' => 22222,
    'multa' => 1, // 1% do valor do boleto após o vencimento
    'juros' => 1, // 1% ao mês do valor do boleto
    'jurosApos' => 0 // quant. de dias para começar a cobrança de juros,
    'descricaoDemonstrativo' => ['demonstrativo 1', 'demonstrativo 2', 'demonstrativo 3'],
    'instrucoes' => ['instrucao 1', 'instrucao 2', 'instrucao 3'],
]);
```

--------------------------------

### Instantiate and Configure Sicredi Boleto - PHP

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/boleto/sicredi

Demonstrates how to instantiate the Sicredi bank class and set various boleto properties using setter methods. It also shows how to add more demonstrativos and instrucoes after initial configuration. This method allows for step-by-step setting of boleto parameters.

```php
$sicredi = new Eduardokum\LaravelBoleto\Boleto\Banco\Sicredi;
$sicredi->setLogo('/path/to/logo.png')
    ->setDataVencimento('1997-10-07')
    ->setValor('100')
    ->setNumero(1)
    ->setNumeroDocumento(1)
    ->setPagador($pagador)
    ->setBeneficiario($beneficiario)
    ->setCarteira(1)
    ->setPosto(11)
    ->setByte(2)
    ->setAgencia(1111)
    ->setConta(22222)
    ->setCodigoCliente(12345)
    ->setDescricaoDemonstrativo(['demonstrativo 1', 'demonstrativo 2', 'demonstrativo 3'])
    ->setInstrucoes(['instrucao 1', 'instrucao 2', 'instrucao 3']);

// You can add more ``Demonstrativos`` or ``Instrucoes`` on this way:

$sicredi->addDescricaoDemonstrativo('demonstrativo 4');
$sicredi->addInstrucoes('instrucao 2');

```

--------------------------------

### Render Boleto Individually to HTML

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/boleto/render

Explains how to render a single Boleto instance to HTML format. Offers options to toggle the print window and hide instruction details. Outputs an HTML string by default.

```php
$boleto->renderHTML($print = false, $instrucoes = true);

// This will generate a HTML string.
$boleto->renderHTML();

// If you want to show a print window after rendering pass true on the first argument.
$boleto->renderHTML(true);

// If you want to hide the print instructions pass false on the second argument.
$boleto->renderHTML(false, false);
```

--------------------------------

### Render Boleto Individually to PDF

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/boleto/render

Demonstrates how to render a single Boleto instance to PDF format. Supports options to control print window display and instruction visibility. Returns a PDF string by default.

```php
$boleto->renderPDF($print = false, $instrucoes = true);

// This will generate a PDF string
$boleto->renderPDF();

// If you want to show a print window after rendering pass true on the first argument
$boleto->renderPDF(true);

// If you want to hide the print instructions pass false in the second argument
$boleto->renderPDF(false, false);
```

--------------------------------

### Instantiate and Process Bancoob Return Files with Laravel Boleto

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/retorno/index

Shows how to directly instantiate and process return files for Bancoob with Laravel Boleto. Supports both 400 and 240 position formats. The `processar()` method is used to parse the return file content.

```PHP
// 400 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab400\Banco\Bancoob($argument)

// 240 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab240\Banco\Bancoob($argument)

// To process the file
$return->processar();
```

--------------------------------

### Render Multiple Boletos to PDF

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/boleto/render

Shows how to render multiple Boleto instances to PDF using the Pdf rendering class. Allows adding multiple boletos, controlling print window and instruction visibility, and specifying output destination. Requires the 'Eduardokum\LaravelBoleto\Boleto\Render\Pdf' class.

```php
$pdf = new Eduardokum\LaravelBoleto\Boleto\Render\Pdf();

// Add as many bills as you want.
$pdf->addBoleto($boleto);

// Or, Simply
$pdf->addBoletos([
    $boleto1,
    $boleto2,
    $boleto3,
]);

// If you want to show a print window after rendering.
$pdf->showPrint();

// If you want to hide the print instructions.
$pdf->hideInstrucoes();

// To Render
$pdf->gerarBoleto($dest = self::OUTPUT_STANDARD, $save_path = null);
```

--------------------------------

### Instantiate Bancoob CNAB 400/240 with configuration array (PHP)

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/remessa/bancoob

This snippet shows an alternative way to instantiate the Bancoob class for CNAB 400 or 240 formats using a configuration array in PHP. The array includes 'beneficiario', 'carteira', 'agencia', 'convenio', and 'conta'. This approach simplifies initialization when all parameters are available at once.

```php
$sendArray = [
    'beneficiario' => $beneficiario,
    'carteira' => 1,
    'agencia' => 1111,
    'convenio' => 123123,
    'conta' => 22222,
];

// for 400 positions
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab400\Banco\Bancoob($sendArray);

// Or, for 240 positions
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab240\Banco\Bancoob($sendArray);
```

--------------------------------

### Process Bank Return Files (Retorno) using Laravel Boleto

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/retorno/index

Demonstrates how to provide bank return file content to the Laravel Boleto library. Accepts file paths, string content, or an array of strings representing the return file. This is the initial step before processing.

```PHP
$argument = '/path/to/retorno.ret';

// Or, String content
$argument = '0RETORNOCONTENTHERE...\n1RETORNOCONTENTHERE...';

// Or, Array content
$argument = [
    '0RETORNOCONTENTHERE...', 
    '1RETORNOCONTENTHERE...' 
];
```

--------------------------------

### Instantiate Banrisul CNAB Remessa (PHP)

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/remessa/banrisul

Instantiates the Banrisul CNAB remessa class for either 400 or 240 positions. Requires setting beneficiary details and bank contract information. Supports direct instantiation or using an array of configuration parameters.

```php
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab400\Banco\Banrisul;

// Or, for 240 positions
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab240\Banco\Banrisul;

$send->setBeneficiario($beneficiario)
    ->setCarteira(1)
    ->setAgencia(1111)
    ->setCodigoCliente(1234567)
    // ->setCodigoClienteOfficeBanking(1234567890)
    ->setConta(22222);
```

```php
$sendArray = [
    'beneficiario' => $beneficiario,
    'carteira' => 1,
    'agencia' => 1111,
    'codigoCliente' => 1234567,
    // 'codigoClienteOfficeBanking' => '1234567890',
    'conta' => 22222,
];

// for 400 positions
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab400\Banco\Banrisul($sendArray);

// Or, for 240 positions
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab240\Banco\Banrisul($sendArray);
```

--------------------------------

### Instantiate and Process Itaúu Return Files with Laravel Boleto

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/retorno/index

Shows how to directly instantiate and process return files for Itaúu with Laravel Boleto. Supports both 400 and 240 position formats. The `processar()` method is used to parse the return file content.

```PHP
// 400 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab400\Banco\Itau($argument)

// 240 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab240\Banco\Itau($argument)

 // To process the file
$return->processar();
```

--------------------------------

### Instantiate and Process Sicredi Return Files with Laravel Boleto

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/retorno/index

Demonstrates how to instantiate and process return files for Sicredi with Laravel Boleto. Supports both 400 and 240 position formats. The `processar()` method is used to parse the return file data.

```PHP
// 400 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab400\Banco\Sicredi($argument)

// 240 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab240\Banco\Sicredi($argument)

 // To process the file
$return->processar();
```

--------------------------------

### Instantiate and Process Bradesco Return Files with Laravel Boleto

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/retorno/index

Shows how to instantiate and process return files for Bradesco with Laravel Boleto. Supports both 400 and 240 position formats. Use the `processar()` method to read and parse the return file.

```PHP
// 400 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab400\Banco\Bradesco($argument)

// 240 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab240\Banco\Bradesco($argument)

 // To process the file
$return->processar();
```

--------------------------------

### Instantiate and Process Banco do Brasil Return Files with Laravel Boleto

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/retorno/index

Demonstrates how to instantiate and process return files specifically for Banco do Brasil with Laravel Boleto. Supports both 400 and 240 position formats. The `processar()` method is used to parse the file.

```PHP
// 400 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab400\Banco\Bb($argument)

// 240 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab240\Banco\Bb($argument)

 // To process the file
$return->processar();
```

--------------------------------

### Initialize and Configure Banrisul Boleto Object in PHP

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/boleto/banrisul

This code snippet demonstrates how to create and configure a Banrisul boleto object using the Laravel Boleto package. It covers setting essential details like logo, due date, value, payer, beneficiary, account information, and optional fields like demonstratives and instructions. It also shows how to add more demonstratives or instructions after initial configuration.

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

// You can add more ``Demonstrativos`` or ``Instrucoes`` on this way:

$banrisul->addDescricaoDemonstrativo('demonstrativo 4');
$banrisul->addInstrucoes('instrucao 2');
```

```php
$banrisul = new Eduardokum\LaravelBoleto\Boleto\Banco\Banrisul([
    'logo' => '/path/to/logo.png',
    'dataVencimento' => '1997-10-07',
    'valor' => 100,
    'numero' => 1,
    'numeroDocumento' => 1,
    'pagador' => $pagador,
    'beneficiario' => $beneficiario,
    'carteira' => 1,
    'agencia' => 1111,
    'conta' => 22222,
    'multa' => 1, // 1% do valor do boleto após o vencimento
    'juros' => 1, // 1% ao mês do valor do boleto
    'jurosApos' => 0 // quant. de dias para começar a cobrança de juros,
    'descricaoDemonstrativo' => ['demonstrativo 1', 'demonstrativo 2', 'demonstrativo 3'],
    'instrucoes' => ['instrucao 1', 'instrucao 2', 'instrucao 3'],
]);
```

--------------------------------

### Instantiate and Process HSBC Return Files with Laravel Boleto

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/retorno/index

Demonstrates how to instantiate and process return files for HSBC using Laravel Boleto. Supports both 400 and 240 position formats. The `processar()` method is used to parse the return file data.

```PHP
// 400 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab400\Banco\Hsbc($argument)

// 240 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab240\Banco\Hsbc($argument)

 // To process the file
$return->processar();
```

--------------------------------

### Render Multiple Boletos to HTML

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/boleto/render

Illustrates rendering multiple Boleto instances to HTML using the Html rendering class. Supports adding multiple boletos, controlling print behavior, and generating either a standard HTML string or a 'carnê' format. Requires the 'Eduardokum\LaravelBoleto\Boleto\Render\Html' class.

```php
$html = new Eduardokum\LaravelBoleto\Boleto\Render\Html();

// Add as many bills as you want
$html->addBoleto($boleto);

// Or, Simply
$html->addBoletos([
    $boleto1,
    $boleto2,
    $boleto3,
]);

// If you want to show a print window after rendering.
$html->showPrint();

// If you want to hide the print instructions.
$html->hideInstrucoes();

// To Render, this will return a html string.
$html->gerarBoleto();

// Html also provides a ``carnê`` as a form of rendering.
$html->gerarCarne();
```

--------------------------------

### Instantiate and Process Banco do Nordeste Return Files with Laravel Boleto

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/retorno/index

Illustrates the process of creating and processing return files for Banco do Nordeste using Laravel Boleto. Supports 400 and 240 position formats. The `processar()` method is called to parse the return file data.

```PHP
// 400 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab400\Banco\Bnb($argument)

// 240 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab240\Banco\Bnb($argument)

 // To process the file
$return->processar();
```

--------------------------------

### Create Laravel Boleto Pagador Instance (PHP)

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/pagador

Demonstrates two methods for creating a Pagador instance in Laravel Boleto. The first method involves instantiating the Pessoa object and then calling setter methods for each attribute. The second method provides a more concise way to initialize the Pagador object by passing an associative array of attributes directly to the constructor. Both methods achieve the same result of creating a fully configured Pagador object, which is a prerequisite for generating Boleto.

```php
$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');

```

```php
$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',
]);

```

--------------------------------

### Instantiate Bancoob CNAB 400/240 with individual properties (PHP)

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/remessa/bancoob

This snippet demonstrates how to instantiate the Bancoob class for either CNAB 400 or CNAB 240 formats in PHP. It shows setting the beneficiary, carteira, agencia, convenio, and conta properties individually on the object. This is useful for programmatic configuration.

```php
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab400\Banco\Bancoob;

// Or, for 240 positions
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab240\Banco\Bancoob;

$send->setBeneficiario($beneficiario)
    ->setCarteira(1)
    ->setAgencia(1111)
    ->setConvenio(123123)
    ->setConta(22222);
```

--------------------------------

### Create Beneficiário Instance (PHP)

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/beneficiario

Demonstrates how to create and configure a Beneficiário object using the Laravel Boleto package. This involves instantiating the Pessoa class and setting various attributes like document, name, and address details. The Beneficiário object is essential for Boleto generation.

```php
$beneficiario = new \Eduardokum\LaravelBoleto\Pessoa;
$beneficiario->setDocumento('00.000.000/0000-00')
    ->setNome('Company co.')
    ->setCep('00000-000')
    ->setEndereco('Street name, 123')
    ->setBairro('district')
    ->setUf('UF')
    ->setCidade('City');

```

```php
$beneficiario = 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',
]);

```

--------------------------------

### Initialize Bradesco Boleto Class (PHP)

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/remessa/bradesco

Demonstrates how to initialize the Bradesco bank class for both CNAB400 and CNAB240 formats. It shows setting beneficiary details and mandatory fields using setter methods. Dependencies include the Laravel Boleto package.

```php
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab400\Banco\Bradesco;

// Or, for 240 positions
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab240\Banco\Bradesco;

$send->setBeneficiario($beneficiario)
    ->setIdremessa(1)
    ->setCarteira('09')
    ->setAgencia(1111)
    ->setCodigoCliente('12345678901234567890')
    ->setConta(2222222);
```

--------------------------------

### Configure Bradesco Boleto Object in PHP

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/boleto/bradesco

Demonstrates how to instantiate and configure a Bradesco boleto object using chained setter methods. This includes setting essential details like logo, due date, amount, account information, and payer/beneficiary details. Additional demonstratives and instructions can be added progressively.

```php
$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']);

// You can add more ``Demonstrativos`` or ``Instrucoes`` on this way:

$bradesco->addDescricaoDemonstrativo('demonstrativo 4');
$bradesco->addInstrucoes('instrucao 2');

```

--------------------------------

### Configure Bradesco Boleto Object with Constructor in PHP

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/boleto/bradesco

Shows an alternative method for creating a Bradesco boleto object by passing configuration options directly to the constructor as an associative array. This approach sets initial values for logo, due date, amount, account details, payer/beneficiary, and various fees like multa and juros.

```php
$bradesco = new Eduardokum\LaravelBoleto\Boleto\Banco\Bradesco([
    'logo' => '/path/to/logo.png',
    'dataVencimento' => '1997-10-07',
    'valor' => 100,
    'numero' => 1,
    'numeroDocumento' => 1,
    'pagador' => $pagador,
    'beneficiario' => $beneficiario,
    'carteira' => '09',
    'agencia' => 1111,
    'conta' => 2222222,
    'multa' => 1, // 1% do valor do boleto após o vencimento
    'juros' => 1, // 1% ao mês do valor do boleto
    'jurosApos' => 0, // quant. de dias para começar a cobrança de juros,
    'descricaoDemonstrativo' => ['demonstrativo 1', 'demonstrativo 2', 'demonstrativo 3'],
    'instrucoes' => ['instrucao 1', 'instrucao 2', 'instrucao 3'],
]);

```

--------------------------------

### Iterating Return Details (400 Positions) in PHP

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/retorno/index

Demonstrates how to iterate through the details of a bank return object when using the 400-position format. It shows how to access individual return details and convert them to arrays. This assumes the `$return` object is already populated.

```php
$return->getDetalhes();
$return->getHeader();
$return->getTrailer();

foreach($return->getDetalhes() as $object) {
    var_dump($object->toArray());
}
```

--------------------------------

### Initialize Caixa Remittance (Laravel)

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/remessa/caixa

Instantiates the Caixa Econômica Federal remittance object for either 400 or 240 positions. Requires setting beneficiary and bank-specific details like idremessa, carteira, agencia, and codigoCliente. Dependencies include the EduardokumLaravelBoleto library.

```php
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab400\Banco\Caixa;

// Or, for 240 positions
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab240\Banco\Caixa;

$send->setBeneficiario($beneficiario)
    ->setIdremessa(1)
    ->setCarteira('RG')
    ->setAgencia(1111)
    ->setCodigoCliente(222222);
```

```php
$sendArray = [
    'beneficiario' => $beneficiario,
    'idremessa' => 1,
    'carteira' => 'RG',
    'agencia' => 1111,
    'codigoCliente' => 222222,
];

// for 400 positions
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab400\Banco\Caixa($sendArray);

// Or, for 240 positions
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab240\Banco\Caixa($sendArray);
```

--------------------------------

### Configure Banco do Brasil Boleto Object in PHP

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/boleto/bancobrasil

This snippet shows how to initialize and configure a Banco do Brasil Boleto object using the Laravel Boleto package. It covers setting essential details like logo, due date, value, payer, beneficiary, and bank-specific information. Dependencies include the `EduardokumLaravelBoletoBoletoBancoBb` class and necessary payer/beneficiary objects. The output is a configured Boleto object ready for further processing or rendering.

```php
$bb = new Eduardokum\LaravelBoleto\Boleto\Banco\Bb;
$bb->setLogo('/path/to/logo.png')
    ->setDataVencimento('1997-10-07')
    ->setValor('100')
    ->setNumero(1)
    ->setNumeroDocumento(1)
    ->setPagador($pagador)
    ->setBeneficiario($beneficiario)
    ->setCarteira(11)
    ->setAgencia(1111)
    ->setConvenio(1231237)
    ->setConta(22222)
    ->setDescricaoDemonstrativo(['demonstrativo 1', 'demonstrativo 2', 'demonstrativo 3'])
    ->setInstrucoes(['instrucao 1', 'instrucao 2', 'instrucao 3']);

// You can add more ``Demonstrativos`` or ``Instrucoes`` on this way:

$bb->addDescricaoDemonstrativo('demonstrativo 4');
$bb->addInstrucoes('instrucao 2');

```

```php
$bb = new Eduardokum\LaravelBoleto\Boleto\Banco\Bb([
    'logo' => '/path/to/logo.png',
    'dataVencimento' => '1997-10-07',
    'valor' => 100,
    'numero' => 1,
    'numeroDocumento' => 1,
    'pagador' => $pagador,
    'beneficiario' => $beneficiario,
    'carteira' => 11,
    'agencia' => 1111,
    'convenio' => 1231237,
    'conta' => 22222,
    'multa' => 1, // 1% do valor do boleto após o vencimento
    'juros' => 1, // 1% ao mês do valor do boleto
    'jurosApos' => 0 // quant. de dias para começar a cobrança de juros,
    'descricaoDemonstrativo' => ['demonstrativo 1', 'demonstrativo 2', 'demonstrativo 3'],
    'instrucoes' => ['instrucao 1', 'instrucao 2', 'instrucao 3'],
]);

```

--------------------------------

### Instantiate Banco do Nordeste CNAB Remittance Object (PHP)

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/remessa/banconordeste

Demonstrates how to instantiate the Banco do Nordeste remittance object for both CNAB 400 and CNAB 240 formats using either direct method chaining or an array of parameters. Requires the `laravel-boleto` library.

```php
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab400\Banco\Bnb;

// Or, for 240 positions
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab240\Banco\Bnb;

$send->setBeneficiario($beneficiario)
    ->setCarteira(21)
    ->setAgencia(1111)
    ->setConta(22222);

```

```php
$sendArray = [
    'beneficiario' => $beneficiario,
    'carteira' => 21,
    'agencia' => 1111,
    'conta' => 22222,
];

// for 400 positions
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab400\Banco\Bnb($sendArray);

// Or, for 240 positions
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab240\Banco\Bnb($sendArray);

```

--------------------------------

### Initialize Bradesco Boleto Class with Array (PHP)

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/remessa/bradesco

Provides an alternative method for initializing the Bradesco bank class for CNAB400 and CNAB240 formats using an associative array. This method simplifies the instantiation process by passing all required parameters at once. Dependencies include the Laravel Boleto package.

```php
$sendArray = [
    'beneficiario' => $beneficiario,
    'idremessa' => 1,
    'carteira' => '09',
    'agencia' => 1111,
    'codigoCliente' => 12345678901234567890,
    'conta' => 2222222,
];

// for 400 positions
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab400\Banco\Bradesco($sendArray);

// Or, for 240 positions
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab240\Banco\Bradesco($sendArray);
```

--------------------------------

### Use Factory to Process Bank Return Files with Laravel Boleto

Source: https://laravel-boleto.readthedocs.io/en/latest/usage/retorno/index

Utilizes the Factory class in Laravel Boleto to automatically detect the return file format (240 or 400 positions) and the bank. It returns an instantiated object ready for processing. After instantiation, you can retrieve the bank type and code.

```PHP
$return = \Eduardokum\LaravelBoleto\Cnab\Retorno\Factory::make($argument);

// To process the file
$return->processar();

// You can know the type of bank after instantiate, using the methods respectively:
$return->getTipo();
$return->getCodigoBanco();
```
Tokens:
Raw