Nfse.Parametros (nfse v0.1.0)

Copy Markdown View Source

Parâmetros municipais do ADN: como o município configurou o sistema nacional (convênio, alíquotas por serviço, regimes especiais, retenções e benefícios). As funções são expostas por Nfse.

São consultas de leitura em GET /parametrizacao/.... Cada função devolve o objeto de dentro da resposta (parametrosConvenio, aliquotas, regimesEspeciais, retencoes ou beneficio), com as chaves da API como vieram. Uma resposta 200 sem esse objeto é :unexpected. Quando o município não tem o dado, o ADN responde 404 com a mensagem no corpo, que vira :not_found com a mensagem em messages.

Os POST .../{idManut} de alteração são operações do próprio município e ficam fora da biblioteca.

Formatos medidos em produção (25/10/2026)

  • o código de serviço vai com pontos, 01.04.01.000; sem eles a API responde 400. A biblioteca aceita os nove dígitos com ou sem pontos e monta o formato da API
  • a competência é um Date e vai como 2026-11-01T00:00:00
  • o código do município é o de sete dígitos do IBGE

O que não está confirmado

  • as chaves beneficio e regimesEspeciais: o swagger não as mostra e nenhuma resposta com sucesso foi vista; a biblioteca assume esses nomes