Pular para o conteúdo principal
Ver como MarkdownDocs para agentes

API de Inscrições Municipais (MunicipalTax)

Cadastre os dados de inscrição municipal para emissão de NFS-e​

Navegação

Visão Geral​

O recurso MunicipalTax (Inscrição Municipal) registra na NFE.io os dados cadastrais da empresa, necessários para emissão de NFS-e (Nota Fiscal de Serviços Eletrônica).

Importante

Esta API não cadastra sua empresa na prefeitura municipal. Ela apenas registra na NFE.io os dados de Inscrição Municipal que você já obteve junto à prefeitura, para utilizá-los como base nas emissões de NFS-e.

O cadastro junto à prefeitura, obtenção de credenciais (login/senha ou token) e habilitação para emissão de NFS-e devem ser feitos diretamente por você no portal da respectiva prefeitura.

Anatomia de uma Inscrição Municipal​

Conceitos Fundamentais​

Ao cadastrar uma inscrição municipal, você informa os dados já obtidos junto à prefeitura:

ConceitoCampos na APIDescrição
LocalizaçãoCityCidade da inscrição (código IBGE, nome, UF)
Identificação MunicipalTaxNumberNúmero da Inscrição Municipal obtido na prefeitura
Numeração RPSRpsSerialNumber, RpsNumberControle de numeração de RPS
AmbienteEnvironmentProdução ou Desenvolvimento para emissão da nota
CredenciaisLoginName, LoginPassword, AuthIssueValueDados de acesso à prefeitura (usados na emissão)

Campos Gerenciados pelo Sistema​

Além dos dados que você informa, o sistema gera e mantém automaticamente:

CampoTipoQuando é definido
IdstringGerado na criação
CompanyIdstringVinculado à empresa da URL
AccountIdstringVinculado à sua conta/tenant
StatusenumInicia como Active
LastRpsSentlongÚltimo RPS enviado (controle interno de numeração utilizado para emissões em prefeituras onde o RPS é sequencial)
FiscalStatusenumVerificado automaticamente (suporte da NFE.io para a cidade)
RpsSerialNumbersarrayLista de séries utilizadas, atualizada automaticamente
City.CountrystringDefinido automaticamente como "BRA"
CreatedOndatetimeData/hora da criação
ModifiedOndatetimeAtualizado a cada alteração

O que o contribuinte faz fora do sistema NFE.io​

  1. Obtém sua Inscrição Municipal diretamente na prefeitura
  2. Consegue credenciais de acesso (login/senha ou token) junto à prefeitura (se exigido)
  3. Habilita a emissão de NFS-e no portal da prefeitura
  4. Verifica com qual série e número de RPS ele deve utilizar na plataforma da NFE.io
  5. Cadastra esses dados no sistema NFE.io através desta API

Referência Completa de Propriedades​

📋 Expandir tabela completa
PropriedadeTipoObrigatórioDescrição
Idstring—Identificador único (gerado)
CompanyIdstring—ID da empresa proprietária
AccountIdstring—Conta/tenant proprietária
Statusenum—Status operacional
Cityobject✅Cidade da inscrição
City.Codestring✅Código IBGE (7 dígitos)
City.Namestring✅Nome da cidade
City.Statestring✅UF (2 letras)
City.Countrystring—País (sempre "BRA")
TaxNumberstring—Número da Inscrição Municipal
SpecialTaxRegimeenum—Regime especial de tributação
Emailstring—E-mail para notificações
LegalNatureenum—Natureza jurídica
CompanyRegistryNumberlong—Registro na Junta Comercial
RegionalTaxNumberlong—Número do cadastro regional
RpsSerialNumberstring✅Série de RPS atual
RpsNumberlong✅Próximo número de RPS
LastRpsSentlong-Último RPS enviado
RpsSerialNumbersarray—Lista de séries (gerado)
IssRatedecimal—Alíquota do ISS (%)
Environmentenum✅Ambiente de processamento
FiscalStatusenum—Suporte da NFE.io para a cidade
FederalTaxDeterminationenum—Determinação fiscal federal
MunicipalTaxDeterminationenum—Determinação fiscal municipal
LoginNamestring—Usuário para acesso à prefeitura
LoginPasswordstring—Senha para acesso à prefeitura
AuthIssueValuestring—Token de autorização
CreatedOndatetime—Data de criação
ModifiedOndatetime—Última modificação

