API Complementar - Metadados
Veja como obter informações sobre o funcionamento de cada prefeitura via API
Características da Prefeitura
Cada município pode exigir um conjunto específico de informações para emitir a NFS-e. Todas as informações essenciais são fornecidas via API pela Nota Gateway.
Assim, seu sistema se adapta automaticamente às particularidades de cada cidade, sem necessidade de ajustes adicionais.
{
"tipoAutenticacao": 1,
"assinaturaDigital": 0,
"helpTipoAutenticacao": {
"certificadoDigital": "Sua prefeitura exige a utilização de certificado digital, portanto, inclua aqui o arquivo de seu certificado A1.",
"usuario": null,
"senha": null,
"token": null,
"fraseSecreta": null
},
"campoLoginProvedor": 0,
"suportaCancelamento": true,
"usaAEDF": false,
"usaRegimeEspecialTributacao": true,
"usaCodigoServicoMunicipal": true,
"usaDescricaoServico": true,
"usaCNAE": true,
"usaNBS": false,
"usaItemListaServico": true,
"helpInscricaoMunicipal": "Informe somente os números sem ponto nem formatação.\r\n\r\nExemplos válidos: 4301000010 ou 131436001",
"helpRegimeEspecialTributacao": "Isso identifica o regime de tributação de sua empresa, se desejar deixar sem nenhuma opção marcada selecione o traço (\"-\").\r\n \r\n Empresas do simples nacional geralmente optam pelo Microempresa Municipal.",
"helpCodigoServicoMunicipal": "Informe aqui o código municipal com 4 a 5 dígitos (com formatação) que identifica o serviço prestado na nota fiscal.\r\n\r\nEsse código é identificado na sua prefeitura como Serviço e é possível visualizá-lo ao tentar emitir uma nota fiscal manualmente, na seção Código de Serviço.\r\nExemplos válidos: 8.01 ou 14.01",
"helpDescricaoServico": "Texto descritivo municipal que descreve o serviço prestado. Essa informação não é transmitida à prefeitura e é utilizada somente na impressão do PDF da nota fiscal.",
"helpCNAE": "Informe aqui o código CNAE que identifica o serviço prestado na nota fiscal. O mesmo deve conter 7 dígitos (somente números).",
"helpItemListaServico": "Informe aqui o item da lista de serviço, é também um identificador do serviço prestado.\r\n \r\n Você precisa preencher o item da lista de serviço mantendo a formatação.\r\n Exemplos válidos: 17.02 ou 8.02",
"suportaEmissaoNFeSemCliente": true,
"suportaEmissaoNFeClienteSemCpf": true,
"suportaEmissaoNFeClienteSemEndereco": false,
"suportaCancelamentoNFeSemCliente": false,
"suportaCancelamentoNFeClienteSemCpf": false,
"regimesEspecialTributacao": [
{
"codigo": "0",
"nome": " - "
},
{
"codigo": "1",
"nome": "Microempresa Municipal"
},
{
"codigo": "2",
"nome": "Estimativa"
},
{
"codigo": "3",
"nome": "Sociedade de Profissionais"
},
{
"codigo": "4",
"nome": "Cooperativa"
},
{
"codigo": "5",
"nome": "MEI - Simples Nacional"
},
{
"codigo": "6",
"nome": "ME EPP - Simples Nacional"
}
]
}Tipo de Autenticação
O campo tipoAutenticacao retorna códigos correspondentes a cada um dos cenários abaixo:
Código | Descrição | |
|---|---|---|
0 | Nenhuma | |
1 | Certificado = Indica que a prefeitura exige o uso de certificado digital | |
2 | UsuarioESenha = Indica que a autenticação é realizada através de Usuário e senha utilizado para acessar o portal da prefeitura. Observação: Pode haver uma variação no padrão do tipo de usuário, de acordo com cada portal. Exemplo: Inscrição municipal, CNPJ, CPF ou E-mail. | |
3 | Token | |
4 | FraseSecretaESenha | |
5 | UsuarioESenha + Token |
Assinatura Digital
O campo assinaturaDigital retorna se a assinatura digital no XML da NFS-e é obrigatório, opcional ou não é utilizado pelo município em questão.
| Código | Descrição | |
|---|---|---|
| 0 | Não utiliza assinatura digital | |
| 1 | Assinatura digital é opcional | |
| 2 | Assinatura digital é obrigatória |
Updated about 18 hours ago
