Skip to main content
GET
Cobertura da NFS-e por município

Authorizations

Authorization
string
header
required

Token JWT obtido via /v1/auth/login

Path Parameters

ibge
string
required

Código IBGE do município (7 dígitos)

Pattern: ^[0-9]{7}$

Query Parameters

ambiente

1=Produção, 2=Produção Restrita. Default: ambiente fiscal do primeiro emissor do parceiro autenticado, ou 1 sem emissor cadastrado.

Allowed value: "1"
atualizar
enum<string>

true força reconsulta ao ADN (ignora o TTL do espelho) usando um certificado do parceiro autenticado, quando disponível.

Available options:
true,
false

Response

{ ibge, ambiente, situacao, aderente, desde, fonte, detalhes, motivo? }

ibge
string
required
ambiente
required
situacao
enum<string>
required
Available options:
aderente,
nao_aderente,
desconhecido
aderente
boolean | null
required
desde
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
fonte
string
required
detalhes
object
required
motivo
string