Endpoints​

MétodoEndpointDescrição
POST/v2/companies/{company_id}/municipaltaxesCriar inscrição
GET/v2/companies/{company_id}/municipaltaxesListar inscrições
GET/v2/companies/{company_id}/municipaltaxes/{municipal_tax_id}Consultar inscrição
PUT/v2/companies/{company_id}/municipaltaxes/{municipal_tax_id}Alterar inscrição
DELETE/v2/companies/{company_id}/municipaltaxes/{municipal_tax_id}Excluir inscrição
PATCH/v2/companies/{company_id}/municipaltaxes/{municipal_tax_id}/updateprefectureVerificar suporte da cidade
GET/v2/companies/{company_id}/municipaltaxes/{municipal_tax_id}/series/{serie}Consultar série RPS
Autenticação

Todos os endpoints exigem autenticação via API Key: Authorization: <sua_api_key>

→ Saiba como obter sua API Key

Criar uma Inscrição Municipal​

Cadastra os dados de uma inscrição municipal no sistema NFE.io.

nota

Este endpoint apenas cadastra os dados no sistema NFE.io. A inscrição municipal deve ter sido previamente obtida junto à prefeitura.

POST /v2/companies/{company_id}/municipaltaxes

Parâmetros de Rota​

ParâmetroTipoDescrição
company_idstringID da empresa

Headers​

HeaderValor
Content-Typeapplication/json
Authorization<sua_api_key>
Ambiente padrão de criação

Toda Inscrição Municipal é criada no ambiente Development, independentemente do valor enviado no campo Environment. Isso evita emissões acidentais em produção durante a configuração e os testes.

Para emitir notas em produção, é necessário alterar a IM após a criação, definindo Environment como Production — veja Alterar Inscrição Municipal.

Corpo da Requisição​

{
  "MunicipalTax": {
    "City": {
      "Code": "3550308",
      "Name": "São Paulo",
      "State": "SP"
    },
    "TaxNumber": "876543",
    "Environment": "Development",
    "RpsSerialNumber": "IO",
    "RpsNumber": 1000,
    "LastRpsSent": 999
  }
}

Parâmetros do Corpo​

CampoTipoObrigatórioDescrição
Cityobject✅Cidade da inscrição
City.Codestring✅Código IBGE (7 dígitos)
City.Namestring✅Nome da cidade
City.Statestring✅UF (2 letras)
TaxNumberstringNúmero da Inscrição Municipal
EnvironmentenumAmbiente. A IM é sempre criada em Development, mesmo que outro valor seja enviado. Para emitir em produção, altere a IM após a criação. Valores: Development (padrão), Production, Staging
RpsSerialNumberstring✅Série do RPS
RpsNumberlong✅Próximo número de RPS
LastRpsSentlong✅Último RPS enviado

Parâmetros Opcionais​

CampoTipoDescrição
SpecialTaxRegimeenumRegime especial de tributação (padrão: Nenhum)
EmailstringE-mail para notificações
LegalNatureenumNatureza jurídica
CompanyRegistryNumberlongNúmero do registro na Junta Comercial
RegionalTaxNumberlongNúmero do cadastro regional
IssRatedecimalAlíquota de ISS (%)
FederalTaxDeterminationenumDeterminação fiscal federal (padrão: Default)
MunicipalTaxDeterminationenumDeterminação fiscal municipal (padrão: Default)
LoginNamestringUsuário para acesso à prefeitura
LoginPasswordstringSenha para acesso à prefeitura
AuthIssueValuestringToken de autorização

Resposta de Sucesso​

Status: 200 OK

