Endpoint utilizado para cadastrar ou atualizar as configurações fiscais da conta para emissão de notas fiscais.
Esse endpoint reúne os dados da empresa e os dados de autenticação exigidos pela prefeitura. Os campos obrigatórios podem variar conforme o município, por isso é importante consultar previamente o endpoint de configurações municipais para identificar quais informações devem ser enviadas.
Parâmetros principais da requisição
-
email- E-mail utilizado pelo Asaas para envio de notificações e alertas relacionados às notas fiscais. -
municipalInscription- Inscrição municipal da empresa. -
simplesNacional- Indica se a empresa é optante pelo Simples Nacional. -
culturalProjectsPromoter- Indica se a empresa é classificada como incentivadora cultural. -
cnae- Código CNAE da atividade exercida. -
specialTaxRegime- Identificador do regime especial de tributação. Deve ser informado quando a prefeitura exigir esse dado. -
serviceListItem- Item da lista de serviço. Deve ser informado quando o município exigir esse campo. -
nbsCode- Código NBS da atividade. Pode ser exigido pela prefeitura ou em cenários específicos, como serviços de importação ou exportação. -
rpsSerie- Série do RPS utilizada pela empresa. -
rpsNumber- Próximo número de RPS a ser utilizado. Se a última nota emitida no município teve RPS 100, o campo deve ser preenchido com 101. -
loteNumber- Próximo número de lote a ser utilizado, quando a prefeitura exigir controle por lote. -
username- Usuário de acesso ao portal da prefeitura. -
password- Senha de acesso ao portal da prefeitura. -
accessToken- Token de acesso ao portal da prefeitura, quando esse for o modelo de autenticação exigido. -
certificateFile- Arquivo do certificado digital, quando a prefeitura exigir autenticação por certificado. -
certificatePassword- Senha do certificado digital enviado. -
nationalPortalTaxCalculationRegime- Identificador do regime de apuração tributária no contexto do Portal Nacional. Deve ser preenchido apenas quando aplicável.
Como usar esse endpoint
O comportamento da chamada depende das exigências do município.
Exemplos:
- se
authenticationTypeforUSER_AND_PASSWORD, normalmente será necessário enviarusernameepassword - se
authenticationTypeforTOKEN, normalmente será necessário enviaraccessToken - se
authenticationTypeforCERTIFICATE, normalmente será necessário enviarcertificateFileecertificatePassword
AtençãoOs campos obrigatórios variam conforme as regras da prefeitura do município da conta.
- Recomenda-se consultar previamente o endpoint de configurações municipais antes de enviar esta requisição.
- O envio incorreto das informações pode impedir a emissão de notas fiscais.
- Alguns municípios exigem autenticação específica, como certificado digital, token ou usuário e senha.
Se a configuração estiver correta, a conta ficará apta para emissão de notas fiscais.
Campos auxiliares retornados pela API
Alguns campos retornados pelo endpoint de configurações municipais possuem o sufixo Help. Esses campos não devem ser enviados na requisição. Eles têm como objetivo orientar o preenchimento correto das informações fiscais conforme as regras da prefeitura.
-
specialTaxRegimeHelp- Texto explicativo com orientações sobre o regime especial de tributação exigido pelo município. -
serviceListItemHelp- Instruções sobre o formato e o valor esperado para o item da lista de serviço. -
digitalCertificateHelp- Orientações sobre o certificado digital exigido pela prefeitura, incluindo formato e requisitos. -
accessTokenHelp- Instruções sobre como obter ou informar o token de autenticação exigido pelo município. -
municipalServiceCodeHelp- Explicação sobre o formato e preenchimento do código de serviço municipal. -
municipalInscriptionHelp- Orientações sobre o formato da inscrição municipal exigida pela prefeitura.
Para entender melhor quais campos são obrigatórios e o que informar em cada campo para a integração com a prefeitura do seu município, execute a consulta de configurações municipais em Listar configurações municipais.
