Documentation

Guia

in package

• Application

Classe responsável por criar uma simples guia GNRE. Essa classe armazena todos os atributos necessários para serem transformados no XML aceito pela SEFAZ e posteriormente submetidos através do webservice

Tags

author

Matheus Marabesi matheus.marabesi@gmail.com

license

http://www.gnu.org/licenses/gpl-howto.html GPL

version

1.0.0

Table of Contents

Properties

$ano  : int

Para esse atributo é esperado um dado do tipo int com algum ano válido como por exemplo 2014 (IMPORTANTE: o ano dever ser menor ou igual a 2000)

$c01_UfFavorecida  : string

Uma sigla representando um dos 27 estados brasileiros por exemplo AC, BA, DF

$c02_receita  : int

Para esse atributo é esperado um dado do tipo inteiro para maiores informações visualizar a documentação oficial do GNRE http://www.gnre.pe.gov.br/gnre/index.html

$c03_idContribuinteEmitente  : int

Informar o CPF ou CNPJ sem nenhuma formatação apenas os dígitos

$c04_docOrigem  : int

Para esse atributo é esperado um dado do tipo inteiro para maiores informações visualizar a documentação oficial do GNRE http://www.gnre.pe.gov.br/gnre/index.html

$c06_valorPrincipal  : float

Para esse atributo é esperado um dado do tipo double com o valor total da guia sem juros e/ou acréscimos

$c10_valorTotal  : float

Para esse atributo é esperado um dado do tipo double com o valor total da guia porém com o juros e/ou acréscimo já somados ao valor principal. Ou seja se o valor total for 5.00 e o juros por exemplo for 5.00 o valor total será 10.00

$c14_dataVencimento  : string

Para esse atributo é esperado um dado do tipo string com a data de vencimento da guia no formato AAAA-MM-DD

$c15_convenio  : int

Para esse atributo é esperado um dado do tipo inteiro para maiores informações visualizar a documentação oficial do GNRE http://www.gnre.pe.gov.br/gnre/index.html

$c16_razaoSocialEmitente  : int

Para esse atributo é esperado um dado do tipo string com a razão social da empresa emitente

$c17_inscricaoEstadualEmitente  : int

Para esse atributo é esperado um dado do tipo int com a inscrição estadual (I.E) da empresa emitente

$c18_enderecoEmitente  : int

Para esse atributo é esperado um dado do tipo string com o endereço da empresa emitente

$c19_municipioEmitente  : int

Para esse atributo é esperado um dado do tipo inteiro com o código do municipio de acordo com a tabela do IBGE removendo os 2 primeiros digitos

$c20_ufEnderecoEmitente  : string

Para esse atributo é esperado um dado do tipo string com a singla do estado da empresa emitente por exemplo SP, TO, AC

$c21_cepEmitente  : int

Para esse atributo é esperado um dado do tipo int com o CEP correspondente da empresa emitente

$c22_telefoneEmitente  : int

Para esse atributo é esperado um dado do tipo int com o telefone do emitente no formato DD99999999

$c25_detalhamentoReceita  : int

Para esse atributo é esperado um dado do tipo inteiro para maiores informações visualizar a documentação oficial do GNRE http://www.gnre.pe.gov.br/gnre/index.html

$c26_produto  : int

Para esse atributo é esperado um dado do tipo inteiro para maiores informações visualizar a documentação oficial do GNRE http://www.gnre.pe.gov.br/gnre/index.html

$c27_tipoIdentificacaoEmitente  : int

Para esse atributo é esperado um dado do tipo inteiro para maiores informações visualizar a documentação oficial do GNRE http://www.gnre.pe.gov.br/gnre/index.html

$c28_tipoDocOrigem  : int

Para esse atributo é esperado um dado do tipo inteiro para maiores informações visualizar a documentação oficial do GNRE http://www.gnre.pe.gov.br/gnre/index.html

$c33_dataPagamento  : string

Para esse atributo é esperado um dado do tipo string com a data de pagamento da guia no formato AAAA-MM-DD

$c34_tipoIdentificacaoDestinatario  : int

Para esse atributo é esperado um dado do tipo inteiro para maiores informações visualizar a documentação oficial do GNRE http://www.gnre.pe.gov.br/gnre/index.html

