\Gnre\SefazGuia

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

Os atributos com o prefixo "retorno" sao populados com os dados do retorno do web service da SEFAZ, alguns deles podem ou nao possuir conteudo.

Summary

Methods

Properties

Constants

__get()
__set()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

verifyProperty()

$c01_UfFavorecida
$c02_receita
$c25_detalhamentoReceita
$c26_produto
$c27_tipoIdentificacaoEmitente
$c03_idContribuinteEmitente
$c28_tipoDocOrigem
$c04_docOrigem
$c06_valorPrincipal
$c10_valorTotal
$c14_dataVencimento
$c15_convenio
$c16_razaoSocialEmitente
$c17_inscricaoEstadualEmitente
$c18_enderecoEmitente
$c19_municipioEmitente
$c20_ufEnderecoEmitente
$c21_cepEmitente
$c22_telefoneEmitente
$c34_tipoIdentificacaoDestinatario
$c35_idContribuinteDestinatario
$c36_inscricaoEstadualDestinatario
$c37_razaoSocialDestinatario
$c38_municipioDestinatario
$c33_dataPagamento
$periodo
$mes
$ano
$parcela
$c39_camposExtras
$c42_identificadorGuia
$retornoInformacoesComplementares
$retornoAtualizacaoMonetaria
$retornoJuros
$retornoMulta
$retornoRepresentacaoNumerica
$retornoCodigoDeBarras
$retornoSituacaoGuia
$retornoSequencialGuia
$retornoErrosDeValidacaoCampo
$retornoErrosDeValidacaoCodigo
$retornoErrosDeValidacaoDescricao
$retornoNumeroDeControle

N/A

File: Sefaz/Guia.php
Package: gnre\sefaz
Class hierarchy: \Gnre\Sefaz\Guia

Tags

author	Matheus Marabesi matheus.marabesi@gmail.com
license	http://www.gnu.org/licenses/gpl-howto.html GPL
version

Properties

$c01_UfFavorecida

$c01_UfFavorecida : string

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

Type

string

$c02_receita

$c02_receita : integer

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

Type

integer

$c25_detalhamentoReceita

$c25_detalhamentoReceita : integer

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

Type

integer

$c26_produto

$c26_produto : integer

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

Type

integer

$c27_tipoIdentificacaoEmitente

$c27_tipoIdentificacaoEmitente : integer

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

Type

integer

$c03_idContribuinteEmitente

$c03_idContribuinteEmitente : integer

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

Type

integer

$c28_tipoDocOrigem

$c28_tipoDocOrigem : integer

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

Type

integer

$c04_docOrigem

$c04_docOrigem : integer

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

Type

integer

$c06_valorPrincipal

$c06_valorPrincipal : double

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

Type

double

$c10_valorTotal

$c10_valorTotal : double

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

Type

double

$c14_dataVencimento

$c14_dataVencimento : string

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

Type

string

$c15_convenio

$c15_convenio : integer

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

Type

integer

$c16_razaoSocialEmitente

$c16_razaoSocialEmitente : integer

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

Type

integer

$c17_inscricaoEstadualEmitente

$c17_inscricaoEstadualEmitente : integer

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

Type

integer

$c18_enderecoEmitente

$c18_enderecoEmitente : integer

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

Type

integer

$c19_municipioEmitente

$c19_municipioEmitente : integer

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

Type

integer

$c20_ufEnderecoEmitente

$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

Type

string

$c21_cepEmitente

$c21_cepEmitente : integer

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

Type

integer

$c22_telefoneEmitente

$c22_telefoneEmitente : integer

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

Type

integer

$c34_tipoIdentificacaoDestinatario

$c34_tipoIdentificacaoDestinatario : integer

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

Type

integer

$c35_idContribuinteDestinatario

$c35_idContribuinteDestinatario : integer

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

Type

integer

$c36_inscricaoEstadualDestinatario

$c36_inscricaoEstadualDestinatario : integer

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

Type

integer

$c37_razaoSocialDestinatario

$c37_razaoSocialDestinatario : integer

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

Type

integer

$c38_municipioDestinatario

$c38_municipioDestinatario : integer

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

Type

integer

$c33_dataPagamento

$c33_dataPagamento : string

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

Type

string

$periodo

$periodo : integer

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

Type

integer

$mes

$mes : integer

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)

Type

integer

$ano

$ano : integer

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)

Type

integer

$parcela

$parcela : integer

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)

Type

integer

$c39_camposExtras

$c39_camposExtras : array

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

Type

array

$c42_identificadorGuia

$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

Type

string

$retornoInformacoesComplementares

$retornoInformacoesComplementares : string

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

Type

string

$retornoAtualizacaoMonetaria

$retornoAtualizacaoMonetaria : double

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

Type

double

$retornoJuros

$retornoJuros : double

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

Type

double

$retornoMulta

$retornoMulta : double

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

Type

double

$retornoRepresentacaoNumerica

$retornoRepresentacaoNumerica : integer

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

Type

integer

$retornoCodigoDeBarras

$retornoCodigoDeBarras : integer

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).

Type

integer

$retornoSituacaoGuia

$retornoSituacaoGuia : integer

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

Para maiores informações sobre esse item consulte a documentação de retorno em http://www.gnre.pe.gov.br/gnre/portal/downloads.jsp

Type

integer

$retornoSequencialGuia

$retornoSequencialGuia : \Gnre\Sefaz\type

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

Para maiores informações sobre esse item consulte a documentação de retorno em http://www.gnre.pe.gov.br/gnre/portal/downloads.jsp

Type

\Gnre\Sefaz\type

$retornoErrosDeValidacaoCampo

$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

Type

string

$retornoErrosDeValidacaoCodigo

$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

Type

string

$retornoErrosDeValidacaoDescricao

$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

Type

string

$retornoNumeroDeControle

$retornoNumeroDeControle : integer

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

Type

integer

Methods

__get()

__get(string  $property) : string

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

Parameters

string

$property

Uma propriedade válida dessa classe

Throws

\Gnre\Exception\UndefinedProperty: Caso a propriedade desejada não exista

Returns

string —

Caso a propriedade exista retorna o seu valor

Tags

since	1.0.0

__set()

__set(string  $property, mixed  $value) : boolean

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

Parameters

string	$property	O nome existente de um atributo existente na classe
mixed	$value	O valor desejado para ser setado no atributo desejado (string, boolean, int, Object ou array)

Throws

\Gnre\Exception\UndefinedProperty: Caso o atributo desejada não exista

Returns

boolean —

Retorna true caso seja setado o valor para o atributo desejado

Tags

since	1.0.0

verifyProperty()

verifyProperty(string  $property) : boolean

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

Parameters

string

$property

O nome existente de um atributo existente na classe

Throws

\Gnre\Exception\UndefinedProperty: Caso o atributo desejada não exista na classe

Returns

boolean —

Retorna true caso o atributo desejado exista na classe

Tags

since	1.0.0