Configurar informações fiscais

Antes de emitir uma Nota Fiscal, é necessário definir as configurações fiscais da sua empresa, como número do RPS, forma de autenticação na prefeitura (usuário e senha, token ou certificado digital), entre outros dados exigidos pelo município.

Para iniciar essa configuração, utilize o endpoint de Listar configurações municipais. Esse endpoint retornará quais informações a prefeitura vinculada ao município cadastrado no CNPJ da conta exige para emissão de notas fiscais.

GET /v3/fiscalInfo/municipalOptions Confira a referência completa deste endpoint.

Como retorno, você terá acesso aos seguintes campos:

• authenticationType (enum) - Tipo de autenticação exigida pela prefeitura para emissão de notas fiscais.

  • CERTIFICATE - Autenticação via certificado digital
  • TOKEN - Autenticação via token
  • USER_AND_PASSWORD - Autenticação via usuário e senha

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

• usesSpecialTaxRegimes (boolean) - Indica se a prefeitura exige o envio de regime especial de tributação. Caso o retorno seja true, informe o regime no campo specialTaxRegime do endpoint Criar ou atualizar informações fiscais, utilizando uma das opções retornadas em specialTaxRegimesList.

• usesServiceListItem (boolean) - Indica se a prefeitura exige o envio do item da lista de serviço municipal.

• usesStateInscription (boolean) - Indica se a prefeitura exige o envio da inscrição estadual nas informações fiscais.

• specialTaxRegimesList (array) - Lista de regimes especiais de tributação aceitos pela prefeitura.

  • label - Nome do regime especial de tributação
  • value - Identificador do regime especial de tributação

Os campos finalizados com Help retornam instruções complementares da prefeitura para auxiliar no preenchimento correto das informações fiscais. O conteúdo pode variar conforme o município configurado na conta.

• municipalInscriptionHelp (string) - Texto explicativo sobre o formato esperado para a inscrição municipal, incluindo regras de preenchimento e exemplos válidos quando aplicável.

• specialTaxRegimeHelp (string) - Texto explicativo contendo orientações sobre o regime especial de tributação exigido pela prefeitura.

• serviceListItemHelp (string) - Texto explicativo sobre o formato esperado para o item da lista de serviço municipal.

• digitalCertificatedHelp (string) - Texto explicativo com orientações sobre o certificado digital exigido pela prefeitura.

• accessTokenHelp (string) - Texto explicativo contendo instruções sobre o token utilizado para autenticação na prefeitura.

• municipalServiceCodeHelp (string) - Texto explicativo sobre o formato esperado para o código de serviço municipal utilizado na emissão da nota fiscal.

🚧

Atenção

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

Um exemplo de retorno:

{
    "authenticationType": "USER_AND_PASSWORD",
    "supportsCancellation": true,
    "usesSpecialTaxRegimes": false,
    "usesServiceListItem": false,
    "usesStateInscription": 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,
    "digitalCertificatedHelp": 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"
}

No exemplo acima, a prefeitura exige autenticação via usuário e senha e não utiliza regime especial de tributação. Com essas informações, já é possível enviar os dados necessários para configurar as informações fiscais da conta.

POST /v3/fiscalInfo Confira a referência completa deste endpoint.

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

Após configurar corretamente as informações fiscais exigidas pela prefeitura, sua conta estará apta para emissão de notas fiscais via API.