Cadastrar uma Empresa via Web Service – Antigo

Última atualização em: 13 de julho, 2015

 

Neste artigo iremos demonstrar como realizar o cadastro de uma empresa através do Web Service do InvoiCy.

A partir de agora, assumimos que você já leu o artigo Integrar com o InvoiCy NFS-e. Caso ainda não tenha lido o artigo, recomendamos que realize a leitura do mesmo, para facilitar o entendimento deste artigo.

O cadastramento da empresa é muito simples. Para que isso se torne possível, siga os seguintes passos:

     1. Consumindo o Web Service
Primeiramente, você deve realizar o consumo do Web Service de Cadastro de prestador – https://gnfse.gnfe.com.br/apnuc208.aspx?wsdl

     2. Criar os XML para o envio
O XML deve ser convertido para String, porém, apenas neste serviço não é preciso gerar a chave de comunicação (EmpCK), apenas o XML deve ser convertido para texto, conforme instruções abaixo. Para mais informações sobre a EmpCK consulte o artigo Como gerar o código Hash MD5?

     3. Armazenar os dados de retorno
Caso a empresa seja cadastrada com sucesso, é preciso guardar o Código da Empresa no InvoiCy e a chave de acesso, informações fundamentais para a emissão com a empresa. Para obter mais informações sobre a chave de acesso consulte o artigo Verificando a chave de acesso da empresa.

Para obter os Layouts de envio e retorno do Cadastro de Empresas, faça o download do arquivo CadastroEmpresa.zip. Nele você encontrará também o arquivo XSD e XML de exemplo.

O documento XML deve ser convertido para texto, e inserido entre as TAGS do SOAP de envio. Veja abaixo um exemplo:

Nos casos em que for usada uma ferramenta RAD para consumo do Web Service através de componente nativo, por exemplo Visual Studio utilizando Web Reference, a conversão do XML para texto irá ocorrer de forma automática. Para os casos em que o desenvolvedor preferir codificar toda a comunicação sem utilizar componentes, além de ser necessário escrever todo o XML do SOAP, também deverá ser feita a conversão do XML do documento para texto, substituindo os caracteres “<”, “>” e “ “ ” (aspas) por “<”, “>” e “”” respectivamente, de acordo com a tabela da W3C: http://www.w3schools.com/html/html_entities.asp.

Para facilitar a geração do XML de integração, disponibilizamos o XML de envio, bem como um arquivo de esquema XSD que poderá servir como base. É recomendável que após a geração do arquivo XML e antes do consumo do Web Service, o mesmo seja validado contra o arquivo de esquema. Maiores detalhes no artigo Validação de arquivos XML.

    4. Realize a leitura do retorno do cadastro de Empresa
Após o envio do XML, precisamos realizar a leitura do retorno do processamento do cadastro. O retorno recebido segue a seguinte estrutura SOAP:

A estrutura SOAP acima demonstra o retorno do envio de apenas uma empresa. O seu sistema deve ler o retorno, validando as informações conforme o layout de retorno. O retorno apresentará o status de cada processo, desde o cadastro da empresa, a instalação do certificado, a validação da licença e o cadastro do usuário.

Para saber mais sobre os possíveis códigos de retorno ao cadastrar uma empresa via Web Service, acesse o artigo Códigos de Retorno Cadastro de Empresa via Web Service.

Agora que você já cadastrou a empresa, podemos dar prosseguimento ao próximo passo.

Seu próximo passo é: Emitir uma NFS-e.

Artigos Relacionados:

Integrando com o módulo NFS-e – Antigo

Última atualização em: 31 de julho, 2014

 

A integração de seu ERP com o InvoiCy NFS-e deve ser realizada através de Web Service disponibilizado pelo InvoiCy. Este Web Service é único, e deve ser utilizado para qualquer emissão com o InvoiCy, independente da prefeitura que se deseja enviar. Abaixo, detalhamos o processo de integração com o módulo NFS-e.

  • Visualize a estrutura WSDL do Web Service.

Para visualizar a estrutura WSDL do Web Service, basta copiar e colar o link do Web Service em seu navegador de internet, por exemplo https://gnfse.gnfe.com.br/apnuc134.aspx?wsdl. Assim podemos visualizar toda a estrutura do WSDL, conforme demonstra a imagem abaixo:

  • Realize o consumo do Web Service.

Você deverá realizar o consumo do Web Service para realizar a integração. Dentro da TAG <nfse:Entradaxml>, você deverá informar o conteúdo XML da NFS-e, contendo a estrutura de campos. Os campos da NFS-e devem estar convertidos para formato texto, conforme exemplo abaixo:

