Negócios Redesim - Lista de Clientes

O que é#

A consulta Redesim - Lista de empresas apresenta a listagem de todas as empresas as quais um contador está vinculado.

Esta consulta só está disponível via API

Sobre a requisição#

Método: POST

Endereço: https://api.plexi.com.br/api/maestro/redesim/lista-clientes

URL Base: https://api.plexi.com.br/

Parâmetros do header#

Nome	Tipo	Obrigatório?	Descrição
Authorization	String	Sim	Chave de API gerada no cadastro no Plexi, prefixada com `Bearer`
Callback	String	Não	URL para onde o resultado da requisição será enviado via HTTP POST.

Parâmetros do body#

Nome	Tipo	Obrigatório?	Descrição
certificate	string	Sim	Certificado do contador a ser utilizado para autenticação.

Regras de Validação#

•   certificate: Deve ser fornecido e ser uma string válida.

Estrutura da resposta#

Status	Significado	Descrição	Informações retornadas
201	Created	Solicitação criada	Campo requestId, com o ID da requisição criada.
422	Unprocessable Entity	A solicitação contém erro	Em quais campos houve erro.

Exemplos de retornos quando você faz a requisição#

Status 201

A consulta recebida com sucesso e será processada. Com o ID retornado você pode consultar se já houve resposta.

JSON

{
  "requestId": "1fdd4247-4f98-4113-887a-b182117b0e42"
}

Status 422

Significa que ocorreu um erro de validação dos dados enviados.

JSON

{
  "message": "The given data was invalid.",
  "errors": {
    "cpf": [
      "O campo cpf é obrigatório."
    ],
    "nome": [
      "O campo nome é obrigatório."
    ]
  }
}

Resultados da pesquisa (retornados no callback ou fazendo requisição à API de respostas)#

Resposta com registro encontrado

JSON

{
    "empresas": [
        {
            "cnpj": "99999999999999",
            "nomeEmpresarial": "EMPRESA EXEMPLO LTDA",
            "nomeFantasia": null,
            "uf": "MG",
            "situacaoCadastral": {
                "codigo": 2,
                "descricao": null
            },
            "tipoEstabelecimento": {
                "codigo": 1,
                "descricao": "Matriz"
            },
            "municipio": {
                "codigo": 9999,
                "nome": "CIDADE EXEMPLO"
            },
            "qualificacaoSocio": {
                "codigo": null,
                "descricao": "Pessoa Física"
            },
            "cpfContador": "99999999999",
            "nomePessoaFisicaContador": null,
            "cnpjContador": "99999999999999",
            "nomeEmpresarialContador": null,
            "valorCapitalSocial": null,
            "vinculo": {
                "codigo": 1,
                "descricao": "CONTABILISTA"
            }
        }
    ]
}

Resposta com erro

JSON

{
    "status": "erro",
    "mensagem": "Mensagem de erro"
}