Beruflich Dokumente
Kultur Dokumente
00
ndice
INTRODUO....................................................................................................................................3 DEFINIES.......................................................................................................................................4 NOTA FISCAL DE SERVIOS ELETRNICA............................................................................4 RECIBO PROVISRIO DE SERVIO RPS..............................................................................4 ARQUITETURA DE COMUNICAO COM O CONTRIBUINTE................................................6 MODELO CONCEITUAL..............................................................................................................6 Recepo e Processamento de Lote de RPS....................................................................................6 Consulta de Situao de Lote de RPS..............................................................................................7 Consulta de NFS-e por RPS.............................................................................................................7 Consulta de Lote de RPS.................................................................................................................8 Consulta de NFS-e...........................................................................................................................8 Cancelamento de NFS-e..................................................................................................................9 PADRES TCNICOS......................................................................................................................11 Padro de Comunicao.................................................................................................................11 Padro de Certificado Digital........................................................................................................12 Padro de Assinatura Digital..........................................................................................................13 Validao de Assinatura Digital pelo Sistema e-Nota...................................................................14 Uso de Assinatura com Certificado Digital...................................................................................15 PADRO DAS MENSAGENS XML................................................................................................16 rea do Cabealho....................................................................................................................16 Validao da estrutura das Mensagens XML.................................................................................17
1 de 35
Schemas XML (arquivos XSD).....................................................................................................17 Verso dos Schemas XML.............................................................................................................18 ESTRUTURA DE DADOS DO WEB SERVICE..............................................................................19 MODELO OPERACIONAL.........................................................................................................19 Servios Sncronos.........................................................................................................................19 Servios Assncronos.....................................................................................................................20 FORMATOS E PADRES UTILIZADOS........................................................................................22 TIPOS SIMPLES...........................................................................................................................23 TIPOS COMPLEXOS...................................................................................................................25 SERVIOS.........................................................................................................................................30 Recepo de Lote de RPS..............................................................................................................31 Consulta de Situao de Lote de RPS............................................................................................32 Consulta de NFS-e por RPS...........................................................................................................32 Consulta de NFS-e.........................................................................................................................33 Consulta de Lote de RPS...............................................................................................................33 Cancelamento NFS-e.....................................................................................................................34 Observaes........................................................................................................................................35
2 de 35
INTRODUO
Este manual tem como objetivo apresentar as especificaes e critrios
tcnicos necessrios para utilizao do Web Service disponibilizado pelas Secretarias Municipais de Fazenda para as empresas prestadoras e/ou tomadoras de servios. Atravs do Web Service as empresas podero integrar seus prprios sistemas de informaes com o Sistema de Notas Fiscais de Servio Eletrnicas das Secretarias Municipais de Fazenda. Desta forma, consegue-se automatizar o processo de gerao, consulta e cancelamento de Nota Eletrnica.
3 de 35
DEFINIES
NOTA FISCAL DE SERVIOS ELETRNICA
A Nota Fiscal de Servios Eletrnica um documento de existncia exclusivamente digital, gerado e armazenado eletronicamente pela prefeitura ou por outra entidade conveniada, para documentar as operaes de prestao de servios. A gerao da Nota Eletrnica ser feita, automaticamente, por meio de servios informatizados, disponibilizados aos prestadores de servios. Para que sua gerao seja efetuada, dados que a compem sero informados, analisados, processados, validados e, se corretos, geraro o documento. A responsabilidade pelo cumprimento da obrigao acessria de emisso da Nota Eletrnica e pelo correto fornecimento dos dados secretaria, para a gerao da mesma, do prestador RECIBO PROVISRIO DE SERVIO RPS A Nota Eletrnica somente ser gerada atravs de servios informatizados disponibilizados pelas Secretarias Municipais de Fazenda. Esse tipo de servio seguido de alguns riscos inerentes ininterrupta disponibilidade, podendo, portanto, em alguns momentos tornar-se indisponvel. Visando manter as atividades dos prestadores ininterruptas, independente de os servios informatizados disponibilizados pelas Secretarias Municipais de Fazenda estarem disponveis, foi criado o Recibo Provisrio de Servios (RPS), que um documento de posse e responsabilidade do contribuinte, que dever ser gerado manualmente ou por alguma aplicao local, possuindo uma numerao seqencial crescente e devendo ser convertido em Nota Eletrnica no prazo estipulado pela
4 de 35
5 de 35
Passos para execuo 1. A aplicao acessa o servio de Recepo e Processamento de Lote de RPS enviando o lote (fluxo b). 2. A requisio recebida pelo servidor do Web Service que grava as informaes recebidas e gera o nmero de protocolo de recebimento (fluxo c). 3. O Web Service retorna uma processamento do servio (fluxo d). mensagem com o resultado do
6 de 35
Passos para execuo 1. A aplicao acessa o servio de Consulta de Situao de Lote de RPS 2. e submete os dados para processamento (fluxo 2.b). 3. A requisio recebida pelo servidor do Web Service, que verifica os dados preenchidos e identifica o status do lote (fluxos 2.c e 2.d). 4. O Web Service retorna uma mensagem com o resultado do processamento do servio (fluxo 2.e). Consulta de NFS-e por RPS Esse servio efetua a consulta de uma NFS-e a partir do nmero de RPS que a gerou.
Passos para execuo 1. A aplicao acessa o servio de Consulta de NFS-e por RPS e submete os dados para processamento (fluxo 2.b).
7 de 35
2. A requisio recebida pelo servidor do Web Service, que verifica os dados preenchidos e identifica a NFS-e correspondente (fluxos 2.c e 2.d). 3. O Web Service retorna uma mensagem com o resultado do processamento do servio (fluxo 2.e). Consulta de Lote de RPS Esse servio permite ao contribuinte obter as NFS-e que foram geradas a partir do Lote de RPS enviado, quando o processamento ocorrer sem problemas; ou obter a lista de erros e/ou inconsistncias encontradas nos RPS. Na validao do lote, devem ser retornados todos os erros verificados. Excepcionalmente, havendo uma excessiva quantidade de erros, poder ser definido um limitador para a quantidade de erros retornados.
Passos para execuo 1. A aplicao acessa o servio de Consulta de Lote de RPS e submete os dados para processamento (fluxo b). 2. A requisio recebida pelo servidor do Web Service, que verifica os dados preenchidos e identifica as NFS-e correspondentes (fluxos c e d). 3. O Web Service retorna uma mensagem (a estrutura com a lista da NFS- e geradas ou as mensagens de erro) com o resultado do processamento do servio (fluxo e). Consulta de NFS-e Esse servio permite a obteno de determinada NFS-e j gerada.
8 de 35
Passos para execuo 1. A aplicao acessa o servio de Consulta de NFS-e e submete os dados para processamento (). 2. A requisio recebida pelo servidor do Web Service, que verifica os dados preenchidos e identifica as NFS-e correspondentes. 3. O Web Service retorna uma mensagem com o resultado do processamento do servio. Cancelamento de NFS-e Esse servio permite o cancelamento direto de uma NFS-e sem substituio da mesma por outra.
Passos para execuo 1. A aplicao acessa o servio de Cancelamento de NFS-e e submete os dados para processamento (fluxo 2.b). 2. A requisio recebida pelo servidor do Web Service, que verifica os dados preenchidos, identifica a NFS-e correspondente e efetua o seu cancelamento (fluxo 2.c).
9 de 35
3. O Web Service retorna uma mensagem com o resultado do processamento do servio (fluxo 2.d).
10 de 35
PADRES TCNICOS
Padro de Comunicao
O meio fsico de comunicao utilizado entre os sistemas de informao dos contribuintes e o Sistema de Notas Fiscais de Servio Eletrnicas das Secretarias Municipais de Fazenda ser a Internet, com o uso do protocolo SSL, que alm de garantir um duto de comunicao seguro na Internet, permite a identificao do servidor e do cliente atravs de certificados digitais, eliminando a necessidade de identificao do usurio atravs de nome ou cdigo de usurio e senha. O modelo de comunicao segue o padro de Web Services definido pelo WSI Basic Profile. A troca de mensagens entre o Web Service do Sistema de Notas Fiscais de Servio Eletrnicas das Secretaria Municipais de Fazenda e o sistema do contribuinte ser realizada no padro SOAP, com troca de mensagens XML no padro Style/Enconding: Document/Literal, wrapped. A opo wrapped representa a chamada aos mtodos disponveis com a passagem de mais de um parmetro. Para descrever os servios disponibilizados, ser utilizado um documento WSDL (Web Service Description Language). O WSDL o padro recomendado para descrio de servios
11 de 35
SOAP.
As chamadas aos servios sero feitas enviando como parmetro um documento XML a ser processado pelo sistema. Esse documento no far parte da descrio do servio (arquivo WSDL), e o formato do XML correspondente ao servio dever ser consultado nesse manual de integrao. Padro de Certificado Digital Como forma de flexibilizar o uso do sistema porm sem perder a segurana na comunicao entre contribuinte e prefeitura existem dois tipos de certificado que podero ser utilizados, o certificado ICP-Brasil(e-CPF, e-CNPJ, e-PJ), e o certificado Betha no caso do contribuinte ainda no possuir um certificado ICP-Brasil. Os certificados devero ser dos tipos A1, A3. Os certificados digitais sero exigidos em 2 (dois) momentos distintos para a integrao entre o sistema do contribuinte e o Web Service das Secretarias Municipais de Fazenda: Assinatura de Mensagens: O certificado digital utilizado para essa funo dever conter o CNPJ do estabelecimento emissor da NFS-e ou o CNPJ do estabelecimento matriz. O certificado digital dever ter o uso da chave previsto para a funo de assinatura digital, respeitando a Poltica do Certificado. Transmisso (durante a transmisso das mensagens entre os servidores do contribuinte e os servios disponibilizados pelas Secretarias Municipais de Fazenda): O
12 de 35
certificado digital utilizado para identificao do aplicativo do contribuinte dever conter o CNPJ do responsvel pela transmisso das mensagens, mas no necessita ser o mesmo CNPJ do estabelecimento emissor da NFS-e, devendo ter a extenso extended Key Usage com permisso de "Autenticao Cliente".
XS14 Xpath XS15 DigestMethod XS16 Algorithm XS17 XS18 XS19 XS20 XS21 DigestValue SignatureValue KeyInfo X509Data X509Certificate
Validao de Assinatura Digital pelo Sistema e-Nota Para a validao da assinatura digital, seguem as regras que sero adotadas pelas Secretarias Municipais de Fazenda: 1. Extrair a chave pblica do certificado; 2. Verificar o prazo de validade do certificado utilizado; 3. Montar e validar a cadeia de confiana dos certificados validando tambm a LCR (Lista de Certificados Revogados) de cada certificado da cadeia; 4. Validar o uso da chave utilizada (Assinatura Digital) de tal forma a aceitar certificados somente do tipo A (no sero aceitos certificados do tipo S); 5. Garantir que o certificado utilizado de um usurio final e no de uma Autoridade Certificadora; 6. Adotar as confiana; regras definidas pelo RFC 3280 para LCRs e cadeia de
14 de 35
7. Validar a integridade de todas as LCR utilizadas pelo sistema; 8. Prazo de validade de cada LCR utilizada (verificar data inicial e final). A forma de conferncia da LCR fica a critrio de cada Secretaria Municipal de Fazenda, podendo ser feita de 2 (duas) maneiras: On-line ou Download peridico. pelo Observatrio Nacional. Uso de Assinatura com Certificado Digital Para garantir a autenticidade dos dados gerados, algumas informaes devero ser assinadas digitalmente. Abaixo segue as informaes que devero ser assinadas e quem dever faz-lo em cada momento: 1. O RPS, pelo contribuinte, antes do envio do mesmo atravs do Lote de RPS; 2. O Lote de RPS, pelo contribuinte, antes do envio do mesmo; A NFS-e: 3. Pela prefeitura e pelo contribuinte, quando gerada pela Aplicao On Line; 1. Pela prefeitura nos demais casos; 2. O Pedido de cancelamento da NFS-e, pelo contribuinte; 4. A Confirmao de cancelamento da NFS-e, pela prefeitura; As assinaturas digitais das mensagens sero verificadas considerando o horrio fornecido
15 de 35
PADRO DAS MENSAGENS XML A especificao adotada para as mensagens XML a recomendao W3C para XML 1.0, disponvel em www.w3.org/TR/REC-xml e a codificao dos caracteres ser em UTF-8. As chamadas dos Web Services disponibilizados pelas Secretarias Municipais de Fazenda e os respectivos resultados do processamento so realizadas atravs das mensagens com o seguinte padro: rea de Cabealho estrutura XML padro para todas as mensagens de chamada e retorno de resultado dos Web Services disponibilizados pelas Secretarias Municipais de Fazenda, que contm os dados de controle da mensagem. A rea de cabealho est sendo utilizada para armazenar a verso do leiaute da estrutura XML informado na rea de dados rea de Dados estrutura XML varivel definida na documentao do Web Service acessado. rea do Cabealho Abaixo, o leiaute da rea de Cabealho padro:
# 1 2 Nome cabecalho Verso versaoDados Elemento G A E Pai Tipo 1 1 N N Ocorrncia Tamanho Descrio 1-1 TAG raiz do cabealho da mensagem. 4 1-1 Verso do leiaute. 4 1-1 O contedo deste campo indica a verso do leiaute XML da estrutura XML informada na rea de dados da mensagem.
O campo versaoDados deve conter a informao da verso do leiaute da estrutura XML armazenada na rea de dados da mensagem. A estrutura XML armazenada na rea de dados est definida na
16 de 35
documentao do Web Service acessado. Validao da estrutura das Mensagens XML Para garantir minimamente a integridade das informaes prestadas e a
correta formao das mensagens XML, o contribuinte dever submeter cada uma das mensagens XML de pedido de servio para validao pelo seu respectivo arquivo XSD (XML Schema Definition, definio de esquemas XML) antes de seu envio. Neste manual utilizaremos a nomenclatura Schema XML para nos referir a arquivo XSD. Um Schema XML define o contedo de uma mensagem XML,
descrevendo os seus atributos, elementos e a suaorganizao, alm de estabelecer regras de preenchimento de contedo e de obrigatoriedade de cada elemento ou grupo de informao. A validao da estrutura da mensagem XML realizada por um analisador sinttico (parser) que verifica se a mensagem XML atende as definies e regras de seu respectivo Schema XML. Qualquer divergncia da estrutura da mensagem XML em relao ao seu respectivo Schema XML, provoca um erro de validao do Schema XML. Neste caso o contedo da mensagem XML de pedido do servio no poder ser processado. A primeira condio para que a mensagem XML seja validada com sucesso que ela seja submetida ao Schema XML correto. Assim, os sistemas de informao dos contribuintes devem estar preparados para gerar mensagens XML em seus respectivos Schemas XML em vigor. Schemas XML (arquivos XSD) O Schema XML (arquivo XSD) correspondente a cada uma das mensagens XML de pedido e de retorno utilizadas pelo Web Service pode ser obtido na internet acessando o Portal do Sistema de Notas Fiscais de Servio Eletrnicas das Secretarias
17 de 35
Municipais de Fazenda. Verso dos Schemas XML Toda mudana de layout das mensagens XML do Web Service implica na atualizao do seu respectivo Schema XML. A identificao da verso dos Schemas XML ser realizada com o acrscimo do nmero da verso com dois dgitos no nome do arquivo XSD precedida da literal _v, como segue: <Nome do Arquivo>_v<Nmero da Verso>.xsd Exemplo: EnvioLoteRps_v01.xsd A maioria dos Schemas XML definidos para a utilizao do Web Service do Sistema de Notas Fiscais de Servio Eletrnicas das Secretarias Municipais de Fazenda utilizam as definies de tipos simples ou tipos complexos que esto definidos em outros Schemas XML, nestes casos, a modificao de verso do Schema bsico ser repercutida no Schema principal. As modificaes de layout das mensagens XML do Web Service podem ser causadas por necessidades tcnicas ou em razo da modificao de alguma legislao. As modificaes decorrentes de alterao da legislao devero ser implementadas nos prazos previstos no ato normativo que introduziu a alterao. As modificaes de ordem tcnica sero divulgadas pelas Secretarias Municipais de Fazenda e podero ocorrer sempre que se fizerem necessrias.
18 de 35
executadas de forma assncrona e as demais solicitaes de servios de forma sncrona. Assim, os servios da NFS-e sero implementados da seguinte forma: Servio Recepo e Processamento de Lote de RPS Consulta de Situao de Lote de RPS Consulta de NFS-e por RPS Consulta de Lote de RPS Consulta de NFS-e Cancelamento de NFS-e Servios Sncronos As solicitaes de servios de implementao sncrona so processadas imediatamente e o resultado do processamento obtido em uma nica conexo. Implementao Assncrona Sncrona Sncrona Sncrona Sncrona Sncrona
19 de 35
Etapas do processo ideal: 1. O aplicativo do contribuinte inicia a conexo enviando uma mensagem de solicitao de servio para o Web Service; 2. O Web Service recebe a mensagem de solicitao de servio e encaminha ao aplicativo da NFS-e que ir processar o servio solicitado; 3. O aplicativo da NFS-e recebe a mensagem de solicitao de servios e realiza o processamento, devolvendo uma mensagem de resultado do processamento ao Web Service; 4. O Web Service recebe a mensagem de resultado do processamento e o encaminha ao aplicativo do contribuinte; 5. O aplicativo do contribuinte recebe a mensagem de resultado do processamento e caso no exista outra mensagem, encerra a conexo. Servios Assncronos As solicitaes de servios de implementao assncrona so processadas de forma distribuda por vrios processos e o resultado do processamento somente obtido na segunda conexo. Etapas do processo ideal: Solicitao e processamento: 1. O aplicativo do contribuinte inicia a conexo enviando uma mensagem de solicitao de servio para o Web Service de recepo de solicitao de servios; 2. O Web Service de recepo de solicitao de servios recebe a mensagem de solicitao de servio e a coloca na fila de servios solicitados, acrescentando o CNPJ do transmissor obtido do certificado digital do transmissor; 3. O Web Service de recepo de solicitao de servios retorna o protocolo da solicitao de servio e a data e hora de gravao na fila de servios solicitados ao aplicativo do contribuinte; 4. O aplicativo do contribuinte recebe o protocolo; 5. Na estrutura interna do aplicativo de NFS-e a solicitao de servios retirada da fila de servios solicitados pelo aplicativo da NFS-e em momento especfico, definido pela equipe tcnica da NFS-e; 6. O servio solicitado processado pelo aplicativo da NFS-e e o resultado do processamento colocado na fila de servios processados;
20 de 35
Obteno do resultado do servio: 1. O aplicativo do contribuinte, atravs do protocolo recebido, envia uma consulta ao servio que retornar o resultado do processamento daquele protocolo, iniciando uma conexo com o Web Service; 2. O Web Service recebe a mensagem de consulta e localiza o resultado de processamento da solicitao de servio; 3. O Web Service contribuinte; devolve o resultado do processamento ao aplicativo do
4. O aplicativo do contribuinte recebe a mensagem de resultado processamento e, caso no exista outra mensagem, encerra a conexo.
21 de 35
FORMATOS E PADRES UTILIZADOS Abaixo segue algumas formataes de dados que devem ser seguidas para gerao correta na estrutura dos arquivos.
Formato
Data (date)
Observao
Formato: AAAA-MM-DD onde: AAAA = ano com 4 caracteres MM = ms com 2 caracteres DD = dia com 2 caracteres Formato AAAA-MM-DDTHH:mm:ss onde: AAAA = ano com 4 caracteres MM = ms com 2 caracteres DD = dia com 2 caracteres T = caractere de formatao que deve existir separando a data da hora mm: minuto com 2 caracteres ss: segundo com 2 caracteres Formato: 0.00 No deve ser utilizado separador de milhar. O ponto (.) deve ser utilizado para separar a parte inteira da fracionria. Exemplo: 48.562,25 = 48562.25 1,00 = 1.00 ou 1 0,50 = 0.50 ou 0.5 Formato 0.0000 O formato em percentual presume o valor percentual em sua forma fracionria, contendo 5 dgitos. O ponto (.) separa a parte inteira da fracionria. Exemplo: 62% = 0.62 150% = 1.5 25,32 = 0.2532
Data/Hora (datetime)
No deve ser inserido caractere no significativo para preencher o tamanho completo do campo, ou seja, zeros antes de nmero ou espao em branco aps cadeia de caracteres. A posio do campo definida na estrutura do documento XML atravs de TAGs (<tag>contedo</tag>). A regra constante do pargrafo anterior dever estender-se para os campos onde no h indicao de obrigatoriedade e que, no entanto, seu preenchimento torna-se obrigatrio por estar condicionado legislao especfica ou ao negcio do contribuinte. Neste caso, dever constar a TAG com o valor correspondente e, para os demais campos, devero ser eliminadas as TAGs.
22 de 35
Para reduzir o tamanho final do arquivo XML da NFS-e alguns cuidados de programao devero ser assumidos:
1. no incluir "zeros no significativos" para campos numricos; 2. no incluir "espaos" no alfanumricos; incio ou no final de campos numricos e
3. no incluir comentrios no arquivo XML; 4. no incluir anotao e documentao no arquivo XML (TAG annotation e 5. TAG documentation); 6. no incluir caracteres de formatao no arquivo XML ("line-feed", "carriage return", "tab", caractere de "espao" entre as TAGs). As TAGs que permitirem valores nulos devem ser omitidas da estrutura XML a ser enviada. TIPOS SIMPLES A seguir encontra-se a tabela com a lista dos tipos simples que sero utilizados como tipos de dados. A tabela est dividida em 4 colunas, a saber: Campo: nome do tipo simples; Tipo: tipo primitivo de dados utilizados pelo campo: C: Caractere; N: Nmero; D: Data ou Data/Hora; Descrio: descreve informaes sobre o campo; Tam.: tamanho do campo: Quando for caracteres o tamanho define a quantidade mxima de caracteres que o texto poder ter; Quando for numrico o tamanho pode ser representado das seguintes formas Nmero inteiro, que define o total de dgitos existente no nmero. Exemplo: 15 significa que o nmero poder ter, no mximo, 15 dgitos; Nmero fracionrio, que define o total de dgitos e quantos deles sero designados para a parte fracionria. Exemplo: 15,2 significa que o nmero poder ter, no mximo, 15 dgitos sendo 2 deles a identificao da parte fracionria. A parte fracionria no obrigatria quando assim definido;
23 de 35
Tipo
N C N N
Descrio
Nmero da Nota Fiscal de Servio Eletrnica, formado pelo ano com 04 (quatro) dgitos e um nmero seqencial com 11 posies Formato AAAANNNNNNNNNNN. Cdigo de verificao do nmero da nota Cdigo de status do RPS 1 Normal 2 Cancelado Cdigo de status da NFS-e 1 Normal 2 Cancelado Cdigo de natureza da operao 1 Tributao no municpio 2 Tributao fora do municpio 3 Iseno 4 Imune 5 Exigibilidade suspensa por deciso judicial 6 Exigibilidade suspensa por procedimento administrativo 7 No Incidncia 8 Substituio Tributria Cdigo de identificao do regime especial de tributao 1 Microempresa municipal 2 - Estimativa 3 Sociedade de profissionais 4 Cooperativa Identificao de Sim/No 1 - Sim 2 No Quantidade de RPS do Lote Nmero do RPS Nmero de srie do RPS Cdigo de tipo de RPS 1 - RPS 2 Nota Fiscal Conjugada (Mista) 3 Cupom Informaes adicionais ao documento. Valor monetrio. Formato: 0.00 (ponto separando casa decimal) Ex: 1.234,56 = 1234.56 1.000,00 = 1000.00 1.000,00 = 1000 Cdigo de item da lista de servio Cdigo CNAE Cdigo de Tributao Alquota. Valor percentual. Formato: 0.0000 Ex: 1% = 0.01 25,5% = 0.255 100% = 1.0000 ou 1 Discriminao do contedo da NFS-e Cdigo de identificao do municpio conforme tabela do IBGE Nmero de inscrio municipal Razo Social do contribuinte Nome fantasia Nmero CNPJ Endereo Nmero do endereo
Tam.
15 9 1 1
tsNaturezaOperacao
tsRegimeEspecialTributacao
N N N C N C N
1 4 15 5 1 255 15,2
tsItemListaServico TsCodigoCnae TsCodigoTributacao TsAliquota tsDiscriminacao tsCodigoMunicipioIbge tsIncricaoMunicipal tsRazaoSocial tsNomeFantasia TsCnpj tsEndereco tsNumeroEndereco
C N C N C N C C C C C C
Campo
tsComplementoEndereco tsBairro tsUf tsCep tsEmail tsTelefone TsCpf tsIndicacaoCpfCnpj tsCodigoObra tsArt tsNumeroLote TsNumeroProtocolo tsSituacaoLoteRps tsCodigoMensagemAlerta TsDescricaoMensagemAlerta TsCodigoCancelamentoNfse
Tipo
C C C N C C C N C C N C N C C C
Descrio
Complemento de endereo Bairro Sigla da unidade federativa Nmero do CEP E-mail Telefone Nmero de CPF Indicador de uso de CPF ou CNPJ 1 CPF 2 CNPJ 3 No Informado Cdigo de Obra Cdigo ART Nmero do Lote de RPS Nmero do protocolo de recebimento do RPS Cdigo de situao de lote de RPS 1 No Recebido 2 No Processado 3 Processado com Erro 4 Processado com Sucesso Cdigo de mensagem de retorno de servio. Descrio da mensagem de retorno de servio. Cdigo de cancelamento com base na tabela de Erros e alertas. Atributo de identificao da tag a ser assinada no documento XML Este atributo formado pelos seguinte campos:
Tam.
60 60 2 8 80 11 11 1 15 15 15 50 1 4 200 4
TsIdTag
Campo 1 Rps Campo 2 Nmero do IBGE do Municpio Campo 3 Nmero do Rps com 15 caracteres, sendo obrigatrio o preenchimento com zeros a esquerda para completar as casas restantes Campo 4 CNPJ do prestador Campo 5 Data de emisso do Rps DDMMYYYY
255
TIPOS COMPLEXOS A seguir sero detalhadas as tabelas de cada tipo composto e seus campos. A tabela est dividida da seguinte forma:
(1)
(2) Nome (3) (4) (4) Tipo (5) (5) Ocorrncia Descrio (6) (6) (7) (7)
3. Identifica se a seqncia de campos far parte de uma escolha (Choice); 4. Nome do campo que faz parte do tipo complexo; 5. Tipo do campo, que pode ser de um tipo simples ou complexo; 6. Quantas vezes o campo se repete na estrutura de dados: 1. Formato: x-y onde x a quantidade mnima e y a quantidade mxima. Se a quantidade mxima for indefinida, ser utilizado N no lugar do y; 7. Descrio do campo.
TcCpfCnpj
Nmero de CPF ou CNPJ Nome Cpf Choice Cnpj Tipo tsCpf tsCnpj Ocorrncia Descrio 1-1 Nmero do Cpf 1-1 Nmero do Cnpj
TcEndereco
Representao completa do endereo Nome Tipo Ocorrncia Descrio Endereco tsEndereco 0-1 Endereo Numero tsNumeroEndereco 0-1 Nmero do endereo Complemento tsComplementoEndereco 0-1 Complemento do Endereo Bairro tsBairro 0-1 Nome do bairro CodigoMunicipio tsCodigoMunicipioIbge 0-1 Cdigo da cidade Uf tsUf 0-1 Sigla do estado Cep tsCep 0-1 CEP da localidade
TcContato
Representa forma de contato com a pessoa (fsica/jurdica) Nome Tipo Ocorrncia Descrio Telefone tsTelefone 0-1 Email tsEmail 0-1
tcIdentificacaoOrgaoGerador
Representa dados para identificao de rgo gerador Nome Tipo Ocorrncia Descrio CodigoMunicipio tsCodigoMunicipioIbge 1-1 Uf tsUf 1-1
tcIdentificacaoRps
Dados de identificao do RPS Nome Numero Serie Tipo Tipo tsNumeroRps tsSerieRps tsTipoRps Ocorrncia Descrio 1-1 1-1 1-1
tcIdentificacaoPrestador
Representa dados para identificao do prestador de servio Nome Tipo Ocorrncia Descrio Cnpj tsCnpj 1-1 InscricaoMunicipal tsInscricaoMunicipal 0-1
tcIdentificacaoTomador
Representa dados para identificao do tomador de servio 26 de 35
Verso: 1.0.00.3 - 09/02/2012 - Verso: 1.00 Nome CpfCnpj InscricaoMunicipal Tipo tcCpfCnpj tsInscricaoMunicipal Ocorrncia Descrio 0-1 0-1
tcDadosTomador
Representa dados do tomador de servio Nome Tipo IdentificacaoTomador TcIdentificacaoTomador RazaoSocial TsRazaoSocial Endereco TcEndereco Contato TcContato Ocorrncia Descrio 0-1 0-1 0-1 0-1
TcIdentificacaoIntermediarioServico
Representa dados para identificao de intermedirio do servio Nome Tipo Ocorrncia Descrio RazaoSocial tsRazaoSocial 1-1 CpfCnpj tcCpfCnpj 1-1 InscricaoMunicipal tsInscricaoMunicipal 0-1
TcValores
Representa um conjunto de valores que compe o documento fiscal Nome Tipo Ocorrncia Descrio ValorServicos tsValor 1-1 ValorDeducoes tsValor 0-1 ValorPis tsValor 0-1 ValorCofins tsValor 0-1 ValorInss tsValor 0-1 ValorIr tsValor 0-1 ValorCsll tsValor 0-1 IssRetido tsSimNao 1-1 ValorIss tsValor 0-1 OutrasRetencoes tsValor 0-1 BaseCalculo tsValor 1-1 (Valor dos servios - Valor das dedues - descontos incondicionados) Aliquota tsAliquota 0-1 ValorLiquidoNfse tsValor 0-1 (ValorServicos - ValorPIS ValorCOFINS - ValorINSS ValorIR - ValorCSLL OutrasRetenoes ValorISSRetido DescontoIncondicionado DescontoCondicionado) ValorIssRetido tsValor 0-1 DescontoCondicionado tsValor 0-1 DescontoIncondicionado tsValor 0-1
TcDadosServico
Representa dados que compe o servio prestado Nome Tipo Ocorrncia Descrio Valores tcValores 1-1 ItemListaServico tsItemListaServico 1-1 CodigoCnae tsCodigoCnae 0-1 CodigoTributacaoMunicipio tsCodigoTributacao 0-1 Discriminacao tsDiscriminacao 1-1 CodigoMunicipio tsCodigoMunicipioIbge 1-1
tcDadosConstrucaoCivil
27 de 35
Verso: 1.0.00.3 - 09/02/2012 - Verso: 1.00 Representa dados para identificao de construo civil Nome Tipo CodigoObra tsCodigoObra Art tsArt
tcDadosPrestador
Representa dados do prestador do servio Nome Tipo Ocorrncia Descrio IdentificacaoPrestador tcIdentificacaoPrestador 1-1 RazaoSocial tsRazaoSocial 1-1 NomeFantasia tsNomeFantasia 0-1 Endereco tcEndereco 1-1 Contato tcContato 0-1
TcInfRps
Representa dados informativos do Recibo Provisrio de Servio (RPS) Nome Tipo Ocorrncia Descrio Id tsIdTag Identificador da TAG a ser assinada IdentificacaoRps TcIdentificacaoRps 1-1 DataEmissao Datetime 1-1 NaturezaOperacao TsNaturezaOperacao 1-1 RegimeEspecialTributacao TsRegimeEspecialTributacao 0-1 OptanteSimplesNacional TsSimNao 1-1 IncentivadorCultural TsSimNao 1-1 Status TsStatusRps 1-1 RpsSubstituido TcIdentificacaoRps 0-1 Servico TcDadosServico 1-1 Prestador TcIdentificacaoPrestador 1-1 Tomador TcDadosTomador 1-1 IntermediarioServico tcIdentificacaoIntermediarioServico 0-1 ConstrucaoCivil TcDadosContrucaoCivil 0-1
TcRps
Representa a estrutura do Recibo Provisrio de Servio (RPS) assinada Nome Tipo Ocorrncia Descrio Rps tcInfRps 1-1 dsig:Signature 0-1 Signature
tcIdentificacaoNfse
Representa dados que identificam uma Nota Fiscal de Servios Eletrnica Nome Tipo Ocorrncia Descrio Numero tsNumeroNfse 1-1 Cnpj tsCnpj 1-1 InscricaoMunicipal tsInscricaoMunicipal 0-1 CodigoMunicipio tsCodigoMunicipioIbge
TcInfNfse
Representa os dados informativos da Nota Fiscal de Servios Eletrnica Nome Tipo Ocorrncia Descrio Id tsIdTag Identificador da TAG a ser assinada Numero tsNumeroNfse 1-1 CodigoVerificacao tsCodigoVerificacao 1-1 DataEmissao Datetime 1-1 IdentificacaoRps tcIdentificacaoRps 0-1 DataEmissaoRps Date 0-1 NaturezaOperacao tsNaturezaOperacao 1-1 RegimeEspecialTributacao tsRegimeEspecialTributacao 0-1
28 de 35
Verso: 1.0.00.3 - 09/02/2012 - Verso: 1.00 OptanteSimplesNacional IncetivadorCultural Competencia NfseSubstituida OutrasInformacoes Servico ValorCredito PrestadorServico TomadorServico IntermediarioServico OrgaoGerador ConstrucaoCivil TsSimNao TsSimNao Date tsNumeroNfse tsOutrasInformacoes tcDadosServico TsValor tcDadosPrestador tcDadosTomador tcIdentificacaoIntermediarioServico tcIdentificacaoOrgaoGerador tcDadosContrucaoCivil 1-1 1-1 1-1 0-1 0-1 1-1 0-1 1-1 1-1 0-1 1-1 0-1
TcNfse
Representa a estrutura da Nota Fiscal de Servios Eletrnica assinada Nome Tipo Ocorrncia InfNfse tcInfNfse 1-1 Dsig:Signature 1-2 Signature Descrio
Representa a estrutura de dados do pedido de cancelamento enviado pelo prestador ao cancelar uma Nota Fiscal de Servios Eletrnica. Nome Tipo Ocorrncia Observao IdentificacaoNfse tcIdentificacaoNfse 1-1 CodigoCancelamento tsCodigoCancelamentoNfse 1-1
tcInfPedidoCancelamento
TcPedidoCancelamento
Representa a estrutura de Pedido de Cancelamento da Nota Fiscal de Servios Eletrnica assinada Nome Tipo Ocorrncia Descrio InfPedidoCancelamento tcInfPedidoCancelamento 1-1 Dsig:Signature 1-1 Signature
Representa a estrutura de dados da confirmao de cancelamento Nota Fiscal de Servios Eletrnica feito pelo Fisco Municipal. Nome Tipo Ocorrncia Observao Sucesso boolean 1-1 DataHora datetime 1-1
tcInfConfirmacaoCancelamento
TcConfirmacaoCancelamento
Representa a estrutura de Confirmao de Cancelamento da Nota Fiscal de Servios Eletrnica assinada Nome Tipo Ocorrncia Descrio Pedido TcPedidoCancelamento 1-1 InfConfirmacaoCancelamento tcInfConfirmacaoCancelamento 1-1
TcCancelamentoNfse
Representa a estrutura completa (pedido + confirmao) de cancelamento de NFS-e. Nome Tipo Ocorrncia Descrio Confirmacao TcConfirmacaoCancelamento 1-1
TcInfSubstituicaoNfse
Representa os dados de registro de substituio de NFS-e. Nome Tipo NfseSubstituidora tsNumeroNfse Ocorrncia 1-1 Descrio
TcSubstituicaoNfse
Representa a estrutura de substituio de NFS-e. Nome Tipo Ocorrncia Descrio 29 de 35
Verso: 1.0.00.3 - 09/02/2012 - Verso: 1.00 SubstituicaoNfse tcInfSubstituicaoNfse dsig:Signature 1-1 1-2
Signature
TcCompNfse
Representa a estrutura de compartilhamento de dados de uma NFS-e. Nome Tipo Ocorrncia Nfse tcNfse 1-1 NfseCancelamento tcCancelamentoNfse 0-1 NfseSubstituicao tcSubstituicaoNfse 0-1 Descrio
tcMensagemRetorno
Representa a estrutura de mensagem de retorno de servio. Nome Tipo Ocorrncia Descrio Codigo TsCodigoMensagemAlerta 1-1 Mensagem tsDescricaoMensagemAlerta 1-1 Correcao tsDescricaoMensagemAlerta 0-1
ListaMensagemRetorno
Representa a estrutura de mensagem de retorno de servio. Nome Tipo MensagemRetorno tcMensagemRetorno Ocorrncia Descrio 1-N
tcMensagemRetornoLote
Representa a estrutura de mensagem de retorno de servio. Nome Tipo Ocorrncia Descrio IdentificacaoRps TcIdentificacaoRps 1-1 Codigo TsCodigoMensagemAlerta 1-1 Mensagem tsDescricaoMensagemAlerta 1-1
tcLoteRps
Nome NumeroLote Cnpj InscricaoMunicipal QuantidadeRps ListaRps Rps Tipo TsNumeroLote TsCnpj TsInscricaoMunicipal TsQuantidadeRps TcRps Ocorrncia Observao 1-1 1-1 1-1 1-1 1-1 1-N
SERVIOS A seguir esto os servios disponveis, conforme descritos no item 3.1, no WebService e seus XML Schema. O XML Schema define a estrutura e formatao do arquivo XML que conter os dados a serem trafegados. Esses documentos sero enviados de forma textual (como uma string) como parmetros do servio oferecido pelo Web Service, como descrito em 3.2.1.
30 de 35
As tabelas que detalham cada XML Schema esto divididas da seguinte forma:
(1)
Tipo (3) (4) Pai (5) Ocorrncia (6) (8) Observao (7) (9)
# Nome (2)
1. Nome do arquivo XSD; 2. Nmero identificador do campo, quando este contiver subitens; 3. Nome do campo; 4. Nome do tipo do campo que pode ser tipo primitivo, simples ou complexo; 5. Indica quem o campo pai, para definio da hierarquia; 6. Quantas vezes o campo se repete na estrutura de dados: 1. a. Formato: z-y onde x a quantidade mnima e y a quantidade mxima. Se a quantidade mxima for indefinida, ser utilizado N no lugar do y; 7. Descreve alguma observao pertinente; 8. Formato de grupo, utilizado para definio de uma escolha (ver prximo item); 9. Identifica os campos ou grupos que faro parte de uma escolha (Choice). Recepo de Lote de RPS Esse servio ser executado, inicialmente, atravs da chamada ao mtodo RecepcionarLoteRps, passando a mensagem XML como parmetro com a estrutura definida na tabela que segue. http://e-gov.betha.com.br/e-nota-contribuinte-ws/recepcionarLoteRps?wsdl
servico_enviar_lote_rps_envio.xsd
# 1 Nome EnviarLoteRpsEnvio LoteRps Tipo TcLoteRps Pai 1 Ocorrncia 1-1 1-1 Observao
Verso: 1.0.00.3 - 09/02/2012 - Verso: 1.00 # 1 Nome EnviarLoteRpsResposta NumeroLote DataRecebimento Protocolo ListaMensagemRetorno Tipo tsNumeroLote Datetime tsNumeroProtocolo ListaMensagemRetorno Pai 1 1 1 1 Ocorrncia 1-1 1-1 1-1 Observao
Choice
O lote ser processado posteriormente, sendo o seu resultado disponibilizado para consulta. Consulta de Situao de Lote de RPS Esse servio ser executado estrutura definida na tabela que segue. http://e-gov..betha.com.br/e-nota-contribuinte-ws/consultarSituacaoLoteRps? wsdl
servico_consultar_situacao_lote_rps_envio.xsd
# 1 Nome ConsultarSituacaoLoteRpsEn vio Prestador Protocolo Tipo Pai 1 1 Ocorrncia 1-1 1-1 1-1 Observao
atravs
da
chamada
ao
mtodo
TcIdentificacaoPrestador TsNumeroProtocolo
1 1 1
Choice
Consulta de NFS-e por RPS Esse servio ser executado definida na tabela que segue. http://e-gov.betha.com.br/e-nota-contribuinte-ws/consultarNfsePorRps?wsdl
servico_consultar_nfse_rps_envio.xsd
# Nome Tipo Pai Ocorrncia Observao 32 de 35
atravs da chamada
ao
mtodo
tcIdentificacaoRps tcIdentificacaoPrestador
1 1
1-1 1-1
Consulta de NFS-e Esse servio ser executado atravs da chamada ao mtodo ConsultarNfse, passando a mensagem XML como parmetro com a estrutura definida na tabela que segue. http://e-gov.betha.com.br/e-nota-contribuinte-ws/consultarNfse?wsdl
# 1
servico_consultar_nfse_envio.xsd
Nome ConsultarNfseEnvio Prestador NumeroNfse PeriodoEmissao DataInicial DataFinal Tomador IntermediarioServico Tipo tcIdentificacaoPrestador tsNumeroNfse date date tcIdentificacaoTomador TcIdentificacaoIntermediar ioServico Pai 1 1 1 2 2 1 1 Ocorrncia 1-1 1-1 0-1 0-1 1-1 1-1 0-1 0-1 Observao
tcCompNfse ListaMensagemRetorno
mtodo ConsultarLoteRps, passando a mensagem XML como parmetro com a estrutura definida na tabela que segue.
33 de 35
http://e-gov.betha.com.br/e-nota-contribuinte-ws/consultarLoteRps?wsdl
servico_consultar_lote_rps_envio.xsd
# 1 Nome ConsultarLoteRpsEnvio Prestador Protocolo Tipo TcIdentificacaoPrestador TsNumeroProtocolo Pai 1 1 Ocorrncia 1-1 1-1 1-1 Observao
servico_consultar_lote_rps_resposta.xsd
Nome ConsultarLoteRpsResposta ListaNfse CompNfse ListaMensagemRetorno Tipo Pai 1 2 1 Ocorrncia 1-1 1-1 1-N 1-1 Observao
tcCompNfse ListaMensagemRetorno
Choice
Cancelamento NFS-e Esse servio ser executado atravs da chamada ao mtodo CancelarNfse, passando a mensagem XML como parmetro com a estrutura definida na tabela que segue. http://e-gov.betha.com.br/e-nota-contribuinte-ws/cancelarNfseV02?wsdl
# 1
servico_cancelar_nfse_envio.xsd
Nome CancelarNfseEnvio Pedido Tipo TcPedidoCancelamento Pai 1 Ocorrncia 1-1 1-1 Observao
34 de 35
Observaes Dvidas ou sugestes, podero ser registradas no frum, forum.betha.com.br, no painel Sistemas Web, opo Fly e-Nota.
35 de 35