Cadastro de Empresas via InvoiCy Conector – versão 5.0

Última atualização em: 27 de setembro, 2017

Integrando com o InvoiCy Conector, além de emitir documentos também é possível realizar o cadastro de empresas. Neste artigo iremos descrever como proceder para cadastrar uma nova empresa através do InvoiCy Conector, demonstrando um exemplo de envio de um arquivo xml seguindo o layout para cadastro de empresas.

A partir deste momento, assumimos que você já leu os artigos “Como funciona o InvoiCy Conector” e “Como integrar com o InvoiCy Conector”. Caso ainda não tenha lido tais artigos por favor, volte um passo antes de iniciar a leitura deste documento.

Após realizar a configuração do InvoiCy Conector de acordo com as suas preferências, e iniciar o serviço de emissão da instância configurada, é necessário gerar um documento de integração de acordo com o layout de cadastro de empresas, que posteriormente será salvo no diretório de Entrada configurado.

Para facilitar seu entendimento disponibilizamos um exemplo do XML com o layout de cadastro de empresas, clique aqui para realizar o download.

Note que é necessário acrescentar no início da estrutura do arquivo xml a tag , onde deve-se informar a chave de parceiro da empresa emissora que está sendo cadastrada. A imagem abaixo demonstra a utilização dessa tag.

Cadastro empresa XML

Após o Conector fazer a leitura e envio desse arquivo para o InvoiCy, no diretório de Saída configurado é possível observar o arquivo XML de retorno do InvoiCy, onde pode-se consultar o status da operação para identificar se a empresa foi cadastrada com sucesso. A imagem a seguir demonstra a estrutura do arquivo de retorno.

Retorno cadastro empresa

O arquivo de retorno contém o código e status final da operação, e a chave de acesso da empresa, quando o cadastro foi concluído com sucesso. Para facilitar seu entendimento anexamos um exemplo do XML do retorno representado acima. Clique aqui e realize o download.

Quando ocorrer alguma falha no cadastro a mesma também estará representada no arquivo de retorno, ou ainda nos logs do Conector. Para acessar os logs basta abrir o Conector e no Menu superior selecionar Opções – Logs, como demostra a imagem a seguir.

4 - Configurações Gerais

Será aberta então uma tela que lista todos os logs das principais ações executadas pelo usuário durante o uso do Conector, como demonstra a imagem abaixo.

Logs

Em caso de dúvidas vocês pode acessar o Menu Ajuda – Documentação, como demonstra a imagem a seguir. Você será direcionado para o nosso Portal dos Desenvolvedores, onde consta uma vasta documentação sobre todas as funcionalidades do InvoiCy Conector, e também alguns exemplos de integração.

Menu - Ajuda

Agora que sua empresa já está cadastrada no InvoiCy você pode iniciar a emissão de seus documentos. Para facilitar seu entendimento disponibilizamos alguns exemplos de layouts de integração. Para mais informações acesse o artigo Downloads.

Exclusão de Empresas

Última atualização em: 24 de abril, 2017

 

O InvoiCy permite a exclusão de empresas cadastradas pelos Parceiros, desde que a mesma não tenha nenhum documento vinculado.

Esta opção é útil principalmente durante o processo de integração na fase de cadastro de empresas via Web Service, pois assim poderá utilizar o mesmo CNPJ para cadastro, incluindo a empresa e podendo exclui-la posteriormente para um novo cadastro, assim permitindo a empresa emitir documentos válidos pois o CNPJ terá vínculo com o CNPJ base do certificado digital da empresa.

Para a exclusão de empresas acesse o Painel de Controle, grupo ‘Configurações do Parceiro’, opção ‘Minhas Empresas’.

Minhas empresas

Filtre pelo código, CNPJ, nome da empresa, ou se desejar uma pesquisa mais avançada clique na opção ‘Mais filtros’. Após encontrar a empresa desejada clique no ícone de excluir, como demonstra a imagem a seguir.

 

Aparacerá uma mensagem de confirmação, como a imagem abaixo. Confirmando a operação a empresa e as demais informações vinculadas a ela serão excluídas da aplicação.

 

Códigos de Retorno Cadastro de Empresa via Web Service

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

 

Neste artigo iremos abordar os possíveis códigos de retorno ao realizar o cadastro de uma empresa através do Web Service do InvoiCy.

Ao realizar o cadastro de uma empresa via Web Service, você usuário poderá obter os seguintes retornos:

100 – Solicitação de cadastro recebida

Ao receber esse retorno significa que a sua empresa foi cadastrada com sucesso no InvoiCy.

101 – Falha na estrutura do XML ou campos obrigatórios não preenchidos

Nessa situação a empresa não foi cadastrada, pois algum dos dados informados não estava de acordo. O usuário receberá o código 101 juntamente com o campo que não foi informado corretamente.

103 – Falha na validação do certificado digital

Esse retorno ocorre quando há uma inconformidade com o certificado digital informado para a empresa, onde a senha pode estar incorreta, a data de validade estar vencida, ou o certificado informado não corresponder a empresa que está sendo cadastrada.

104 – E-mail do usuário é inválido

