API e uso dos dados

Como obter o código IBGE do município pelo CNPJ?

O código IBGE deve corresponder ao município do estabelecimento identificado pelo CNPJ completo. Na API do CFO, a consulta de dossiê retorna esse identificador em data.endereco.codigo_ibge, junto do município e da UF. O código possui sete dígitos e deve ser conferido antes de preencher o cadastro de um ERP. Quando o campo vier vazio, a integração deve registrar a ausência e verificar sua causa.

Publicado em · Atualizado em

Fatos e fontes

Como consultar o código na API do CFO?

A operação indicada é resource=empresa, usando o CNPJ completo da unidade. A busca de empresas serve para localizar candidatos; o dossiê fornece o endereço detalhado.

  1. Conferir o CNPJ do estabelecimento no documento que será usado no cadastro. Guardar o identificador como texto, preservando zeros e letras.
  2. Fazer uma requisição autenticada à operação de dossiê. Manter a credencial no servidor da integração.
  3. Verificar o status HTTP e o CNPJ retornado antes de ler data.endereco.codigo_ibge.
  4. Conferir município, UF e código. Salvar a origem do dado, a referência da base e a data da consulta em campos próprios.

Formato ilustrativo da requisição. O marcador CNPJ_DO_ESTABELECIMENTO deve ser substituído pelo identificador real; a autenticação e as cotas estão na documentação da operação.

GET /api?resource=empresa&cnpj=CNPJ_DO_ESTABELECIMENTO
Authorization: Bearer SUA_CHAVE

Como mapear o retorno para o ERP?

O campo de destino deve receber o código da tabela esperada pelo ERP. O trecho abaixo é ilustrativo e mostra apenas parte do endereço; não representa uma consulta a uma empresa real. O código municipal de São Paulo pode ser conferido na API oficial do IBGE.

{
  "data": {
    "endereco": {
      "municipio": "São Paulo",
      "uf": "SP",
      "codigo_ibge": "3550308"
    }
  }
}
Campos do endereço no cadastro de destino
Origem no dossiêDestino sugeridoConferência
data.endereco.codigo_ibgeCódigo IBGE do municípioSete dígitos e correspondência com município e UF
data.endereco.municipio e ufMunicípio e estadoConservar os dois campos junto do código
data.endereco.cepCEPManter em campo próprio
data.endereco.complementoComplemento do endereçoTratar campo vazio sem apagar informação validada

O código de município da Receita é o mesmo do IBGE?

As duas tabelas devem ser identificadas pela origem. O CFO faz a correspondência entre o código de município da Receita e o do IBGE antes de preencher codigo_ibge. Acrescentar zeros ao código de outra tabela não realiza essa conversão. A conferência deve usar o identificador IBGE acompanhado de município e UF.

O que fazer quando codigo_ibge vier null?

O valor nulo indica ausência do código no retorno. Segundo a documentação do CFO, isso pode ocorrer para estabelecimento no exterior ou para código de origem sem correspondência válida. A integração deve conservar o cadastro recebido, sinalizar a pendência e conferir o endereço. Preencher com zero ou copiar o código da matriz pode atribuir outro município à unidade.

Esse código basta para preencher uma NFS-e?

Ele ajuda a identificar o município do endereço cadastral da unidade consultada. O preenchimento de uma nota também exige identificar o papel da empresa na operação e conferir os demais campos do leiaute. Local da prestação e município de incidência precisam de sua própria conferência. Os manuais e anexos vigentes estão no Portal Nacional da NFS-e.

O procedimento de integração com CRM e ERP explica como preservar dados validados e tratar erros antes de gravar a atualização.

Aplicar esta consulta no CFO

O código IBGE está no dossiê da API REST, que exige autenticação e segue a cota de empresas do plano. Há acesso Free com cotas; a prévia pública simplificada não exibe esse campo.

Fontes e orientações conferidas em . Exemplos identificados como hipotéticos ou ilustrativos não representam consultas a empresas reais.