Laravel Boleto

https://github.com/eduardokum/laravel-boleto
Admin
A Laravel package for generating payment slips (boletos), remittance files, and processing return...
Tokens:157,448
Snippets:884
Trust Score:9.2
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Create Caixa boleto with array constructor

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/boleto/caixa.rst

Creates a Caixa boleto by passing an array to the constructor. Includes optional multa, juros, and jurosApos parameters with comments explaining their meaning. Requires the same mandatory fields as the fluent example.

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

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

### Install via composer require

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/install.rst

Run this command in the terminal to install the laravel-boleto package. Requires PHP 5.6 or 7.0 (recommended) and the Intl extension.

```default
composer require "eduardokum/laravel-boleto"
```

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

### Create Bancoob boleto with array constructor

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/boleto/bancoob.rst

Alternative constructor using an array. Includes optional multa (1% after due date), juros (1% monthly), and jurosApos (days before interest starts). Note the trailing comma after jurosApos in the source.

```php
$bancoob = new Eduardokum\LaravelBoleto\Boleto\Banco\Bancoob([
    'logo' => '/path/to/logo.png',
    'dataVencimento' => '1997-10-07',
    'valor' => 100,
    'numero' => 1,
    'numeroDocumento' => 1,
    'pagador' => $pagador,
    'beneficiario' => $beneficiario,
    'carteira' => 1,
    'agencia' => 1111,
    'convenio' => 123123,
    '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'],
]);
```

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

### Create HSBC boleto with array constructor

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/boleto/hsbc.rst

Alternative way to create an HSBC boleto by passing an array to the constructor. Includes optional fields multa, juros, and jurosApos with their meanings in comments. Requires the same mandatory fields as the fluent example.

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

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

### Create Santander boleto with fluent interface

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/boleto/santander.rst

Shows how to instantiate a Santander boleto and set its properties using method chaining. Includes adding demonstrativos and instrucoes via addDescricaoDemonstrativo and addInstrucoes.

```php
$santander = new Eduardokum\LaravelBoleto\Boleto\Banco\Santander;
$santander->setLogo('/path/to/logo.png')
    ->setDataVencimento('1997-10-07')
    ->setValor('100')
    ->setNumero(1)
    ->setNumeroDocumento(1)
    ->setPagador($pagador)
    ->setBeneficiario($beneficiario)
    ->setCarteira(101)
    ->setCodigoCliente(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:

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

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

### fatorVencimento: Convert date to expiration factor

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/utilities.rst

Converts a date to the expiration factor. The example shows that '2018-01-01' returns 7391.

```php
Util::fatorVencimento($date, $format = 'Y-m-d')
// Example
Util::fatorVencimento('2018-01-01')
// will return
7391
```

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

### Create Bradesco boleto with fluent interface

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/boleto/bradesco.rst

Shows how to instantiate a Bradesco boleto and set its properties using method chaining. Includes adding demonstrativos and instrucoes with addDescricaoDemonstrativo and addInstrucoes.

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

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

### Retorno Constructor Argument Formats

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/retorno/index.rst

Shows the three supported argument formats for the constructor: a file path, a string with newline separators, or an array of lines. Use this to prepare the input data before reading a bank return file.

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

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

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

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

### array2Controle: Convert array to control string

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/utilities.rst

Converts an array to a control string that can be passed in the bill. The example shows the output 'A47885B212C9598' for the given input array.

```php
Util::array2Controle(array $array)
// Example
$array = [
    'A' => 47885,
    'B' => 212,
    'C' => 9598,
];
Util::array2Controle($array);
// will return
A47885B212C9598
```

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

### controle2array: Parse control string to array

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/utilities.rst

Parses the bill's digitable line, extracting the contained variables. The example shows the returned array for the control string 'A47885B212C9598'.

```php
Util::controle2array($control)
// Example
Util::controle2array('A47885B212C9598')
// will return
[
    'A' => 47885,
    'B' => 212,
    'C' => 9598,
]
```

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

### Create Banco do Brasil boleto with method chaining

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/boleto/bancobrasil.rst

Instantiates a Eduardokum\LaravelBoleto\Boleto\Banco\Bb object and sets all required fields via fluent setters. Demonstrates adding extra demonstrativos and instrucoes with addDescricaoDemonstrativo and addInstrucoes.

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

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

### Render multiple boletos to PDF with Pdf class

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/boleto/render.rst

Instantiates Eduardokum\LaravelBoleto\Boleto\Render\Pdf, adds one or many boletos, configures print options, and generates the PDF. The gerarBoleto() method accepts a destination constant and optional save path; available destinations include OUTPUT_STANDARD, OUTPUT_DOWNLOAD, OUTPUT_SAVE, and OUTPUT_STRING.

```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);
```

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

### Bancoob return instantiation for Cnab400 and Cnab240

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/retorno/index.rst

Instantiates a Bancoob return object directly for either the 400-position or 240-position layout, then processes the file with processar(). Use this when you already know the bank and layout.

```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();
```

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

### Instantiate Bancoob Cnab Remessa (with method chaining)

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/remessa/bancoob.rst

Shows how to instantiate the Bancoob remittance class for both 400 and 240 positions and set required fields using method chaining. Requires the beneficiary object and mandatory fields: agencia (size 4), conta (size 8), and convenio (size 7).

```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 Bancoob boleto with fluent setters

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/boleto/bancoob.rst