{
  "MunicipalTax": {
    "Id": "mtx_001",
    "CompanyId": "company_abc123",
    "AccountId": "acct_12345",
    "Status": "Active",
    "City": {
      "Code": "3550308",
      "Name": "São Paulo",
      "State": "SP",
      "Country": "BRA"
    },
    "TaxNumber": "876543",
    "SpecialTaxRegime": "Nenhum",
    "Email": null,
    "LegalNature": "None",
    "CompanyRegistryNumber": null,
    "RegionalTaxNumber": null,
    "RpsSerialNumber": "IO",
    "RpsNumber": 1000,
    "LastRpsSent": 999,
    "IssRate": null,
    "Environment": "Development",
    "FiscalStatus": "Active",
    "FederalTaxDetermination": "Default",
    "MunicipalTaxDetermination": "Default",
    "LoginName": null,
    "LoginPassword": null,
    "AuthIssueValue": null,
    "RpsSerialNumbers": ["IO"],
    "CreatedOn": "2024-01-15T10:30:00Z",
    "ModifiedOn": null
  }
}

Respostas de Erro​

StatusDescrição
400 Bad RequestDados inválidos
404 Not FoundEmpresa não encontrada
{
  "Errors": [
    {
      "Code": 40044,
      "Message": "city is null"
    }
  ]
}

Exemplo cURL​

curl -X POST https://api.nfse.io/v2/companies/company_abc123/municipaltaxes \
  -H "Authorization: sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "MunicipalTax": {
      "City": { "Code": "3550308", "Name": "São Paulo", "State": "SP" },
      "Environment": "Development",
      "RpsSerialNumber": "IO",
      "RpsNumber": 1000,
      "LastRpsSent": 999
    }
  }'

Exemplo PowerShell​

$headers = @{ Authorization = "sk_live_xxx" }
$body = @{
  MunicipalTax = @{
    City = @{ Code = "3550308"; Name = "São Paulo"; State = "SP" }
    TaxNumber = "876543"
    Environment = "Development"
    RpsSerialNumber = "IO"
    RpsNumber = 1000
    LastRpsSent = 999
  }
} | ConvertTo-Json -Depth 5

