Consultando Empresa cadastradas no grupo via API de Administração do Manager SaaS – Central de Atendimento

Para consultar as empresas cadastradas em um grupo, é necessário informar o Token e o ID do Grupo (também chamado de handle, recebido na consulta anterior) e realizar a seguinte requisição GET:

GET

https://managersaas.tecnospeed.com.br:1337/api/v1/empresa?token=6zg9mjudrqe86ko6r1514568678381&idgrupo=3245&skip=0&limit=10&sort=identificacao

Parâmetros da requisição:

Nome	Descrição
token	Token da Software House.
idgrupo	Identificador numérico do grupo (handle).
skip	Define a partir de qual registro o retorno deve começar. Exemplo: se existem 7 empresas no total e `skip=2`, serão retornados apenas os 5 últimos registros (os dois primeiros serão ignorados).
limit	Quantidade máxima de registros que serão retornados.
sort	Campo utilizado para ordenar o resultado. Exemplos: `identificacao` ou `handle`.

Para consultar uma empresa específica, adicione também o parâmetro:

Nome	Descrição
cnpj	CNPJ da empresa a ser consultada.

Retorno

O retorno trará a lista de empresas cadastradas no grupo, com suas respectivas informações. Exemplo de resposta bem-sucedida:

{
  "mensagem": "Registros retornados com sucesso",
  "dados": [
    {
      "handle": 5449,
      "iduf": 21,
      "idcidade": 4120,
      "idgrupo": 3425,
      "cnpj": "60642435000161",
      "identificacao": "IDENTIFICAÇÃO DA EMPRESA",
      "descricao": "DESCRIÇÃO DA EMPRESA",
      "certificado": "CN=INFORMAÇÃO DO CERTIFICADO",
      "inscricaomunicipal": "000",
      "inscricaoestadual": "0000000000",
      "tipocertificado": null,
      "pincode": null,
      "razaosocial": "EMPRESA.LTDA",
      "endereco": "RUA",
      "telefone": null,
      "email": "teste@gmail.com",
      "criadoem": "2022-06-30T17:51:51.148Z",
      "atualizadoem": "2022-08-24T12:00:00.455Z",
      "nfe": {
        "situacao": 0, // Documento ativo
        "tipocontrato": 0,
        "motivo": "",
        "dataativacao": "2022-06-30T17:51:51.297Z",
        "datainativacao": null
      },
      "nfse": {
        "situacao": 1, // Documento inativo
        "tipocontrato": 0,
        "motivo": null,
        "dataativacao": null,
        "datainativacao": null
      },
      "nfce": {
        "situacao": -1, // Nunca foi ativo
        "tipocontrato": 0,
        "motivo": "",
        "dataativacao": "2022-06-30T17:51:51.000Z",
        "datainativacao": null
      },
      "situacao": 0,
      "datainativacao": null,
      "motivo": "",
      "hashcertificado": null,
      "dtvencimentocertificado": "2023-08-18T19:38:36.000Z",
      "multicidades": null
    }
  ],
  "total": 1
}

Exemplo de retorno quando nenhuma empresa é encontrada:

{
  "mensagem": "Grupo não encontrado"
}

GET

Retorno

Artigos relacionados