$c35_idContribuinteDestinatario  : int

Informar o CPF ou CNPJ sem nenhuma formatação apenas os dígitos

$c36_inscricaoEstadualDestinatario  : int

Para esse atributo é esperado um dado do tipo int com a inscrição estadual (I.E) da empresa a quem se destina a guia

$c37_razaoSocialDestinatario  : int

Para esse atributo é esperado um dado do tipo string com a razão social da empresa a quem se destina a guia

$c38_municipioDestinatario  : int

Para esse atributo é esperado um dado do tipo inteiro com o código do municipio de acordo com a tabela do IBGE removendo os 2 primeiros digitos

$c39_camposExtras  : array<string|int, mixed>

Para esse atributo é esperado um dado do tipo array contendo os campos extras para a guia com os seguintes índices : codigo, tipo e valor

$c42_identificadorGuia  : string

Para esse atributo é esperado um dado do tipo string para maiores informações visualizar a documentação oficial do GNRE http://www.gnre.pe.gov.br/gnre/index.html

$mes  : int

Para esse atributo é esperado um dado do tipo int com algum mês do ano (IMPORTANTE : é necessário informar o zero a esquerma caso o mês desejado esteja entre 1 e 9)

$parcela  : int

Para esse atributo é esperado um dado do tipo int com o número de parcelas desejadas entre 1 e 999 ( 1, 2, 3, 4 ... 999)

$periodo  : int

Para esse atributo é esperado um dado do tipo int com o intervalo entre 0 e 5 (1, 2, 3, 4 ou 5)

$retornoAtualizacaoMonetaria  : float

Dados retornados pelo web service da SEFAZ com o valor da atualização monetária, esse item pode ser encontrado do lado direito da guia em https://github.com/marabesi/gnrephp/blob/dev-pdf/exemplos/guia.jpg na sétima linha

$retornoCodigoDeBarras  : int

Dados retornados pelo web service da SEFAZ com o código de barras, possuindo 44 caracteres (esse valor deve ser usado para gerar a imagem do código de barras do boleto).

$retornoErrosDeValidacaoCampo  : string

Dados retornados pelo web service da SEFAZ com o nome dos campos do XML que causaram o erro caso a guia não tenha sido processada com sucesso

$retornoErrosDeValidacaoCodigo  : string

Dados retornados pelo web service da SEFAZ com o código do erro caso a guia não tenha sido processada com sucesso

$retornoErrosDeValidacaoDescricao  : string

Dados retornados pelo web service da SEFAZ com a descrição do erro caso a guia não tenha sido processada com sucesso

$retornoInformacoesComplementares  : string

Dados retornados pelo web service da SEFAZ com os dados complementares da guia

$retornoJuros  : float

Dados retornados pelo web service da SEFAZ com o valor do juros, esse item pode ser encontrado do lado direito da guia em https://github.com/marabesi/gnrephp/blob/dev-pdf/exemplos/guia.jpg na oitava linha

$retornoMulta  : float

Dados retornados pelo web service da SEFAZ com o valor da multa, esse item pode ser encontrado do lado direito da guia em https://github.com/marabesi/gnrephp/blob/dev-pdf/exemplos/guia.jpg na nona linha

$retornoNumeroDeControle  : int

Dados retornados pelo web service da SEFAZ com o número de controle da guia, <b>o valor desse atributo é gerado pela SEFAZ</b>

$retornoRepresentacaoNumerica  : int

Dados retornados pelo web service da SEFAZ com a linha digitável do código de barras possuindo 48 caracteres

$retornoSequencialGuia  : type

Dados retornados pelo web service da SEFAZ com o numero de sequencia que a guia tem na SEFAZ.

$retornoSituacaoGuia  : int

Dados retornados pelo web service da SEFAZ com a situação da guia, se foi processada com sucesso ou se houve erro.

Methods

__get()  : string

Método mágico utilizado para retornar um valor de um determinado atributo na classe

__set()  : bool

Método mágico utilizado para setar valores aos atributos existentes na classe

verifyProperty()  : bool

Método utilizado para verificar se o atributo desejado exista na classe