# Depreciações

Esta página consolida todas as rotas e parâmetros depreciados ao longo do tempo em nossa API.

Refira-se aos indicadores de compatibilidade para saber se há uma alternativa imediata:

Tipo Descrição
Compatível A alternativa é aplicada automaticamente
Parcial A alternativa é aplicada automaticamente, entretanto problemas podem ocorrer em casos de borda
Depreciado Não há alternativa

# Rotas

# GET /companies/:taxId

Parcial

Descrição
Consulta unificada a Receita Federal, Simples Nacional e Inscrições Estaduais utilizando como parâmetro o CNPJ da empresa.

Motivo
Embora tenha sua praticidade, o padrão gera confusão sobre a idade dos dados e foi implementado sobre uma modelagem que restringe a expansão de novas funcionalidades.

Alterações

  • As consultas serão redirecionadas a /office/:taxId e seu retorno transformado ao contrato JSON antigo.
  • Os links presentes no retorno passam a expirar em 90 dias contados da data de consulta
  • A propriedade partnership (empresas relacionadas) será sempre uma matriz vazia
  • Os dados de endereço passam a conter acentuação

Substituto

Parâmetro Descrição
taxId
Obrigatório
CNPJ sem pontuação

Query

Parâmetro Descrição
company_max_age Máximo de dias que um dado da Receita Federal é aceito em cache
sintegra_max_age Máximo de dias que um dado do Cadastro de Contribuintes é aceito em cache
simples_max_age Máximo de dias que um dado do Simples Nacional é aceito em cache
enable_cache_fallback Em caso de erro permite que o dado mais recente em cache seja retornado

Exemplos

/companies/37335118000180
{
  "last_update": "2021-07-08T18:10:55.000Z",
  "name": "CNPJA TECNOLOGIA LTDA",
  "alias": "CNPJA",
  "tax_id": "37335118000180",
  "type": "MATRIZ",
  "founded": "2020-06-05",
  "size": "ME",
  "capital": 1000,
  "email": "meucnpj@contabilizei.com.br",
  "phone": "(41) 9686-9828",
  "phone_alt": null,
  "federal_entity": null,
  "registration": {
    "status": "ATIVA",
    "status_date": "2020-06-05",
    "status_reason": null,
    "special_status": null,
    "special_status_date": null
  },
  "address": {
    "street": "AVENIDA BRIG FARIA LIMA",
    "number": "2369",
    "details": "CONJ 1102",
    "zip": "01452922",
    "neighborhood": "JARDIM PAULISTANO",
    "city": "SÃO PAULO",
    "state": "SP",
    "city_ibge": "3550308",
    "state_ibge": "35"
  },
  "legal_nature": {
    "code": "2062",
    "description": "Sociedade Empresária Limitada"
  },
  "primary_activity": {
    "code": "6311900",
    "description": "Tratamento de dados, provedores de serviços de aplicação e serviços de hospedagem na Internet"
  },
  "secondary_activities": [
    {
      "code": "6201501",
      "description": "Desenvolvimento de programas de computador sob encomenda"
    },
    {
      "code": "6201502",
      "description": "Web desing"
    },
    {
      "code": "6202300",
      "description": "Desenvolvimento e licenciamento de programas de computador customizáveis"
    },
    {
      "code": "6203100",
      "description": "Desenvolvimento e licenciamento de programas de computador não customizáveis"
    },
    {
      "code": "6204000",
      "description": "Consultoria em tecnologia da informação"
    },
    {
      "code": "6209100",
      "description": "Suporte técnico, manutenção e outros serviços em tecnologia da informação"
    },
    {
      "code": "6319400",
      "description": "Portais, provedores de conteúdo e outros serviços de informação na Internet"
    },
    {
      "code": "6399200",
      "description": "Outras atividades de prestação de serviços de informação não especificadas anteriormente"
    },
    {
      "code": "8599603",
      "description": "Treinamento em informática"
    }
  ],
  "membership": [
    {
      "name": "ETIENNE RODRIGUES BECHARA",
      "tax_id": "***538418**",
      "role": {
        "code": "49",
        "description": "Sócio-Administrador"
      }
    },
    {
      "name": "CAMILA PEDROSA ALVES",
      "tax_id": "***708668**",
      "role": {
        "code": "22",
        "description": "Sócio"
      }
    }
  ],
  "partnership": [],
  "simples_nacional": {
    "last_update": "2021-07-05T13:05:53.397Z",
    "simples_optant": true,
    "simples_included": "2020-06-05",
    "simples_excluded": null,
    "simei_optant": false
  },
  "sintegra": {
    "last_update": "2021-07-05T13:05:53.646Z",
    "home_state_registration": null,
    "registrations": []
  },
  "files": {
    "registration": "https://api.cnpja.com.br/files/eyJ1Ij...kNSIn0",
    "membership": "https://api.cnpja.com.br/files/eyJ1Ij...kNNIn0"
  },
  "maps": {
    "roads": "https://api.cnpja.com.br/files/eyJ1Ij...kdSIn0",
    "satellite": "https://api.cnpja.com.br/files/eyJ1Ij...kdTIn0",
    "street": "https://api.cnpja.com.br/files/eyJ1Ij...kdUIn0"
  }
}

# GET /file/:token

Depreciado

Descrição
Disponibiliza um link público para acesso a arquivos delegando a cobrança para uma conta específica.

Motivo
Os tokens não são assinados nem restringem a qual recurso o usuário tem acesso.

Alterações
Chamadas a esta rota retornarão erro 404.

Substituto
Para gerar links públicos o usuário deve utilizar Assinatura de URLs.


# GET /me/requests

Depreciado

Descrição
Retorna o histórico de consultas do usuário permitindo filtros e paginação.

Motivo
O uso em massa desta consulta degradava a performance do sistema.

Alterações
Chamadas a esta rota retornarão erro 404.

Substituto
Oferecemos um dashboard online contendo todas as estatísticas e filtros necessários para analisar sua utilização:

Dashboard de Consultas


# Parâmetros

# GET /office/:taxId

&embeds={SIMPLES|CCC}

Compatível

Descrição
Determina quais portais adicionais a incluir na consulta de Estabelecimento.

Motivo
Gera complexidade desnecessárias tanto para o client como para o server.

Alterações
Requisições com embeds=SIMPLES serão transformadas para simples=true, e com embeds=CCC considerarão apenas cccStates (vide a seguir).

Substituto
Parâmetros simples e registrations.

&cccStates={UFs}

Compatível

Descrição
Determina quais UFs buscar as Inscrições Estaduais.

Motivo
Propriedade renomeada para fazer sentido com seu propósito.

Alterações
Requisições com cccStates={UFs} serão transformadas em registrations={UFs}.

Substituto
Parâmetro registrations.