nfephp-org / sped-gtin
Classes for validation of GTIN codes.
Installs: 580 380
Dependents: 7
Suggesters: 0
Security: 0
Stars: 15
Watchers: 8
Forks: 22
Open Issues: 2
Requires
- php: >= 7.4
- ext-curl: *
- ext-dom: *
- ext-json: *
- ext-libxml: *
- ext-openssl: *
- ext-simplexml: *
- ext-soap: *
- nfephp-org/sped-common: ^5.1.0
Requires (Dev)
- phpcompatibility/php-compatibility: ^9.3
- phpstan/phpstan: ^1.4
- phpunit/phpunit: ^9.3
- scrutinizer/ocular: ^1.8
- squizlabs/php_codesniffer: dev-master
README
A partir do layout 4.00 da NFe (e NFCe) o GTIN do produto passa a ser um item OBRIGATÓRIO, quando existir. Portanto em todas as NFe (e NFCe) que contêm produtos que possuem códigos de barras para fins comerciais (GTIN 8, 12, 13 ou 14) derão indicar os mesmos em suas notas.
É importantissimo que esses GTIN sejam corretos e validados, antes de serem inseridos em seus sistemas para evitar rejeições por parte da SEFAZ.
NT 2021.003_v1_00 Validação do GTIN
Esta Nota Técnica entrou em vigor em setembro e estabelece que apenas GTINs nacionais podem ser utilizados, ou seja apenas GTINs que iniciem 789 ou 790, além disso apenas os produtos cadastrados no Cadastro Nacional de Produtos - CNP.
É importante destacar que o cadastro centralizado irá também comparar outras informações como:
- GTIN
- Marca
- Tipo GTIN (8, 12, 13 ou 14 posições)
- Descrição do Produto
- Identificação do Dono da Marca (CNPJ ou CPF)
- Dados da classificação do produto (Segmento, Família, Classe e Subclasse/Bloco)
- NCM
- CEST (quando existir)
- Peso Bruto e Peso Líquido
- Unidade de Medida de Peso Bruto e Peso Líquido
Estes dados devem estar compatíveis com os informados na NFe ou NFCe.
Para verificar https://gepir.gs1.org/index.php/search-by-gtin
NOTA: caso o fabricante/importador, não cadastre corretamente o seu produto poderão ocorrer rejeiçoes, isso não afeta os comerciantes pois quem será impedido de emitir a NFe será o fabricante/importador.
Esta classe faz exatamente isso, verifica a correção do numero GTIN, com relação a sua estrutura, prefixo, região e digito verificador.
A SEFAZ fará consultas adicionais ao Cadastro Nacional de Produtos - CNP. mas ainda não existe a disponibilidade de uma API para que nós também possamos faze-lo, então ainda poderão haver rejeições caso os dados que você possue não estejam de acordo com o CNP.
Formas de Uso
use NFePHP\Gtin\Gtin; try { $gtin = new Gtin('78935761'); $region = $gtin->region; $prefix = $gtin->prefix; $digitoVerificador = $gtin->checkDigit; if ($gtin->isValid()) { echo "Valido"; } } catch (\Exception $e) { echo $e->getMessage(); }
A classe Gtin, possue várias propriedades
region - (string) indica a região de uso do numero ex. GS1 Brasil
prefix - (string) indica o prefixo da região ex. 789
checkDigit - (int) indica o digito verificador para uma determinada sequência numérica (calculado)
restricted - (bool) indica se o pefixo é de uso restrito
type - (int) indica o tipo de gtin (8,12,13, ou 14)
A função principal da classe é :
function isValid()
Essa função não recebe parâmetros e retornará TRUE caso o numero GTIN seja em principio válido.
A classe também pode ser instanciada estaticamente.
use NFePHP\Gtin\Gtin; try { $gtin = Gtin::check('78935761'); $region = $gtin->region; $prefix = $gtin->prefix; $digitoVerificador = $gtin->checkDigit; if ($gtin->isValid()) { echo "Válido"; } } catch (\Exception $e) { echo $e->getMessage(); }
Ou ainda:
use NFePHP\Gtin\Gtin; $gtin = "78935761"; try { if (Gtin::check($gtin)->isValid()) { echo "Válido"; } } catch (\Exception $e) { echo $e->getMessage(); }
NOTA: A validação retornará TRUE (Válida) caso o GTIN seja "SEM GTIN" exatamente dessa forma com letras maiúsculas, qualquer outra forma gera uma rejeição.
Validações e Exceptions
Caso o numero fornecido não atenda alguma restrição será retornado um Exception:
Este pacote é aderente com os PSR-1, PSR-2 e PSR-4. Se você observar negligências de conformidade, por favor envie um patch via pull request.
Não deixe de se cadastrar no grupo de discussão do NFePHP para acompanhar o desenvolvimento e participar das discussões e tirar dúvidas!
Install
Este pacote está listado no Packgist foi desenvolvido para uso do Composer, portanto não será explicitada nenhuma alternativa de instalação.
E deve ser instalado com:
composer require nfephp-org/sped-gtin
Ou ainda alterando o composer.json do seu aplicativo inserindo:
"require": { "nfephp-org/sped-gtin" : "^1.0" }
Para utilizar o pacote em desenvolvimento (branch master) deve ser instalado com:
composer require nfephp-org/sped-gtin:dev-master
Ou ainda alterando o composer.json do seu aplicativo inserindo:
"require": { "nfephp-org/sped-gtin" : "dev-master" }
NOTA: Ao utilizar este pacote na versão em desenvolvimento não se esqueça de alterar o composer.json da sua aplicação para aceitar pacotes em desenvolvimento, alterando a propriedade "minimum-stability" de "stable" para "dev".
"minimum-stability": "dev"
Requirements
Para que este pacote possa funcionar são necessários os seguintes requisitos do PHP e outros pacotes dos quais esse depende.
- PHP >= 7.x (recomendável PHP 7.2.x) (já inclui suporte PHP 8.0.x)
Contributing
Para contribuir com correções de BUGS, melhoria no código, documentação, elaboração de testes ou qualquer outro auxílio técnico e de programação por favor observe o CONTRIBUTING e o Código de Conduta para maiores detalhes.
Change log
Acompanhe o CHANGELOG para maiores informações sobre as alterações recentes.
Testing
Todos os testes são desenvolvidos para operar com o PHPUNIT
Security
Caso você encontre algum problema relativo a segurança, por favor envie um email diretamente aos mantenedores do pacote ao invés de abrir um ISSUE.
Credits
Roberto L. Machado (owner and developer) Gustavo Lidani (developer)
License
Este pacote está diponibilizado sob LGPLv3 ou MIT License (MIT). Leia Arquivo de Licença para maiores informações.