Creates a Bancoob boleto using fluent setters. Requires mandatory fields: numero (7 digits), agencia (4), conta (5), and convenio (6). Demonstrates adding extra demonstrativos and instrucoes with addDescricaoDemonstrativo and addInstrucoes.

```php
$bancoob = new Eduardokum\LaravelBoleto\Boleto\Banco\Bancoob;
$bancoob->setLogo('/path/to/logo.png')
    ->setDataVencimento('1997-10-07')
    ->setValor('100')
    ->setNumero(1)
    ->setNumeroDocumento(1)
    ->setPagador($pagador)
    ->setBeneficiario($beneficiario)
    ->setCarteira(1)
    ->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:

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

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

### Create Banrisul boleto with method chaining

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/boleto/banrisul.rst

Creates a Banrisul boleto object using setter methods. Includes optional methods to add demonstrativos and instrucoes.

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

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

### Create Itau boleto using constructor array

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/boleto/itau.rst

Alternative constructor that passes all settings as an array. Includes optional fields for multa, juros, and jurosApos with comments explaining the meaning of each value.

```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 Bancoob Cnab Remessa (with array constructor)

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/remessa/bancoob.rst

Shows an alternative way to create the Bancoob remittance object by passing an array of configuration values to the constructor. The array includes the mandatory fields and the 'beneficiario' object.

```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);
```

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

### Create Santander boleto with array constructor

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/boleto/santander.rst

Shows an alternative way to instantiate a Santander boleto by passing an array of options to the constructor. Includes optional fields for multa, juros, and jurosApos.

```php
$santander = new Eduardokum\LaravelBoleto\Boleto\Banco\Santander([
    'logo' => '/path/to/logo.png',
    'dataVencimento' => '1997-10-07',
    'valor' => 100,
    'numero' => 1,
    'numeroDocumento' => 1,
    'pagador' => $pagador,
    'beneficiario' => $beneficiario,
    'carteira' => 101,
    'codigoCliente' => 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'],
]);
```

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

### Render multiple boletos to HTML with Html class

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/boleto/render.rst

Instantiates Eduardokum\LaravelBoleto\Boleto\Render\Html, adds one or many boletos, configures print options, and generates the HTML string. The gerarCarne() method provides an alternative 'carnê' rendering format.

```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();
```

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

### Create Banco do Brasil boleto with array constructor

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/boleto/bancobrasil.rst

Instantiates a Eduardokum\LaravelBoleto\Boleto\Banco\Bb object by passing an array of options. Includes multa, juros, and jurosApos fields with comments explaining their meaning.

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

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

### Create Caixa boleto with fluent setters

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/boleto/caixa.rst

Creates a Caixa bank boleto object using fluent setters. Requires the mandatory fields numero, agencia, and codigoCliente. Demonstrates adding extra demonstrativos and instrucoes with addDescricaoDemonstrativo and addInstrucoes.

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

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

### Common Remessa methods: addBoleto, addBoletos, gerar, save, download

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/remessa/index.rst

Shows the common methods available on all Remessa instances (240 or 400 positions) for adding bills, generating the file, saving it, and downloading it. The methods are the same across banks; only the required fields differ.

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

