Esse artigo explica como você pode realizar o gerenciamento das empresas cadastradas nos grupos do Manager SaaS.
Para saber como gerenciar Grupos via API, acesse este artigo.
Cadastro de empresa
Para realizar o cadastro de empresa, primeiro é necessário ter obtido o token e ter cadastrado o grupo no qual a empresa será criada, assim como ter o handle do mesmo. Após isso, é preciso realizar uma requisição POST na rota abaixo, lembrando que se deve informar o token:
POST
https://managersaas.tecnospeed.com.br:1337/api/v1/empresa?token=6zl7aiaxfdhen4s4i1514552593339
Os parâmetros se dividem em três grupos:
- Informações do grupo: O handle do grupo será informado no parâmetro idgrupo, em idUF o código da UF e o código da cidade (para as emissões de NFS-e);
- Informações da empresa: Deve-se informar a situação (0=Ativo ou 1=Bloqueado), o CNPJ, Razão Social, Identificação, Descrição, Inscrição Estadual, Inscrição Municipal, endereço, telefone certificado;
- Informações para a liberação de licença: Para a liberação de licença, deve-se informar o documento e a situação do contrato, por exemplo nfce[situacao] =1 e nfce[tipocontrato]=1, onde:
- Tipo de Contrato pode ser Bilhetagem=0 ou Ilimitado=1.
- Situação pode ser Ativo=0 ou Inativo=1.
Não é necessário informar todos os documentos como no exemplo do Postman.
Atenção! Os parâmetros obrigatórios na requisição são:
- idgrupo
- iduf (Não utilize os códigos do IBGE, utilize a requisição Listar UF's no final deste link)
- idcidade
- cnpj
- razaosocial
- identificacao
- descricao
- inscricaomunicipal (Apenas para NFS-e)
OBS.: A partir do mês de setembro de 2019, o campo "iduf" não será obrigatório. O campo "idcidade" irá suprir a necessidade do mesmo. Também a partir desta data, o campo "idcidade" poderá ser preenchido com o Código IBGE referente a cidade de cadastro.
Cadastrando empresa que usará o certificado A3
Obs: Disponível apenas para NFe e NFCe:
Caso a empresa cadastrada vá utilizar o certificado A3 para assinatura das notas, deve-se adicionar os três seguintes campos na sua requisição:
removercertificado=false
selecionaA3Saas=true
selecionaCertiSAT=false
Cadastrando empresa que usará o certificado A1
Caso a empresa cadastrada vá utilizar o certificado A1 para assinatura das notas, deve-se adicionar os três seguintes campos na sua requisição:
certificadobinario=(informar o certificado)
tipocertificado=FILE
senhacertificado=(informar a senha do certificado)
Retorno
O retorno da requisição será no formato a seguir:
{
"mensagem": "Cadastro efetuado com sucesso",
"dados": {
"handle": 5449,
"idgrupo": 3425,
"cnpj": "60642435000161",
"identificacao": "testeapi",
"descricao": "testeapi",
"certificado": null,
"iduf": 21,
"idcidade": 4120,
"inscricaomunicipal": "12345",
"inscricaoestadual": "12345",
"tipocertificado": "CURRENT_USER_STORE",
"pincode": null,
"razaosocial": "testeapi",
"endereco": "Av. TesteAPI",
"telefone": "4433000033",
"email": null,
"criadoem": "2017-12-29T14:22:25.000Z",
"atualizadoem": "2017-12-29T14:22:25.000Z",
"standby": null,
"nfe": false,
"nfce": false,
"mdfe": false,
"cte": false,
"nfse": false,
"cfesat": false,
"situacao": 0,
"gnre": false,
"datainativacao": null,
"motivo": null,
"dtentradastandby": null,
"dtsaidastandby": null,
"dtvencimentocertificado": null,
"hashcertificado": null,
"cteos": false
}
}
Em anexo, exemplo em PHP.
Alterar dados da empresa
Os dados que foram cadastrados podem ser alterados por meio de uma requisição PUT na rota a seguir, na qual será informado o handle da empresa como parte da URL (no exemplo, 5449):
PUT
https://managersaas.tecnospeed.com.br:1337/api/v1/empresa/5449?token=6zg9mjudrqe86ko6r1514568674381
Os dados da empresa que serão alterados devem ser passados como parâmetro no body da requisição. Por exemplo:
Retorno
O retorno trará todos os dados da empresa, incluindo os alterados. Por exemplo:
{
"mensagem": "Cadastro atualizado com sucesso",
"dados": {
"handle": 5449,
"idgrupo": 3425,
"iduf": 21,
"idcidade": 4120,
"cnpj": "60642435000161",
"identificacao": "testeapi",
"descricao": "testeapi",
"certificado": null,
"inscricaomunicipal": "12345",
"inscricaoestadual": "12345",
"tipocertificado": "CURRENT_USER_STORE",
"pincode": null,
"razaosocial": "testeapi",
"endereco": "Av. TesteAPI",
"telefone": "4433000033",
"email": null,
"criadoem": "2017-12-29T14:22:25.000Z",
"atualizadoem": "2017-12-29T18:06:47.000Z",
"nfe": false,
"nfce": false,
"mdfe": false,
"cte": false,
"nfse": false,
"cfesat": false,
"gnre": false,
"cteos": false,
"situacao": 0,
"datainativacao": null,
"motivo": null,
"hashcertificado": null,
"dtvencimentocertificado": null
}
}
Consultar empresas cadastradas
Para realizar a consulta das empresas cadastradas, é necessário informar o Token e o id do grupo (que é o handle recebido na consulta anterior) e enviar a seguinte requisição GET:
GET
https://managersaas.tecnospeed.com.br:1337/api/v1/empresa?token=6zg9mjudrqe86ko6r1514568674381&idgrupo=3425&skip=0&limit=10&sort=identificacao
Os parâmetros da requisição são:
| Nome | Descrição |
| token | Token da Software House. |
| idgrupo | Número de identificação do grupo. (Handle) |
| skip | Indica de qual registro o resultado deve ser retornado. Por exemplo: Numa consulta de 7 empresas no total, utilizando o skip = 2 será retornado 5 registros (os dois primeiros serão ignorados). |
| limit | Limita o número de registros da consulta. |
| sort | Utilizado para indicar uma coluna para ordenação. Por exemplo: identificacao ou handle |
| cnpj | CNPJ da Empresa a ser consultada no Grupo |
Retorno
O retorno trará todas as empresas cadastradas no grupo e as informações das mesmas, como por exemplo:
{
"mensagem": "Registros retornados com sucesso",
"dados": [
{
"handle": 5449,
"idgrupo": 3425,
"iduf": 21,
"idcidade": 4120,
"cnpj": "60642435000161",
"identificacao": "testeapi",
"descricao": "testeapi",
"certificado": null,
"inscricaomunicipal": "12345",
"inscricaoestadual": "12345",
"tipocertificado": "CURRENT_USER_STORE",
"pincode": null,
"razaosocial": "testeapi",
"endereco": "Av. TesteAPI",
"telefone": "4433000033",
"email": null,
"criadoem": "2017-12-29T14:22:25.000Z",
"atualizadoem": "2017-12-29T14:22:25.000Z",
"nfe": false,
"nfce": false,
"mdfe": false,
"cte": false,
"nfse": false,
"cfesat": false,
"gnre": false,
"cteos": false,
"situacao": 0,
"datainativacao": null,
"motivo": null,
"hashcertificado": null,
"dtvencimentocertificado": null
}
],
"total": 1
}
Exemplo retorno de empresas não encontradas:
Veja também o post: Gerenciando Grupos Via API
Comentários
0 comentário
Por favor, entre para comentar.