Municípios

Verificar se a cidade é atendida

GET https://apifiscal.weesy.com.br/v1/municipios/{codigoIbge}

Antes de cadastrar uma empresa, confira se emitimos notas na cidade dela. A resposta também diz se a prefeitura tem ambiente de testes e se exige certificado. Cidade não atendida vem com atendido: false — não é um erro.

Parâmetros

Nome	Onde	Tipo	Descrição
codigoIbge obrigatório	caminho	string	Código IBGE do município consultado.

Exemplo de chamada

cURLcurl --request GET \
  --url "https://apifiscal.weesy.com.br/v1/municipios/3547809" \
  --header "Authorization: Bearer $WEESY_TOKEN"

Node.jsconst resposta = await fetch("https://apifiscal.weesy.com.br/v1/municipios/3547809", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.WEESY_TOKEN}`,
  },
});
console.log(resposta.status, await resposta.text());

Pythonimport os

import requests

resposta = requests.get(
    "https://apifiscal.weesy.com.br/v1/municipios/3547809",
    headers={"Authorization": f"Bearer {os.environ['WEESY_TOKEN']}"},
    timeout=30,
)
print(resposta.status_code, resposta.text)

PHP<?php

$contexto = stream_context_create(["http" => [
    "method" => "GET",
    "header" => implode("\r\n", ["Authorization: Bearer " . getenv("WEESY_TOKEN")]),
    "ignore_errors" => true, // lê o corpo também nas respostas de erro
]]);
$resposta = file_get_contents("https://apifiscal.weesy.com.br/v1/municipios/3547809", false, $contexto);
echo $http_response_header[0], PHP_EOL, $resposta, PHP_EOL;

C#using System.Net.Http.Headers;

using var http = new HttpClient();
http.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("WEESY_TOKEN"));

using var resposta = await http.GetAsync("https://apifiscal.weesy.com.br/v1/municipios/3547809");
Console.WriteLine($"{(int)resposta.StatusCode} {await resposta.Content.ReadAsStringAsync()}");

Respostas

200: Capacidades do município.
400: Algum dado está errado ou faltando. A lista erros diz qual campo e o que corrigir (code = validacao). (formato de erro)
401: Token ausente, errado ou revogado (credencialinvalida). Confira o cabeçalho Authorization. (formato de erro)

Campos da resposta 200

Campo Tipo Descrição

codigoIbge
obrigatório

string

Código IBGE do município consultado.

nome
obrigatório

string

Nome do município consultado.

uf
obrigatório

string

Sigla da unidade federativa.

atendido
obrigatório

boolean

A Weesy emite NFS-e neste município. false = os demais campos vêm ausentes.

padrao

string

O sistema de NFS-e que a prefeitura usa. Novos valores podem aparecer: trate valor desconhecido sem quebrar.

Valor	Significado
`nacional`	NFS-e Nacional (Sefin Nacional / ADN)
`gissonline`	GissOnline (ABRASF 2.04)
`ginfes`	Ginfes
`sao_paulo`	Nota Paulistana (São Paulo)
`barueri`	Barueri

homologacaoDisponivel

boolean

A prefeitura tem ambiente de testes. Se for false, teste com ambiente: simulacao.

exigeCertificado

boolean

A prefeitura exige o certificado digital A1 da empresa para emitir.

cancelamentoPrazoDias

integer ou null

Prazo de cancelamento pela API, em dias após a emissão. null = sem prazo conhecido.

observacao

string

Regra relevante do município, em texto.

Exemplo de resposta 200

JSON

{
  "codigoIbge": "3547809",
  "nome": "Santo André",
  "uf": "SP",
  "atendido": true,
  "padrao": "gissonline",
  "homologacaoDisponivel": false,
  "exigeCertificado": true,
  "cancelamentoPrazoDias": null,
  "observacao": "Simples Nacional (ME/EPP) emite no padrão Nacional a partir de 01/11/2026."
}

← Voltar ao início