Manual de integração - Amazon S3 · 2016. 5. 16. · Manual de Integração Consist e.ISS 8 0 – Nenhum 1 – SUS 2 – Outros descServicos A(250) S 1-14 Discriminação dos Serviços

Manual de Integração Consist e.ISS 1

Manual de integração


Introdução

Este manual específica o funcionamento e a interface dos serviços disponibilizado pelo e.ISS,

acessados via WebService.

Esses serviços poderão ser acessados pelos sistemas utilizados pelos contadores/contribuintes.

Visão Geral

O WebService disponibiliza os seguintes serviços:

Processamento de RPS (geração de NF-e)

Validar lote de RPS

Emissão de NF-e

Validar emissão de NF-e

Cancelamento de NF-e

Consulta de NF-e canceladas

Consulta de NF-e existentes

Consulta de empresas

Toda a comunicação feita entre o WebService e o sistema que o esta acessando será via

mensagens XML. O serviço acessado é sempre feito de forma síncrona.

Serviços disponíveis

Emissão de NF-e

Esse serviço permite a emissão de NF-e. A resposta do serviço, caso executado com sucesso, é o

número da NF-e gerada, o hashCode para verificação de autenticidade e a URL para impressão da

nota. Caso a nota não seja emitida, deverá ser usado o serviço ValidaNFe, para verificar os possíveis

erros da nota.

Validar NF-e

Esse serviço é disponibilizado para uma possível validação da NF-e, antes da chamada do serviço de

Emissão. Ele informa se a nota a ser gerada possuí algum erro que possa impossibilitar a geração da

nota. No caso de algum dado estar incorreto, é informado a descrição do erro. Também podem ser

informados alguns alertas, que não impedem a geração da NF-e.


Processamento de RPS(ProcessaRPS)

Esse serviço processa um lote de RPS e emite as respectivas NF-e. A resposta do serviço é o total de

NF-e geradas, a numeração da NF-e gerada para cada RPS e o hashcode correspondente.

Validar lote de RPS(ValidaRPS)

Este serviço valida se o arquivo XML contendo a informação sobre os RPS esta correto, podendo ser

utilizado antes de usar o serviço de “Processamento de RPS”. A resposta do serviço informa se o

arquivo esta correto ou não. No caso de estar incorreto, é informado o erro e o número do RPS

correspodente. Também podem ser informados alguns alertas, que não impedem a geração da NF-

e.

Cancelamento de NF-e(CancelaNFe)

Esse serviço realiza o cancelamente de uma NF-e. A resposta é a confirmação do cancelamento para

cada nota.

Consulta de NF-e canceladas(ConsultaNFeCancelada)

Esse serviço permite a consulta para saber se uma determinada nota esta cancelada.

Consulta de NF-e existentes(ConsultaNFe)

Permite verificar a existencia de uma nota. Caso a nota exista, a resposta é a data de emissão, RPS

(se houver) e o hashcode. Caso contrário esses campos estarão vazios.

Consulta de empresa(ConsultaEmpresa)

Permite a consulta de dados de uma determinada empresa. Deverá ser informado se a empresa

pertence ou não ao município. A resposta contém os dados da empresa pesquisada.


Formato de campos

Campos alfa-numéricos

São representados como A(x), onde x é o tamanho máximo do campo.

Campos numéricos

Os inteiros são representados como N(x), onde x é o tamanho máximo do campo. Os campos com

decimais, são representados como N(y,z), onde y é o tamanho máximo da parte inteira e z é o

tamanho máximo da parte decimal.

O separador de decimal “ponto” deverá ser informado. Se o valor for 1.235,56 deverá ser

informado 1235.56. Se o valor for 2.500,00 informar 2500.00.

Data

Os campos do tipo data (data do RPS, data de emissão, etc), deverão estar no formato numérico

AAAAMMDD, sem separadores. Por exemplo, para representar 10 de dezembro de 2014, informar

20141210.

Ocorrência dos campos Campos com uma única ocorrência são sempre representados por 1-1. Campos com múltiplas

ocorrências são representados por 1-x, onde x é a quantidade máxima. As múltiplas ocorrências

podem acontecer tanto em campos simples (alfa-numéricos ou numéricos) como estruturas.