Invoke-RestMethod -Uri "https://api.nfse.io/v2/companies/company_abc123/municipaltaxes" `
  -Method Post -Headers $headers -Body $body -ContentType "application/json"

Listar Inscrições Municipais​

Lista todas as inscrições municipais de uma empresa com paginação.

GET /v2/companies/{company_id}/municipaltaxes

Parâmetros de Rota​

ParâmetroTipoDescrição
company_idstringID da empresa

Headers​

HeaderValor
Acceptapplication/json
Authorization<sua_api_key>

Parâmetros de Query​

ParâmetroTipoPadrãoDescrição
limitint10Limite de resultados (1-50)
startingAfterstringID do cursor para próxima página
endingBeforestringID do cursor para página anterior

Ordenação​

  • Primária: CreatedOn (descendente - mais recentes primeiro)
  • Secundária: Id (ascendente)

Resposta de Sucesso​

Status: 200 OK

{
  "hasMore": true,
  "municipalTaxes": [
    {
      "Id": "mtx_001",
      "CompanyId": "company_abc123",
      "AccountId": "acct_12345",
      "Status": "Active",
      "City": {
        "Code": "3550308",
        "Name": "São Paulo",
        "State": "SP",
        "Country": "BRA"
      },
      "TaxNumber": "876543",
      "SpecialTaxRegime": "Nenhum",
      "Email": "contato@acme.com.br",
      "LegalNature": "SociedadeEmpresariaLimitada",
      "CompanyRegistryNumber": 1234567,
      "RegionalTaxNumber": null,
      "RpsSerialNumber": "IO",
      "RpsNumber": 1000,
      "LastRpsSent": 999,
      "IssRate": 2.0,
      "Environment": "Production",
      "FiscalStatus": "Active",
      "FederalTaxDetermination": "Default",
      "MunicipalTaxDetermination": "Default",
      "LoginName": "pref_user",
      "AuthIssueValue": null,
      "RpsSerialNumbers": ["IO"],
      "CreatedOn": "2024-01-15T10:30:00Z",
      "ModifiedOn": "2024-02-20T14:45:00Z"
    },
    {
      "Id": "mtx_002",
      "CompanyId": "company_abc123",
      "AccountId": "acct_12345",
      "Status": "Active",
      "City": {
        "Code": "3304557",
        "Name": "Rio de Janeiro",
        "State": "RJ",
        "Country": "BRA"
      },
      "TaxNumber": "112233",
      "SpecialTaxRegime": "Nenhum",
      "Email": null,
      "LegalNature": "None",
      "CompanyRegistryNumber": null,
      "RegionalTaxNumber": null,
      "RpsSerialNumber": "A1",
      "RpsNumber": 200,
      "LastRpsSent": 199,
      "IssRate": null,
      "Environment": "Production",
      "FiscalStatus": "Active",
      "FederalTaxDetermination": "Default",
      "MunicipalTaxDetermination": "Default",
      "LoginName": null,
      "AuthIssueValue": null,
      "RpsSerialNumbers": ["A1"],
      "CreatedOn": "2024-01-10T14:00:00Z",
      "ModifiedOn": null
    }
  ]
}

Paginação​

Use o Id do último item como startingAfter para obter a próxima página:

GET /v2/companies/{company_id}/municipaltaxes?limit=20&startingAfter=mtx_002

Respostas de Erro​

StatusDescrição
400 Bad RequestParâmetros inválidos
404 Not FoundEmpresa ou cursor não encontrado

Exemplo cURL​

curl -X GET "https://api.nfse.io/v2/companies/company_abc123/municipaltaxes?limit=20" \
  -H "Authorization: sk_live_xxx"

Consultar Inscrição Municipal por ID​

Retorna os detalhes de uma inscrição municipal específica.

GET /v2/companies/{company_id}/municipaltaxes/{municipal_tax_id}

Parâmetros de Rota​

ParâmetroTipoDescrição
company_idstringID da empresa
municipal_tax_idstringID da inscrição municipal

Headers​

HeaderValor
Acceptapplication/json
Authorization<sua_api_key>

Resposta de Sucesso​

Status: 200 OK

{
  "MunicipalTax": {
    "Id": "mtx_001",
    "CompanyId": "company_abc123",
    "AccountId": "acct_12345",
    "Status": "Active",
    "City": {
      "Code": "3550308",
      "Name": "São Paulo",
      "State": "SP",
      "Country": "BRA"
    },
    "TaxNumber": "876543",
    "SpecialTaxRegime": "Nenhum",
    "Email": "contato@acme.com.br",
    "LegalNature": "SociedadeEmpresariaLimitada",
    "CompanyRegistryNumber": 1234567,
    "RegionalTaxNumber": 98765,
    "RpsSerialNumber": "IO",
    "RpsNumber": 1000,
    "LastRpsSent": 999,
    "IssRate": 2.0,
    "Environment": "Production",
    "FiscalStatus": "Active",
    "FederalTaxDetermination": "Default",
    "MunicipalTaxDetermination": "Default",
    "LoginName": "pref_user",
    "LoginPassword": null,
    "AuthIssueValue": "ABC-XYZ",
    "RpsSerialNumbers": ["IO", "A1"],
    "CreatedOn": "2024-01-15T10:30:00Z",
    "ModifiedOn": "2024-02-20T14:45:00Z"
  }
}

Respostas de Erro​

StatusDescrição
400 Bad RequestID inválido
404 Not FoundInscrição não encontrada
{
  "Errors": [
    {
      "Code": 40041,
      "Message": "municipal tax not found"
    }
  ]
}

Exemplo cURL​

curl -X GET https://api.nfse.io/v2/companies/company_abc123/municipaltaxes/mtx_001 \
  -H "Authorization: sk_live_xxx"

Alterar Inscrição Municipal​

Atualiza os dados de uma inscrição municipal existente.

PUT /v2/companies/{company_id}/municipaltaxes/{municipal_tax_id}

Parâmetros de Rota​

ParâmetroTipoDescrição
company_idstringID da empresa
municipal_tax_idstringID da inscrição municipal

Headers​

HeaderValor
Content-Typeapplication/json
Authorization<sua_api_key>

Corpo da Requisição​

Promover a IM para produção

Como a IM nasce em Development, este é o endpoint usado para movê-la para produção: basta enviar "Environment": "Production" no corpo da requisição. Confirme que a integração com a prefeitura está validada (FiscalStatus: Active) antes de promover.

{
  "MunicipalTax": {
    "TaxNumber": "876544",
    "Email": "novo-email@acme.com.br",
    "IssRate": 3.0,
    "Environment": "Production",
    "LoginName": "novo_usuario",
    "LoginPassword": "nova_senha"
  }
}

Campos Atualizáveis​

CampoTipoDescrição
CityobjectCidade da inscrição
TaxNumberstringNúmero da Inscrição Municipal
EmailstringE-mail para notificações
SpecialTaxRegimeenumRegime especial de tributação
LegalNatureenumNatureza jurídica
CompanyRegistryNumberlongNúmero do registro na Junta Comercial
RegionalTaxNumberlongNúmero do cadastro regional
IssRatedecimalAlíquota de ISS (%)
RpsSerialNumberstringSérie do RPS
RpsNumberlongPróximo número de RPS
LastRpsSentlongÚltimo RPS enviado
EnvironmentenumAmbiente de processamento
LoginNamestringUsuário da prefeitura
LoginPasswordstringSenha da prefeitura
AuthIssueValuestringToken de autorização
FederalTaxDeterminationenumDeterminação fiscal federal
MunicipalTaxDeterminationenumDeterminação fiscal municipal

Resposta de Sucesso​

Status: 200 OK

{
  "MunicipalTax": {
    "Id": "mtx_001",
    "CompanyId": "company_abc123",
    "AccountId": "acct_12345",
    "Status": "Active",
    "City": {
      "Code": "3550308",
      "Name": "São Paulo",
      "State": "SP",
      "Country": "BRA"
    },
    "TaxNumber": "876544",
    "SpecialTaxRegime": "Nenhum",
    "Email": "novo-email@acme.com.br",
    "LegalNature": "SociedadeEmpresariaLimitada",
    "CompanyRegistryNumber": 1234567,
    "RegionalTaxNumber": null,
    "RpsSerialNumber": "IO",
    "RpsNumber": 1000,
    "LastRpsSent": 999,
    "IssRate": 3.0,
    "Environment": "Production",
    "FiscalStatus": "Active",
    "FederalTaxDetermination": "Default",
    "MunicipalTaxDetermination": "Default",
    "LoginName": "novo_usuario",
    "LoginPassword": null,
    "AuthIssueValue": null,
    "RpsSerialNumbers": ["IO"],
    "CreatedOn": "2024-01-15T10:30:00Z",
    "ModifiedOn": "2024-03-10T16:20:00Z"
  }
}

Respostas de Erro​

StatusDescrição
400 Bad RequestDados inválidos
404 Not FoundInscrição não encontrada

Exemplo cURL​

curl -X PUT https://api.nfse.io/v2/companies/company_abc123/municipaltaxes/mtx_001 \
  -H "Authorization: sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "MunicipalTax": {
      "Email": "novo-email@acme.com.br",
      "IssRate": 3.0
    }
  }'

Excluir Inscrição Municipal​

Exclui uma inscrição municipal da empresa.

Atenção

Este processo é irreversível. Histórico de numeração RPS será perdido.

DELETE /v2/companies/{company_id}/municipaltaxes/{municipal_tax_id}

Parâmetros de Rota​

ParâmetroTipoDescrição
company_idstringID da empresa
municipal_tax_idstringID da inscrição municipal

Headers​

HeaderValor
Authorization<sua_api_key>

Resposta de Sucesso​

Status: 204 No Content

(Sem corpo na resposta)

Respostas de Erro​

StatusDescrição
400 Bad RequestID inválido
404 Not FoundInscrição não encontrada

Exemplo cURL​

curl -X DELETE https://api.nfse.io/v2/companies/company_abc123/municipaltaxes/mtx_001 \
  -H "Authorization: sk_live_xxx"

Verificar Suporte da Cidade​

Força uma verificação se a NFE.io possui suporte/homologação para emissão de NFS-e na cidade cadastrada.

Importante

Este endpoint não verifica o status da prefeitura em si. Ele verifica internamente se o sistema NFE.io tem integração homologada com a prefeitura daquela cidade.

PATCH /v2/companies/{company_id}/municipaltaxes/{municipal_tax_id}/updateprefecture

Parâmetros de Rota​

ParâmetroTipoDescrição
company_idstringID da empresa
municipal_tax_idstringID da inscrição municipal

Headers​

HeaderValor
Authorization<sua_api_key>

Uso​

Este endpoint é útil quando:

  • Você quer verificar se a NFE.io adicionou suporte para uma cidade que antes não era suportada
  • Houve atualização na lista de cidades homologadas
  • Você quer atualizar o FiscalStatus após mudanças internas no sistema

Resposta de Sucesso​

Status: 204 No Content

(Sem corpo na resposta - o FiscalStatus é atualizado internamente)

Respostas de Erro​

StatusDescrição
400 Bad RequestID inválido
404 Not FoundInscrição não encontrada

Exemplo cURL​

curl -X PATCH https://api.nfse.io/v2/companies/company_abc123/municipaltaxes/mtx_001/updateprefecture \
  -H "Authorization: sk_live_xxx"

Consultar Série RPS​

Consulta informações de numeração de uma série específica de RPS.

GET /v2/companies/{company_id}/municipaltaxes/{municipal_tax_id}/series/{serie}

Parâmetros de Rota​

ParâmetroTipoDescrição
company_idstringID da empresa
municipal_tax_idstringID da inscrição municipal
seriestringIdentificador da série RPS

Headers​

HeaderValor
Acceptapplication/json
Authorization<sua_api_key>

Resposta de Sucesso​

Status: 200 OK

{
  "Serie": {
    "RpsNumber": 1500,
    "LastRpsSent": 1499
  }
}

Campos da Resposta​

CampoTipoDescrição
RpsNumberlongPróximo número de RPS disponível
LastRpsSentlongÚltimo número de RPS enviado/utilizado

Respostas de Erro​

StatusDescrição
400 Bad RequestParâmetros inválidos
404 Not FoundInscrição ou série não encontrada

Exemplo cURL​

curl -X GET https://api.nfse.io/v2/companies/company_abc123/municipaltaxes/mtx_001/series/IO \
  -H "Authorization: sk_live_xxx"

Exemplo PowerShell​

$headers = @{ Authorization = "sk_live_xxx" }

Invoke-RestMethod -Uri "https://api.nfse.io/v2/companies/company_abc123/municipaltaxes/mtx_001/series/IO" `
  -Method Get -Headers $headers

