README

Projeto para criar arquivos de remessas e processar arquivos de retorno no formato CNAB, utilizado nos bancos geralmente para boleto bancário.

Creditos

Os créditos deste projeto são dos autores Anderson Danilo e Hermenegildo Marin Junior que criaram o projeto. Após o fork do projeto original toda a modificação em especifico deste repositório devem ser mantido os créditos para os autores de criação do projeto e para André Gonçalves o mantenedor deste repositório.

Requisitos mínimos

Funcionalidades

Leitura e geração de arquivos de retorno e remessa nos formatos CNAB 240 e 400

Instalação

Composer

Se você já conhece o Composer, adicione a dependência abaixo à diretiva "require" no seu composer.json:

"andreseko/cnab_php": "^2.0"

Como Usar

Lendo um arquivo de Retorno

$cnabFactory = new Cnab\Factory();
$arquivo = $cnabFactory->createRetorno('AQUI VAI O CAMINHO DO ARQUIVO DE RETORNO, EX: RET1010.RET');
$detalhes = $arquivo->listDetalhes();
foreach($detalhes as $detalhe) {
    if($detalhe->getValorRecebido() > 0) {
        $nossoNumero   = $detalhe->getNossoNumero();
        $valorRecebido = $detalhe->getValorRecebido();
        $dataPagamento = $detalhe->getDataOcorrencia();
        $carteira      = $detalhe->getCarteira();
        // você já tem as informações, pode dar baixa no boleto aqui
    }
}

Criando um arquivo de remessa

Consulte na wiki: https://github.com/andreseko/CnabPHP/wiki/Criando-um-arquivo-de-remessa

Como Contribuir

Você pode contribuir com testes (unitários ou manuais), ou adaptando o formato para outro banco através do projeto cnab_yaml (https://github.com/andreseko/cnab_yaml) (que é utilizado pelo cnab_php). Leia a wiki

Licença

Este projeto esta sobre a licença MIT

andreseko / cnab_php

Maintainers

Details