Estruturas de dados São tipos de dados que contém mais de um campo, funcionando como um agrupador. São usados

tanto para entrada de dados (no caso do RPSInfo) como para saída.


NFeInfo

Utilizado como parâmetro de entrada para os serviços EmiteNFe e ValidaNFe. Deverá conter as

informações necessárias para a emissão da NF-e.

Nome Formato Obrigatório Ocorrência Descrição

vlServicos N(9,2) S 1-1 Valor dos serviços, com 11 posições, sendo 9 posições representando a parte inteira e

duas últimas os decimais.

codAtiv N(8) S 1-1 Código do serviço prestado. Este código deverá pertencer à lista de serviços do

prestador.

aliq N(2,2) S 1-1 Valor da alíquota, de acordo com a atividade informada. Campo com 4 posições, sendo

duas casas para os decimais.

vlImposto N(9,2) S 1-1 Valor do imposto a pagar, com 11 posições, sendo que as duas últimas são os decimais.

(caso tipo de recolhimento não incidente

valor do imposto deve ser zero)

tipoRecol N(1) S 1-1 Tipo de recolhimento do imposto. Possíveis Valores:

0-Outro município (Informar o município

onde foi prestado o serviço, nos campos

municipioServ e ufServ)

1-Retido na fonte

2–Normal (A recolher)

3-Simples Nacional/MEI

identTomador N(14) S 1-1 Informar CNPJ/CPF ou IM do tomador

tipoIdent N(1) S 1-1 Tipo de identificação do tomador que foi informado no campo anterior. Possíveis

valores:

0 – CNPJ

1 – CPF

2 – IM

rzSocial A(100) S 1-1 Nome/Razão Social do tomador do serviço.

endereco A(200) N 1-1 Endereço do tomador quando o mesmo não for do município ou não estiver cadastrado.

bairro A(30) N 1-1 Bairro do tomador quando o mesmo não for do município ou não estiver cadastrado.

NFeInfo


Cep A(8) N 1-1 CEP do tomador quando o mesmo não for do município ou não estiver cadastrado.

cidade A(40) S 1-1 Cidade do tomador.

uf A(2) S 1-1 UF do tomador

email A(80) N 1-1 Email do tomador

local A(1) S 1-1 Local do Tomador. Possíveis Valores:

0 – Cadastrado no município.

1 – Fora do município

2 – Não cadastrado no município

3 – Consumidor Final

simples A(1) S 1-1 Optante do Simples Nacional. ‘S’ – Sim ‘N’ – Não Se campo estiver em branco será

considerado NÃO

vlPIS N(8,4) S 1-1 Valor do Tributo Federal, com 12 posições, sendo que as quatro últimas são os

decimais.

vlCOFINS N(8,4) S 1-1 Valor do Tributo Federal, com 12 posições, sendo que as quatro últimas são os

decimais.

vlIR N(8,4) S 1-1 Valor do Tributo Federal, com 12 posições, sendo que as quatro últimas são os

decimais.

vlINSS N(8,4) S 1-1 Valor do Tributo Federal, com 12 posições, sendo que as quatro últimas são os

decimais.

vlCSLL N(8,4) S 1-1 Valor do Tributo Federal, com 12 posições, sendo que as quatro últimas são os

decimais.

vlDeducoes N(9,2) S 1-1 Valor das deduções, quando aplcável, com 11 posições, sendo que as duas últimas são

os decimais.

competencia N(6) S 1-1 Competência da prestação do serviço. Deve estar no format AAAAMM.

municipioServ A(40) N 1-1 Município de prestação de serviço, quando prestado em outro município. Quando não

for informado, será assumido Patos de

Minas.

ufServ A(2) N 1-1 Estado do município de prestação de serviço, quando prestado em outro

município. Quando não for informado, será

assumido MG

tipoConvenio N(1) S 1-1 Tipo de convênio. Possíveis valores:


0 – Nenhum

1 – SUS

2 – Outros

descServicos A(250) S 1-14 Discriminação dos Serviços prestados. Cada linha desse tipo de registro coresponde a

uma linha de Alfanumérico da discriminação

dos serviços. Máximo de 14 linhas ou 1200

caracteres no total. Pelo menos uma linha

deverá existir.

RetornoEmiteNFe