Regras de Validação​

O sistema aplica as seguintes regras de validação ao criar ou alterar uma inscrição municipal:

Dados da Inscrição Municipal​

CampoRegraMensagem de Erro
StatusInscrição deve estar ativa para alteraçõesmunicipal tax is not active
CityObrigatóriocity is null
City.Code7 dígitos, primeiros 2 devem corresponder ao código da UFcity code does not match the state code
City.NameObrigatóriocity name is null or empty
City.StateObrigatório, deve ser UF válidastate is null or empty / state is not valid
RpsSerialNumberObrigatóriorps serial number is null or empty
EmailSe informado, não pode ser vazioemail is null or empty

Validação de Cidade​

O código IBGE da cidade deve corresponder ao estado informado (exemplos):

UFCódigo IBGE (primeiros 2 dígitos)
SP35
RJ33
MG31
PR41
RS43

Códigos de Erro​

Validação de Dados​

CódigoMensagemDescrição
40035account id is null or emptyAccountId não informado
40037company id is null or emptyCompanyId não informado
40040request municipal tax is nullPayload da inscrição municipal nulo
40044city is nullCidade não informada
40045city code is null or emptyCódigo IBGE não informado

Validação de Empresa​

CódigoMensagemDescrição
40041company not foundEmpresa não encontrada
40042company is not available to issueEmpresa inativa
40043account id is not valid to this companyAccountId não corresponde à empresa

