Pular para o conteúdo principal

Referência de campos da NFS-e GovDigital

Campos do objeto nota quando o provedor é o GovDigital. O payload é o mesmo infDPS do Padrão Nacional — o que muda é o XML que geramos a partir dele, não o que você envia.

Esta página é gerada, não escrita

Ela sai de duas fontes, direto do que roda em produção:

  • o conversor — quais nomes você pode enviar e em que campo do layout cada um vira;
  • os XSD oficiais — tipo, tamanho, valores permitidos e a descrição de cada campo.

Por isso ela não diverge do sistema: se um campo muda no código, muda aqui. E por isso os textos da coluna "O que é" são os oficiais, não uma reescrita nossa.

São 35 campos em 12 grupos, 30 deles com descrição oficial.

Como ler

O corpo da emissão tem esta forma:

{
"cpf_cnpj": "11222333000181",
"provedor": "govdigital",
"nota": {
"infDPS": {
"prest": { "CNPJ": "...", "IM": "..." },
"toma": { "...": "..." },
"serv": { "cServ": { "...": "..." } }
}
}
}

Cada seção abaixo é um desses blocos. A coluna Campo é o próprio nome que você envia: neste provedor não há tradução de nome, só a montagem do XML.

Um campo pode aceitar mais de um nome

8 campos aceitam nomes alternativos. Quando existem, aparecem como "também:" na primeira coluna — qualquer um funciona.

Campo com nome errado não dá erro

O conversor repassa chave desconhecida como veio, e o emissor a ignora: um vlrProd no lugar de vProd gera uma nota válida com o produto valendo R$ 0,00.

Antes da primeira emissão, passe o seu payload em POST /v1/nfe/verificar-campos — ele aponta o campo desconhecido e sugere o certo, sem emitir e sem consumir cota.

nota.prest

Neste grupo o nome que você envia é o nome do layout — não há tradução.

CampoCampoTipoTam.ValoresO que é
CNPJCNPJstring14Número do CNPJ do emitente da NFS-e.
IM
também: InscricaoMunicipal
IMstring15Número da inscrição municipal
xNome
também: RazaoSocial
xNomestring300Nome / Razão Social do emitente.
opSimpNacopSimpNacstring1 2 3Situação perante o Simples Nacional: 1 - Não Optante; 2 - Optante - Microempreendedor Individual (MEI); 3 - Optante - Microempresa ou Empresa de Pequeno Porte (ME/EPP);

nota.cServ

Neste grupo o nome que você envia é o nome do layout — não há tradução.

CampoCampoTipoTam.ValoresO que é
cNBScNBSstringCódigo NBS correspondente ao serviço prestado, seguindo a versão 2.0, conforme Anexo B
xDescServxDescServTSStringComQuebraDeLinha2000Descrição completa do serviço prestado

nota.locPrest

Neste grupo o nome que você envia é o nome do layout — não há tradução.

CampoCampoTipoTam.ValoresO que é
cLocPrestacaocLocPrestacaostringCódigo do município onde o serviço foi prestado (tabela do IBGE)

nota.tribMun

Neste grupo o nome que você envia é o nome do layout — não há tradução.

CampoCampoTipoTam.ValoresO que é
cLocIncid
também: cLocPrestacao
cLocIncidstringO código de município utilizado pelo Sistema Nacional NFS-e é o código definido para cada município pertencente ao ""Anexo V – Tabela de Código de Municípios do IBGE"", que consta ao final do Manual de Orientação ao Contribuinte do ISSQN para a Sefin Nacional NFS-e. O município de incidência do ISSQN é determinado automaticamente pelo sistema, conforme regras do aspecto espacial da lei complementar federal (LC 116/03) que são válidas para todos os municípios. http://www.planalto.gov.br/ccivil_03/Leis/LCP/Lcp116.htm
vISSQNvISSQNstringValor do ISSQN (R$) = Valor da Base de Cálculo x Alíquota ISSQN = vBC x pAliqAplic
pAliqpAliqstringValor da alíquota (%) do serviço prestado relativo ao município sujeito ativo (município de incidência) do ISSQN. Se o município de incidência pertence ao Sistema Nacional NFS-e a alíquota estará parametrizada e, portanto, será fornecida pelo sistema. Se o município de incidência não pertence ao Sistema Nacional NFS-e a alíquota não estará parametrizada e, por isso, deverá ser fornecida pelo emitente.
vBC
também: vServ
vBCstring
tpRetISSQNtpRetISSQNstring1 2 3Tipo de retencao do ISSQN: 1 - Não Retido; 2 - Retido pelo Tomador; 3 - Retido pelo Intermediario;

