Configurar informações fiscais

Antes de emitir uma Nota Fiscal de Serviço (NFS-e), configure os dados fiscais da conta conforme as exigências do município.

A integração deve primeiro consultar quais informações a prefeitura exige e, somente depois, enviar a configuração fiscal.

Como funciona

%%{init: {"flowchart": {"nodeSpacing": 18,"rankSpacing": 24,"diagramPadding": 4,"padding": 7}}}%%
flowchart TD
    A["Consultar exigências municipais"] --> B["Interpretar os campos obrigatórios"]
    B --> C["Configurar informações fiscais"]
    C --> D["Recuperar a configuração"]
    D --> E["Validar a conta para emissão"]

    classDef inicio fill:#DBEAFE,stroke:#2563EB,color:#1E3A8A,stroke-width:3px
    classDef validacao fill:#E0F2FE,stroke:#0284C7,color:#0C4A6E,stroke-width:2px
    classDef sucesso fill:#DCFCE7,stroke:#16A34A,color:#14532D,stroke-width:3px

    class A inicio
    class B,C,D validacao
    class E sucesso

    linkStyle default stroke:#94A3B8,stroke-width:2px

1. Consulte as exigências do município

Faça a consulta:

GET /v3/fiscalInfo/municipalOptions

A resposta considera o município cadastrado no CNPJ da conta e informa quais dados devem ser utilizados na configuração fiscal.

Listar configurações municipais

Interprete os campos necessários

Os principais campos que influenciam a configuração são:

Campo	Como utilizar
`authenticationType`	Identifica como a prefeitura autentica a emissão
`usesSpecialTaxRegimes`	Quando `true`, informe `specialTaxRegime`
`specialTaxRegimesList`	Utilize o `value` correspondente ao regime aplicável
`usesServiceListItem`	Quando `true`, informe `serviceListItem`
`supportsCancellation`	Indica se o município permite cancelamento automático pela integração

authenticationType pode retornar:

Valor	Configuração esperada
`USER_AND_PASSWORD`	`username` e `password`
`TOKEN`	`accessToken`
`CERTIFICATE`	`certificateFile` e `certificatePassword`

Não defina previamente qual método de autenticação será usado. Utilize o valor retornado para o município da conta.

2. Utilize as orientações da prefeitura

A consulta também pode retornar campos com sufixo Help, como:

municipalInscriptionHelp;
specialTaxRegimeHelp;
serviceListItemHelp;
digitalCertificateHelp;
accessTokenHelp;
municipalServiceCodeHelp.

Esses campos servem somente como orientação de preenchimento e não devem ser enviados ao configurar as informações fiscais.

🚧
Atenção
Os campos Help podem retornar null quando a prefeitura não possuir orientações adicionais para o preenchimento daquela informação.

Exemplo de resposta:

{
  "authenticationType": "USER_AND_PASSWORD",
  "supportsCancellation": true,
  "usesSpecialTaxRegimes": false,
  "usesServiceListItem": false,
  "specialTaxRegimesList": null,
  "municipalInscriptionHelp": "A inscrição municipal da empresa deve conter de 1 a 8 dígitos (somente números).\r\n\r\nExemplo válido: 11356",
  "specialTaxRegimeHelp": null,
  "serviceListItemHelp": null,
  "digitalCertificateHelp": null,
  "accessTokenHelp": null,
  "municipalServiceCodeHelp": "Informe aqui o código de serviço municipal que identifica o serviço prestado na nota fiscal. \r\n\r\nEle possui geralmente 4 a 5 dígitos com formatação.\r\nExemplo válido: 1.01"
}

Nesse exemplo, a prefeitura utiliza autenticação por usuário e senha e não exige regime especial de tributação.

3. Configure as informações fiscais

Depois de interpretar as exigências municipais, envie:

POST /v3/fiscalInfo

Informe os dados fiscais da empresa e somente as credenciais correspondentes ao método de autenticação retornado.

Exemplo para USER_AND_PASSWORD:

{
  "email": "[email protected]",
  "municipalInscription": "21779501",
  "simplesNacional": true,
  "cnae": "6209100",
  "rpsSerie": "1",
  "rpsNumber": 1,
  "username": "[email protected]",
  "password": "secret@123"
}

Outros campos podem ser necessários conforme o município, como specialTaxRegime, serviceListItem, loteNumber, nbsCode ou informações específicas do Portal Nacional.

Consulte todos os campos de Criar e atualizar informações fiscais.

4. Valide a configuração

Depois de salvar, consulte:

GET /v3/fiscalInfo

Recuperar informações fiscais

Confirme se os dados necessários foram cadastrados corretamente antes de iniciar a emissão.

Se nenhuma configuração fiscal existir, essa consulta retorna HTTP 404.

Resultado esperado

A configuração fiscal deve estar cadastrada e compatível com as exigências retornadas para o município.

Com essa etapa concluída, siga para a identificação do serviço municipal e o agendamento da NFS-e.

Exemplo completo

Para executar a configuração com exemplos de requisição, consulte:

Configurar informações fiscais para emissão de Nota Fiscal

Próximos passos

Updated 15 days ago

Did this page help you?