No momento de cadastrar a empresa, ao informar incorretamente o e-mail do usuário será retornado o código 104.

105 – Campos nome ou senha do usuário não informados

Se ao cadastrar a empresa não for informado corretamente as informações referentes ao nome e senha do usuário será retornado o código 105.

106 – Usuário já cadastrado

Se o usuário informado no momento de cadastrar a empresa já estiver cadastrado será retornado o código 106.

107 – Usuário e senha da caixa de e-mail não informada

Ao cadastrar uma empresa pode-se também configurar uma caixa de e-mail. Será retornado o código 107 quando o usuário e senha da caixa de e-mail não forem informados corretamente.

108 – Não foi possível conectar ao servidor de e-mail informado

Esse retorno irá ocorrer quando o servidor de e-mail informado não estiver de acordo, não possibilitando o acesso ao mesmo.

109 – Empresa Matriz não encontrada

Ao cadastrar uma Filial, quando a empresa Matriz não for encontrada irá retornar o código 109 para o usuário.

173 – Chave de comunicação ou chave de parceiro inválida

O código 173 será retornado quando a chave de comunicação ou a chave de parceiro estiverem inválidas, retornando especificamente para o usuário qual das chaves está incorreta.

Licenciamento das empresas

Última atualização em: 13 de outubro, 2017

 

Ao cadastrar uma empresa emitente em ambiente de produção, o usuário parceiro já deverá fazer a solicitação da licença para os módulos que possui contrato.

Caso o sistema esteja no ambiente de produção, ao preencher as informações na primeira etapa de Dados da empresa, ao avançar para a próxima etapa será apresentada uma tela com informações de licenciamento, com os módulos disponíveis para solicitação de licença.

Para solicitar uma licença basta selecionar os módulos desejados, então já serão apresentados em tela os contratos que o usuário tem disponível para cada módulo selecionado. Caso tiver mais de um contrato os mesmos serão apresentados em um combobox destacando o modelo do contrato, por exemplo bilhetagem ou licença, possibilitando selecionar qual contrato será atribuído para a empresa que está sendo cadastrada. Caso possuir um só contrato para o módulo selecionado apenas aquele aparecerá em tela.

 

Após selecionar os módulos e definir os contratos que serão atribuídos para a empresa, ao clicar em Solicitar licença o InvoiCy já fará a solicitação das licenças. Se ocorrer algum problema será apresentada para o usuário uma mensagem em tela, possibilitando que o mesmo altere as informações e tente solicitar novamente a licença.

Nesse processo também será controlado o estoque de licenças do parceiro, ou seja, se o mesmo possui licenças disponíveis para os módulos selecionados. Caso não possua mais licenças ativas será exibida uma mensagem em tela para conhecimento do usuário.

É importante salientar que ao realizar o cadastro de uma empresa via Web Service, também será possível definir o tipo de contrato utilizado para cada módulo, e assim ao final do cadastro a empresa já estará licenciada para realizar emissões no InvoiCy. Caso não seja definido nenhum contrato durante o cadastro, a licença será solicitada automaticamente, mas apenas na primeira emissão da empresa.

Após o usuário Parceiro finalizar o cadastro da sua empresa,  através do Painel de Controle, tela de Módulos contratados, poderá visualizar e gerenciar as licenças das suas empresas emissoras, podendo cancelar a licença de algum módulo, bloquear ou solicitar uma nova licença. É possível também editar uma licença selecionando um outro contrato disponível, ou cancelar todas as licenças que estão ativas.

 

Através dessa tela fica mais fácil para o usuário Parceiro identificar para quais módulos já possui licença ativa. Para solicitar uma nova licença basta clicar no ícone semelhante a uma medalha, como demonstra a imagem abaixo.

 

Serão exibidos então os contratos que o usuário tem disponível para o módulo selecionado. Caso possuir mais de um contrato, estes serão apresentados em um combobox destacando o modelo do contrato, bilhetagem ou licença, por exemplo.

 

Ao clicar em Solicitar licença, aparecerá uma mensagem informativa em tela, com mais informações sobre o tipo de contrato selecionado e a forma de cobrança do mesmo. Ao finalizar o processo aparecerá uma mensagem em tela, indicando o sucesso ou falha na solicitação de licença.

Através dessa tela de módulos contratados também é possível bloquear uma licença. O bloqueio é temporário, onde a licença continuará sendo cobrada normalmente. O processo de bloqueio poderá ser revertido pelo usuário parceiro a qualquer momento.

 

Por fim, através da tela de Módulos contratados o Parceiro também conseguirá efetuar o cancelamento de suas licenças, como demonstra a imagem a seguir.

 

É importante destacar que o cancelamento da licença é permanente, onde a partir do próximo mês essa licença não será mais cobrada. Esse processo deve ser executado apenas para emissores que não irão mais utilizar o sistema, e só pode ser revertido através da solicitação de uma nova licença.

Ao optar por cancelar todas as licenças a cobrança também será interrompida a partir do próximo mês, e o acesso dos usuários ao InvoiCy será bloqueado permanentemente.

É importante destacar que esse processo de licenciamento das empresas também pode ser executado via Web Service. Para mais informações leia o artigo Licenciamento das empresas via Web Service.