GET/nfse/cidades/{codigoIbge}

Consultar disponibilidade do município e metadados

Consulta através do código IBGE, a disponibilidade para emissão, e algumas de suas particularidades. Cenários de uso: - Quero verificar quais municípios já são atendidos pela API, para informar ao meu time comercial e/ou cliente. - Quero obter mais informações sobre o município que vou utilizar, para dar mais intel Observações: - Essa rota é atualizada constantemente, fornecendo cada vez mais metadados dos municípios. - Um município pertence a somente um PADRAO (fornecedor), caso a prefeitura troque de fornecedor, novos metadados serão disponibilizados para o município.

Produção: https://api.otentecnologia.com.brSandbox: https://api.sandbox.otentecnologia.com.br

Parâmetros

codigoIbge

path · obrigatório

Código IBGE da cidade que será consultada.

Requisição

cURL

curl -X GET 'https://api.otentecnologia.com.br/nfse/cidades/{codigoIbge}' \
  -H 'x-api-key: $OTEN_API_KEY' \
  -H 'Content-Type: application/json'

Respostas

200OK

JSON

{
  "id": 4115200,
  "nome": "Maringá",
  "uf": "PR",
  "padrao": "MARINGA",
  "certificado": true,
  "multiservicos": false,
  "login": false,
  "senha": false,
  "upload": false,
  "sequencial": true,
  "substituicao": true,
  "informacoesComplementares": 0,
  "descricao": 0,
  "padraoNacional": {
    "producao": true,
    "homologacao": true
  }
}

400Bad Request

JSON

{
  "error": {
    "message": "A cidade vinculada ao código IBGE utilizado ainda não foi homologada",
    "data": {
      "id": 4116208,
      "nome": "Morretes",
      "uf": "PR"
    }
  }
}

404Not Found

JSON

{
  "error": {
    "message": "Não localizamos qualquer Cidade com os parâmetros informados",
    "data": {
      "id": "411520"
    }
  }
}