Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Current »

O que é

A Receita Federal do Brasil (RFB), em cumprimento às determinações contidas no Decreto nº 8.777, de 11 de maio de 2016, disponibiliza, os dados referentes aos quadros societários e de administradores das pessoas jurídicas.

Sobre a requisição:

Método: POST

Endereço: URL Base + /api/maestro/receita/qsa

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

cpfCnpj

string

Sim

CPF ou CNPJ de login

senha

string

Sim

Senha para login

sql

string

Sim

Número do cadastro do imóvel (também chamado de número do contribuinte ou SQL)

anoExercicio

string

Sim

Ano de exercício do IPTU

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.

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

Status 422

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

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

Exemplos de retornos do resultado da pesquisa

Valores possíveis do campo “status“

Status

Significado

cadastrado

Empresa encontrada

erro

Empresa não encontrada.

Respostas com registro encontrado

{
    "status": "cadastrado",
    "empresa": {
        "cnpjBasico": "99999999",
        "naturezaJuridica": "Sociedade Empresária Limitada",
        "porte": "DEMAIS",
        "qualificacaoResponsavel": "Administrador",
        "razaoSocial": "EMPRESA LTDA.",
        "capitalSocial": 9999999.00
    },
    "socios": [
        {
            "cpfCnpjRepresentanteLegal": "***000000**",
            "identificadorSocio": "PESSOA FÍSICA",
            "faixaEtaria": "Entre 41 a 50 anos",
            "cnpjBasico": "99999999",
            "qualificacaoSocio": "Administrador",
            "qualificacaoRepresentante": "Não informada",
            "nome": "FULANO FERRAZ",
            "dataEntradaSociedade": "20220502",
            "cpfCnpj": "***999999**"
        },
        {
            "cpfCnpjRepresentanteLegal": "***000000**",
            "identificadorSocio": "PESSOA FÍSICA",
            "faixaEtaria": "Entre 31 a 40 anos",
            "cnpjBasico": "99999999",
            "qualificacaoSocio": "Administrador",
            "qualificacaoRepresentante": "Não informada",
            "nome": "FULANO PILOTO",
            "dataEntradaSociedade": "20211116",
            "cpfCnpj": "***999999**"
        },
        {
            "cpfCnpjRepresentanteLegal": "***000000**",
            "identificadorSocio": "PESSOA FÍSICA",
            "faixaEtaria": "Entre 31 a 40 anos",
            "cnpjBasico": "99999999",
            "qualificacaoSocio": "Administrador",
            "qualificacaoRepresentante": "Não informada",
            "nome": "FULANO OLDHAM",
            "dataEntradaSociedade": "20211116",
            "cpfCnpj": "***999999**"
        },
        {
            "cpfCnpjRepresentanteLegal": "***000000**",
            "identificadorSocio": "PESSOA FÍSICA",
            "faixaEtaria": "Entre 41 a 50 anos",
            "cnpjBasico": "99999999",
            "qualificacaoSocio": "Administrador",
            "qualificacaoRepresentante": "Não informada",
            "nome": "FULANO CIRNE",
            "dataEntradaSociedade": "20210824",
            "cpfCnpj": "***999999**"
        },
        {
            "cpfCnpjRepresentanteLegal": "***000000**",
            "identificadorSocio": "PESSOA FÍSICA",
            "faixaEtaria": "Entre 31 a 40 anos",
            "cnpjBasico": "99999999",
            "qualificacaoSocio": "Administrador",
            "qualificacaoRepresentante": "Não informada",
            "nome": "FULANO NAZAR",
            "dataEntradaSociedade": "20210824",
            "cpfCnpj": "***999999**"
        },
        {
            "cpfCnpjRepresentanteLegal": "***000000**",
            "identificadorSocio": "PESSOA FÍSICA",
            "faixaEtaria": "Entre 31 a 40 anos",
            "cnpjBasico": "99999999",
            "qualificacaoSocio": "Administrador",
            "qualificacaoRepresentante": "Não informada",
            "nome": "FULANO DE MELO",
            "dataEntradaSociedade": "20191114",
            "cpfCnpj": "***999999**"
        },
        {
            "cpfCnpjRepresentanteLegal": "***000000**",
            "identificadorSocio": "PESSOA FÍSICA",
            "faixaEtaria": "Entre 31 a 40 anos",
            "cnpjBasico": "99999999",
            "qualificacaoSocio": "Administrador",
            "qualificacaoRepresentante": "Não informada",
            "nome": "FULANO REIS",
            "dataEntradaSociedade": "20191114",
            "cpfCnpj": "***999999**"
        },
        {
            "cpfCnpjRepresentanteLegal": "***000000**",
            "identificadorSocio": "PESSOA FÍSICA",
            "faixaEtaria": "Entre 31 a 40 anos",
            "cnpjBasico": "99999999",
            "qualificacaoSocio": "Administrador",
            "qualificacaoRepresentante": "Não informada",
            "nome": "FULANO HUBER",
            "dataEntradaSociedade": "20180919",
            "cpfCnpj": "***999999**"
        },
        {
            "cpfCnpjRepresentanteLegal": "***000000**",
            "identificadorSocio": "PESSOA FÍSICA",
            "faixaEtaria": "Entre 31 a 40 anos",
            "cnpjBasico": "99999999",
            "qualificacaoSocio": "Administrador",
            "qualificacaoRepresentante": "Não informada",
            "nome": "FULANO GRIGOLETTO",
            "dataEntradaSociedade": "20180919",
            "cpfCnpj": "***999999**"
        },
        {
            "cpfCnpjRepresentanteLegal": "***000000**",
            "identificadorSocio": "PESSOA FÍSICA",
            "faixaEtaria": "Entre 31 a 40 anos",
            "cnpjBasico": "99999999",
            "qualificacaoSocio": "Administrador",
            "qualificacaoRepresentante": "Não informada",
            "nome": "FULANO PENCZ",
            "dataEntradaSociedade": "20180919",
            "cpfCnpj": "***999999**"
        },
        {
            "cpfCnpjRepresentanteLegal": "***999999**",
            "nomeRepresentante": "FULANO HAGENBUCH",
            "identificadorSocio": "PESSOA JURÍDICA",
            "faixaEtaria": "Não se aplica",
            "cnpjBasico": "99999999",
            "qualificacaoSocio": "Sócio Pessoa Jurídica Domiciliado no Exterior",
            "qualificacaoRepresentante": "Procurador",
            "nome": "EMPRESA LLC",
            "dataEntradaSociedade": "20180710",
            "cpfCnpj": "99999999999999",
            "pais": "ESTADOS UNIDOS"
        },
        {
            "cpfCnpjRepresentanteLegal": "***000000**",
            "identificadorSocio": "PESSOA FÍSICA",
            "faixaEtaria": "Entre 31 a 40 anos",
            "cnpjBasico": "99999999",
            "qualificacaoSocio": "Administrador",
            "qualificacaoRepresentante": "Não informada",
            "nome": "FULANO HAGENBUCH",
            "dataEntradaSociedade": "20180611",
            "cpfCnpj": "***999999**"
        }
    ],
    "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}
{
  "status": "cadastrado",
  "empresa": {
		"cnpjBasico": "99999999",
		"naturezaJuridica": "Empresa Domiciliada no Exterior",
		"qualificacaoResponsavel": "Procurador",
		"razaoSocial": "EMPRESA LLC",
		"capitalSocial": 0
  },
  "socios": [],
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}
{
  "status": "cadastrado",
  "empresa": {
		"cnpjBasico": "99999999",
		"naturezaJuridica": "Empresário (Individual)",
		"porte": "MICRO EMPRESA",
		"qualificacaoResponsavel": "Empresário",
		"razaoSocial": "FULANO DA SILVA 99999999999",
		"capitalSocial": 2000
  },
  "socios": [],
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}

Resposta com erro

{
  "status": "erro",
  "mensagem": "Empresa não encontrada.",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}

  • No labels