Nos casos em que for usada uma ferramenta RAD para consumo do Web Service através de componente nativo, por exemplo Visual Studio utilizando Web Reference, a conversão do XML para texto irá ocorrer de forma automática. Para os casos em que o desenvolvedor preferir codificar toda a comunicação sem utilizar componentes, além de ser necessário escrever todo o XML do SOAP, também deverá ser feita a conversão do XML do documento para texto, substituindo os caracteres “<”, “>” e “ “ ” (aspas) por “&lt;”, “&gt;” e “&quot;” respectivamente, de acordo com a tabela da W3C: http://www.w3schools.com/html/html_entities.asp. Para facilitar seu entendimento, disponibilizamos para você o download de um exemplo completo de consumo dos Webservices do InvoiCy (Schemas XSD e XMLs de Exemplo). RecepcaoRPS.zip

  •  Realize a leitura do retorno do envio da NF-e.

Após o envio da NFS-e, precisamos realizar a leitura do retorno do processamento do documento. O retorno recebido segue a seguinte estrutura SOAP:

A estrutura SOAP acima demonstra o retorno do envio de apenas um único documento. Note que na TAG <EspelhoRPS> é retornado o “espelho” do RPS, codificado em Base64. Agora que você já realizou sua integração, podemos dar prosseguimento ao próximo passo. Seu próximo passo é: Cadastrar uma Empresa via Web Service

Artigos Relacionados:

Como funciona a NFS-e? – Antigo

Última atualização em: 31 de julho, 2014

 

O InvoiCy NFS-e é uma solução complementar ao ERP do cliente e permite o gerenciamento completo do ciclo de envio e retorno das NFS-e (Notas Fiscais de Serviço Eletrônica), contemplando os diferentes padrões adotados pelas Prefeituras através de um único padrão integrado com o ERP.

Arquitetura da Solução
A comunicação com o ERP é realizada através de Web Services disponibilizados pelo InvoiCy NFS-e. Essa integração possibilita que o InvoiCy NFS-e possa ler e interpretar os dados informados pelo ERP e processar o RPS (Recibo Provisório de Serviço), que é enviado para a prefeitura do município de prestação do serviço.

A imagem abaixo ilustra a arquitetura do InvoiCy NFS-e.

arquitetura_nfse

Arquitetura do InvoiCy NFS-e

1. A comunicação entre o ERP e o InvoiCy NFS-e é através de Web Services disponibilizados pelo sistema InvoiCy NFS-e.

2. O InvoiCy NFS-e tem conhecimento das formas e os meios de integração utilizados pelos municípios e gerencia essa comunicação. Após receber o retorno do sistema do município, as informações são retornadas para o ERP via Web Services.

Serviços Disponíveis (Web Services)

Envio de RPS em lote – Responsável por receber os dados referentes as prestações de serviço, processar o RPS no layout da prefeitura, realizar o envio em lote e retornar o status das notas ao ERP.

Consulta de RPS/NFS-e – Responsável por receber uma lista de RPS/NFS-e a serem consultadas e retornar o status das notas ao ERP.

Cancelamento da NFS-e – Responsável por receber uma lista de NFS-e, enviar o cancelamento para a prefeitura e retornar o status das notas ao ERP.

Donwload do XML das NFS-e – Responsável por receber uma lista de NFS-e e retonar o XML das NFS-e ao ERP.

Download do Espelho do RPS – Responsável por receber uma lista de RPS/NFS-e e retonar o Espelho RPS das notas ao ERP.

Cadastro de Prestador – Responsável por receber os dados das empresas e realizar o cadastro ou atualização.


Tipo de Serviços

Síncrono – Para envio de pequenos lotes por requisição e resposta em tempo real.

Assíncrono – Para envio de grandes lotes por requisição, e resposta em uma segunda requisição. Depende do tempo de processamento da prefeitura. Muitas prefeituras não processam a nota em tempo real.


Sistema web

Através da interface web é possível gerenciar as empresas e suas notas, acompanhar o processo de envio e retorno, aplicar configurações por empresa e realizar diversas ações.

tela_inicial_nfse

Tela inicial do InvoiCy NFS-e

É possível realizar diversas ações com as notas, podendo citar as principais:

atualizar_statusAtualizar status – Permite atualizar o status do RPS com a situação da nota da prefeitura.