Estrutura retornada pelo EmiteNFe

Nome Formato Ocorrência Descrição

Retorno N(1) 1 Código de retorno do serviço. Possíveis Valores:

0 – NF-e gerada com sucesso

1 – NF-e não gerada devido a inconsistências. Para consultar

o erro, utilize o serviço “ValidaNFe”

2 – Erro de processamento. Verificar campo ‘mensagem’

numNota N(14) 1-1 Número da NF-e gerada

hashCode A(20) 1-1 Código de validação da NF-e

urlNota A(120) 1-1 URL para validação/impressão da NF-e gerada.

RetornoValidaNFe

Estrutura retornada pelo serviço ValidaNFe. Indica se os dados informados estão corretos, gerando

a nota fiscal eletrônica correspondente.

O índice dos campos tipoOcorrencia e ocorrencia são determinados pela quantidade de erro/alerta.

Ex: Para verificar a terceira ocorrência de erro/alerta, utilize:

tipoOcorrencia[2]

ocorrencia[2]

RetornoEmiteNFe



retorno N(1) 1-1 Código de retorno do serviço. Possíveis Valores:

0 – NF-e pode ser gerada. Os dados processados podem

conter alertas, que não impedem a geração da NF-e.

1 – NF-e não pode ser efetivada por conter erros que não

permitem a geração da nota.


tipoOcorrencia N(1) 1-999999 Os tipos de ocorência podem ser:

1 – Erro

2- Alerta

NF-e com alerta pode ser processada normalmente.

ocorrencia A(100) 1-999999 Descrição do erro/alerta ocorrido

mensagem A(100) 1-1 Descrição do erro ocorrido ao solicitar a validação de Nf-e. Preenchido quando campo retorno possuir valor ‘2’.

RPSInfo

Utilizado como um dos parâmetros de entrada para os serviços ProcessaRPS e ValidaRPS. Deverá

conter as informações necessárias do RPS para a geração da NF-e.

Nome Formato Obrigatório Ocorrência Descrição

tipoRPS N(1) S 1-1 Tipo do RPS. Possíveis Valores:

0 – RPS

1 – RPS-C (Recibo provisório de serviços

simplificado)

serieRPS A(5) S 1-1 Caso o estabelecimento possua mais de um equipamento emissor de RPS, a numeração

deverá ser precedida de até 5 caracteres

alfanuméricos capazes de individualizar os

equipamentos. Caso contrário deve ser

informado ‘1’.

numRPS N(8) S 1-1 Número do RPS

RetornoValidaNFe

RPSInfo


dtEmissaoRPS N(8) S 1-1 Data que o RPS foi emitido

sitRPS N(1) S 1-1 Situação do RPS.

1 – Normal.

2 – Cancelada. (Dia do processamento será

assumido como data do cancelamento. Para

cancelar uma NFe já importada basta

importá-la novamente com situação ‘2’)

vlServicos N(9,2) S 1-1 Valor dos serviços, com 11 posições, sendo 9 posições representando a parte inteira e

duas últimas os decimais.

codAtiv N(8) S 1-1 Código do serviço prestado. Este código deverá pertencer à lista de serviços do

prestador.

aliq N(2,2) S 1-1 Valor da alíquota, de acordo com a atividade informada. Campo com 4 posições, sendo

duas casas para os decimais.

vlImposto N(9,2) S 1-1 Valor do imposto a pagar, com 11 posições, sendo que as duas últimas são os decimais.

(caso tipo de recolhimento não incidente

valor do imposto deve ser zero)

tipoRecol N(1) S 1-1 Tipo de recolhimento do imposto. Possíveis Valores:

0-Outro município (Informar o município

onde foi prestado o serviço, nos campos

municipioServ e ufServ)

1-Retido na fonte

2–Normal (A recolher)

3-Simples Nacional/MEI

identTomador N(14) S 1-1 Informar CNPJ/CPF ou IM do tomador

tipoIdent N(1) S 1-1 Tipo de identificação do tomador que foi informado no campo anterior. Possíveis

valores:

0 – CNPJ

1 – CPF

2 – IM

rzSocial A(100) S 1-1 Nome/Razão Social do tomador do serviço.

endereco A(200) N 1-1 Endereço do tomador quando o mesmo não for do município ou não estiver cadastrado.