Validação de Inscrição Municipal​

MensagemDescrição
municipal tax is not activeInscrição inativa não permite alterações
municipal tax not foundInscrição municipal não encontrada
city name is null or emptyNome da cidade não informado
state is null or emptyUF não informada
state is not validUF inválida
city code does not match the state codeCódigo IBGE não corresponde à UF
rps serial number is null or emptySérie RPS não informada
series not foundSérie não encontrada
serial number not foundSérie especificada não existe
account id is not valid to this municipal taxAccountId não corresponde à inscrição
company id is not valid to this municipal taxCompanyId não corresponde à inscrição

Enums​

ApiEnvironment (Ambiente)​

NomeValorDescrição
Development0Desenvolvimento (padrão)
Production1Produção (emissão real)
Staging2Homologação

Importante: ao criar uma IM, o ambiente é sempre Development, mesmo que outro valor seja enviado no POST. Para mudar para Production ou Staging, altere a IM após a criação.

nota

Nem todas as prefeituras suportam ambiente de teste/homologação.

Status​

NomeValorDescrição
Inactive-1Inativa (excluída/desativada)
None0Não definido
Active1Ativa (permite operações)

MunicipalTaxFiscalStatus (Suporte da Cidade)​

Indica se a NFE.io possui integração homologada com a prefeitura da cidade.

