Receita Federal - Simples Nacional

O que é#

Na consulta ao Simples Nacional você verifica, a partir de um CNPJ, se a empresa é optante pelo Simples Nacional e se está enquadrada no SIMEI, incluindo a situação atual, os períodos anteriores e os eventos futuros de cada regime.

Sobre a requisição#

Método: POST

Endereço: https://api.plexi.com.br/api/maestro/simples-nacional/consulta-optante

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
cnpj	string	Sim	CNPJ a ser pesquisado.

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."
    ]
  }
}

Exemplos de retornos do resultado da pesquisa#

Valores possíveis do campo "status"

Status	Significado
optante	Optante pelo Simples Nacional
negativo	NÃO optante pelo Simples Nacional
erro	Erro ao buscar informações, seja por documento ou outro dado incorreto

Respostas com registro encontrado

JSON

{
  "status": "optante",
  "nomeEmpresa": "EMPRESA LTDA",
  "cnpj": "99.999.999/9999-99",
  "situacaoAtual": {
    "simplesNacional": "Optante pelo Simples Nacional desde 01/01/2020",
    "simei": "NÃO enquadrado no SIMEI"
  },
  "periodosAnteriores": {
    "simplesNacional": [],
    "simei": []
  },
  "eventosFuturos": {
    "simplesNacional": "Não Existem",
    "simei": "Não Existem"
  },
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}

JSON

{
  "status": "negativo",
  "nomeEmpresa": "EMPRESA LTDA",
  "cnpj": "99.999.999/9999-99",
  "situacaoAtual": {
    "simplesNacional": "NÃO optante pelo Simples Nacional",
    "simei": "NÃO enquadrado no SIMEI"
  },
  "periodosAnteriores": {
    "simplesNacional": [],
    "simei": []
  },
  "eventosFuturos": {
    "simplesNacional": "Não Existem",
    "simei": "Não Existem"
  },
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}

Resposta com erro

JSON

{
  "status": "erro",
  "mensagem": "CNPJ não encontrado na base.",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}