// Add multiples bill to a send object. Here need a array of instances of Boleto.
$send->addBoletos(BoletoContract[] $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);
```

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

### Create Bradesco boleto with array constructor

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/boleto/bradesco.rst

Shows an alternative way to instantiate a Bradesco boleto by passing an array of options to the constructor. Includes optional multa, juros, and jurosApos parameters.

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

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

### Render individual boleto to PDF with renderPDF()

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/boleto/render.rst

Call $boleto->renderPDF() to generate a PDF string. The first argument enables a print window, the second controls the print instructions. By default, both are false and true respectively.

```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);
```

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

### Render individual boleto to HTML with renderHTML()

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/boleto/render.rst

Call $boleto->renderHTML() to generate an HTML string. The first argument enables a print window, the second controls the print instructions. By default, both are false and true respectively.

```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 in the second argument.
$boleto->renderHTML(false, false);
```

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

### Instantiate BNB remittance with setter methods

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/remessa/banconordeste.rst

Creates a BNB remittance object for either 400 or 240 positions, then sets the required fields: beneficiario, carteira (21), agencia (1111), and conta (22222).

```php
// for 400 positions
$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);
```

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

### Instantiate Itau boleto and set fields via methods

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/boleto/itau.rst

Constructor calls and fluent setters for the Itau boleto object. Includes optional addDescricaoDemonstrativo and addInstrucoes methods to append additional demonstratives or instructions.

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

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

### Create Sicredi boleto with fluent setters

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/boleto/sicredi.rst

Creates a Sicredi boleto using fluent setters. Requires mandatory fields: numero, agencia, conta, codigoCliente, byte, and posto. Demonstrates adding extra demonstrativos and instrucoes with addDescricaoDemonstrativo and addInstrucoes.

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

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

### Create HSBC boleto with fluent setters

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/boleto/hsbc.rst

Creates an HSBC boleto using the fluent setter interface. Requires the mandatory fields numero, agencia, conta, range, and contaDv. Demonstrates adding extra demonstrativos and instrucoes with addDescricaoDemonstrativo and addInstrucoes.

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

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

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

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

### Configure Itaú remessa with setter methods

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/remessa/itau.rst

Instantiate the Itaú remessa class for either 400 or 240 positions, then configure the required fields: beneficiario, carteira, agencia, and conta. The agencia field has size 4 and the conta field has size 5.

```php
// for 400 positions
$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);
```

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

### Create BNB boleto with fluent setters

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/boleto/banconordeste.rst

Creates a BNB boleto using fluent setters. Requires mandatory fields: numero (7 digits), agencia (4 digits), and conta (7 digits). Demonstrates adding extra demonstrativos and instrucoes with addDescricaoDemonstrativo and addInstrucoes.

```php
$bnb = new Eduardokum\LaravelBoleto\Boleto\Banco\Bnb;
$bnb->setLogo('/path/to/logo.png')
    ->setDataVencimento('1997-10-07')
    ->setValor('100')
    ->setNumero(1)
    ->setNumeroDocumento(1)
    ->setPagador($pagador)
    ->setBeneficiario($beneficiario)
    ->setCarteira(21)
    ->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:

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

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

### Create Beneficiário with constructor array

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/beneficiario.rst

Creates a Beneficiário instance by passing an array of attributes to the Pessoa constructor. This is an alternative to using setter methods.

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

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

### Create Banrisul remittance with array constructor

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/remessa/banrisul.rst

Creates a Banrisul remittance object by passing an array of configuration values to the constructor. The commented 'codigoClienteOfficeBanking' key is required when the bank contract is 'R', 'S', or 'X'. Choose the Cnab400 or Cnab240 class for the desired file layout.

```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);
```

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

### Create HSBC remittance object with method chaining

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/remessa/hsbc.rst

Shows how to instantiate the HSBC remittance class for 400 or 240 positions and set the required fields using method chaining. The carteira is set to 'CSB' and the agency, account, and account verification digit are provided.

```php
// for 400 positions
$send = new Eduardokum\LaravelBoleto\Cnab\Remessa\Cnab400\Banco\Hsbc;

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

$send->setBeneficiario($beneficiario)
    ->setCarteira('CSB')
    ->setAgencia(1111)
    ->setConta(222222)
    ->setContaDv(2);
```

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

### Create Beneficiário with setter methods

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/beneficiario.rst