bairro A(30) N 1-1 Bairro do tomador quando o mesmo não for do município ou não estiver cadastrado.


Cep A(8) N 1-1 CEP do tomador quando o mesmo não for do município ou não estiver cadastrado.

cidade A(40) S 1-1 Cidade do tomador.

uf A(2) S 1-1 UF do tomador

email A(80) N 1-1 Email do tomador

local A(1) S 1-1 Local do Tomador. Possíveis Valores:

0 – Cadastrado no município.

1 – Fora do município

2 – Não cadastrado no município

3 – Consumidor Final

simples A(1) S 1-1 Optante do Simples Nacional. ‘S’ – Sim ‘N’ – Não Se campo estiver em branco será

considerado NÃO

vlPIS N(8,4) S 1-1 Valor do Tributo Federal, com 12 posições, sendo que as quatro últimas são os

decimais.

vlCOFINS N(8,4) S 1-1 Valor do Tributo Federal, com 12 posições, sendo que as quatro últimas são os

decimais.

vlIR N(8,4) S 1-1 Valor do Tributo Federal, com 12 posições, sendo que as quatro últimas são os

decimais.

vlINSS N(8,4) S 1-1 Valor do Tributo Federal, com 12 posições, sendo que as quatro últimas são os

decimais.

vlCSLL N(8,4) S 1-1 Valor do Tributo Federal, com 12 posições, sendo que as quatro últimas são os

decimais.

vlDeducoes N(9,2) S 1-1 Valor das deduções, quando aplcável, com 11 posições, sendo que as duas últimas são

os decimais.

competencia N(6) S 1-1 Competência da prestação do serviço. Deve estar no format AAAAMM.

municipioServ A(40) N 1-1 Município de prestação de serviço, quando prestado em outro município. Quando não

for informado, será assumido Patos de

Minas.

ufServ A(2) N 1-1 Estado do município de prestação de serviço, quando prestado em outro

município. Quando não for informado, será

assumido MG

tipoConvenio N(1) S 1-1 Tipo de convênio. Possíveis valores:


0 – Nenhum

1 – SUS

2 – Outros

descServicos A(250) S 1-14 Discriminação dos Serviços prestados. Cada linha desse tipo de registro coresponde a

uma linha de Alfanumérico da discriminação

dos serviços. Máximo de 14 linhas ou 1200

caracteres no total. Pelo menos uma linha

deverá existir.

RetornoProcessaRPS

Estrutura retornada pelo serviço ProcessaRPS.



0 – Lote de RPS efetivado. NF-e geradas com

sucesso

1 – Lote de RPS não efetivado devido a

inconsistências no RPS. As notas não foram

geradas. Para consultar o erro, utilize o serviço

“ValidaRPS”

2 - 2 – Erro de processamento. Verificar

campo ‘mensagem’

totalNotas N(6) 1-1 Total de NF-e geradas

primeiraNota N(14) 1-1 Número da primeira NF-e gerada no lote de RPS enviado

ultimaNota N(14) 1-1 Número da última NF-e gerada no lote de RPS enviado

rpsItem RetornoProcessaRPSItem 1-999999 Estrutura que contém a relação número do RPS/número da NF-e. Um elemento da

estrutura corresponde a uma NF-e gerada. O

número de ocorrências depende da

quantidade de RPS processados. Vide

definição da estrutura mais abaixo.

mensagem A(100) 1-1 Descrição do erro ocorrido ao solicitar o processamento de RPS. Preenchido quando

campo retorno possuir valor ‘2’.

RetornoProcessaRPS


RetornoProcessaRPSItem

Estrutura retornada pelo serviço ProcessaRPS. Faz parte da estrutura RetornoProcessaRPS. Cada

ocorrência dessa estrutura contém a relação RPS/NF- gerada.


numRPS N(8) 1-1 Número do RPS

numNota N(14) 1-1 Número da NF-e gerada

hashCode A(20) 1-1 Código de validação da NF-e

urlNota A(120) 1-1 URL para validação/impressão da NF-e gerada.

RetornoValidaRPS

Estrutura retornada pelo serviço ValidaRPS. Indica se o lote de RPS esta pronto para ser processado,

gerando as notas fiscais eletrônicas correspondentes.