nota.vServPrest

Neste grupo o nome que você envia é o nome do layout — não há tradução.

CampoCampoTipoTam.ValoresO que é
vServvServstringValor dos serviços em R$

nota.IBSCBS

Neste grupo o nome que você envia é o nome do layout — não há tradução.

CampoCampoTipoTam.ValoresO que é
cIndOpcIndOpstringCódigo indicador da operação de fornecimento, conforme tabela "código indicador de operação"

nota.gIBSCBS

Neste grupo o nome que você envia é o nome do layout — não há tradução.

CampoCampoTipoTam.ValoresO que é
cClassTrib
também: CClassTribReg, cClassTribReg
cClassTribstringCódigo de Classificação Tributária do IBS e da CBS
CST
também: cst
CSTstring00 01 02 03 04 05 06 07 08 09 49 50
TpRetPisCofins
também: tpRetPisCofins
TpRetPisCofinscampo do emissor, sem descrição no layout

nota (raiz)

Neste grupo o nome que você envia é o nome do layout — não há tradução.

CampoCampoTipoTam.ValoresO que é
usar_nt004usar_nt004campo do emissor, sem descrição no layout

nota.toma

Neste grupo o nome que você envia é o nome do layout — não há tradução.

CampoCampoTipoTam.ValoresO que é
CPFCPFstring11Número da inscrição no Cadastro de Pessoa Física (CPF) do Destinatário do serviço
CNPJCNPJstring14Número da inscrição no Cadastro Nacional de Pessoa Jurídica (CNPJ) do Destinatário do serviço
IMIMstring15Número da inscrição municipal
xNomexNomestring300Nome / Nome Empresarial do do Destinatário do serviço

nota.atvEvento

Neste grupo o nome que você envia é o nome do layout — não há tradução.

CampoCampoTipoTam.ValoresO que é
desc
também: nome, xNome
desccampo do emissor, sem descrição no layout
dtInidtInistringData de início da atividade de evento. Ano, Mês e Dia (AAAA-MM-DD)
dtFimdtFimstringData de fim da atividade de evento. Ano, Mês e Dia (AAAA-MM-DD)
idAtvEvtidAtvEvtstring30Identificação da Atividade de Evento (código identificador de evento determinado pela Administração Tributária Municipal)

nota.end

Neste grupo o nome que você envia é o nome do layout — não há tradução.

CampoCampoTipoTam.ValoresO que é
xLgrxLgrTSString255Tipo e nome do logradouro da localização do imóvel
nronroTSString60Número do imóvel
xCplxCplTSString156Complemento do endereço
xBairroxBairroTSString60Bairro
UFUFstringAC AL AM AP BA CE DF ES GO MA MG MSSigla da unidade da federação do município do endereço do emitente.
CEPCEPstringNúmero do CEP
cMuncMunstringCódigo do município, conforme Tabela do IBGE

nota.endNac

Neste grupo o nome que você envia é o nome do layout — não há tradução.

CampoCampoTipoTam.ValoresO que é
cMuncMunstringCódigo do município, conforme Tabela do IBGE
CEPCEPstringNúmero do CEP

Grupos que passam direto

Em 12 grupos o campo vai para o layout com o mesmo nome, sem tradução: prest · cServ · locPrest · tribMun · vServPrest · IBSCBS · gIBSCBS · raiz · toma · atvEvento · end · endNac

São os grupos da Reforma Tributária e do ISSQN. Use os nomes do layout oficial.

O que esta página não cobre

Ela lista quais campos existem e o que cada um aceita. Ela não diz quando cada grupo é exigido — isso depende de UF, município, regime tributário e da operação, e está nos guias de emissão. Um payload que passa por esta referência ainda pode ser rejeitado por regra fiscal.