Rota consulta Cliente Ativo

Nessa rota é possível consultar os clientes ativos para o módulo SPED.

Atenção: só serão retornados clientes com módulo SPED com status ATIVO.

Para utilizar as rotas de manipulação de cliente ( /cliente/ ) é necessário utilizar o token da SH como todas as outras rotas, mas também utilizar o login e senha da SH na Basic Authentication

• Requisição
  • Método HTTP
  • Endpoint
  • Query string
  • Headers
  • Body
• Resposta
  • Retorno de sucesso
  • Retornos de erro

Requisição

Método HTTP

GET

Endpoints

• Consulta geral:
  https://sped.plugstorage.com.br/api/v2/sped/cliente/

• Consulta por CNPJ:
  https://sped.plugstorage.com.br/api/v2/sped/cliente/:cnpj

Query Params

Headers

Obs: Rota especifica para a  Software House

Body

Nenhum.

Exemplos

Consulta por CNPJ:

GET https://sped.plugstorage.com.br/api/v2/sped/cliente/:cnpj?token=99999token

Consulta por SH:

GET https:/p/sped.lugstorage.com.br/api/v2/sped/cliente/?token=99999token

Resposta

Retorno de sucesso

Status code 200

Por CNPJ

{
    "data": {
        "cnpj": "9999999999",
        "tipoSped": [
            "fiscal",
            "contribuicoes"
        ],
        "nomeFantasia": "Teste - Matriz",
        "razaoSocial": "Teste - Matriz",
        "inscricaoEstadual": "1111111",
        "tipoEmpresa": "industria",
        "regimeTributario": "lucro presumido",
        "telefone": "44123549123"
        "dataAtivacao": "2025-07-07T18:05:13.033Z",
        "endereco": {
          "uf": "SP",
          "cidade": "São Paulo",
          "logradouro": "Rua dos testes",
          "numero": "111",
          "cep": "21231233",
          "complemento": "ap 101"          
        }
    }
}

Por SH

{
    "data": [
        {
            "cnpj": "9999999999",
            "dataAtivacao": "2025-07-02T13:14:36.322Z",
            "inscricaoEstadual": "123453445",
            "nomeFantasia": "Teste - Matriz1",
            "razaoSocial": "Teste - Matriz1",
            "tipoEmpresa": "atacado",
            "regimeTributario": "simples",
            
            "tipoSped": [
                "fiscal",
                "contribuicoes"
            ],
        },
        {
            "cnpj": "9999999992",
            "tipoSped": [
                "fiscal",
                "contribuicoes"
            ],
            "nomeFantasia": "Teste - Matriz2",
            "razaoSocial": "Teste - Matriz2",
            "inscricaoEstadual": "12346554645",
            "tipoEmpresa": "industria",
            "regimeTributario": "lucro presumido",
            "dataAtivacao": "2025-07-07T18:05:13.033Z"
        }
    ]
}

Retornos de erro

Status code 400

{
  "error": true,
  "message": "Nenhum(a) cliente localizado(a) com os parâmetros informados."
}

Status code 401

Consulte essa documentação para saber os possíveis retornos de erros de autenticação.