O índice dos campos tipoOcorrencia, ocorrencia e numRPS são determinados pelo quantidade de

RPS com erro/alerta e são pareados pelo RPS processado. Para acessar, por exemplo, esses campos

correspondentes ao terceiro RPS que contém erro/alerta:

tipoOcorrencia[2]

ocorrencia[2]

numRPS[2]



0 – Lote de RPS pode ser efetivado. Os RPS´s processados

podem conter alertas, que não impedem a geração das NF-

e.

1 – Lote de RPS não pode ser efetivado por conter erros que

não permitem a geração das notas.


tipoOcorrencia N(1) 1-999999 Os tipos de ocorência podem ser:

1 – Erro

RetornoProcessaRPSItem

RetornoValidaRPS


2- Alerta

RPS com alerta pode ser processado normalmente.

ocorrencia A(100) 1-999999 Descrição do erro/alerta ocorrido

numRPS N(14) 1-999999 Número do RPS com erro/alerta.

mensagem A(100) 1-1 Descrição do erro ocorrido ao solicitar a validação de RPS. Preenchido quando campo retorno possuir valor ‘2’.

RetornoCancelaNFe

Estrutura retornada pelo serviço CancelaNFe.



0 – NF-e cancelada com sucesso

1 – NF-e não cancelada. Consultar o campo mensagem para

consultar o erro ocorrido.

mensagem A(100) 1-1 Descrição do erro ocorrido ao solicitar o cancelamento da NF-e

RetornoConsultaNFeCancelada

Estrutura retornada pelo serviço ConsultaNFeCancelada.


numNota N(14) 1-1 Número da nota cancelada. Se ocorrer erro durante a solicitação de consulta, o valor retornado será 0.

dataCancelamento N(8) 1-1 Data do cancelamento da NF-e. Se ocorrer erro durante a solicitação de consulta, o valor retornado será 0.

motivo A(250) 1-1 Motivo do cancelamento

mensagem A(100) 1-1 Descrição do erro ocorrido ao executar a consulta.

RetornoCancelaNFe

RetornoConsultaNFeCancelada


RetornoConsultaNFe

Estrutura retornada pelo serviço ConsultaNFe.


numNota N(14) 1-1 Número da nota.. Se ocorrer erro durante a solicitação de consulta, o valor retornado será 0.

numRPS N(8) 1-1 Número do RPS que originou a NF-e. Se ocorrer erro durante a solicitação de consulta, o valor retornado será 0.

dataEmissao N(8) 1-1 Data de emissão da NF-e

hashCode A(20) 1-1 Código de validação da NF-e.


RetornoConsultaEmpresa

Estrutura retornada pelo serviço ConsultaEmpresa.


cnpjcpf N(14) 1-1 CPF ou CNPJ da empresa consultada. Se ocorrer erro durante a solicitação de consulta, o valor retornado será 0.

insMunicipal N(8) 1-1 Inscrição municipal da empresa consultada. Se ocorrer erro durante a solicitação de consulta, o valor retornado será 0.

razao A(100) 1-1 Razão social

endereco A(100) 1-1 Endereço da empresa.

bairro A(30) 1-1 Bairro

cidade A(40) 1-1 Cidade

uf A(2) 1-1 Estado

cep N(8) 1-1 CEP

email A(80) 1-1 Email


RetornoConsultaNFe

RetornoConsultaEmpresa


Utilizando os serviços

Abaixo estão descritos os parâmetros de entrada e saída de cada serviço.

EmiteNFe


insMunicipal N(8) 1-1 Inscrição municipal do prestador.

senha C(16) 1-1 Senha de emissão de NF-e.

aNFeInfo NFeInfo 1 Estrutura que contém as informações da NF-e a ser emitida. Ver estrutura NFeInfo.


RetornoEmiteNFe RetornoEmiteNFe 1-1 Ver estrutura RetornoEmiteNFe

ValidaNFe




aNFeInfo NFeInfo 1 Estrutura que contém as informações da NF-e a ser emitida. Ver estrutura NFeInfo.


RetornoValidaNFe RetornoValidaNFe 1-1 Ver estrutura RetornoValidaNFe

Entrada

Saída

Entrada

Saída


ProcessaRPS