NomeValorDescriçãoNFE.io pode emitir?
CityNotSupported-3NFE.io não possui integração com esta cidade❌ Não
Pending-2Integração em desenvolvimento❌ Não
Inactive-1Integração temporariamente indisponível❌ Não
None0Status não determinado❌ Não
Active1NFE.io tem integração homologada✅ Sim

SpecialTaxRegime (Regime Especial de Tributação)​

NomeValorDescrição
Automatico-1Automático (detectado pelo sistema)
Nenhum0Sem regime especial
MicroempresaMunicipal1Microempresa municipal
Estimativa2Regime de estimativa
SociedadeDeProfissionais3Sociedade de profissionais
Cooperativa4Cooperativa
MicroempreendedorIndividual5MEI
MicroempresarioEmpresaPequenoPorte6ME/EPP

FederalTaxDeterminationBy (Determinação Fiscal Federal)​

NomeValorDescrição
NotInformed0Não informado
Default2Padrão
SimplesNacional4Simples Nacional

MunicipalTaxDeterminationBy (Determinação Fiscal Municipal)​

NomeValorDescrição
NotInformed0Não informado
Default2Padrão
SimplesNacional4Simples Nacional

LegalNature (Natureza Jurídica)​

Código de acordo com a Tabela de Natureza Jurídica (Resolução Concla). Exemplos mais comuns:

NomeCódigoDescrição
None0Não definido
EmpresaPublica2011201-1 Empresa Pública
SociedadeAnonimaAberta2046204-6 S.A. Aberta
SociedadeAnonimaFechada2054205-4 S.A. Fechada
SociedadeEmpresariaLimitada2062206-2 Sociedade Empresária Limitada
SociedadeEmpresariaEmNomeColetivo2070207-0 Sociedade em Nome Coletivo
SociedadeEmpresariaEmComanditaSimples2089208-9 Sociedade em Comandita Simples
Empresario2135213-5 Empresário Individual
Cooperativa2143214-3 Cooperativa
SociedadeSimplesPura2232223-2 Sociedade Simples Pura
SociedadeSimplesLimitada2240224-0 Sociedade Simples Limitada
EireliNaturezaEmpresaria2305230-5 EIRELI (Natureza Empresária)
EireliNaturezaSimples2313231-3 EIRELI (Natureza Simples)
EmpresaSimplesDeInovacao2348234-8 Inova Simples
AssociacaoPrivada3999399-9 Associação Privada
info

Consulte a tabela completa de Natureza Jurídica no site do IBGE/Concla.

Valores Padrão​

O sistema aplica os seguintes valores padrão quando não informados:

CampoValor PadrãoDescrição
RpsSerialNumber"IO"Série padrão de RPS
SpecialTaxRegimeNenhumSem regime especial
FederalTaxDeterminationDefaultDeterminação padrão
MunicipalTaxDeterminationDefaultDeterminação padrão
LegalNatureNoneNão definido
EnvironmentDevelopmentAmbiente de desenvolvimento
City.Country"BRA"Brasil (aplicado automaticamente)