Creates a Beneficiário instance using the Pessoa class and setter methods. The Beneficiário is the person issuing the charge and is required by the Boleto.

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

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

### Create Banrisul boleto with array constructor

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/boleto/banrisul.rst

Creates a Banrisul boleto object by passing an associative array to the constructor. Includes optional multa, juros, and jurosApos parameters.

```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 Banco do Brasil remittance class with array constructor

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/remessa/bancobrasil.rst

Creates a remittance object for Banco do Brasil by passing an array of configuration values to the constructor. Supports both Cnab400 and Cnab240. The array includes beneficiario, carteira, agencia, convenio, and conta; variacaoCarteira is optional and commented out.

```php
$sendArray = [
    'beneficiario' => $beneficiario,
    'carteira' => 11,
    'agencia' => 1111,
    'convenio' => 1231237,
    // 'variacaoCarteira' => '017',
    'conta' => 22222,
];

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

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

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

### Resposta SOAP do registro de título (BB)

Source: https://github.com/eduardokum/laravel-boleto/blob/master/manuais/BB/webservice.pdf

Exemplo de resposta XML/SOAP do WebService de registro de títulos do Banco do Brasil. Inclui campos de retorno do programa (código, mensagem de erro) e dados do título registrado, como número do título, carteira, linha digitável e código de barras.

```xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <ns0:resposta xmlns:ns0="http://www.tibco.com/schemas/bws_registro_cbr/Recursos/XSD/Schema.xsd"> <ns0:siglaSistemaMensagem></ns0:siglaSistemaMensagem> <ns0:codigoRetornoPrograma>0</ns0:codigoRetornoPrograma> <ns0:nomeProgramaErro></ns0:nomeProgramaErro> <ns0:textoMensagemErro></ns0:textoMensagemErro> <ns0:numeroPosicaoErroPrograma>0</ns0:numeroPosicaoErroPrograma> <ns0:codigoTipoRetornoPrograma>0</ns0:codigoTipoRetornoPrograma> <ns0:textoNumeroTituloCobrancaBb>00010140510000000000</ns0:textoNumeroTituloCobrancaBb> <ns0:numeroCarteiraCobranca>17</ns0:numeroCarteiraCobranca> <ns0:numeroVariacaoCarteiraCobranca>19</ns0:numeroVariacaoCarteiraCobranca> <ns0:codigoPrefixoDependenciaBeneficiario>3851</ns0:codigoPrefixoDependenciaBeneficiario> <ns0:numeroContaCorrenteBeneficiario>8570</ns0:numeroContaCorrenteBeneficiario> <ns0:codigoCliente>932131545</ns0:codigoCliente> <ns0:linhaDigitavel>00190000090101405100500000630178673500003000000</ns0:linhaDigitavel> <ns0:codigoBarraNumerico>0019673500003000000000000101405100000006301721112017</ns0:codigoBarraNumerico> <ns0:codigoTipoEnderecoBeneficiario>0</ns0:codigoTipoEnderecoBeneficiario> <ns0:nomeLogradouroBeneficiario>Cliente nao informado.</ns0:nomeLogradouroBeneficiario> <ns0:nomeBairroBeneficiario> </ns0:nomeBairroBeneficiario> <ns0:nomeMunicipioBeneficiario> </ns0:nomeMunicipioBeneficiario> <ns0:codigoMunicipioBeneficiario>0</ns0:codigoMunicipioBeneficiario> <ns0:siglaUfBeneficiario> </ns0:siglaUfBeneficiario> <ns0:codigoCepBeneficiario>0</ns0:codigoCepBeneficiario> <ns0:indicadorComprovacaoBeneficiario> </ns0:indicadorComprovacaoBeneficiario> <ns0:numeroContratoCobranca>17414296</ns0:numeroContratoCobranca> </ns0:resposta> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
```

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

### Factory::make() with processar() and bank type methods

Source: https://github.com/eduardokum/laravel-boleto/blob/master/docs/source/usage/retorno/index.rst

Uses the Factory to automatically detect the return layout (240 or 400) and the bank, returning an instantiated object. After processing with processar(), you can query the layout type and bank code with getTipo() and getCodigoBanco().

```php
// The Factory will guess what the return if it is 240 or 400 and which bank and already return the instantiated object
$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