Endpoints de Empresas
Este artigo detalha sobre como realizar os processos de cadastro, consulta, atualização, envio e exclusão do certificado digital, licenciamento, consulta de bilhetagem e consulta do CNPJ SEFAZ da empresa via API REST.
Estes processos exigem o procedimento de autenticação, onde será necessário gerar um token JWT, para que seja possível gerar os tokens "accessToken" e "refreshToken". Em seguida, informe o primeiro token na seção Header no value do "Authorization" dentro da requisição selecionada, conforme segue:
Com o processo de autenticação finalizado, é preciso iniciar o preenchimento dos dados na estrutura de exemplo disponibilizada na seção Body (raw). Em seguida, realize o envio da requisição através da opção "Send" e aguarde o retorno. Por meio destas instruções será possível realizar as seguintes operações:
Cadastrar Empresa
Através desta requisição, é possível incluir uma nova empresa no InvoiCy. Para facilitar o entendimento, acesse a documentação sobre "Cadastrar Empresa".
Também foi desenvolvido um layout de integração para o cadastro de empresas, sendo ele o: Layout de cadastro de empresa.
Consultar Empresa
É possível realizar a consulta de empresas por meio da API REST. Para tal, é necessário que a empresa a ser consultada esteja devidamente cadastrada na base de dados do InvoiCy. Além disso, na seção Params da requisição, deve ser adicionada uma Key "CNPJ" e no campo "Value" informado o CNPJ da empresa a ser consultada.
Nos Params da requisição, deve ser adicionada uma Key "CNPJ" e no campo Value informado o CNPJ da empresa a ser consultada, conforme demonstrado a seguir:
Acesse aqui a documentação no Postman, para obter mais informações sobre como realizar a consulta para as empresas cadastradas no InvoiCy.
Atualizar Empresa
Esta requisição tem como objetivo alterar os dados cadastrais de uma empresa que já consta na base de dados do InvoiCy através da integração API REST. Para facilitar o entendimento, acesse a documentação sobre "Atualizar Empresa".
Certificado Digital
Existem dois tipos de de requisições que podem ser enviadas para o certificado digital, sendo eles: o "Envio Certificado Digital" e o "Excluir Certificado Digital".
A primeira requisição, permite incluir um certificado digital para empresas já existentes na base de dados do InvoiCy, utilizando a integração via API REST. Mais informações sobre este envio podem ser obtidas aqui.
Para referência visual desse processo, consulte o vídeo demonstrativo aqui.
A segunda requisição tem como objetivo excluir, através da integração API REST, o certificado da empresa informada que já consta na base de dados do InvoiCy. Clique aqui para acessar um exemplo de envio para a exclusão do certificado.
Licenciamento
Nesta requisição, o parceiro tem a possbilidade de solicitar as licenças dos módulos de emissão para a empresa conforme o contrato. Sendo possível realizar esse processo através da integração API REST.
Para facilitar o entendimento, acesse a documentação: Licenciamento.
Consultar Bilhetagem
A requisição "Consulta Bilhetagem" permite consultar as informações de bilhetagem das empresas cadastradas na base de dados do InvoiCy, utilizando a integração API REST.
Nos Params da requisição, algumas key’s devem ser adicionadas, segue exemplo:
Clique aqui para ter acesso à requisição de "Consulta Bilhetagem".
Consulta CNPJ SEFAZ
A requisição "Consulta CNPJ SEFAZ" tem como intuito consultar o cadastro de empresas perante a SEFAZ, através da integração API REST. Nos Params da requisição, algumas key’s devem ser adicionadas, segue exemplo:
Para mais informações sobre como realizar a consulta CNPJ SEFAZ, acesse aqui a documentação no Postman.