dataInicio data 1-1 Data de início a que se referem os RPS.

dataFim Data 1-1 Data final dos RPS.

versão N(3) 1-1 Versão do layout. Deverá ser preenchido com 1.

aRPSInfo RPSInfo 1-999999 Estrutura que contém as informações do RPS. Ver estrutura RPSInfo.


RetornoProcessaRPS RetornoProcessaRPS 1-1 Ver estrutura RetornoProcessaRPS

ValidaRPS




dataInicio data 1-1 Data de início a que se referem os RPS.

dataFim Data 1-1 Data final dos RPS.

versão N(3) 1-1 Versão do layout. Deverá ser preenchido com 1.

aRPSInfo RPSInfo 1-999999 Estrutura que contém as informações do RPS. Ver estrutura RPSInfo.


RetornoValidaRPS RetornoValidaRPS 1-1 Ver estrutura RetornoValidaRPS

Entrada

Saída

Entrada

Saída


CancelaNFe




numNota N(14) 1-1 Número da nota a ser cancelada.

motivo C(250) 1-1 Motivo do cancelamento. Campo obrigatório,


RetornoCancelaNFe RetornoCancelaNFe 1-1 Ver estrutura RetornoCancelaNFe

ConsultaNFeCancelada




numNota N(14) 1-1 Número da nota a ser consultada.


RetornoConsultaNFeCancelada RetornoConsultaNFeCancelada 1-1 Ver estrutura RetornoConsult

aNFeCancelada

Entrada

Saída

Entrada

Saída


ConsultaNFe




numNota N(14) 1-1 Número da nota a ser consultada. A busca pode ser feita pelo número da NF-e ou pelo número do RPS que a mesma

foi gerada.

numRps N(8) 1-1 Número do RPS que originou a NF-e. A busca pode ser feita pelo número da NF-e ou pelo número do RPS que a mesma

foi gerada.


RetornoConsultaNFe RetornoConsultaNFe 1-1 Ver estrutura RetornoConsultaNFe

ConsultaEmpresa




insMunicipalEmpresa N(8) 1-1 Incrição municipal da empresa a ser consultada. Caso deseje informar o CNPJ/CPF, informe 0 (zero) nessa campo.

cnpjcpfEmpresa N(14) 1-1 CNPJ ou CPF da empresa a ser consultada. Caso deseje consultar pela inscrição municipal, informe 0 (zero) nesse

campo.

empresaFora N(1) 1-1 Indica se a busca deve ser feita em empresa cadastrada como fora do município. Possíveis valores:

0 – Pesquisa apenas no município

1-Pesquisa também no cadastro de empresas de fora do

munícipio. Nesse caso, é obrigatória a informação do campo

cnpjcpfEmpresa. Empresas de fora não serão pesquisadas

através da inscrição municipa.

Entrada

Saída

Entrada



RetornoConsultaEmpresa RetornoConsultaEmpres

a

1-1 Ver estrutura RetornoConsultaEmpresa

Utilizando os serviços

A senha que permite o uso dos serviços deve ser solicitada no site, através da função “Solicitar –

Acesso ao WebService” disponível no menu.

IMPORTANTE: A senha do ambiente de homologação é idêntica a do ambiente de produção, caso a

empresa tenha recebido a mesma antes do dia 04/09/2015. Se a solicitação foi posterior a essa

data, favor solicitar o acesso ao ambiente de homologação pelo email

[email protected]

Caso seja necessário, está disponível no site (página principal) arquivos XML de exemplo de

chamadas aos serviços.

WSDL dos serviços

A WSDL(Web Service Definition Language) poderá ser encontrade no seguinte endereço:

Ambiente de produção:

http://200.162.29.193:8080/axis2/services/eISSWService?wsdl

Ambiente de homologação:

http://200.162.29.193:8082/axis2/services/eISSWService?wsdl

Saída

mailto:[email protected]://200.162.29.193:8080/axis2/services/eISSWService?wsdlhttp://200.162.29.193:8082/axis2/services/eISSWService?wsdl

Documents

Manual de integração - Amazon S3 · 2016. 5. 16. · Manual de Integração Consist e.ISS 8 0 – Nenhum 1 – SUS 2 – Outros descServicos A(250) S 1-14 Discriminação dos Serviços