Endpoint utilizado para consultar quais informações fiscais a prefeitura do município exige para emissão de notas fiscais.

Essa chamada deve ser o primeiro passo da integração fiscal, pois nem todas as prefeituras exigem os mesmos dados. A resposta informa quais campos precisam ser preenchidos posteriormente no endpoint de criação ou atualização das informações fiscais.

A consulta considera a cidade cadastrada no CNPJ da conta.

Informações retornadas

A resposta pode incluir os seguintes campos:

• authenticationType - Informa qual é o tipo de autenticação exigido pela prefeitura para emissão de notas fiscais.

Os valores possíveis são:

• CERTIFICATE - A prefeitura exige certificado digital.

• TOKEN - A prefeitura exige token de acesso.

• USER_AND_PASSWORD - A prefeitura exige usuário e senha.

• supportsCancellation - Informa se a prefeitura permite cancelamento automático de notas fiscais via integração.

• usesSpecialTaxRegimes - Informa se o município exige o envio de regime especial de tributação. Quando esse campo for true, o valor deve ser enviado no atributo specialTaxRegime ao criar ou atualizar as informações fiscais.

• usesServiceListItem - Informa se o município exige o item da lista de serviço. Quando esse campo for true, o valor deve ser enviado em serviceListItem.

• specialTaxRegimesList - Lista de regimes especiais aceitos pela prefeitura. Cada item normalmente contém:

  • label - Nome exibido do regime.
  • value - Identificador que deve ser enviado na API.

• municipalInscriptionHelp - Texto de apoio com orientações sobre o formato esperado para a inscrição municipal.

• specialTaxRegimeHelp - Texto de apoio sobre o preenchimento do regime especial de tributação.

• serviceListItemHelp - Texto de apoio sobre o item da lista de serviço.

• digitalCertificatedHelp - Texto de apoio sobre o certificado digital.

• accessTokenHelp - Texto de apoio sobre o token exigido pela prefeitura.

• municipalServiceCodeHelp - Texto de apoio sobre o formato do código de serviço municipal.

🚧

Atenção

Cada prefeitura possui regras próprias para emissão de notas fiscais.

• Alguns municípios exigem autenticação via certificado digital, enquanto outros utilizam token ou usuário e senha.
• Campos como specialTaxRegime e serviceListItem podem ser obrigatórios dependendo da configuração retornada.
• Recomenda-se sempre consultar este endpoint antes de configurar ou atualizar as informações fiscais da conta.

Importância da consulta

Esse endpoint é importante porque evita tentativas de configuração com campos incorretos, inválidos ou desnecessários.

A utilização prévia dessa consulta reduz falhas no processo de emissão fiscal e garante que a integração envie apenas as informações exigidas pela prefeitura do município correspondente.