eenviarReenviar – Permite reenviar o RPS para a prefeitura;

download_xmlDownload do XML – Permite realizar o download do XML da NFS-e e demais XML armazenados durante o fluxo.

espelhoEspelho do RPS – É possível imprimir o Espelho RPS.

No menu lateral esquerdo possui as seguintes opções:

Inicio – Acesso à tela inicial, conforme imagem acima.

Cancelar NFS-e – Permite solicitar o cancelamento de uma NFS-e.

Consultar RPS – Permite a consultar determinados RPS no InvoiCy NFS-e.

Nova Empresa – Permite cadastrar uma nova empresa.

Municípios – Acesso a uma listagem com pesquisa com todos os municípios integrados e padrões.

Painel de Controle – Permite realizar diversas configurações de uma empresa, conforme imagem abaixo:

painel de controle

Painel de controle

Dados empresa – Permite editar os dados da empresa

Logotipo – Permite configurar um logotipo para a empresa, ao qual será utilizado no espelho do RPS.

Usuários – Permite configurar usuários para a empresa.

Certificado – Permite inserir o certificado da empresa.

Status da Licença – Permite consultar o status da licença da empresa.

Perfis de usuários – Permite configurar perfis de usuários.

Meus dados – Permite editar os dados do usuário logado no sistema.

Trocar senha – Permite trocar a senha do usuário logado no sistema.


Atualizações

Na solução SaaS, as atualizações são feitas apenas pela Migrate, otimizando todo o processo e liberando o parceiro de qualquer esforço.

Sempre que houver a integração com um novo padrão/prefeituras, a atualização ocorre de forma automática com o InvoiCy NFS-e, e sem necessidade de alteração na integração.

O usuário final não tem esforço de atualização. Exceto eventual mudança no processo de emissão, com o objetivo de atender informação adicional exigida por alguma prefeitura, que não esteja presente nas configurações do ERP.

Alteração no layout de integração será necessária apenas se alguma prefeitura utilizada pelo parceiro requisitar informações que não constam no presente layout de integração.

Pronto para realizar a integração?

Seu próximo passo é: Integrando com o InvoiCy NFS-e

Padrão SMARAPD SIL Tecnologia WS

Última atualização em: 24 de julho, 2019

Algumas particularidades do padrão SMARAPD SIL Tecnologia WS:

  • É necessário informar um usuário e senha para emitir as notas, os mesmos são fornecidos pela prefeitura. Devem ser informados nos dados da empresa, nos seguintes campos:

1. Usuário Autent. – CNPJ da empresa 2. Senha Autent. – Senha da empresa para acesso ao sistema da prefeitura. OBS: Se a senha contiver letras (ex: abc123), as mesmas devem ser inseridas maiúsculas (ex: ABC123).
Nota: Para homologação, há dados de teste, ver mais abaixo nesse artigo.

  • No campo Série, informar “7” fixo.
  • Os dados do tomador são obrigatórios.
  • Não é possível enviar RPS de substituição e RPS com intermediário.
  • A data de emissão do RPS <dEmis> não pode ser menor do que a data da última NFSe efetivada.
  • Outra informação importante indica se a tributação de ISS é realizada ou não no município. Para esta informação, deve informar o campo LocalPrestServ com os valores: 1 – Caso Tributação do ISS seja no município 2 – Caso não seja no município

Status em conflito:

Neste padrão é comum ocorrer falhas na comunicação com a prefeitura e time out.

Quando isso ocorre, não é possível capturar o protocolo do documento, que é um parâmetro obrigatório para consultar a nota.

Com esta limitação do serviço do padrão, o sistema não pode consultar se a nota foi processada para solucionar automaticamente.

Desta forma, o status da nota é alterado para Em Conflito e requer que o usuário verifique no site da prefeitura se existe uma NFS-e para este número de RPS.

No site de NFS-e do município, acesse a tela de consulta de nota fiscal, preencha o CNPJ do prestador, número de RPS e CPF/CNPJ do tomador.

Consultar nota fiscal

Se existir NFS-e, será apresentado o resultado contendo a chave de verificação e número de NFS-e.

Nota fiscal localizada

Em posse desses dados, o registro pode ser atualizado a partir do web service de correção, leia o artigo Permitir resolver notas em conflito via Web Service, ou atualizado manualmente através da tela de suporte nos detalhes do documento.

Observações:

  • O município não possui ambiente de homologação.
  • O município de Nova Odessa/SP não possui serviço de cancelamento via Web Service. Desta forma, as notas devem ser canceladas na prefeitura e posteriormente canceladas no InvoiCy para atualizar o status da nota.

