Pular para o conteúdo
notemnotemDocumentação

Referência da API › Situação da empresa

Verificar município

Consulta no governo se o município da empresa aceita a NFS-e nacional e atualiza a situação.

POST/api/v1/empresas/{id}/situacao/verificar-municipio

Use quando a situação indicar que o convênio do município ainda não foi verificado. A consulta usa o certificado da empresa, que precisa estar válido.

Pode ser feita uma vez por minuto por empresa e ambiente. Antes disso, a resposta é 429, com o tempo de espera no cabeçalho Retry-After.

Parâmetros

idtextono caminhoobrigatório
Empresa da organização da chave (de outra organização → 404). UUID (RFC 9562); fora do padrão → 400 REQUISICAO_INVALIDA com campo id. · UUID
Idempotency-Keytextono cabeçalho
Chave de idempotência (até 100 caracteres) aceita em POST, PATCH, PUT e DELETE; vale 24 h por integração e ambiente, exceto emissão, cancelamento, análise e substituição de notas (associação duradoura ao pedido). Mesmo conteúdo devolve a mesma resposta (cabeçalho Idempotent-Replayed true); conteúdo diferente devolve 409 IDEMPOTENCIA_CONFLITO. Obrigatória em emissão, cancelamento e substituição. · até 100 caracteres

Respostas

200 Situação atualizada

Campos da resposta
ambientetexto
Valores: homologacao, producao
pronta_para_emitirbooleano
itenslista de objeto
itens[].itemtexto
Valores: empresa_ativa, certificado, configuracao_fiscal, servico_ativo, classificacao_ibscbs, municipio
itens[].okbooleano ou null
itens[].mensagemtexto
itens[].verificado_emtexto ou null
data e hora ISO 8601
avisoslista de objeto
Alertas que não impedem a emissão. Antes da data de obrigatoriedade do IBS/CBS do ambiente (padrão 01/01/2027), serviços ativos sem classificação geram aviso; a partir dela viram o item classificacao_ibscbs.
avisos[].itemtexto
Valores: classificacao_ibscbs, atividade_simples
avisos[].mensagemtexto
pendenciaslista de texto
Lista dos item com ok diferente de true.

404 Erro no formato padrão

422 REGRA_DE_NEGOCIO — exige certificado válido

429 LIMITE_EXCEDIDO — 1 por minuto por empresa e ambiente; ver Retry-After

Cabeçalho Retry-After: segundos até poder tentar de novo.

Limites

Esta operação: 1 por minuto por empresa e ambiente. Valem também os limites gerais da chave. Veja Limites de uso.