Documentação
Documentação

API Complementar - Metadados

Veja como obter informações sobre o funcionamento de cada prefeitura via API.

Suggest Edits

Cada prefeitura solicita informações diferentes para emitir a NFS-e.

Todas as informações necessárias são fornecidas via API pelo Gateway.

Com isso, seu sistema pode se adequar automaticamente à realidade de cada município, sem ajuste nenhum.

Informações para autenticação no sistema da prefeitura

  • Certificado digital e/ou,
  • Usuário e senha e/ou,
  • Frase secreta e/ou,
  • Token alfanumérico

📘

Opções possíveis

  • 0 - Nenhuma
  • 1 - Certificado
  • 2 - Usuário e Senha
  • 3 - Token de autenticação/API Key
  • 4 - Frase secreta e senha (mesma coisa que usuário e senha, só muda o nome do campo)
  • 5 - Usuário, senha e token

Informações de assinatura no momento da emissão da nota

  • Se a assinatura digital no XML da NFS-e é obrigatório, opcional ou não é utilizado pelo município em questão.

📘

Opções possíveis

  • 0 - Não utiliza assinatura digital
  • 1 - Assinatura digital é opcional
  • 2 - Assinatura digital é obrigatória

Características da empresa

Utiliza regime especial de tributação? Se sim, quais são os valores?

{
  "usaRegimeEspecialTributacao": true,
  "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"
        }
    ],
    (...)
}

Características da nota fiscal

  • Serviço municipal unificado
  • Sugestões de percentuais aproximados de impostos municipal/estadual/federal
  • Natureza da operação é deduzida automaticamente 
{
    "totalRecords": 2,
    "data": [
        {
            "codigo": 18749,
            "descricao": "010600188 | 1.06 - ASSESSORIA E CONSULTORIA EM INFORMATICA",
            "codigoIBGECidade": 3106200,
            "aliquotaSugerida": 3,
            "construcaoCivil": false,
            "percentualAproximadoFederalIBPT": 13.45,
            "percentualAproximadoEstadualIBPT": 0,
            "percentualAproximadoMunicipalIBPT": 3.03,
            "chaveTabelaIBPT": "ca7gi3"
        },
        {
            "codigo": 18750,
            "descricao": "010700188 | 1.07 - SUPORTE TECNICO EM INFORMATICA, INCLUSIVE INSTALACAO, CONFIGURACAO E MANUTENCAO DE PROGRAMAS DE COMPUTACAO E BANCO DE DADOS",
            "codigoIBGECidade": 3106200,
            "aliquotaSugerida": 3,
            "construcaoCivil": false,
            "percentualAproximadoFederalIBPT": 13.45,
            "percentualAproximadoEstadualIBPT": 0,
            "percentualAproximadoMunicipalIBPT": 3,
            "chaveTabelaIBPT": "ca7gi3"
        }
    ]
}

Solicite o acesso à API

Essa parte da API não é pública e precisa ser solicitada através do nosso atendimento disponível no seu painel.

Updated over 5 years ago