Padrão INFISC – Caxias do Sul

Última atualização em: 10 de junho, 2016

Algumas particularidades do padrão INFISC:

  • O Número do RPS será o número da NFS-e quando a nota for efetivada. A numeração deverá ser emitida de forma sequencial.
  • O campo “Série” permite apenas 3 dígitos.
  • Não será possível o envio de RPS de Substituição e Intermediário.
  • O Tomador é obrigatório.
  • O layout de impressão da NFS-e será o modelo da prefeitura.
  • Não haverá impressão do RPS.
  • Não poderá enviar o caractere & nos dados do RPS.

1. Inutilização
Quando uma numeração não pode ser mais utilizada (foi pulado a ordem cronológica), é necessário enviar uma inutilização da mesma para a prefeitura. Para fazer esse processo, basta reenviar o RPS com o campo “Status” = 5 (Inutilização).

2. Optante pelo Simples Nacional

Os valores aceitos para optante simples nacional são:

Optante Simples Nacional

Se for informado que o prestador é optante pelo Simples Nacional, o InvoiCy irá zerar alguns campos (listados abaixo), conforme instrução do manual de integração da INFISC:

  • Base de cálculo
  • Base de cálculo do ISS Retido
  • Valor do ISS
  • Alíquota ISS
  • Base de cálculo do ISS

3. Canhoto de RPS

Desde setembro de 2015 está disponível no layout de recepção um novo campo RPSCanhoto. Este campo permite que na exportação da nota em PDF no sistema da prefeitura de Caxias do Sul seja possível imprimir um canhoto da nota, como mostra a imagem abaixo.

Incluindo um condutor no MDF-e

Última atualização em: 21 de fevereiro, 2017

 

Olá! Neste artigo iremos descrever o funcionamento e finalidade do evento de inclusão de condutor no MDF-e.

A inclusão de condutor para o MDF-e não consiste em um evento obrigatório. Este deverá ser informado apenas quando ocorrer alterações referentes ao condutor do veículo e for necessária a inclusão de um novo condutor.

Proceda com os seguintes passos para realizar a inclusão de condutor em um documento:

1. Autorize um documento
A inclusão de condutor somente poderá ser realizada para documentos que receberam a autorização de uso pela SEFAZ.

2. Gere a estrutura do arquivo XML para inclusão de condutor
Você deverá gerar a estrutura do XML para inclusão de condutor em um MDF-e de acordo com o Layout de eventos do MDF-e. Disponibilizamos aqui um exemplo do “Layout 3.0 Evento MDF-e”.

Para facilitar seu entendimento, disponibilizamos também um exemplo com a estrutura do arquivo xml de inclusão de condutor em MDF-e. Clique aqui, para realizar o download.

Por fim, para facilitar a geração do XML de inclusão de condutor, disponibilizamos um arquivo de esquema XSD que poderá servir como base. Clique aqui, para realizar o download do arquivo.

Encerrando um MDF-e

Última atualização em: 21 de fevereiro, 2017

 

Olá! Neste artigo iremos descrever o funcionamento e finalidade do evento de encerramento do MDF-e.

O encerramento do MDF-e consiste em um evento obrigatório, onde deve-se informar ao fisco, através da utilização do Web Service de registro de eventos, sobre o fim da vigência do mesmo, ou seja, quando o MDF-e chegar ao seu destino final este deverá ser encerrado.

Enquanto houver um MDF-e pendente de encerramento não será possível autorizar novo MDF-e para o mesmo UF de carregamento e descarregamento, e para o mesmo veículo.

Proceda com os seguintes passos para realizar o encerramento de um documento:

1. Autorize um documento
O encerramento só pode ser feito para documentos que receberam a autorização de uso pela SEFAZ.

2. Gere a estrutura do arquivo XML de encerramento
Você deverá gerar a estrutura do XML de encerramento de um MDF-e de acordo com o Layout de eventos do MDF-e. Disponibilizamos aqui um exemplo do “Layout 3.0 Evento MDF-e”.

Para facilitar seu entendimento, disponibilizamos também um exemplo com a estrutura do arquivo xml de encerramento do MDF-e. Clique aqui, para realizar o download.

Por fim, para facilitar a geração do XML de encerramento, disponibilizamos um arquivo de esquema XSD que poderá servir como base. Clique aqui, para realizar o download do arquivo.

Como solicitar um novo município e qual o prazo para integração