Boas Práticas​

Numeração RPS​

  • Inicie a numeração corretamente: Defina RpsNumber como o próximo número a ser usado
  • Sincronize LastRpsSent: Deve ser RpsNumber - 1 na criação
  • Use séries simples: IO, A1, 1 são exemplos comuns
  • Não reutilize números: Cada RPS deve ter número único na série

Códigos IBGE​

Use códigos IBGE válidos de 7 dígitos. Exemplos:

CidadeCódigo IBGE
São Paulo/SP3550308
Rio de Janeiro/RJ3304557
Belo Horizonte/MG3106200
Curitiba/PR4106902
Porto Alegre/RS4314902

Credenciais da Prefeitura​

As credenciais são armazenadas no sistema NFE.io e utilizadas automaticamente no momento da emissão de cada NFS-e:

  • Algumas prefeituras exigem LoginName e LoginPassword
  • Outras exigem AuthIssueValue (token)
  • Consulte os requisitos específicos da prefeitura no portal dela
  • As credenciais devem ser obtidas diretamente na prefeitura pelo contribuinte
  • Nunca compartilhe credenciais em logs ou mensagens de erro

Monitoramento​

  • Verifique FiscalStatus para confirmar que a NFE.io tem suporte para a cidade
  • Use updateprefecture para verificar se houve atualização no suporte da cidade
  • Se FiscalStatus != Active, a cidade pode não ser suportada pela NFE.io ainda

Próximos Passos​

Após cadastrar a inscrição municipal no sistema NFE.io:

  1. Verifique o FiscalStatus - Confirme que a NFE.io tem suporte para a cidade (Active)
  2. Configure o certificado digital se ainda não tiver → Ver documentação
  3. Confirme as credenciais - Se a prefeitura exige login/senha ou token, verifique se foram cadastradas corretamente
  4. Valide a numeração RPS - Confirme que RpsNumber e LastRpsSent estão sincronizados com a prefeitura
  5. Teste a emissão - Se possível, use ambiente de desenvolvimento para validar a configuração
Lembre-se

A NFE.io apenas registra os dados que você já possui. O cadastro na prefeitura (obtenção da Inscrição Municipal, credenciais e habilitação para emissão) deve ser feito diretamente por você no portal da prefeitura.

Veja também:​

NFE.io

A NFE.io é uma empresa de tecnologia que fornece soluções para automatizar e simplificar a emissão e gestão de notas fiscais eletrônicas. Com suas ferramentas, as empresas podem economizar tempo e reduzir erros, aumentando a eficiência e precisão do processo de emissão de notas fiscais.

Um dos principais cases de sucesso da NFE.io é a implementação da solução na empresa de transporte Rodonaves. Com a automatização da emissão e gestão de notas fiscais eletrônicas, a Rodonaves conseguiu reduzir em até 80% o tempo gasto nesse processo, o que se traduziu em uma significativa melhoria na eficiência operacional. Além disso, a empresa também conseguiu eliminar erros e atrasos na emissão de notas fiscais, o que melhorou a relação com seus clientes e aumentou a confiança dos órgãos fiscais.

Outro exemplo é a implementação da NFE.io na empresa de comércio eletrônico, a Loja Integrada. Com a automatização da emissão de notas fiscais, a Loja Integrada conseguiu aumentar a velocidade de emissão de notas em até 10 vezes, o que permitiu que a empresa atendesse a uma maior quantidade de clientes e, consequentemente, aumentar as suas vendas.

Além desses exemplos, a NFE.io também tem outros cases de sucesso com empresas de setores como indústria, construção, varejo e serviços, mostrando a versatilidade e eficácia da sua solução.

Em resumo, a NFE.io é uma empresa de tecnologia que oferece soluções para automatizar e simplificar a emissão e gestão de notas fiscais eletrônicas, ajudando as empresas a economizar tempo e reduzir erros, melhorando a eficiência e precisão do processo. Com cases de sucesso em diferentes setores, a NFE.io tem se destacado como uma empresa líder em automação fiscal.