Última atualização em: 05 de maio, 2016

 

Uma dúvida frequente sobre as integrações do InvoiCy NFS-e, é como solicitar a integração com um município que ainda não está integrado, quais os requisitos para realizar a solicitação e qual o prazo para concluir a mesma. Neste artigo, solucionaremos as dúvidas com relação a esse tema.

1. Como solicitar a integração
O primeiro passo é determinar se o município já está integrado ou não.  A melhor alternativa é consultar no próprio InvoiCy NFS-e, que oferece uma opção no menu principal para consultar os municípios integrados, conforme a figura abaixo.

Outra forma de realizar a consulta é através do mapa dos municípios integrados, acessando o endereço InvoiCy NFS-e: Municípios Integrados. É possível também consultar via Web Service se o município está integrado, o que permite por exemplo, validar se o município está integrado antes do seu sistema ERP enviar o cadastro de uma empresa via Web Service para o InvoiCy. Para integrar a consulta de municípios verifique o artigo Consulta de Municípios Integrados.

Por fim, também é possível contatar o seu gerente de contas, que pode lhe enviar uma relação de municípios integrados.

Após constatar que o município não está de fato integrado, você precisa reunir as informações de uma empresa domiciliada neste município, empresa esta que será utilizada como piloto na integração.

2. Pré-requisito para a integração
Conforme citado, o pré-requisito para realizar a integração é a disponibilização de uma empresa que será usada como piloto na integração, necessariamente sendo domiciliada no município desejado.

A disponibilização da empresa é fundamental, uma vez que não realizamos integrações baseadas apenas em manuais, pois muitas vezes os manuais disponibilizados não refletem a realidade efetiva dos sistemas, onde muitas questões não estão documentadas, ou foram alteradas após a documentação.

A empresa piloto precisa estar habilitada no ambiente de homologação da prefeitura (se existir), e possuir certificado digital A1. É preciso preencher o formulário abaixo:

DADOS CADASTRAIS:
CNPJ
Nome Fantasia
Razão Social
Endereço
Cidade/UF
Bairro
CEP
Complemento
DDD telefone
CMC (Cadastro Mobiliário do Contribuinte)
Inscrição Municipal
Inscrição Estadual
Itens da Lista de serviços habilitados para empresa
Código de tributação do município habilitados para a empresa
Cnae utilizado pela empresa
Alíquota de ISS que a empresa utiliza
Usuário para acesso ao portal da prefeitura
Senha para autenticação no portal da prefeitura
Certificado Digital A1
Senha do Certificado
Estimativa aproximada de notas emitidas (pode ser por dia, semana ou mês)
Data de exigência legal para iniciar a emissão (se tiver)

Para facilitar a comunicação entre a Migrate e nossos parceiros, gostaríamos também de um contato que seja responsável pela NFS-e no parceiro para que possamos tirar dúvidas, solicitar mais informações ou mesmo comunicar a finalização da integração.
Contato do parceiro

De posse das informações relatadas acima, é possível solicitar a integração através de duas principais formas:

Gerente de Contas: Contate o seu gerente de contas, enviando o(s) município(s) que existe o interesse, bem como o formulário, que o mesmo encaminhará a integração.

Integração: Através de um e-mail para integracao@migrate.com.br com o assunto: “Solicitação de novo município na NFS-e do InvoiCy – Nome Município – Estado”.

Importante: Nesse e-mail de solicitação informe sempre o nome do Município solicitado, mais o Estado.

Ex.: Solicitação de novo município na NFS-e do InvoiCy, Três de Maio – RS.

3. Qual o prazo para concluir a integração
Para entender os prazos, vamos primeiro analisar a forma de priorização das integrações. Possuímos uma fila de desenvolvimento, que leva em conta a data da solicitação, a prioridade (existência de obrigação legal), a expectativa do parceiro e o número de municípios que a integração agregará ao InvoiCy. Para ser inserida na fila, antes a integração é validada por um analista (a validação contempla análise da documentação e testes de envio). Dessa forma, a validação exige as informações de uma empresa piloto, bem como o certificado digital A1.

O processo de validação é fundamental, pois diversas vezes uma determinada integração foi priorizada, mas o desenvolvimento parou pois a empresa não possuía habilitação, ou o sistema estava programado diferente do manual, entre outros fatores. Uma vez na fila, na medida em que as integrações em desenvolvimento no momento são finalizadas, as outras são priorizadas e uma data de liberação é programada (e compartilhada com o parceiro que solicitou).