Todo campo do payload de emissão de NFSe (POST /v1/nfse): tipo, tamanho, tag do leiaute e obrigatoriedade.
Esta página lista exatamente o que a engineAPI aceita hoje no payload de emissão
de NFSe, nem mais, nem menos, com a tag do leiaute de cada campo onde ela já
foi catalogada. A NFSe tem provider por município (ABRASF) ou Padrão Nacional (SEFIN/ADN, bloco dpsNacional): o formato aceito é o mesmo nos dois, mas cada provider usa um subconjunto. Com resolverTributacao: true (Cérebro Fiscal), campos da DPS ausentes são preenchidos pelo cadastro do emissor; campo obrigatório sem fonte devolve 422 com camposNaoResolvidos; ver Cérebro Fiscal. Para empresa do Simples, dpsNacional.pTotTribSN enviado na nota tem prioridade; sem ele, o cadastro pode informar pTotTribSNPadrao e seu mês de referência pTotTribSNCompetencia (AAAA-MM). Percentual de mês anterior, futuro ou sem mês registrado não bloqueia a emissão, mas devolve um aviso para confirmar o valor com o contador. O bloco ibsCbs (Reforma Tributária) é passthrough puro: nada nele é resolvido pelo Cérebro Fiscal. Esta página descreve o contrato de entrada, não a cobertura fiscal completa do leiaute oficial. servico.valorServicos e os demais valores monetários TSDec15V2 aceitam até 15 dígitos inteiros e 2 casas decimais: excesso de largura ou fração de centavo devolve 400 antes da emissão. Ver Erros e respostas.Leiaute: versão 1.01 · Contrato revisado em: 2026-08-15 75 campos documentados abaixo (contagem recursiva, incluindo objetos aninhados e itens de array).
Tag do leiaute: sem tag própria no XML · Obrigatoriedade do leiaute: não é campo do leiaute (informativo/de compatibilidade)Nota do leiaute: Grupo do modelo municipal antigo. A DPS não possui contêiner de RPS porque a própria declaração é o documento de origem.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfDPS (sem grupo de RPS no leiaute nacional).
Show 3 campo(s)
integer
required
Tag do leiaute: sem tag própria no XML · Obrigatoriedade do leiaute: não é campo do leiaute (informativo/de compatibilidade) · Preenche: você, na requisiçãoNúmero do RPS. Só tem efeito na emissão pelo provedor municipal. Na emissão pelo Padrão Nacional o campo é recusado com 422 RPS_SEM_CAMPO_NO_PADRAO_NACIONAL, porque o leiaute da DPS não tem campo de RPSNota do leiaute: O Padrão Nacional não tem RPS: a própria DPS é o documento de origem, e o número dela é alocado pela engineAPI por empresa e série. Enviar este campo na emissão nacional é recusado com 422, em vez de gerar uma nota sem o dado. Guarde a correspondência com o seu RPS pelo número da DPS devolvido na emissão.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfDPS não tem grupo de RPS. O número do documento é nDPS, sequencial controlado pela engineAPI.
string
Tag do leiaute: sem tag própria no XML · Obrigatoriedade do leiaute: não é campo do leiaute (informativo/de compatibilidade) · Preenche: você, na requisiçãoSérie do RPS. Só tem efeito na emissão pelo provedor municipal. Na emissão pelo Padrão Nacional o campo é recusado com 422 RPS_SEM_CAMPO_NO_PADRAO_NACIONAL, porque o leiaute da DPS não tem campo de RPSNota do leiaute: Série do RPS do modelo municipal, sem equivalente no Padrão Nacional. A série que vai para a DPS é o campo serie do topo do payload. Enviar este campo na emissão nacional é recusado com 422.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfDPS não tem grupo de RPS. A série do documento é TCInfDPS/serie.
integer
Tag do leiaute: sem tag própria no XML · Obrigatoriedade do leiaute: não é campo do leiaute (informativo/de compatibilidade) · Preenche: você, na requisiçãoTipo do RPS. Só tem efeito na emissão pelo provedor municipal. Na emissão pelo Padrão Nacional o campo é recusado com 422 RPS_SEM_CAMPO_NO_PADRAO_NACIONAL, porque o leiaute da DPS não tem campo de RPSNota do leiaute: Tipo de RPS do modelo municipal, sem equivalente no Padrão Nacional. Enviar este campo na emissão nacional é recusado com 422.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfDPS não tem grupo de RPS.
string
Tamanho: Até 5 dígitos numéricos (TSSerieDPS) · Tag do leiaute:serie (grupo infDPS) · Obrigatoriedade do leiaute: obrigatório no leiaute · Preenche: você, na requisiçãoFonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfDPS/serie (TSSerieDPS). Ausente no payload, a engineAPI usa a série 1.
object
Tag do leiaute: sem tag própria no XML · Obrigatoriedade do leiaute: não é campo do leiaute (informativo/de compatibilidade)Nota do leiaute: Grupo lógico da API que organiza os campos fiscais do padrão nacional; no XML esses campos ficam distribuídos em prest/regTrib, serv/cServ e valores/trib.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfDPS (sem elemento dpsNacional; os campos ficam em grupos distintos).
Show 10 campo(s)
string
required
Tamanho: 1 dígito (TSOpSimpNac) · Tag do leiaute:opSimpNac (grupo infDPS/prest/regTrib) · Obrigatoriedade do leiaute: obrigatório no leiaute · Preenche: preenchido automaticamente pela engineAPIFonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRegTrib/opSimpNac (TSOpSimpNac). Com resolverTributacao igual a true, o Cérebro Fiscal preenche a partir do cadastro da empresa.
string
Tamanho: 1 dígito (TSRegimeApuracaoSimpNac) · Tag do leiaute:regApTribSN (grupo infDPS/prest/regTrib) · Obrigatoriedade do leiaute: condicional no leiaute · Preenche: você, na requisiçãoCondição do leiaute: Só para optante ME/EPP (opSimpNac igual a 3), para indicar em que regime os tributos federais e o municipal estão inseridos quando algum sublimite do Simples foi ultrapassado. MEI não leva o campo. Na engineAPI o campo é OBRIGATÓRIO NA REQUISIÇÃO quando a empresa está cadastrada com crt igual a 2 (Simples Nacional com excesso de sublimite): o crt confirma que a empresa é optante do Simples, mas sozinho não diz o regime de apuração, e não existe um padrão desse regime no cadastro da empresa. Sem o campo, a emissão é recusada com 422 e o código CRT2_SEM_REGIME_APURACAO, antes de qualquer transmissão e sem consumir número de DPS. Vale em QUALQUER forma de emissão, inclusive com resolverTributacao igual a true. Para crt igual a 1 (Simples) a engineAPI continua derivando o valor 1 do cadastro quando o campo é omitido.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRegTrib/regApTribSN (TSRegimeApuracaoSimpNac). A engineAPI só deriva o valor quando também derivou o opSimpNac E o cadastro traz a fonte do regime (crt igual a 1); no crt igual a 2 não há fonte e o campo tem de vir na requisição.
string
Tamanho: 1 dígito (TSRegEspTrib) · Tag do leiaute:regEspTrib (grupo infDPS/prest/regTrib) · Obrigatoriedade do leiaute: obrigatório no leiaute · Preenche: você, na requisiçãoFonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRegTrib/regEspTrib (TSRegEspTrib), elemento obrigatório. Ausente no payload, a engineAPI escreve 0 (nenhum).
string
required
Tamanho: 6 dígitos: 2 do item da lista de serviços, 2 do subitem e 2 do desdobro nacional · Tag do leiaute:cTribNac (grupo infDPS/serv/cServ) · Obrigatoriedade do leiaute: obrigatório no leiaute · Preenche: preenchido automaticamente pela engineAPIFonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCCServ/cTribNac (TSCodTribNac). Com resolverTributacao igual a true, o Cérebro Fiscal resolve o código a partir do serviço padrão da empresa.
string
Tamanho: 3 dígitos numéricos (TCCodTribMun) · Tag do leiaute:cTribMun (grupo infDPS/serv/cServ) · Obrigatoriedade do leiaute: opcional no leiaute · Preenche: você, na requisiçãoCódigo de tributação municipal do ISSQN (3 dígitos). Vai para serv/cServ/cTribMun na DPS. Equivalente de baixo nível de servico.codigoTributacaoMunicipio: informar os dois com valores diferentes recusa com 422 CTRIBMUN_CONFLITOCondição do leiaute: Este campo e servico.codigoTributacaoMunicipio escrevem a MESMA tag. Informe um dos dois, ou os dois com o mesmo valor: valores diferentes são recusados com 422.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCCServ/cTribMun (TCCodTribMun, 3 dígitos).
string
required
Tamanho: 1 dígito (TSTribISSQN) · Tag do leiaute:tribISSQN (grupo infDPS/valores/trib/tribMun) · Obrigatoriedade do leiaute: obrigatório no leiaute · Preenche: preenchido automaticamente pela engineAPIFonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribMunicipal/tribISSQN (TSTribISSQN). Com resolverTributacao igual a true, o Cérebro Fiscal preenche.
string
Tamanho: 1 dígito (TSTipoRetISSQN) · Tag do leiaute:tpRetISSQN (grupo infDPS/valores/trib/tribMun) · Obrigatoriedade do leiaute: obrigatório no leiaute · Preenche: derivado de outros campos (calculado)Tipo de retenção do ISSQN: 1 (não retido), 2 (retido pelo tomador) ou 3 (retido pelo intermediário). Equivalente de baixo nível de retencoes.issRetidoPor: informar os dois com valores diferentes recusa com 422 RETENCAO_ISS_CONFLITOFonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribMunicipal/tpRetISSQN (TSTipoRetISSQN), elemento obrigatório. A engineAPI reconcilia este campo com retencoes.issRetidoPor (valores diferentes recusam com 422 RETENCAO_ISS_CONFLITO) e escreve 1 quando nenhum dos dois vem.
string
Tamanho: 2 dígitos (TSTipoCST) · Tag do leiaute:CST (grupo infDPS/valores/trib/tribFed/piscofins) · Obrigatoriedade do leiaute: condicional no leiaute · Preenche: você, na requisiçãoCondição do leiaute: Obrigatório sempre que o grupo de PIS/COFINS for escrito, ou seja, sempre que houver indicador de retenção. Informar o indicador sem o CST recusa com 422 RETENCAO_PIS_COFINS_SEM_CST.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribOutrosPisCofins/CST (TSTipoCST), elemento obrigatório do grupo.
string
Tamanho: 1 dígito (TSTipoRetPISCofins) · Tag do leiaute:tpRetPisCofins (grupo infDPS/valores/trib/tribFed/piscofins) · Obrigatoriedade do leiaute: opcional no leiaute · Preenche: você, na requisiçãoTipo de retenção do PIS/COFINS (enum TSTipoRetPISCofins, códigos 0 a 9; ex.: 1 = PIS/COFINS retidos, 3 = PIS/COFINS/CSLL retidos). É como se declara a retenção de PIS/COFINS, que não tem campo de valor na DPS. Exige dpsNacional.cstPisCofinsCondição do leiaute: É por este indicador que a retenção de PIS/COFINS se declara: o leiaute não tem campo para o valor retido desses tributos. Exige dpsNacional.cstPisCofins e é conferido contra retencoes.csll.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribOutrosPisCofins/tpRetPisCofins (TSTipoRetPISCofins). O código vai como o integrador informou: a engineAPI nunca o infere.
number
Tamanho: Até 3 dígitos inteiros e 2 decimais (TSDec3V2) · Tag do leiaute:pTotTribSN (grupo infDPS/valores/trib/totTrib) · Obrigatoriedade do leiaute: condicional no leiaute · Preenche: preenchido automaticamente pela engineAPICondição do leiaute: O grupo de total de tributos exige exatamente uma das quatro opções do leiaute. Para optante ME/EPP (opSimpNac igual a 3) o sistema nacional recusa o indicador de omissão, então o percentual passa a ser obrigatório: sem ele no payload nem no cadastro da empresa, a emissão para antes de transmitir com 422. O valor enviado nesta requisição sempre tem precedência e segue sem alteração. Quando vier do cadastro, informe também pTotTribSNCompetencia (AAAA-MM): se o mês estiver anterior ao mês corrente em Brasília, futuro ou não estiver registrado, a nota é emitida e avisos[] pede a confirmação com o contador. Nos demais regimes, ausente, a engineAPI declara que não informa o valor estimado dos tributos.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribTotal/pTotTribSN (em xs:choice com vTotTrib, pTotTrib e indTotTrib).
integer
Tag do leiaute: sem tag própria no XML · Obrigatoriedade do leiaute: não é campo do leiaute (informativo/de compatibilidade) · Preenche: você, na requisiçãoNota do leiaute: Conceito do modelo municipal. No Padrão Nacional a natureza da operação é expressa pela tributação do ISSQN (dpsNacional.tribISSQN) e pelo local da prestação. Campo aceito por compatibilidade e não escrito no documento.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): não há elemento de natureza da operação em TCInfDPS.
integer
Tag do leiaute: sem tag própria no XML · Obrigatoriedade do leiaute: não é campo do leiaute (informativo/de compatibilidade) · Preenche: você, na requisiçãoNota do leiaute: Conceito do modelo municipal. No Padrão Nacional o regime vai no grupo prest/regTrib, alimentado por dpsNacional.opSimpNac, regApTribSN e regEspTrib. Campo aceito por compatibilidade e não escrito no documento.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): o regime do prestador é TCRegTrib, com três elementos próprios.
boolean
Tag do leiaute: sem tag própria no XML · Obrigatoriedade do leiaute: não é campo do leiaute (informativo/de compatibilidade) · Preenche: você, na requisiçãoNota do leiaute: Booleano do modelo municipal. O Padrão Nacional exige um código de três valores (não optante, MEI, ME/EPP), informado em dpsNacional.opSimpNac. Campo aceito por compatibilidade e não escrito no documento.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRegTrib/opSimpNac é enumeração de três valores, não booleano.
integer
Tag do leiaute: sem tag própria no XML · Obrigatoriedade do leiaute: não é campo do leiaute (informativo/de compatibilidade) · Preenche: você, na requisiçãoNota do leiaute: Código do modelo municipal. No Padrão Nacional a exigibilidade se declara por dpsNacional.tribISSQN (tributável, imunidade, exportação, não incidência) e pelo grupo de exigibilidade suspensa, que este motor ainda não escreve. Campo aceito por compatibilidade e não escrito no documento.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribMunicipal/tribISSQN e TCExigSuspensa.
string
Tamanho: AAAA-MM-DD (TSData) · Tag do leiaute:dCompet (grupo infDPS) · Obrigatoriedade do leiaute: obrigatório no leiaute · Preenche: você, na requisiçãopadrão: ^\d{4}-\d{2}-\d{2}$Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfDPS/dCompet (TSData), “data em que se iniciou a prestação do serviço”. Ausente no payload, vale a data de emissão.
Emitente
Os dados completos do emitente (razão social, CNPJ, endereço, Inscrição Estadual) vêm do cadastro da empresa selecionada em issuerId, não são enviados campo a campo no payload de emissão.
string
required
Tamanho: mínimo 1 caractere(s) · Tag do leiaute: sem tag própria no XML · Obrigatoriedade do leiaute: não é campo do leiaute (informativo/de compatibilidade) · Preenche: você, na requisiçãoNota do leiaute: Identificador da empresa emissora na engineAPI, não é campo do leiaute. É ele que determina o grupo prest (CNPJ ou CPF e regime) e o município emissor, lidos do cadastro.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): não há elemento correspondente. O grupo prest é montado a partir do cadastro da empresa.
Destinatário
Na NFS-e o destinatário do leiaute é o tomador do serviço.
object
required
Tag do leiaute:toma (grupo infDPS) · Obrigatoriedade do leiaute: condicional no leiauteCondição do leiaute: No XSD o grupo é opcional para cobrir operações sem tomador identificado, mas neste contrato ele é obrigatório.Nota do leiaute: Grupo, não campo: toma é o contêiner de identificação e endereço do tomador.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfDPS/toma (TCInfoPessoa, minOccurs=“0”).
Show 6 campo(s)
string
required
Tamanho: 14 dígitos (CNPJ) ou 11 dígitos (CPF), só números · Tag do leiaute:CNPJ|CPF (grupo infDPS/toma) · Obrigatoriedade do leiaute: obrigatório no leiaute · Preenche: derivado de outros campos (calculado)Condição do leiaute: O leiaute escolhe uma das duas tags. A engineAPI classifica pelo comprimento do documento limpo: 14 dígitos vão em CNPJ, 11 em CPF.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfoPessoa/CNPJ (TSCNPJ) ou TCInfoPessoa/CPF (TSCPF), em xs:choice com NIF/cNaoNIF.
string
required
Tamanho: 1 a 300 caracteres (TSNomeRazaoSocial) · Tag do leiaute:xNome (grupo infDPS/toma) · Obrigatoriedade do leiaute: obrigatório no leiaute · Preenche: você, na requisiçãoFonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfoPessoa/xNome (TSNomeRazaoSocial).
string
Tamanho: 1 a 80 caracteres (TSEmail) · Tag do leiaute:email (grupo infDPS/toma) · Obrigatoriedade do leiaute: opcional no leiaute · Preenche: você, na requisiçãoFonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfoPessoa/email (TSEmail).
string
Tamanho: 6 a 20 dígitos (TSTelefone), DDD mais número · Tag do leiaute:fone (grupo infDPS/toma) · Obrigatoriedade do leiaute: opcional no leiaute · Preenche: derivado de outros campos (calculado)Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfoPessoa/fone (TSTelefone). A engineAPI remove tudo que não é dígito antes de escrever.
string
Tamanho: 1 a 15 caracteres (TSInscMun) · Tag do leiaute:IM (grupo infDPS/toma) · Obrigatoriedade do leiaute: opcional no leiaute · Preenche: você, na requisiçãoInscrição municipal do tomador (até 15 caracteres). Vai para toma/IM na DPSFonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfoPessoa/IM (TSInscMun), escrito antes do nome do tomador, na ordem do grupo.
object
required
Tag do leiaute:end (grupo infDPS/toma) · Obrigatoriedade do leiaute: condicional no leiauteCondição do leiaute: No XSD o grupo é opcional dentro de toma, mas neste contrato o endereço do tomador é obrigatório.Nota do leiaute: Grupo, não campo: end é o contêiner do endereço do tomador.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfoPessoa/end (TCEndereco, minOccurs=“0”).
Show 7 campo(s)
string
required
Tamanho: 1 a 255 caracteres (TSLogradouro) · Tag do leiaute:xLgr (grupo infDPS/toma/end) · Obrigatoriedade do leiaute: obrigatório no leiaute · Preenche: você, na requisiçãoTexto do endereço (até 255 caracteres). Vai para a DPS. Aceita apenas caracteres latinos básicos: travessão, aspas curvas, reticências e emoji são recusados com 400. Quebra de linha e tabulação viram espaço na emissãoFonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCEndereco/xLgr (TSLogradouro).
string
required
Tamanho: 1 a 60 caracteres (TSNumeroEndereco) · Tag do leiaute:nro (grupo infDPS/toma/end) · Obrigatoriedade do leiaute: obrigatório no leiaute · Preenche: você, na requisiçãoTexto do endereço (até 60 caracteres). Vai para a DPS. Aceita apenas caracteres latinos básicos: travessão, aspas curvas, reticências e emoji são recusados com 400. Quebra de linha e tabulação viram espaço na emissãoFonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCEndereco/nro (TSNumeroEndereco).
string
Tamanho: 1 a 156 caracteres (TSComplementoEndereco) · Tag do leiaute:xCpl (grupo infDPS/toma/end) · Obrigatoriedade do leiaute: opcional no leiaute · Preenche: você, na requisiçãoTexto do endereço (até 156 caracteres). Vai para a DPS. Aceita apenas caracteres latinos básicos: travessão, aspas curvas, reticências e emoji são recusados com 400. Quebra de linha e tabulação viram espaço na emissãoFonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCEndereco/xCpl (TSComplementoEndereco).
string
required
Tamanho: 1 a 60 caracteres (TSBairro) · Tag do leiaute:xBairro (grupo infDPS/toma/end) · Obrigatoriedade do leiaute: obrigatório no leiaute · Preenche: você, na requisiçãoTexto do endereço (até 60 caracteres). Vai para a DPS. Aceita apenas caracteres latinos básicos: travessão, aspas curvas, reticências e emoji são recusados com 400. Quebra de linha e tabulação viram espaço na emissãoFonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCEndereco/xBairro (TSBairro).
string
required
Tamanho: 7 dígitos, código IBGE do município (TSCodMunIBGE) · Tag do leiaute:cMun (grupo infDPS/toma/end/endNac) · Obrigatoriedade do leiaute: obrigatório no leiaute · Preenche: você, na requisiçãoFonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCEnderNac/cMun (TSCodMunIBGE).
string
required
Tamanho: mínimo 1 caractere(s) · Tag do leiaute: sem tag própria no XML · Obrigatoriedade do leiaute: não é campo do leiaute (informativo/de compatibilidade) · Preenche: você, na requisiçãoNota do leiaute: O endereço nacional da DPS tem apenas código do município e CEP: a UF é deduzida do código IBGE pelo sistema nacional. Campo aceito por compatibilidade e não escrito no documento.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCEnderNac tem somente cMun e CEP.
string
required
Tamanho: 8 dígitos, só números (TSCEP) · Tag do leiaute:CEP (grupo infDPS/toma/end/endNac) · Obrigatoriedade do leiaute: obrigatório no leiaute · Preenche: derivado de outros campos (calculado)Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCEnderNac/CEP (TSCEP). A engineAPI remove tudo que não é dígito antes de escrever.
Itens
Na NFS-e o item do leiaute é o serviço prestado: cada DPS descreve um único serviço, não é um array como em NF-e/NFC-e.
object
required
Tag do leiaute:serv (grupo infDPS) · Obrigatoriedade do leiaute: obrigatório no leiauteNota do leiaute: Grupo, não campo: serv é o contêiner dos dados do serviço.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfDPS/serv (TCServ).
Show 11 campo(s)
string
required
Tamanho: 7 dígitos, código IBGE do município (TSCodMunIBGE) · Tag do leiaute:cLocPrestacao (grupo infDPS/serv/locPrest) · Obrigatoriedade do leiaute: obrigatório no leiaute · Preenche: você, na requisiçãoCondição do leiaute: O leiaute aceita o município da prestação ou o país da prestação, quando o serviço é prestado no exterior. Este motor escreve sempre o município.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCLocPrest/cLocPrestacao (TSCodMunIBGE), em xs:choice com cPaisPrestacao.
string
Tamanho: mínimo 1 caractere(s) · Tag do leiaute: sem tag própria no XML · Obrigatoriedade do leiaute: não é campo do leiaute (informativo/de compatibilidade) · Preenche: preenchido automaticamente pela engineAPINota do leiaute: O Padrão Nacional identifica o serviço pelo código de tributação nacional de 6 dígitos (dpsNacional.cTribNac), não pelo item da lista no formato do modelo municipal. Este campo é a entrada do Cérebro Fiscal, que resolve o cTribNac quando resolverTributacao é true, mas não vira tag na DPS.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCCServ tem cTribNac, cTribMun, xDescServ, cNBS e cIntContrib, nenhum no formato do item da lista de serviços.
string
Tag do leiaute: sem tag própria no XML · Obrigatoriedade do leiaute: não é campo do leiaute (informativo/de compatibilidade) · Preenche: você, na requisiçãoNota do leiaute: O leiaute da DPS não tem campo de CNAE. Campo aceito por compatibilidade com o modelo municipal e não escrito no documento.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): nenhuma ocorrência de CNAE nos três esquemas oficiais.
string
Tamanho: 3 dígitos numéricos (TCCodTribMun) · Tag do leiaute:cTribMun (grupo infDPS/serv/cServ) · Obrigatoriedade do leiaute: opcional no leiaute · Preenche: você, na requisiçãoCódigo de tributação municipal do ISSQN (3 dígitos). Vai para serv/cServ/cTribMun na DPS. Equivalente de alto nível de dpsNacional.cTribMun: informar os dois com valores diferentes recusa com 422 CTRIBMUN_CONFLITOCondição do leiaute: Este campo e dpsNacional.cTribMun escrevem a MESMA tag. Informe um dos dois, ou os dois com o mesmo valor: valores diferentes são recusados com 422, porque escolher um deles seria decidir a tributação municipal no lugar de quem emite.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCCServ/cTribMun (TCCodTribMun, 3 dígitos).
string
Tamanho: 9 dígitos numéricos (TSCodNBS, NBS versão 2.0). A pontuação usual do código é aceita e removida na emissão: 1.1401.20.00 e 114012000 dão no mesmo. · Tag do leiaute:cNBS (grupo infDPS/serv/cServ) · Obrigatoriedade do leiaute: opcional no leiaute · Preenche: preenchido automaticamente pela engineAPICódigo NBS 2.0 (9 dígitos). Vai para serv/cServ/cNBS na DPSCondição do leiaute: Com resolverTributacao igual a true, o Cérebro Fiscal preenche o código a partir da tabela vigente quando o campo vem ausente. Se o código da tabela não tiver os 9 dígitos exigidos, a nota é emitida sem ele e a resposta traz o aviso.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCCServ/cNBS (TSCodNBS, 9 dígitos), escrito depois da descrição do serviço, na ordem do grupo.
string
required
Tamanho: 1 a 2000 caracteres (TSDesc2000) · Tag do leiaute:xDescServ (grupo infDPS/serv/cServ) · Obrigatoriedade do leiaute: obrigatório no leiaute · Preenche: você, na requisiçãoFonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCCServ/xDescServ (TSDesc2000), “descrição completa do serviço prestado”.
number
required
Tamanho: Até 15 dígitos inteiros e 2 decimais (TSDec15V2) · Tag do leiaute:vServ (grupo infDPS/valores/vServPrest) · Obrigatoriedade do leiaute: obrigatório no leiaute · Preenche: você, na requisiçãoValor em R$, com no máximo 2 casas decimais. Vai para valores/vServPrest/vServ na DPSFonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCVServPrest/vServ (TSDec15V2), “valor dos serviços em R$”. O valor é apenas formatado com 2 casas, nunca calculado.
number
Tamanho: 1 dígito inteiro e 2 decimais (TSDec1V2): percentual de 0 a 9,99. Percentual de dois dígitos, como 15, é recusado pelo esquema oficial. · Tag do leiaute:pAliq (grupo infDPS/valores/trib/tribMun) · Obrigatoriedade do leiaute: condicional no leiaute · Preenche: você, na requisiçãoAlíquota do ISS em percentual (0 a 9,99; no máximo 1 dígito inteiro e 2 casas). Vai para tribMun/pAliq na DPSCondição do leiaute: Informe apenas quando o município de incidência não é parametrizado no Sistema Nacional. Se o município participa, a alíquota é fornecida pelo próprio sistema. Com resolverTributacao igual a true o valor enviado é ignorado, com aviso na resposta: ecoar alíquota divergente causa rejeição.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribMunicipal/pAliq (TSDec1V2). A ordem dos elementos do grupo é normativa e foi conferida contra o esquema.
number
Tamanho: Até 15 dígitos inteiros e 2 decimais (TSDec15V2) · Tag do leiaute:vDR (grupo infDPS/valores/vDedRed) · Obrigatoriedade do leiaute: condicional no leiaute · Preenche: você, na requisiçãoValor em R$, com no máximo 2 casas decimais. Vai para valores/vDedRed/vDR na DPSCondição do leiaute: O leiaute permite declarar a dedução como percentual, como valor ou por lista de documentos. Este motor escreve o valor em reais; percentual e lista de documentos ainda não são suportados. O valor reduz a base de cálculo apurada pelo sistema nacional.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfoValores/vDedRed/vDR (TSDec15V2), folha obrigatória dentro da escolha de TCInfoDedRed quando a dedução é declarada por valor monetário. O valor é apenas formatado com 2 casas, nunca calculado.
number
Tamanho: Até 15 dígitos inteiros e 2 decimais (TSDec15V2) · Tag do leiaute:vDescIncond (grupo infDPS/valores/vDescCondIncond) · Obrigatoriedade do leiaute: opcional no leiaute · Preenche: você, na requisiçãoValor em R$, com no máximo 2 casas decimais. Vai para valores/vDescCondIncond/vDescIncond na DPSCondição do leiaute: Reduz a base de cálculo do ISSQN apurada pelo sistema nacional, ao contrário do desconto condicionado.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCVDescCondIncond/vDescIncond (TSDec15V2), dentro de TCInfoValores/vDescCondIncond. O valor é apenas formatado com 2 casas, nunca calculado.
number
Tamanho: Até 15 dígitos inteiros e 2 decimais (TSDec15V2) · Tag do leiaute:vDescCond (grupo infDPS/valores/vDescCondIncond) · Obrigatoriedade do leiaute: opcional no leiaute · Preenche: você, na requisiçãoValor em R$, com no máximo 2 casas decimais. Vai para valores/vDescCondIncond/vDescCond na DPSCondição do leiaute: Informativo: o desconto condicionado NÃO entra na fórmula da base de cálculo do ISSQN do leiaute, diferente do incondicionado.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCVDescCondIncond/vDescCond (TSDec15V2). A fórmula da base de cálculo documentada no esquema desconta apenas o incondicionado e a dedução.
Totais
O grupo de totais do leiaute não é enviado no payload: a engineAPI soma os itens e calcula o total automaticamente.
Transporte
NFS-e (prestação de serviço) não tem grupo de transporte no leiaute.
Cobrança
NFS-e não tem grupo de cobrança/fatura no contrato hoje.
Pagamento
NFS-e não tem grupo de pagamento no contrato hoje: a cobrança do serviço é tratada fora da emissão fiscal.
Informações adicionais
string
Tamanho: 1 a 2000 caracteres (TSDescInfCompl). Diferente da discriminação do serviço, este campo aceita apenas caracteres latinos básicos (até U+00FF): travessão, aspas curvas, reticências e emoji são recusados com 400. Quebra de linha, tabulação e espaço nas bordas são convertidos em espaço simples na emissão. · Tag do leiaute:xInfComp (grupo infDPS/serv/infoCompl) · Obrigatoriedade do leiaute: opcional no leiaute · Preenche: você, na requisiçãoInformações complementares da nota (até 2000 caracteres). Vai para serv/infoCompl/xInfComp na DPS. Aceita apenas caracteres latinos básicos: travessão, aspas curvas, reticências e emoji são recusados com 400. Quebra de linha e tabulação viram espaço na emissãoFonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfoCompl/xInfComp (TSDescInfCompl, 1 a 2000, derivado de TSString, cujo padrão oficial não admite quebra de linha nem caractere acima de U+00FF).
Tributação (Reforma e retenções)
Fora da taxonomia clássica do leiaute NF-e/NFC-e: ibsCbs é o grupo da Reforma Tributária (passthrough puro, o Cérebro Fiscal não resolve nada dele), retencoes são as retenções de ISS da prestação e resolverTributacao ativa a emissão assistida; ver guia do Cérebro Fiscal.
object
Tag do leiaute:IBSCBS (grupo infDPS) · Obrigatoriedade do leiaute: opcional no leiauteCondição do leiaute: Opcional no leiaute: o grupo só é emitido quando a operação declara IBS/CBS no padrão RTC.Nota do leiaute: Grupo, não campo: IBSCBS é o contêiner do bloco da Reforma.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfDPS/IBSCBS (TCRTCInfoIBSCBS, minOccurs=“0”).
Show 11 campo(s)
string
Tamanho: 1 dígito (TSRTCFinNFSe) · Tag do leiaute:finNFSe (grupo infDPS/IBSCBS) · Obrigatoriedade do leiaute: obrigatório no leiaute · Preenche: preenchido automaticamente pela engineAPIFinalidade da emissão. O leiaute v1.01 prevê um único valor: “0” (NFS-e regular). Ausente = “0”Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoIBSCBS/finNFSe (TSRTCFinNFSe), com um único valor enumerado. Ausente, a engineAPI escreve 0.
Valor
Significado
0
NFS-e regular
string
Tamanho: 1 dígito (TSRTCIndFinal) · Tag do leiaute:indFinal (grupo infDPS/IBSCBS) · Obrigatoriedade do leiaute: opcional no leiaute · Preenche: você, na requisiçãoOperação de uso ou consumo pessoal (LC 214/2025, art. 57): “0” não · “1” simFonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoIBSCBS/indFinal (TSRTCIndFinal).
Valor
Significado
0
Não é operação de uso ou consumo pessoal
1
Operação de uso ou consumo pessoal (LC 214/2025, artigo 57)
string
required
Tamanho: 6 dígitos (TSRTCCodIndOp) · Tag do leiaute:cIndOp (grupo infDPS/IBSCBS) · Obrigatoriedade do leiaute: obrigatório no leiaute · Preenche: você, na requisiçãoCódigo indicador da operação de fornecimento (6 dígitos), conforme a tabela oficial “Código Indicador de Operação” (ANEXO_C/AnexoVII do portal nacional da NFS-e). Obrigatório quando o bloco ibsCbs é enviado (padrão: ^\d{6}$)Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoIBSCBS/cIndOp (TSRTCCodIndOp), conforme a tabela oficial de código indicador de operação.
string
Tamanho: 1 dígito (TSRTCTpOper) · Tag do leiaute:tpOper (grupo infDPS/IBSCBS) · Obrigatoriedade do leiaute: opcional no leiaute · Preenche: você, na requisiçãoTipo de operação com entes governamentais ou serviços sobre bens imóveis: 1 fornecimento com pagamento posterior · 2 recebimento com fornecimento já realizado · 3 fornecimento com pagamento já realizado · 4 recebimento com fornecimento posterior · 5 fornecimento e recebimento concomitantesFonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoIBSCBS/tpOper (TSRTCTpOper), operação com entes governamentais ou serviços sobre bens imóveis.
Valor
Significado
1
Fornecimento com pagamento posterior
2
Recebimento com fornecimento já realizado
3
Fornecimento com pagamento já realizado
4
Recebimento com fornecimento posterior
5
Fornecimento e recebimento concomitantes
string
Tamanho: 1 dígito (TSRTCTpEnteGov) · Tag do leiaute:tpEnteGov (grupo infDPS/IBSCBS) · Obrigatoriedade do leiaute: opcional no leiaute · Preenche: você, na requisiçãoTipo de ente governamental: 1 União · 2 Estado · 3 DF · 4 MunicípioFonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoIBSCBS/tpEnteGov (TSRTCTpEnteGov).
Valor
Significado
1
União
2
Estado
3
Distrito Federal
4
Município
string
Tamanho: 1 dígito (TSRTCIndDest) · Tag do leiaute:indDest (grupo infDPS/IBSCBS) · Obrigatoriedade do leiaute: obrigatório no leiaute · Preenche: preenchido automaticamente pela engineAPIDestinatário do serviço: “0” o destinatário é o próprio tomador (padrão) · “1” o destinatário é outra pessoa, o que exige o grupo dest do leiaute, ainda NÃO suportado por este motor, que recusa com 422 IBSCBS_DPS_DESTINATARIO_NAO_SUPORTADO em vez de emitir sem o grupoCondição do leiaute: O valor 1 exige o grupo de destinatário do leiaute, que este motor ainda não escreve: nesse caso a emissão recusa com 422 IBSCBS_DPS_DESTINATARIO_NAO_SUPORTADO em vez de emitir o documento sem o grupo.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoIBSCBS/indDest (TSRTCIndDest), elemento obrigatório. Ausente, a engineAPI escreve 0.
Valor
Significado
0
O destinatário é o próprio tomador
1
O destinatário é outra pessoa
string
required
Tamanho: 3 dígitos (TSRTCCodSitTrib) · Tag do leiaute:CST (grupo infDPS/IBSCBS/valores/trib/gIBSCBS) · Obrigatoriedade do leiaute: obrigatório no leiaute · Preenche: você, na requisiçãoCódigo de Situação Tributária do IBS/CBS (3 dígitos). Obrigatório quando o bloco ibsCbs é enviado (o motor não infere CST na NFS-e) (padrão: ^\d{3}$)Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoTributosSitClas/CST (TSRTCCodSitTrib). A DPS declara a situação tributária: alíquota e valor de IBS/CBS são calculados pelo sistema nacional e não existem neste documento.
string
required
Tamanho: 6 dígitos (TSRTCCodClassTrib) · Tag do leiaute:cClassTrib (grupo infDPS/IBSCBS/valores/trib/gIBSCBS) · Obrigatoriedade do leiaute: obrigatório no leiaute · Preenche: você, na requisiçãoCódigo de Classificação Tributária do IBS/CBS (6 dígitos). Obrigatório quando o bloco ibsCbs é enviado (padrão: ^\d{6}$)Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoTributosSitClas/cClassTrib (TSRTCCodClassTrib).
string
Tamanho: 2 dígitos (TSRTCCodCredPres) · Tag do leiaute:cCredPres (grupo infDPS/IBSCBS/valores/trib/gIBSCBS) · Obrigatoriedade do leiaute: opcional no leiaute · Preenche: você, na requisiçãoCódigo e classificação do crédito presumido de IBS/CBS (2 dígitos) (padrão: ^\d{2}$)Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoTributosSitClas/cCredPres (TSRTCCodCredPres).
object
Tag do leiaute:gTribRegular (grupo infDPS/IBSCBS/valores/trib/gIBSCBS) · Obrigatoriedade do leiaute: opcional no leiauteTributação regular: a situação que valeria se o benefício não existisseCondição do leiaute: Opcional no leiaute: só é emitido quando a operação informa a tributação regular de referência.Nota do leiaute: Grupo, não campo: gTribRegular é o contêiner dos campos CSTReg e cClassTribReg.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoTributosSitClas/gTribRegular (minOccurs=“0”).
Show 2 campo(s)
string
required
Tamanho: 3 dígitos (TSRTCCodSitTrib) · Tag do leiaute:CSTReg (grupo infDPS/IBSCBS/valores/trib/gIBSCBS/gTribRegular) · Obrigatoriedade do leiaute: condicional no leiaute · Preenche: você, na requisiçãoCST do IBS/CBS que valeria na tributação regular (sem o benefício aplicado) (padrão: ^\d{3}$)Condição do leiaute: Obrigatório dentro do grupo de tributação regular, que descreve a situação que valeria se o benefício não existisse.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoTributosTribRegular/CSTReg (TSRTCCodSitTrib).
string
required
Tamanho: 6 dígitos (TSRTCCodClassTrib) · Tag do leiaute:cClassTribReg (grupo infDPS/IBSCBS/valores/trib/gIBSCBS/gTribRegular) · Obrigatoriedade do leiaute: condicional no leiaute · Preenche: você, na requisiçãoCódigo de classificação tributária do IBS/CBS na tributação regular (padrão: ^\d{6}$)Condição do leiaute: Obrigatório dentro do grupo de tributação regular, ao lado do CSTReg.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoTributosTribRegular/cClassTribReg (TSRTCCodClassTrib).
object
Tag do leiaute:gDif (grupo infDPS/IBSCBS/valores/trib/gIBSCBS) · Obrigatoriedade do leiaute: opcional no leiauteDiferimento do IBS/CBS. Os três percentuais (pDifUF, pDifMun, pDifCBS) são exigidos juntos pelo leiauteCondição do leiaute: Opcional no leiaute: quando o grupo existe, os três percentuais de diferimento são obrigatórios.Nota do leiaute: Grupo, não campo: gDif é o contêiner dos três percentuais.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoTributosSitClas/gDif (minOccurs=“0”).
Show 3 campo(s)
number
required
Tamanho: Até 3 dígitos inteiros e 2 decimais (TSDec3V2) · Tag do leiaute:pDifUF (grupo infDPS/IBSCBS/valores/trib/gIBSCBS/gDif) · Obrigatoriedade do leiaute: condicional no leiaute · Preenche: você, na requisiçãoPercentual de diferimento do IBS estadual, em % (ex.: 30 para 30%). No máximo 2 casas decimaisCondição do leiaute: O leiaute exige os três percentuais de diferimento juntos: informar um obriga a informar os outros dois.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoTributosDif/pDifUF (TSDec3V2), IBS estadual. Percentual com mais de 2 casas é recusado, nunca arredondado.
number
required
Tamanho: Até 3 dígitos inteiros e 2 decimais (TSDec3V2) · Tag do leiaute:pDifMun (grupo infDPS/IBSCBS/valores/trib/gIBSCBS/gDif) · Obrigatoriedade do leiaute: condicional no leiaute · Preenche: você, na requisiçãoPercentual de diferimento do IBS municipal, em %. No máximo 2 casas decimaisCondição do leiaute: O leiaute exige os três percentuais de diferimento juntos: informar um obriga a informar os outros dois.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoTributosDif/pDifMun (TSDec3V2), IBS municipal.
number
required
Tamanho: Até 3 dígitos inteiros e 2 decimais (TSDec3V2) · Tag do leiaute:pDifCBS (grupo infDPS/IBSCBS/valores/trib/gIBSCBS/gDif) · Obrigatoriedade do leiaute: condicional no leiaute · Preenche: você, na requisiçãoPercentual de diferimento da CBS, em %. No máximo 2 casas decimaisCondição do leiaute: O leiaute exige os três percentuais de diferimento juntos: informar um obriga a informar os outros dois.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoTributosDif/pDifCBS (TSDec3V2), CBS.
object
Tag do leiaute: sem tag própria no XML · Obrigatoriedade do leiaute: não é campo do leiaute (informativo/de compatibilidade)Nota do leiaute: Grupo lógico da API para retenções. No XML da DPS os campos ficam em valores/trib/tribMun e valores/trib/tribFed.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfoValores/trib (sem elemento retencoes; os campos ficam em tribMun e tribFed).
Show 7 campo(s)
string
Tamanho: 1 dígito (TSTipoRetISSQN) · Tag do leiaute:tpRetISSQN (grupo infDPS/valores/trib/tribMun) · Obrigatoriedade do leiaute: obrigatório no leiaute · Preenche: derivado de outros campos (calculado)Quem retém o ISS: “tomador” (tpRetISSQN=2) ou “intermediario” (tpRetISSQN=3). Ausente = não retidoFonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribMunicipal/tpRetISSQN (TSTipoRetISSQN). O leiaute não tem campo para o VALOR do ISS retido: o sistema nacional calcula o imposto e o inclui no total de retenções da NFS-e quando o indicador diz que houve retenção.
Valor
Significado
tomador
Escreve tpRetISSQN igual a 2
intermediario
Escreve tpRetISSQN igual a 3
number
Tamanho: Até 15 dígitos inteiros e 2 decimais (TSDec15V2) · Tag do leiaute:vRetIRRF (grupo infDPS/valores/trib/tribFed) · Obrigatoriedade do leiaute: opcional no leiaute · Preenche: você, na requisiçãoValor retido em R$, com no máximo 2 casas decimais. Vai para tribFed/vRetIRRF na DPSFonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribFederal/vRetIRRF (TSDec15V2), “valor monetário do IRRF (R$)”. O valor vai como informado: nenhuma alíquota de retenção é aplicada pela engineAPI.
number
Tamanho: Até 15 dígitos inteiros e 2 decimais (TSDec15V2) · Tag do leiaute:vRetCSLL (grupo infDPS/valores/trib/tribFed) · Obrigatoriedade do leiaute: opcional no leiaute · Preenche: você, na requisiçãoValor retido em R$, com no máximo 2 casas decimais. Vai para tribFed/vRetCSLL na DPSCondição do leiaute: Quando dpsNacional.tpRetPisCofins afirma que a CSLL é retida (códigos 3, 7, 8 e 9), o valor passa a ser exigido: a divergência recusa com 422 RETENCAO_PIS_COFINS_INCOERENTE.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribFederal/vRetCSLL (TSDec15V2), “valor monetário do CSLL (R$)”.
number
Tamanho: Até 15 dígitos inteiros e 2 decimais (TSDec15V2) · Tag do leiaute:vRetCP (grupo infDPS/valores/trib/tribFed) · Obrigatoriedade do leiaute: opcional no leiaute · Preenche: você, na requisiçãoValor retido em R$, com no máximo 2 casas decimais. Vai para tribFed/vRetCP (Contribuição Previdenciária) na DPSFonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribFederal/vRetCP (TSDec15V2), “valor monetário do CP (R$)”, a contribuição previdenciária retida.
number
Tamanho: mínimo 0 · Tag do leiaute: sem tag própria no XML · Obrigatoriedade do leiaute: não é campo do leiaute (informativo/de compatibilidade) · Preenche: você, na requisiçãoSem campo de VALOR na DPS do Padrão Nacional (vCofins do leiaute é o débito de apuração própria, não a retenção): valor diferente de zero recusa com 422 RETENCAO_SEM_CAMPO_NO_LEIAUTE. No máximo 2 casas decimais. A retenção de PIS/COFINS se declara pelo indicador dpsNacional.tpRetPisCofinsNota do leiaute: A DPS não tem campo para o valor de COFINS retida. O vCofins do leiaute é o débito de apuração própria do prestador e fica fora do total de retenções da NFS-e. Valor diferente de zero recusa com 422 RETENCAO_SEM_CAMPO_NO_LEIAUTE: a retenção se declara pelo indicador dpsNacional.tpRetPisCofins.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribOutrosPisCofins/vCofins, documentado como “valor do débito de COFINS apuração própria (R$)”.
number
Tamanho: mínimo 0 · Tag do leiaute: sem tag própria no XML · Obrigatoriedade do leiaute: não é campo do leiaute (informativo/de compatibilidade) · Preenche: você, na requisiçãoSem campo de VALOR na DPS do Padrão Nacional (vPis do leiaute é o débito de apuração própria, não a retenção): valor diferente de zero recusa com 422 RETENCAO_SEM_CAMPO_NO_LEIAUTE. No máximo 2 casas decimais. A retenção de PIS/COFINS se declara pelo indicador dpsNacional.tpRetPisCofinsNota do leiaute: A DPS não tem campo para o valor de PIS retido. O vPis do leiaute é o débito de apuração própria do prestador e fica fora do total de retenções da NFS-e. Valor diferente de zero recusa com 422 RETENCAO_SEM_CAMPO_NO_LEIAUTE, nunca é descartado em silêncio: a retenção se declara pelo indicador dpsNacional.tpRetPisCofins.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribOutrosPisCofins/vPis, documentado como “valor do débito de PIS apuração própria (R$)”. O total de retenções da NFS-e é a soma de vRetCP, vRetIRRF, vRetCSLL e do ISSQN.
number
Tamanho: mínimo 0 · Tag do leiaute: sem tag própria no XML · Obrigatoriedade do leiaute: não é campo do leiaute (informativo/de compatibilidade) · Preenche: você, na requisiçãoSem campo de VALOR na DPS do Padrão Nacional (a DPS não tem campo de “outras retenções”): valor diferente de zero recusa com 422 RETENCAO_SEM_CAMPO_NO_LEIAUTE. No máximo 2 casas decimais. Informe o tributo no campo próprio: retencoes.inss, retencoes.irrf ou retencoes.csllNota do leiaute: A DPS só comporta valor retido de contribuição previdenciária, IRRF e CSLL. Não existe campo de outras retenções: valor diferente de zero recusa com 422 RETENCAO_SEM_CAMPO_NO_LEIAUTE.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribFederal tem apenas o grupo de PIS/COFINS, vRetCP, vRetIRRF e vRetCSLL.
boolean
Tag do leiaute: sem tag própria no XML · Obrigatoriedade do leiaute: não é campo do leiaute (informativo/de compatibilidade) · Preenche: você, na requisiçãoNota do leiaute: Chave da engineAPI que liga a emissão assistida pelo Cérebro Fiscal. Não é campo do leiaute: muda quem preenche os códigos fiscais, não o conteúdo do documento.Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): não há elemento correspondente.
Índice reverso: tag do leiaute → nosso campo
Procure pelo nome que o leiaute usa (ex.: natOp, vFrete) e encontre o campo correspondente no contrato da engineAPI.
Todo campo listado acima é suportado: está no contrato e a engineAPI o usa. Esta seção cobre o resto do leiaute: o que a API aceita com outro nome, o que ela recusa hoje e as ressalvas de campos que estão no contrato mas o leiaute trata de um jeito específico.
rps.numero: O Padrão Nacional não tem RPS: a própria DPS é o documento de origem, e o número dela é alocado pela engineAPI por empresa e série. Enviar este campo na emissão nacional é recusado com 422, em vez de gerar uma nota sem o dado. Guarde a correspondência com o seu RPS pelo número da DPS devolvido na emissão.
rps.serie: Série do RPS do modelo municipal, sem equivalente no Padrão Nacional. A série que vai para a DPS é o campo serie do topo do payload. Enviar este campo na emissão nacional é recusado com 422.
rps.tipo: Tipo de RPS do modelo municipal, sem equivalente no Padrão Nacional. Enviar este campo na emissão nacional é recusado com 422.
rps: Grupo do modelo municipal antigo. A DPS não possui contêiner de RPS porque a própria declaração é o documento de origem.
dpsNacional: Grupo lógico da API que organiza os campos fiscais do padrão nacional; no XML esses campos ficam distribuídos em prest/regTrib, serv/cServ e valores/trib.
naturezaOperacao: Conceito do modelo municipal. No Padrão Nacional a natureza da operação é expressa pela tributação do ISSQN (dpsNacional.tribISSQN) e pelo local da prestação. Campo aceito por compatibilidade e não escrito no documento.
regimeTributacao: Conceito do modelo municipal. No Padrão Nacional o regime vai no grupo prest/regTrib, alimentado por dpsNacional.opSimpNac, regApTribSN e regEspTrib. Campo aceito por compatibilidade e não escrito no documento.
optanteSimples: Booleano do modelo municipal. O Padrão Nacional exige um código de três valores (não optante, MEI, ME/EPP), informado em dpsNacional.opSimpNac. Campo aceito por compatibilidade e não escrito no documento.
exigibilidadeISS: Código do modelo municipal. No Padrão Nacional a exigibilidade se declara por dpsNacional.tribISSQN (tributável, imunidade, exportação, não incidência) e pelo grupo de exigibilidade suspensa, que este motor ainda não escreve. Campo aceito por compatibilidade e não escrito no documento.
issuerId: Identificador da empresa emissora na engineAPI, não é campo do leiaute. É ele que determina o grupo prest (CNPJ ou CPF e regime) e o município emissor, lidos do cadastro.
tomador.endereco.uf: O endereço nacional da DPS tem apenas código do município e CEP: a UF é deduzida do código IBGE pelo sistema nacional. Campo aceito por compatibilidade e não escrito no documento.
tomador.endereco: Grupo, não campo: end é o contêiner do endereço do tomador.
tomador: Grupo, não campo: toma é o contêiner de identificação e endereço do tomador.
servico.itemListaServico: O Padrão Nacional identifica o serviço pelo código de tributação nacional de 6 dígitos (dpsNacional.cTribNac), não pelo item da lista no formato do modelo municipal. Este campo é a entrada do Cérebro Fiscal, que resolve o cTribNac quando resolverTributacao é true, mas não vira tag na DPS.
servico.codigoCnae: O leiaute da DPS não tem campo de CNAE. Campo aceito por compatibilidade com o modelo municipal e não escrito no documento.
servico: Grupo, não campo: serv é o contêiner dos dados do serviço.
ibsCbs.gTribRegular: Grupo, não campo: gTribRegular é o contêiner dos campos CSTReg e cClassTribReg.
ibsCbs.gDif: Grupo, não campo: gDif é o contêiner dos três percentuais.
ibsCbs: Grupo, não campo: IBSCBS é o contêiner do bloco da Reforma.
retencoes.cofins: A DPS não tem campo para o valor de COFINS retida. O vCofins do leiaute é o débito de apuração própria do prestador e fica fora do total de retenções da NFS-e. Valor diferente de zero recusa com 422 RETENCAO_SEM_CAMPO_NO_LEIAUTE: a retenção se declara pelo indicador dpsNacional.tpRetPisCofins.
retencoes.pis: A DPS não tem campo para o valor de PIS retido. O vPis do leiaute é o débito de apuração própria do prestador e fica fora do total de retenções da NFS-e. Valor diferente de zero recusa com 422 RETENCAO_SEM_CAMPO_NO_LEIAUTE, nunca é descartado em silêncio: a retenção se declara pelo indicador dpsNacional.tpRetPisCofins.
retencoes.outrasRetencoes: A DPS só comporta valor retido de contribuição previdenciária, IRRF e CSLL. Não existe campo de outras retenções: valor diferente de zero recusa com 422 RETENCAO_SEM_CAMPO_NO_LEIAUTE.
retencoes: Grupo lógico da API para retenções. No XML da DPS os campos ficam em valores/trib/tribMun e valores/trib/tribFed.
resolverTributacao: Chave da engineAPI que liga a emissão assistida pelo Cérebro Fiscal. Não é campo do leiaute: muda quem preenche os códigos fiscais, não o conteúdo do documento.
Não suportados hoje (fora do contrato)
Termo(s) do leiaute
Motivo
obra, ART, codigoobra
O grupo obra/ART (identificação da obra de construção civil e da Anotação de Responsabilidade Técnica do serviço) ainda não é suportado pela engineAPI. Serviço de construção civil que a prefeitura exige vincular a uma obra cadastrada não pode ser emitido com essa vinculação por enquanto.
intermediario
O grupo intermediario da NFS-e (identificação de quem intermediou a prestação do serviço, com CNPJ/CPF, nome e endereço) ainda não é suportado pela engineAPI. A RETENÇÃO pelo intermediário, essa sim, é suportada: informe retencoes.issRetidoPor: "intermediario" (vira tpRetISSQN=3 na DPS). O que não sai no documento é a identificação de quem reteve.
nif, tomadorexterior
nif (Número de Identificação Fiscal do tomador no exterior) e o restante dos dados de tomador estrangeiro ainda não são suportados pela engineAPI. O tomador aceita hoje só cnpjCpf nacional; serviço exportado para tomador sem CNPJ/CPF brasileiro não pode ser emitido por enquanto.
substituicaorps, substituicao
A substituição de RPS (nova DPS que substitui um RPS/NFS-e já emitido, referenciando o número original) ainda não é suportada pela engineAPI. No Padrão Nacional a própria DPS ocupa o lugar do RPS e o leiaute não tem campo para o número dele (por isso rps é recusado nesse caminho); para corrigir um RPS ou NFS-e já emitido, use o cancelamento (POST /v1/nfse/:id/cancelar) e emita um novo documento.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"EngineAPI","description":"Documentação pública da engineAPI: emissão de NF-e, NFC-e, NFS-e e mais, direto na SEFAZ.","colors":{"primary":"#1E56B1","light":"#2D7AF6","dark":"#0F2A5E"},"logo":{"light":"https://mintcdn.com/3xtec/upxot-gn5enp24zf/logo/light.svg?fit=max\u0026auto=format\u0026n=upxot-gn5enp24zf\u0026q=85\u0026s=63aef46d17335e80239cdc40c74322e9","dark":"https://mintcdn.com/3xtec/upxot-gn5enp24zf/logo/dark.svg?fit=max\u0026auto=format\u0026n=upxot-gn5enp24zf\u0026q=85\u0026s=32d8c9d72ff50350091826485812d053"},"favicon":"https://mintcdn.com/3xtec/upxot-gn5enp24zf/favicon.svg?fit=max\u0026auto=format\u0026n=upxot-gn5enp24zf\u0026q=85\u0026s=2710eead1ba540400726bc73e0244b91","api":{"openapi":"openapi.json"},"appearance":{"default":"light","strict":false},"navbar":{"links":[{"href":"https://app.engineapi.com.br","label":"App"}],"primary":{"type":"button","label":"Começar grátis","href":"https://app.engineapi.com.br/auth/register"}},"footer":{"links":[{"header":"Produto","items":[{"label":"App","href":"https://app.engineapi.com.br"},{"label":"Começar grátis","href":"https://app.engineapi.com.br/auth/register"}]},{"header":"Suporte","items":[{"label":"suporte@engineapi.com.br","href":"mailto:suporte@engineapi.com.br"}]}]},"search":{"prompt":"Buscar..."},"fonts":{"family":"Inter"},"icons":{"library":"fontawesome"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"3xtec","hasAudioNarration":false,"actualSubdomain":"3xtec","customDomains":["docs.engineapi.com.br"],"gitSource":{"type":"github","owner":"3x-git","repo":"engine-api","deployBranch":"develop","contentDirectory":"apps/docs-mintlify","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6af7e641474f4586a49700ac","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API Reference","count":121},{"language":"default","tag":"Endpoints","count":113},{"language":"default","tag":"Documentação","count":47},{"language":"default","tag":"NFe","count":22},{"language":"default","tag":"Autenticação","count":21},{"language":"default","tag":"Cérebro Fiscal","count":16},{"language":"default","tag":"Empresas","count":11},{"language":"default","tag":"NFSe","count":11},{"language":"default","tag":"Emissão","count":10},{"language":"default","tag":"Erros e operação","count":10}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/campos-nfse","slug":"/api-reference/campos-nfse","pageMetadata":{"title":"Referência de campos: NFSe","description":"Todo campo do payload de emissão de NFSe (POST /v1/nfse): tipo, tamanho, tag do leiaute e obrigatoriedade.","href":"/api-reference/campos-nfse"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Todo campo do payload de emissão de NFSe (POST /v1/nfse): tipo, tamanho, tag do leiaute e obrigatoriedade.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,em:`em`,hr:`hr`,li:`li`,ol:`ol`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Expandable,Heading,ParamField,Table}=_components;if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Esta página lista `,_jsx(_components.strong,{children:`exatamente`}),` o que a engineAPI aceita hoje no payload de emissão\nde NFSe, nem mais, nem menos, com a tag do leiaute de cada campo onde ela já\nfoi catalogada. A NFSe tem provider por município (ABRASF) ou Padrão Nacional (SEFIN/ADN, bloco `,_jsx(_components.code,{children:`dpsNacional`}),`): o formato aceito é o mesmo nos dois, mas cada provider usa um subconjunto. Com `,_jsx(_components.code,{children:`resolverTributacao: true`}),` (Cérebro Fiscal), campos da DPS ausentes são preenchidos pelo cadastro do emissor; campo obrigatório sem fonte devolve `,_jsx(_components.code,{children:`422`}),` com `,_jsx(_components.code,{children:`camposNaoResolvidos`}),`; ver `,_jsx(_components.a,{href:`/guides/cerebro-fiscal`,children:`Cérebro Fiscal`}),`. Para empresa do Simples, `,_jsx(_components.code,{children:`dpsNacional.pTotTribSN`}),` enviado na nota tem prioridade; sem ele, o cadastro pode informar `,_jsx(_components.code,{children:`pTotTribSNPadrao`}),` e seu mês de referência `,_jsx(_components.code,{children:`pTotTribSNCompetencia`}),` (`,_jsx(_components.code,{children:`AAAA-MM`}),`). Percentual de mês anterior, futuro ou sem mês registrado não bloqueia a emissão, mas devolve um aviso para confirmar o valor com o contador. O bloco `,_jsx(_components.code,{children:`ibsCbs`}),` (Reforma Tributária) é `,_jsx(_components.strong,{children:`passthrough puro`}),`: nada nele é resolvido pelo Cérebro Fiscal. Esta página descreve o `,_jsx(_components.strong,{children:`contrato de entrada`}),`, não a cobertura fiscal completa do leiaute oficial. `,_jsx(_components.code,{children:`servico.valorServicos`}),` e os demais valores monetários `,_jsx(_components.code,{children:`TSDec15V2`}),` aceitam até 15 dígitos inteiros e 2 casas decimais: excesso de largura ou fração de centavo devolve `,_jsx(_components.code,{children:`400`}),` antes da emissão. Ver `,_jsx(_components.a,{href:`/guides/errors#casas-decimais-em-valores-monetrios-400`,children:`Erros e respostas`}),`.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Leiaute:`}),` versão 1.01 · `,_jsx(_components.strong,{children:`Contrato revisado em:`}),` 2026-08-15 `]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`75 campos`}),` documentados abaixo (contagem recursiva, incluindo objetos aninhados e itens de array).`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`navegação-por-grupo-do-leiaute`,children:`Navegação por grupo do leiaute`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`#grupo-identificacao`,children:`Identificação`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`#grupo-emitente`,children:`Emitente`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`#grupo-destinatario`,children:`Destinatário`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`#grupo-itens`,children:`Itens`})}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#grupo-totais`,children:`Totais`}),` `,_jsx(_components.em,{children:`(sem campo no contrato hoje, ver nota)`})]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#grupo-transporte`,children:`Transporte`}),` `,_jsx(_components.em,{children:`(sem campo no contrato hoje, ver nota)`})]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#grupo-cobranca`,children:`Cobrança`}),` `,_jsx(_components.em,{children:`(sem campo no contrato hoje, ver nota)`})]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#grupo-pagamento`,children:`Pagamento`}),` `,_jsx(_components.em,{children:`(sem campo no contrato hoje, ver nota)`})]}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`#grupo-informacoes-adicionais`,children:`Informações adicionais`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`#grupo-tributacao-reforma`,children:`Tributação (Reforma e retenções)`})}),`\n`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`grupo-identificacao`,children:`Identificação`}),`\n`,_jsxs(ParamField,{path:`rps`,type:`object`,id:`param-rps`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tag do leiaute:`}),` sem tag própria no XML · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` não é campo do leiaute (informativo/de compatibilidade)`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Nota do leiaute:`}),` Grupo do modelo municipal antigo. A DPS não possui contêiner de RPS porque a própria declaração é o documento de origem.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfDPS (sem grupo de RPS no leiaute nacional).`})}),_jsxs(Expandable,{title:`3 campo(s)`,children:[_jsxs(ParamField,{path:`rps.numero`,type:`integer`,required:true,id:`param-rps-numero`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tag do leiaute:`}),` sem tag própria no XML · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` não é campo do leiaute (informativo/de compatibilidade) · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Número do RPS. Só tem efeito na emissão pelo provedor municipal. Na emissão pelo Padrão Nacional o campo é recusado com 422 RPS_SEM_CAMPO_NO_PADRAO_NACIONAL, porque o leiaute da DPS não tem campo de RPS`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Nota do leiaute:`}),` O Padrão Nacional não tem RPS: a própria DPS é o documento de origem, e o número dela é alocado pela engineAPI por empresa e série. Enviar este campo na emissão nacional é recusado com 422, em vez de gerar uma nota sem o dado. Guarde a correspondência com o seu RPS pelo número da DPS devolvido na emissão.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfDPS não tem grupo de RPS. O número do documento é nDPS, sequencial controlado pela engineAPI.`})})]}),_jsxs(ParamField,{path:`rps.serie`,type:`string`,id:`param-rps-serie`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tag do leiaute:`}),` sem tag própria no XML · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` não é campo do leiaute (informativo/de compatibilidade) · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Série do RPS. Só tem efeito na emissão pelo provedor municipal. Na emissão pelo Padrão Nacional o campo é recusado com 422 RPS_SEM_CAMPO_NO_PADRAO_NACIONAL, porque o leiaute da DPS não tem campo de RPS`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Nota do leiaute:`}),` Série do RPS do modelo municipal, sem equivalente no Padrão Nacional. A série que vai para a DPS é o campo serie do topo do payload. Enviar este campo na emissão nacional é recusado com 422.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfDPS não tem grupo de RPS. A série do documento é TCInfDPS/serie.`})})]}),_jsxs(ParamField,{path:`rps.tipo`,type:`integer`,id:`param-rps-tipo`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tag do leiaute:`}),` sem tag própria no XML · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` não é campo do leiaute (informativo/de compatibilidade) · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Tipo do RPS. Só tem efeito na emissão pelo provedor municipal. Na emissão pelo Padrão Nacional o campo é recusado com 422 RPS_SEM_CAMPO_NO_PADRAO_NACIONAL, porque o leiaute da DPS não tem campo de RPS`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Nota do leiaute:`}),` Tipo de RPS do modelo municipal, sem equivalente no Padrão Nacional. Enviar este campo na emissão nacional é recusado com 422.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfDPS não tem grupo de RPS.`})})]})]})]}),`\n`,_jsxs(ParamField,{path:`serie`,type:`string`,id:`param-serie`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` Até 5 dígitos numéricos (TSSerieDPS) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`serie`}),` (grupo `,_jsx(_components.code,{children:`infDPS`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` obrigatório no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfDPS/serie (TSSerieDPS). Ausente no payload, a engineAPI usa a série 1.`})})]}),`\n`,_jsxs(ParamField,{path:`dpsNacional`,type:`object`,id:`param-dps-nacional`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tag do leiaute:`}),` sem tag própria no XML · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` não é campo do leiaute (informativo/de compatibilidade)`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Nota do leiaute:`}),` Grupo lógico da API que organiza os campos fiscais do padrão nacional; no XML esses campos ficam distribuídos em prest/regTrib, serv/cServ e valores/trib.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfDPS (sem elemento dpsNacional; os campos ficam em grupos distintos).`})}),_jsxs(Expandable,{title:`10 campo(s)`,children:[_jsxs(ParamField,{path:`dpsNacional.opSimpNac`,type:`string`,required:true,id:`param-dps-nacional-op-simp-nac`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 1 dígito (TSOpSimpNac) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`opSimpNac`}),` (grupo `,_jsx(_components.code,{children:`infDPS/prest/regTrib`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` obrigatório no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` preenchido automaticamente pela engineAPI`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRegTrib/opSimpNac (TSOpSimpNac). Com resolverTributacao igual a true, o Cérebro Fiscal preenche a partir do cadastro da empresa.`})})]}),_jsxs(ParamField,{path:`dpsNacional.regApTribSN`,type:`string`,id:`param-dps-nacional-reg-ap-trib-sn`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 1 dígito (TSRegimeApuracaoSimpNac) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`regApTribSN`}),` (grupo `,_jsx(_components.code,{children:`infDPS/prest/regTrib`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` condicional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Condição do leiaute:`}),` Só para optante ME/EPP (opSimpNac igual a 3), para indicar em que regime os tributos federais e o municipal estão inseridos quando algum sublimite do Simples foi ultrapassado. MEI não leva o campo. Na engineAPI o campo é OBRIGATÓRIO NA REQUISIÇÃO quando a empresa está cadastrada com crt igual a 2 (Simples Nacional com excesso de sublimite): o crt confirma que a empresa é optante do Simples, mas sozinho não diz o regime de apuração, e não existe um padrão desse regime no cadastro da empresa. Sem o campo, a emissão é recusada com 422 e o código CRT2_SEM_REGIME_APURACAO, antes de qualquer transmissão e sem consumir número de DPS. Vale em QUALQUER forma de emissão, inclusive com resolverTributacao igual a true. Para crt igual a 1 (Simples) a engineAPI continua derivando o valor 1 do cadastro quando o campo é omitido.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRegTrib/regApTribSN (TSRegimeApuracaoSimpNac). A engineAPI só deriva o valor quando também derivou o opSimpNac E o cadastro traz a fonte do regime (crt igual a 1); no crt igual a 2 não há fonte e o campo tem de vir na requisição.`})})]}),_jsxs(ParamField,{path:`dpsNacional.regEspTrib`,type:`string`,id:`param-dps-nacional-reg-esp-trib`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 1 dígito (TSRegEspTrib) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`regEspTrib`}),` (grupo `,_jsx(_components.code,{children:`infDPS/prest/regTrib`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` obrigatório no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRegTrib/regEspTrib (TSRegEspTrib), elemento obrigatório. Ausente no payload, a engineAPI escreve 0 (nenhum).`})})]}),_jsxs(ParamField,{path:`dpsNacional.cTribNac`,type:`string`,required:true,id:`param-dps-nacional-c-trib-nac`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 6 dígitos: 2 do item da lista de serviços, 2 do subitem e 2 do desdobro nacional · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`cTribNac`}),` (grupo `,_jsx(_components.code,{children:`infDPS/serv/cServ`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` obrigatório no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` preenchido automaticamente pela engineAPI`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCCServ/cTribNac (TSCodTribNac). Com resolverTributacao igual a true, o Cérebro Fiscal resolve o código a partir do serviço padrão da empresa.`})})]}),_jsxs(ParamField,{path:`dpsNacional.cTribMun`,type:`string`,id:`param-dps-nacional-c-trib-mun`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 3 dígitos numéricos (TCCodTribMun) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`cTribMun`}),` (grupo `,_jsx(_components.code,{children:`infDPS/serv/cServ`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` opcional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Código de tributação municipal do ISSQN (3 dígitos). Vai para serv/cServ/cTribMun na DPS. Equivalente de baixo nível de servico.codigoTributacaoMunicipio: informar os dois com valores diferentes recusa com 422 CTRIBMUN_CONFLITO`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Condição do leiaute:`}),` Este campo e servico.codigoTributacaoMunicipio escrevem a MESMA tag. Informe um dos dois, ou os dois com o mesmo valor: valores diferentes são recusados com 422.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCCServ/cTribMun (TCCodTribMun, 3 dígitos).`})})]}),_jsxs(ParamField,{path:`dpsNacional.tribISSQN`,type:`string`,required:true,id:`param-dps-nacional-trib-issqn`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 1 dígito (TSTribISSQN) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`tribISSQN`}),` (grupo `,_jsx(_components.code,{children:`infDPS/valores/trib/tribMun`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` obrigatório no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` preenchido automaticamente pela engineAPI`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribMunicipal/tribISSQN (TSTribISSQN). Com resolverTributacao igual a true, o Cérebro Fiscal preenche.`})})]}),_jsxs(ParamField,{path:`dpsNacional.tpRetISSQN`,type:`string`,id:`param-dps-nacional-tp-ret-issqn`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 1 dígito (TSTipoRetISSQN) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`tpRetISSQN`}),` (grupo `,_jsx(_components.code,{children:`infDPS/valores/trib/tribMun`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` obrigatório no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` derivado de outros campos (calculado)`]}),_jsx(_components.p,{children:`Tipo de retenção do ISSQN: 1 (não retido), 2 (retido pelo tomador) ou 3 (retido pelo intermediário). Equivalente de baixo nível de retencoes.issRetidoPor: informar os dois com valores diferentes recusa com 422 RETENCAO_ISS_CONFLITO`}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribMunicipal/tpRetISSQN (TSTipoRetISSQN), elemento obrigatório. A engineAPI reconcilia este campo com retencoes.issRetidoPor (valores diferentes recusam com 422 RETENCAO_ISS_CONFLITO) e escreve 1 quando nenhum dos dois vem.`})})]}),_jsxs(ParamField,{path:`dpsNacional.cstPisCofins`,type:`string`,id:`param-dps-nacional-cst-pis-cofins`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 2 dígitos (TSTipoCST) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`CST`}),` (grupo `,_jsx(_components.code,{children:`infDPS/valores/trib/tribFed/piscofins`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` condicional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Condição do leiaute:`}),` Obrigatório sempre que o grupo de PIS/COFINS for escrito, ou seja, sempre que houver indicador de retenção. Informar o indicador sem o CST recusa com 422 RETENCAO_PIS_COFINS_SEM_CST.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribOutrosPisCofins/CST (TSTipoCST), elemento obrigatório do grupo.`})})]}),_jsxs(ParamField,{path:`dpsNacional.tpRetPisCofins`,type:`string`,id:`param-dps-nacional-tp-ret-pis-cofins`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 1 dígito (TSTipoRetPISCofins) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`tpRetPisCofins`}),` (grupo `,_jsx(_components.code,{children:`infDPS/valores/trib/tribFed/piscofins`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` opcional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Tipo de retenção do PIS/COFINS (enum TSTipoRetPISCofins, códigos 0 a 9; ex.: 1 = PIS/COFINS retidos, 3 = PIS/COFINS/CSLL retidos). É como se declara a retenção de PIS/COFINS, que não tem campo de valor na DPS. Exige dpsNacional.cstPisCofins`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Condição do leiaute:`}),` É por este indicador que a retenção de PIS/COFINS se declara: o leiaute não tem campo para o valor retido desses tributos. Exige dpsNacional.cstPisCofins e é conferido contra retencoes.csll.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribOutrosPisCofins/tpRetPisCofins (TSTipoRetPISCofins). O código vai como o integrador informou: a engineAPI nunca o infere.`})})]}),_jsxs(ParamField,{path:`dpsNacional.pTotTribSN`,type:`number`,id:`param-dps-nacional-p-tot-trib-sn`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` Até 3 dígitos inteiros e 2 decimais (TSDec3V2) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`pTotTribSN`}),` (grupo `,_jsx(_components.code,{children:`infDPS/valores/trib/totTrib`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` condicional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` preenchido automaticamente pela engineAPI`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Condição do leiaute:`}),` O grupo de total de tributos exige exatamente uma das quatro opções do leiaute. Para optante ME/EPP (opSimpNac igual a 3) o sistema nacional recusa o indicador de omissão, então o percentual passa a ser obrigatório: sem ele no payload nem no cadastro da empresa, a emissão para antes de transmitir com 422. O valor enviado nesta requisição sempre tem precedência e segue sem alteração. Quando vier do cadastro, informe também pTotTribSNCompetencia (AAAA-MM): se o mês estiver anterior ao mês corrente em Brasília, futuro ou não estiver registrado, a nota é emitida e avisos[] pede a confirmação com o contador. Nos demais regimes, ausente, a engineAPI declara que não informa o valor estimado dos tributos.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribTotal/pTotTribSN (em xs:choice com vTotTrib, pTotTrib e indTotTrib).`})})]})]})]}),`\n`,_jsxs(ParamField,{path:`naturezaOperacao`,type:`integer`,id:`param-natureza-operacao`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tag do leiaute:`}),` sem tag própria no XML · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` não é campo do leiaute (informativo/de compatibilidade) · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Nota do leiaute:`}),` Conceito do modelo municipal. No Padrão Nacional a natureza da operação é expressa pela tributação do ISSQN (dpsNacional.tribISSQN) e pelo local da prestação. Campo aceito por compatibilidade e não escrito no documento.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): não há elemento de natureza da operação em TCInfDPS.`})})]}),`\n`,_jsxs(ParamField,{path:`regimeTributacao`,type:`integer`,id:`param-regime-tributacao`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tag do leiaute:`}),` sem tag própria no XML · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` não é campo do leiaute (informativo/de compatibilidade) · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Nota do leiaute:`}),` Conceito do modelo municipal. No Padrão Nacional o regime vai no grupo prest/regTrib, alimentado por dpsNacional.opSimpNac, regApTribSN e regEspTrib. Campo aceito por compatibilidade e não escrito no documento.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): o regime do prestador é TCRegTrib, com três elementos próprios.`})})]}),`\n`,_jsxs(ParamField,{path:`optanteSimples`,type:`boolean`,id:`param-optante-simples`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tag do leiaute:`}),` sem tag própria no XML · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` não é campo do leiaute (informativo/de compatibilidade) · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Nota do leiaute:`}),` Booleano do modelo municipal. O Padrão Nacional exige um código de três valores (não optante, MEI, ME/EPP), informado em dpsNacional.opSimpNac. Campo aceito por compatibilidade e não escrito no documento.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRegTrib/opSimpNac é enumeração de três valores, não booleano.`})})]}),`\n`,_jsxs(ParamField,{path:`exigibilidadeISS`,type:`integer`,id:`param-exigibilidade-iss`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tag do leiaute:`}),` sem tag própria no XML · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` não é campo do leiaute (informativo/de compatibilidade) · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Nota do leiaute:`}),` Código do modelo municipal. No Padrão Nacional a exigibilidade se declara por dpsNacional.tribISSQN (tributável, imunidade, exportação, não incidência) e pelo grupo de exigibilidade suspensa, que este motor ainda não escreve. Campo aceito por compatibilidade e não escrito no documento.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribMunicipal/tribISSQN e TCExigSuspensa.`})})]}),`\n`,_jsxs(ParamField,{path:`competencia`,type:`string`,id:`param-competencia`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` AAAA-MM-DD (TSData) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`dCompet`}),` (grupo `,_jsx(_components.code,{children:`infDPS`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` obrigatório no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsxs(_components.p,{children:[`padrão: `,_jsx(_components.code,{children:`^\\\\d{4}-\\\\d{2}-\\\\d{2}$`})]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfDPS/dCompet (TSData), “data em que se iniciou a prestação do serviço”. Ausente no payload, vale a data de emissão.`})})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`grupo-emitente`,children:`Emitente`}),`\n`,_jsxs(_components.p,{children:[`Os dados completos do emitente (razão social, CNPJ, endereço, Inscrição Estadual) vêm do cadastro da empresa selecionada em `,_jsx(_components.code,{children:`issuerId`}),`, não são enviados campo a campo no payload de emissão.`]}),`\n`,_jsxs(ParamField,{path:`issuerId`,type:`string`,required:true,id:`param-issuer-id`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` mínimo 1 caractere(s) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` sem tag própria no XML · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` não é campo do leiaute (informativo/de compatibilidade) · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Nota do leiaute:`}),` Identificador da empresa emissora na engineAPI, não é campo do leiaute. É ele que determina o grupo prest (CNPJ ou CPF e regime) e o município emissor, lidos do cadastro.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): não há elemento correspondente. O grupo prest é montado a partir do cadastro da empresa.`})})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`grupo-destinatario`,children:`Destinatário`}),`\n`,_jsx(_components.p,{children:`Na NFS-e o destinatário do leiaute é o tomador do serviço.`}),`\n`,_jsxs(ParamField,{path:`tomador`,type:`object`,required:true,id:`param-tomador`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`toma`}),` (grupo `,_jsx(_components.code,{children:`infDPS`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` condicional no leiaute`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Condição do leiaute:`}),` No XSD o grupo é opcional para cobrir operações sem tomador identificado, mas neste contrato ele é obrigatório.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Nota do leiaute:`}),` Grupo, não campo: toma é o contêiner de identificação e endereço do tomador.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfDPS/toma (TCInfoPessoa, minOccurs=“0”).`})}),_jsxs(Expandable,{title:`6 campo(s)`,children:[_jsxs(ParamField,{path:`tomador.cnpjCpf`,type:`string`,required:true,id:`param-tomador-cnpj-cpf`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 14 dígitos (CNPJ) ou 11 dígitos (CPF), só números · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`CNPJ|CPF`}),` (grupo `,_jsx(_components.code,{children:`infDPS/toma`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` obrigatório no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` derivado de outros campos (calculado)`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Condição do leiaute:`}),` O leiaute escolhe uma das duas tags. A engineAPI classifica pelo comprimento do documento limpo: 14 dígitos vão em CNPJ, 11 em CPF.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfoPessoa/CNPJ (TSCNPJ) ou TCInfoPessoa/CPF (TSCPF), em xs:choice com NIF/cNaoNIF.`})})]}),_jsxs(ParamField,{path:`tomador.razaoSocial`,type:`string`,required:true,id:`param-tomador-razao-social`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 1 a 300 caracteres (TSNomeRazaoSocial) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`xNome`}),` (grupo `,_jsx(_components.code,{children:`infDPS/toma`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` obrigatório no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfoPessoa/xNome (TSNomeRazaoSocial).`})})]}),_jsxs(ParamField,{path:`tomador.email`,type:`string`,id:`param-tomador-email`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 1 a 80 caracteres (TSEmail) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`email`}),` (grupo `,_jsx(_components.code,{children:`infDPS/toma`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` opcional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfoPessoa/email (TSEmail).`})})]}),_jsxs(ParamField,{path:`tomador.telefone`,type:`string`,id:`param-tomador-telefone`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 6 a 20 dígitos (TSTelefone), DDD mais número · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`fone`}),` (grupo `,_jsx(_components.code,{children:`infDPS/toma`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` opcional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` derivado de outros campos (calculado)`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfoPessoa/fone (TSTelefone). A engineAPI remove tudo que não é dígito antes de escrever.`})})]}),_jsxs(ParamField,{path:`tomador.inscricaoMunicipal`,type:`string`,id:`param-tomador-inscricao-municipal`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 1 a 15 caracteres (TSInscMun) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`IM`}),` (grupo `,_jsx(_components.code,{children:`infDPS/toma`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` opcional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Inscrição municipal do tomador (até 15 caracteres). Vai para toma/IM na DPS`}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfoPessoa/IM (TSInscMun), escrito antes do nome do tomador, na ordem do grupo.`})})]}),_jsxs(ParamField,{path:`tomador.endereco`,type:`object`,required:true,id:`param-tomador-endereco`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`end`}),` (grupo `,_jsx(_components.code,{children:`infDPS/toma`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` condicional no leiaute`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Condição do leiaute:`}),` No XSD o grupo é opcional dentro de toma, mas neste contrato o endereço do tomador é obrigatório.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Nota do leiaute:`}),` Grupo, não campo: end é o contêiner do endereço do tomador.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfoPessoa/end (TCEndereco, minOccurs=“0”).`})}),_jsxs(Expandable,{title:`7 campo(s)`,children:[_jsxs(ParamField,{path:`tomador.endereco.logradouro`,type:`string`,required:true,id:`param-tomador-endereco-logradouro`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 1 a 255 caracteres (TSLogradouro) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`xLgr`}),` (grupo `,_jsx(_components.code,{children:`infDPS/toma/end`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` obrigatório no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Texto do endereço (até 255 caracteres). Vai para a DPS. Aceita apenas caracteres latinos básicos: travessão, aspas curvas, reticências e emoji são recusados com 400. Quebra de linha e tabulação viram espaço na emissão`}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCEndereco/xLgr (TSLogradouro).`})})]}),_jsxs(ParamField,{path:`tomador.endereco.numero`,type:`string`,required:true,id:`param-tomador-endereco-numero`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 1 a 60 caracteres (TSNumeroEndereco) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`nro`}),` (grupo `,_jsx(_components.code,{children:`infDPS/toma/end`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` obrigatório no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Texto do endereço (até 60 caracteres). Vai para a DPS. Aceita apenas caracteres latinos básicos: travessão, aspas curvas, reticências e emoji são recusados com 400. Quebra de linha e tabulação viram espaço na emissão`}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCEndereco/nro (TSNumeroEndereco).`})})]}),_jsxs(ParamField,{path:`tomador.endereco.complemento`,type:`string`,id:`param-tomador-endereco-complemento`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 1 a 156 caracteres (TSComplementoEndereco) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`xCpl`}),` (grupo `,_jsx(_components.code,{children:`infDPS/toma/end`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` opcional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Texto do endereço (até 156 caracteres). Vai para a DPS. Aceita apenas caracteres latinos básicos: travessão, aspas curvas, reticências e emoji são recusados com 400. Quebra de linha e tabulação viram espaço na emissão`}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCEndereco/xCpl (TSComplementoEndereco).`})})]}),_jsxs(ParamField,{path:`tomador.endereco.bairro`,type:`string`,required:true,id:`param-tomador-endereco-bairro`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 1 a 60 caracteres (TSBairro) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`xBairro`}),` (grupo `,_jsx(_components.code,{children:`infDPS/toma/end`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` obrigatório no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Texto do endereço (até 60 caracteres). Vai para a DPS. Aceita apenas caracteres latinos básicos: travessão, aspas curvas, reticências e emoji são recusados com 400. Quebra de linha e tabulação viram espaço na emissão`}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCEndereco/xBairro (TSBairro).`})})]}),_jsxs(ParamField,{path:`tomador.endereco.codigoMunicipio`,type:`string`,required:true,id:`param-tomador-endereco-codigo-municipio`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 7 dígitos, código IBGE do município (TSCodMunIBGE) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`cMun`}),` (grupo `,_jsx(_components.code,{children:`infDPS/toma/end/endNac`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` obrigatório no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCEnderNac/cMun (TSCodMunIBGE).`})})]}),_jsxs(ParamField,{path:`tomador.endereco.uf`,type:`string`,required:true,id:`param-tomador-endereco-uf`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` mínimo 1 caractere(s) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` sem tag própria no XML · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` não é campo do leiaute (informativo/de compatibilidade) · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Nota do leiaute:`}),` O endereço nacional da DPS tem apenas código do município e CEP: a UF é deduzida do código IBGE pelo sistema nacional. Campo aceito por compatibilidade e não escrito no documento.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCEnderNac tem somente cMun e CEP.`})})]}),_jsxs(ParamField,{path:`tomador.endereco.cep`,type:`string`,required:true,id:`param-tomador-endereco-cep`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 8 dígitos, só números (TSCEP) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`CEP`}),` (grupo `,_jsx(_components.code,{children:`infDPS/toma/end/endNac`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` obrigatório no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` derivado de outros campos (calculado)`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCEnderNac/CEP (TSCEP). A engineAPI remove tudo que não é dígito antes de escrever.`})})]})]})]})]})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`grupo-itens`,children:`Itens`}),`\n`,_jsx(_components.p,{children:`Na NFS-e o item do leiaute é o serviço prestado: cada DPS descreve um único serviço, não é um array como em NF-e/NFC-e.`}),`\n`,_jsxs(ParamField,{path:`servico`,type:`object`,required:true,id:`param-servico`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`serv`}),` (grupo `,_jsx(_components.code,{children:`infDPS`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` obrigatório no leiaute`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Nota do leiaute:`}),` Grupo, não campo: serv é o contêiner dos dados do serviço.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfDPS/serv (TCServ).`})}),_jsxs(Expandable,{title:`11 campo(s)`,children:[_jsxs(ParamField,{path:`servico.codigoMunicipio`,type:`string`,required:true,id:`param-servico-codigo-municipio`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 7 dígitos, código IBGE do município (TSCodMunIBGE) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`cLocPrestacao`}),` (grupo `,_jsx(_components.code,{children:`infDPS/serv/locPrest`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` obrigatório no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Condição do leiaute:`}),` O leiaute aceita o município da prestação ou o país da prestação, quando o serviço é prestado no exterior. Este motor escreve sempre o município.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCLocPrest/cLocPrestacao (TSCodMunIBGE), em xs:choice com cPaisPrestacao.`})})]}),_jsxs(ParamField,{path:`servico.itemListaServico`,type:`string`,id:`param-servico-item-lista-servico`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` mínimo 1 caractere(s) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` sem tag própria no XML · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` não é campo do leiaute (informativo/de compatibilidade) · `,_jsx(_components.strong,{children:`Preenche:`}),` preenchido automaticamente pela engineAPI`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Nota do leiaute:`}),` O Padrão Nacional identifica o serviço pelo código de tributação nacional de 6 dígitos (dpsNacional.cTribNac), não pelo item da lista no formato do modelo municipal. Este campo é a entrada do Cérebro Fiscal, que resolve o cTribNac quando resolverTributacao é true, mas não vira tag na DPS.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCCServ tem cTribNac, cTribMun, xDescServ, cNBS e cIntContrib, nenhum no formato do item da lista de serviços.`})})]}),_jsxs(ParamField,{path:`servico.codigoCnae`,type:`string`,id:`param-servico-codigo-cnae`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tag do leiaute:`}),` sem tag própria no XML · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` não é campo do leiaute (informativo/de compatibilidade) · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Nota do leiaute:`}),` O leiaute da DPS não tem campo de CNAE. Campo aceito por compatibilidade com o modelo municipal e não escrito no documento.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): nenhuma ocorrência de CNAE nos três esquemas oficiais.`})})]}),_jsxs(ParamField,{path:`servico.codigoTributacaoMunicipio`,type:`string`,id:`param-servico-codigo-tributacao-municipio`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 3 dígitos numéricos (TCCodTribMun) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`cTribMun`}),` (grupo `,_jsx(_components.code,{children:`infDPS/serv/cServ`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` opcional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Código de tributação municipal do ISSQN (3 dígitos). Vai para serv/cServ/cTribMun na DPS. Equivalente de alto nível de dpsNacional.cTribMun: informar os dois com valores diferentes recusa com 422 CTRIBMUN_CONFLITO`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Condição do leiaute:`}),` Este campo e dpsNacional.cTribMun escrevem a MESMA tag. Informe um dos dois, ou os dois com o mesmo valor: valores diferentes são recusados com 422, porque escolher um deles seria decidir a tributação municipal no lugar de quem emite.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCCServ/cTribMun (TCCodTribMun, 3 dígitos).`})})]}),_jsxs(ParamField,{path:`servico.codigoNBS`,type:`string`,id:`param-servico-codigo-nbs`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 9 dígitos numéricos (TSCodNBS, NBS versão 2.0). A pontuação usual do código é aceita e removida na emissão: 1.1401.20.00 e 114012000 dão no mesmo. · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`cNBS`}),` (grupo `,_jsx(_components.code,{children:`infDPS/serv/cServ`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` opcional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` preenchido automaticamente pela engineAPI`]}),_jsx(_components.p,{children:`Código NBS 2.0 (9 dígitos). Vai para serv/cServ/cNBS na DPS`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Condição do leiaute:`}),` Com resolverTributacao igual a true, o Cérebro Fiscal preenche o código a partir da tabela vigente quando o campo vem ausente. Se o código da tabela não tiver os 9 dígitos exigidos, a nota é emitida sem ele e a resposta traz o aviso.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCCServ/cNBS (TSCodNBS, 9 dígitos), escrito depois da descrição do serviço, na ordem do grupo.`})})]}),_jsxs(ParamField,{path:`servico.discriminacao`,type:`string`,required:true,id:`param-servico-discriminacao`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 1 a 2000 caracteres (TSDesc2000) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`xDescServ`}),` (grupo `,_jsx(_components.code,{children:`infDPS/serv/cServ`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` obrigatório no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCCServ/xDescServ (TSDesc2000), “descrição completa do serviço prestado”.`})})]}),_jsxs(ParamField,{path:`servico.valorServicos`,type:`number`,required:true,id:`param-servico-valor-servicos`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` Até 15 dígitos inteiros e 2 decimais (TSDec15V2) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`vServ`}),` (grupo `,_jsx(_components.code,{children:`infDPS/valores/vServPrest`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` obrigatório no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Valor em R$, com no máximo 2 casas decimais. Vai para valores/vServPrest/vServ na DPS`}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCVServPrest/vServ (TSDec15V2), “valor dos serviços em R$”. O valor é apenas formatado com 2 casas, nunca calculado.`})})]}),_jsxs(ParamField,{path:`servico.aliquotaIss`,type:`number`,id:`param-servico-aliquota-iss`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 1 dígito inteiro e 2 decimais (TSDec1V2): percentual de 0 a 9,99. Percentual de dois dígitos, como 15, é recusado pelo esquema oficial. · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`pAliq`}),` (grupo `,_jsx(_components.code,{children:`infDPS/valores/trib/tribMun`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` condicional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Alíquota do ISS em percentual (0 a 9,99; no máximo 1 dígito inteiro e 2 casas). Vai para tribMun/pAliq na DPS`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Condição do leiaute:`}),` Informe apenas quando o município de incidência não é parametrizado no Sistema Nacional. Se o município participa, a alíquota é fornecida pelo próprio sistema. Com resolverTributacao igual a true o valor enviado é ignorado, com aviso na resposta: ecoar alíquota divergente causa rejeição.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribMunicipal/pAliq (TSDec1V2). A ordem dos elementos do grupo é normativa e foi conferida contra o esquema.`})})]}),_jsxs(ParamField,{path:`servico.valorDeducoes`,type:`number`,id:`param-servico-valor-deducoes`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` Até 15 dígitos inteiros e 2 decimais (TSDec15V2) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`vDR`}),` (grupo `,_jsx(_components.code,{children:`infDPS/valores/vDedRed`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` condicional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Valor em R$, com no máximo 2 casas decimais. Vai para valores/vDedRed/vDR na DPS`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Condição do leiaute:`}),` O leiaute permite declarar a dedução como percentual, como valor ou por lista de documentos. Este motor escreve o valor em reais; percentual e lista de documentos ainda não são suportados. O valor reduz a base de cálculo apurada pelo sistema nacional.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfoValores/vDedRed/vDR (TSDec15V2), folha obrigatória dentro da escolha de TCInfoDedRed quando a dedução é declarada por valor monetário. O valor é apenas formatado com 2 casas, nunca calculado.`})})]}),_jsxs(ParamField,{path:`servico.descontoIncondicionado`,type:`number`,id:`param-servico-desconto-incondicionado`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` Até 15 dígitos inteiros e 2 decimais (TSDec15V2) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`vDescIncond`}),` (grupo `,_jsx(_components.code,{children:`infDPS/valores/vDescCondIncond`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` opcional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Valor em R$, com no máximo 2 casas decimais. Vai para valores/vDescCondIncond/vDescIncond na DPS`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Condição do leiaute:`}),` Reduz a base de cálculo do ISSQN apurada pelo sistema nacional, ao contrário do desconto condicionado.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCVDescCondIncond/vDescIncond (TSDec15V2), dentro de TCInfoValores/vDescCondIncond. O valor é apenas formatado com 2 casas, nunca calculado.`})})]}),_jsxs(ParamField,{path:`servico.descontoCondicionado`,type:`number`,id:`param-servico-desconto-condicionado`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` Até 15 dígitos inteiros e 2 decimais (TSDec15V2) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`vDescCond`}),` (grupo `,_jsx(_components.code,{children:`infDPS/valores/vDescCondIncond`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` opcional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Valor em R$, com no máximo 2 casas decimais. Vai para valores/vDescCondIncond/vDescCond na DPS`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Condição do leiaute:`}),` Informativo: o desconto condicionado NÃO entra na fórmula da base de cálculo do ISSQN do leiaute, diferente do incondicionado.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCVDescCondIncond/vDescCond (TSDec15V2). A fórmula da base de cálculo documentada no esquema desconta apenas o incondicionado e a dedução.`})})]})]})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`grupo-totais`,children:`Totais`}),`\n`,_jsx(_components.p,{children:`O grupo de totais do leiaute não é enviado no payload: a engineAPI soma os itens e calcula o total automaticamente.`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`grupo-transporte`,children:`Transporte`}),`\n`,_jsx(_components.p,{children:`NFS-e (prestação de serviço) não tem grupo de transporte no leiaute.`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`grupo-cobranca`,children:`Cobrança`}),`\n`,_jsx(_components.p,{children:`NFS-e não tem grupo de cobrança/fatura no contrato hoje.`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`grupo-pagamento`,children:`Pagamento`}),`\n`,_jsx(_components.p,{children:`NFS-e não tem grupo de pagamento no contrato hoje: a cobrança do serviço é tratada fora da emissão fiscal.`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`grupo-informacoes-adicionais`,children:`Informações adicionais`}),`\n`,_jsxs(ParamField,{path:`informacoesComplementares`,type:`string`,id:`param-informacoes-complementares`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 1 a 2000 caracteres (TSDescInfCompl). Diferente da discriminação do serviço, este campo aceita apenas caracteres latinos básicos (até U+00FF): travessão, aspas curvas, reticências e emoji são recusados com 400. Quebra de linha, tabulação e espaço nas bordas são convertidos em espaço simples na emissão. · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`xInfComp`}),` (grupo `,_jsx(_components.code,{children:`infDPS/serv/infoCompl`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` opcional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Informações complementares da nota (até 2000 caracteres). Vai para serv/infoCompl/xInfComp na DPS. Aceita apenas caracteres latinos básicos: travessão, aspas curvas, reticências e emoji são recusados com 400. Quebra de linha e tabulação viram espaço na emissão`}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfoCompl/xInfComp (TSDescInfCompl, 1 a 2000, derivado de TSString, cujo padrão oficial não admite quebra de linha nem caractere acima de U+00FF).`})})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`grupo-tributacao-reforma`,children:`Tributação (Reforma e retenções)`}),`\n`,_jsxs(_components.p,{children:[`Fora da taxonomia clássica do leiaute NF-e/NFC-e: `,_jsx(_components.code,{children:`ibsCbs`}),` é o grupo da Reforma Tributária (passthrough puro, o Cérebro Fiscal não resolve nada dele), `,_jsx(_components.code,{children:`retencoes`}),` são as retenções de ISS da prestação e `,_jsx(_components.code,{children:`resolverTributacao`}),` ativa a emissão assistida; ver `,_jsx(_components.a,{href:`/guides/cerebro-fiscal`,children:`guia do Cérebro Fiscal`}),`.`]}),`\n`,_jsxs(ParamField,{path:`ibsCbs`,type:`object`,id:`param-ibs-cbs`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`IBSCBS`}),` (grupo `,_jsx(_components.code,{children:`infDPS`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` opcional no leiaute`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Condição do leiaute:`}),` Opcional no leiaute: o grupo só é emitido quando a operação declara IBS/CBS no padrão RTC.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Nota do leiaute:`}),` Grupo, não campo: IBSCBS é o contêiner do bloco da Reforma.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfDPS/IBSCBS (TCRTCInfoIBSCBS, minOccurs=“0”).`})}),_jsxs(Expandable,{title:`11 campo(s)`,children:[_jsxs(ParamField,{path:`ibsCbs.finNFSe`,type:`string`,id:`param-ibs-cbs-fin-nf-se`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 1 dígito (TSRTCFinNFSe) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`finNFSe`}),` (grupo `,_jsx(_components.code,{children:`infDPS/IBSCBS`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` obrigatório no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` preenchido automaticamente pela engineAPI`]}),_jsx(_components.p,{children:`Finalidade da emissão. O leiaute v1.01 prevê um único valor: “0” (NFS-e regular). Ausente = “0”`}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoIBSCBS/finNFSe (TSRTCFinNFSe), com um único valor enumerado. Ausente, a engineAPI escreve 0.`})}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Valor`}),_jsx(_components.th,{children:`Significado`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`0`})}),_jsx(_components.td,{children:`NFS-e regular`})]})})]})]}),_jsxs(ParamField,{path:`ibsCbs.indFinal`,type:`string`,id:`param-ibs-cbs-ind-final`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 1 dígito (TSRTCIndFinal) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`indFinal`}),` (grupo `,_jsx(_components.code,{children:`infDPS/IBSCBS`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` opcional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Operação de uso ou consumo pessoal (LC 214/2025, art. 57): “0” não · “1” sim`}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoIBSCBS/indFinal (TSRTCIndFinal).`})}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Valor`}),_jsx(_components.th,{children:`Significado`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`0`})}),_jsx(_components.td,{children:`Não é operação de uso ou consumo pessoal`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`1`})}),_jsx(_components.td,{children:`Operação de uso ou consumo pessoal (LC 214/2025, artigo 57)`})]})]})]})]}),_jsxs(ParamField,{path:`ibsCbs.cIndOp`,type:`string`,required:true,id:`param-ibs-cbs-c-ind-op`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 6 dígitos (TSRTCCodIndOp) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`cIndOp`}),` (grupo `,_jsx(_components.code,{children:`infDPS/IBSCBS`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` obrigatório no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsxs(_components.p,{children:[`Código indicador da operação de fornecimento (6 dígitos), conforme a tabela oficial “Código Indicador de Operação” (ANEXO_C/AnexoVII do portal nacional da NFS-e). Obrigatório quando o bloco ibsCbs é enviado (padrão: `,_jsx(_components.code,{children:`^\\\\d{6}$`}),`)`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoIBSCBS/cIndOp (TSRTCCodIndOp), conforme a tabela oficial de código indicador de operação.`})})]}),_jsxs(ParamField,{path:`ibsCbs.tpOper`,type:`string`,id:`param-ibs-cbs-tp-oper`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 1 dígito (TSRTCTpOper) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`tpOper`}),` (grupo `,_jsx(_components.code,{children:`infDPS/IBSCBS`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` opcional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Tipo de operação com entes governamentais ou serviços sobre bens imóveis: 1 fornecimento com pagamento posterior · 2 recebimento com fornecimento já realizado · 3 fornecimento com pagamento já realizado · 4 recebimento com fornecimento posterior · 5 fornecimento e recebimento concomitantes`}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoIBSCBS/tpOper (TSRTCTpOper), operação com entes governamentais ou serviços sobre bens imóveis.`})}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Valor`}),_jsx(_components.th,{children:`Significado`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`1`})}),_jsx(_components.td,{children:`Fornecimento com pagamento posterior`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`2`})}),_jsx(_components.td,{children:`Recebimento com fornecimento já realizado`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`3`})}),_jsx(_components.td,{children:`Fornecimento com pagamento já realizado`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`4`})}),_jsx(_components.td,{children:`Recebimento com fornecimento posterior`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`5`})}),_jsx(_components.td,{children:`Fornecimento e recebimento concomitantes`})]})]})]})]}),_jsxs(ParamField,{path:`ibsCbs.tpEnteGov`,type:`string`,id:`param-ibs-cbs-tp-ente-gov`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 1 dígito (TSRTCTpEnteGov) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`tpEnteGov`}),` (grupo `,_jsx(_components.code,{children:`infDPS/IBSCBS`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` opcional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Tipo de ente governamental: 1 União · 2 Estado · 3 DF · 4 Município`}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoIBSCBS/tpEnteGov (TSRTCTpEnteGov).`})}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Valor`}),_jsx(_components.th,{children:`Significado`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`1`})}),_jsx(_components.td,{children:`União`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`2`})}),_jsx(_components.td,{children:`Estado`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`3`})}),_jsx(_components.td,{children:`Distrito Federal`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`4`})}),_jsx(_components.td,{children:`Município`})]})]})]})]}),_jsxs(ParamField,{path:`ibsCbs.indDest`,type:`string`,id:`param-ibs-cbs-ind-dest`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 1 dígito (TSRTCIndDest) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`indDest`}),` (grupo `,_jsx(_components.code,{children:`infDPS/IBSCBS`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` obrigatório no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` preenchido automaticamente pela engineAPI`]}),_jsxs(_components.p,{children:[`Destinatário do serviço: “0” o destinatário é o próprio tomador (padrão) · “1” o destinatário é outra pessoa, o que exige o grupo `,_jsx(_components.code,{children:`dest`}),` do leiaute, ainda NÃO suportado por este motor, que recusa com 422 IBSCBS_DPS_DESTINATARIO_NAO_SUPORTADO em vez de emitir sem o grupo`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Condição do leiaute:`}),` O valor 1 exige o grupo de destinatário do leiaute, que este motor ainda não escreve: nesse caso a emissão recusa com 422 IBSCBS_DPS_DESTINATARIO_NAO_SUPORTADO em vez de emitir o documento sem o grupo.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoIBSCBS/indDest (TSRTCIndDest), elemento obrigatório. Ausente, a engineAPI escreve 0.`})}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Valor`}),_jsx(_components.th,{children:`Significado`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`0`})}),_jsx(_components.td,{children:`O destinatário é o próprio tomador`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`1`})}),_jsx(_components.td,{children:`O destinatário é outra pessoa`})]})]})]})]}),_jsxs(ParamField,{path:`ibsCbs.cst`,type:`string`,required:true,id:`param-ibs-cbs-cst`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 3 dígitos (TSRTCCodSitTrib) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`CST`}),` (grupo `,_jsx(_components.code,{children:`infDPS/IBSCBS/valores/trib/gIBSCBS`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` obrigatório no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsxs(_components.p,{children:[`Código de Situação Tributária do IBS/CBS (3 dígitos). Obrigatório quando o bloco ibsCbs é enviado (o motor não infere CST na NFS-e) (padrão: `,_jsx(_components.code,{children:`^\\\\d{3}$`}),`)`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoTributosSitClas/CST (TSRTCCodSitTrib). A DPS declara a situação tributária: alíquota e valor de IBS/CBS são calculados pelo sistema nacional e não existem neste documento.`})})]}),_jsxs(ParamField,{path:`ibsCbs.cClassTrib`,type:`string`,required:true,id:`param-ibs-cbs-c-class-trib`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 6 dígitos (TSRTCCodClassTrib) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`cClassTrib`}),` (grupo `,_jsx(_components.code,{children:`infDPS/IBSCBS/valores/trib/gIBSCBS`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` obrigatório no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsxs(_components.p,{children:[`Código de Classificação Tributária do IBS/CBS (6 dígitos). Obrigatório quando o bloco ibsCbs é enviado (padrão: `,_jsx(_components.code,{children:`^\\\\d{6}$`}),`)`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoTributosSitClas/cClassTrib (TSRTCCodClassTrib).`})})]}),_jsxs(ParamField,{path:`ibsCbs.cCredPres`,type:`string`,id:`param-ibs-cbs-c-cred-pres`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 2 dígitos (TSRTCCodCredPres) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`cCredPres`}),` (grupo `,_jsx(_components.code,{children:`infDPS/IBSCBS/valores/trib/gIBSCBS`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` opcional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsxs(_components.p,{children:[`Código e classificação do crédito presumido de IBS/CBS (2 dígitos) (padrão: `,_jsx(_components.code,{children:`^\\\\d{2}$`}),`)`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoTributosSitClas/cCredPres (TSRTCCodCredPres).`})})]}),_jsxs(ParamField,{path:`ibsCbs.gTribRegular`,type:`object`,id:`param-ibs-cbs-g-trib-regular`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`gTribRegular`}),` (grupo `,_jsx(_components.code,{children:`infDPS/IBSCBS/valores/trib/gIBSCBS`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` opcional no leiaute`]}),_jsx(_components.p,{children:`Tributação regular: a situação que valeria se o benefício não existisse`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Condição do leiaute:`}),` Opcional no leiaute: só é emitido quando a operação informa a tributação regular de referência.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Nota do leiaute:`}),` Grupo, não campo: gTribRegular é o contêiner dos campos CSTReg e cClassTribReg.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoTributosSitClas/gTribRegular (minOccurs=“0”).`})}),_jsxs(Expandable,{title:`2 campo(s)`,children:[_jsxs(ParamField,{path:`ibsCbs.gTribRegular.cstReg`,type:`string`,required:true,id:`param-ibs-cbs-g-trib-regular-cst-reg`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 3 dígitos (TSRTCCodSitTrib) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`CSTReg`}),` (grupo `,_jsx(_components.code,{children:`infDPS/IBSCBS/valores/trib/gIBSCBS/gTribRegular`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` condicional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsxs(_components.p,{children:[`CST do IBS/CBS que valeria na tributação regular (sem o benefício aplicado) (padrão: `,_jsx(_components.code,{children:`^\\\\d{3}$`}),`)`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Condição do leiaute:`}),` Obrigatório dentro do grupo de tributação regular, que descreve a situação que valeria se o benefício não existisse.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoTributosTribRegular/CSTReg (TSRTCCodSitTrib).`})})]}),_jsxs(ParamField,{path:`ibsCbs.gTribRegular.cClassTribReg`,type:`string`,required:true,id:`param-ibs-cbs-g-trib-regular-c-class-trib-reg`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 6 dígitos (TSRTCCodClassTrib) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`cClassTribReg`}),` (grupo `,_jsx(_components.code,{children:`infDPS/IBSCBS/valores/trib/gIBSCBS/gTribRegular`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` condicional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsxs(_components.p,{children:[`Código de classificação tributária do IBS/CBS na tributação regular (padrão: `,_jsx(_components.code,{children:`^\\\\d{6}$`}),`)`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Condição do leiaute:`}),` Obrigatório dentro do grupo de tributação regular, ao lado do CSTReg.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoTributosTribRegular/cClassTribReg (TSRTCCodClassTrib).`})})]})]})]}),_jsxs(ParamField,{path:`ibsCbs.gDif`,type:`object`,id:`param-ibs-cbs-g-dif`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`gDif`}),` (grupo `,_jsx(_components.code,{children:`infDPS/IBSCBS/valores/trib/gIBSCBS`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` opcional no leiaute`]}),_jsx(_components.p,{children:`Diferimento do IBS/CBS. Os três percentuais (pDifUF, pDifMun, pDifCBS) são exigidos juntos pelo leiaute`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Condição do leiaute:`}),` Opcional no leiaute: quando o grupo existe, os três percentuais de diferimento são obrigatórios.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Nota do leiaute:`}),` Grupo, não campo: gDif é o contêiner dos três percentuais.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoTributosSitClas/gDif (minOccurs=“0”).`})}),_jsxs(Expandable,{title:`3 campo(s)`,children:[_jsxs(ParamField,{path:`ibsCbs.gDif.pDifUF`,type:`number`,required:true,id:`param-ibs-cbs-g-dif-p-dif-uf`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` Até 3 dígitos inteiros e 2 decimais (TSDec3V2) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`pDifUF`}),` (grupo `,_jsx(_components.code,{children:`infDPS/IBSCBS/valores/trib/gIBSCBS/gDif`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` condicional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Percentual de diferimento do IBS estadual, em % (ex.: 30 para 30%). No máximo 2 casas decimais`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Condição do leiaute:`}),` O leiaute exige os três percentuais de diferimento juntos: informar um obriga a informar os outros dois.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoTributosDif/pDifUF (TSDec3V2), IBS estadual. Percentual com mais de 2 casas é recusado, nunca arredondado.`})})]}),_jsxs(ParamField,{path:`ibsCbs.gDif.pDifMun`,type:`number`,required:true,id:`param-ibs-cbs-g-dif-p-dif-mun`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` Até 3 dígitos inteiros e 2 decimais (TSDec3V2) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`pDifMun`}),` (grupo `,_jsx(_components.code,{children:`infDPS/IBSCBS/valores/trib/gIBSCBS/gDif`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` condicional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Percentual de diferimento do IBS municipal, em %. No máximo 2 casas decimais`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Condição do leiaute:`}),` O leiaute exige os três percentuais de diferimento juntos: informar um obriga a informar os outros dois.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoTributosDif/pDifMun (TSDec3V2), IBS municipal.`})})]}),_jsxs(ParamField,{path:`ibsCbs.gDif.pDifCBS`,type:`number`,required:true,id:`param-ibs-cbs-g-dif-p-dif-cbs`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` Até 3 dígitos inteiros e 2 decimais (TSDec3V2) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`pDifCBS`}),` (grupo `,_jsx(_components.code,{children:`infDPS/IBSCBS/valores/trib/gIBSCBS/gDif`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` condicional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Percentual de diferimento da CBS, em %. No máximo 2 casas decimais`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Condição do leiaute:`}),` O leiaute exige os três percentuais de diferimento juntos: informar um obriga a informar os outros dois.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCRTCInfoTributosDif/pDifCBS (TSDec3V2), CBS.`})})]})]})]})]})]}),`\n`,_jsxs(ParamField,{path:`retencoes`,type:`object`,id:`param-retencoes`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tag do leiaute:`}),` sem tag própria no XML · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` não é campo do leiaute (informativo/de compatibilidade)`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Nota do leiaute:`}),` Grupo lógico da API para retenções. No XML da DPS os campos ficam em valores/trib/tribMun e valores/trib/tribFed.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCInfoValores/trib (sem elemento retencoes; os campos ficam em tribMun e tribFed).`})}),_jsxs(Expandable,{title:`7 campo(s)`,children:[_jsxs(ParamField,{path:`retencoes.issRetidoPor`,type:`string`,id:`param-retencoes-iss-retido-por`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` 1 dígito (TSTipoRetISSQN) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`tpRetISSQN`}),` (grupo `,_jsx(_components.code,{children:`infDPS/valores/trib/tribMun`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` obrigatório no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` derivado de outros campos (calculado)`]}),_jsx(_components.p,{children:`Quem retém o ISS: “tomador” (tpRetISSQN=2) ou “intermediario” (tpRetISSQN=3). Ausente = não retido`}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribMunicipal/tpRetISSQN (TSTipoRetISSQN). O leiaute não tem campo para o VALOR do ISS retido: o sistema nacional calcula o imposto e o inclui no total de retenções da NFS-e quando o indicador diz que houve retenção.`})}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Valor`}),_jsx(_components.th,{children:`Significado`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`tomador`})}),_jsx(_components.td,{children:`Escreve tpRetISSQN igual a 2`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`intermediario`})}),_jsx(_components.td,{children:`Escreve tpRetISSQN igual a 3`})]})]})]})]}),_jsxs(ParamField,{path:`retencoes.irrf`,type:`number`,id:`param-retencoes-irrf`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` Até 15 dígitos inteiros e 2 decimais (TSDec15V2) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`vRetIRRF`}),` (grupo `,_jsx(_components.code,{children:`infDPS/valores/trib/tribFed`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` opcional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Valor retido em R$, com no máximo 2 casas decimais. Vai para tribFed/vRetIRRF na DPS`}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribFederal/vRetIRRF (TSDec15V2), “valor monetário do IRRF (R$)”. O valor vai como informado: nenhuma alíquota de retenção é aplicada pela engineAPI.`})})]}),_jsxs(ParamField,{path:`retencoes.csll`,type:`number`,id:`param-retencoes-csll`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` Até 15 dígitos inteiros e 2 decimais (TSDec15V2) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`vRetCSLL`}),` (grupo `,_jsx(_components.code,{children:`infDPS/valores/trib/tribFed`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` opcional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Valor retido em R$, com no máximo 2 casas decimais. Vai para tribFed/vRetCSLL na DPS`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Condição do leiaute:`}),` Quando dpsNacional.tpRetPisCofins afirma que a CSLL é retida (códigos 3, 7, 8 e 9), o valor passa a ser exigido: a divergência recusa com 422 RETENCAO_PIS_COFINS_INCOERENTE.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribFederal/vRetCSLL (TSDec15V2), “valor monetário do CSLL (R$)”.`})})]}),_jsxs(ParamField,{path:`retencoes.inss`,type:`number`,id:`param-retencoes-inss`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` Até 15 dígitos inteiros e 2 decimais (TSDec15V2) · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` `,_jsx(_components.code,{children:`vRetCP`}),` (grupo `,_jsx(_components.code,{children:`infDPS/valores/trib/tribFed`}),`) · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` opcional no leiaute · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Valor retido em R$, com no máximo 2 casas decimais. Vai para tribFed/vRetCP (Contribuição Previdenciária) na DPS`}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribFederal/vRetCP (TSDec15V2), “valor monetário do CP (R$)”, a contribuição previdenciária retida.`})})]}),_jsxs(ParamField,{path:`retencoes.cofins`,type:`number`,id:`param-retencoes-cofins`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` mínimo 0 · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` sem tag própria no XML · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` não é campo do leiaute (informativo/de compatibilidade) · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Sem campo de VALOR na DPS do Padrão Nacional (vCofins do leiaute é o débito de apuração própria, não a retenção): valor diferente de zero recusa com 422 RETENCAO_SEM_CAMPO_NO_LEIAUTE. No máximo 2 casas decimais. A retenção de PIS/COFINS se declara pelo indicador dpsNacional.tpRetPisCofins`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Nota do leiaute:`}),` A DPS não tem campo para o valor de COFINS retida. O vCofins do leiaute é o débito de apuração própria do prestador e fica fora do total de retenções da NFS-e. Valor diferente de zero recusa com 422 RETENCAO_SEM_CAMPO_NO_LEIAUTE: a retenção se declara pelo indicador dpsNacional.tpRetPisCofins.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribOutrosPisCofins/vCofins, documentado como “valor do débito de COFINS apuração própria (R$)”.`})})]}),_jsxs(ParamField,{path:`retencoes.pis`,type:`number`,id:`param-retencoes-pis`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` mínimo 0 · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` sem tag própria no XML · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` não é campo do leiaute (informativo/de compatibilidade) · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Sem campo de VALOR na DPS do Padrão Nacional (vPis do leiaute é o débito de apuração própria, não a retenção): valor diferente de zero recusa com 422 RETENCAO_SEM_CAMPO_NO_LEIAUTE. No máximo 2 casas decimais. A retenção de PIS/COFINS se declara pelo indicador dpsNacional.tpRetPisCofins`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Nota do leiaute:`}),` A DPS não tem campo para o valor de PIS retido. O vPis do leiaute é o débito de apuração própria do prestador e fica fora do total de retenções da NFS-e. Valor diferente de zero recusa com 422 RETENCAO_SEM_CAMPO_NO_LEIAUTE, nunca é descartado em silêncio: a retenção se declara pelo indicador dpsNacional.tpRetPisCofins.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribOutrosPisCofins/vPis, documentado como “valor do débito de PIS apuração própria (R$)”. O total de retenções da NFS-e é a soma de vRetCP, vRetIRRF, vRetCSLL e do ISSQN.`})})]}),_jsxs(ParamField,{path:`retencoes.outrasRetencoes`,type:`number`,id:`param-retencoes-outras-retencoes`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tamanho:`}),` mínimo 0 · `,_jsx(_components.strong,{children:`Tag do leiaute:`}),` sem tag própria no XML · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` não é campo do leiaute (informativo/de compatibilidade) · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsx(_components.p,{children:`Sem campo de VALOR na DPS do Padrão Nacional (a DPS não tem campo de “outras retenções”): valor diferente de zero recusa com 422 RETENCAO_SEM_CAMPO_NO_LEIAUTE. No máximo 2 casas decimais. Informe o tributo no campo próprio: retencoes.inss, retencoes.irrf ou retencoes.csll`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Nota do leiaute:`}),` A DPS só comporta valor retido de contribuição previdenciária, IRRF e CSLL. Não existe campo de outras retenções: valor diferente de zero recusa com 422 RETENCAO_SEM_CAMPO_NO_LEIAUTE.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): TCTribFederal tem apenas o grupo de PIS/COFINS, vRetCP, vRetIRRF e vRetCSLL.`})})]})]})]}),`\n`,_jsxs(ParamField,{path:`resolverTributacao`,type:`boolean`,id:`param-resolver-tributacao`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tag do leiaute:`}),` sem tag própria no XML · `,_jsx(_components.strong,{children:`Obrigatoriedade do leiaute:`}),` não é campo do leiaute (informativo/de compatibilidade) · `,_jsx(_components.strong,{children:`Preenche:`}),` você, na requisição`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Nota do leiaute:`}),` Chave da engineAPI que liga a emissão assistida pelo Cérebro Fiscal. Não é campo do leiaute: muda quem preenche os códigos fiscais, não o conteúdo do documento.`]}),_jsx(_components.p,{children:_jsx(_components.em,{children:`Fonte do leiaute: tiposComplexos_v1.01.xsd (NFSe-ESQUEMAS_XSD-v1.01-20260209): não há elemento correspondente.`})})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`indice-reverso`,children:`Índice reverso: tag do leiaute → nosso campo`}),`\n`,_jsxs(_components.p,{children:[`Procure pelo nome que o leiaute usa (ex.: `,_jsx(_components.code,{children:`natOp`}),`, `,_jsx(_components.code,{children:`vFrete`}),`) e encontre o campo correspondente no contrato da engineAPI.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Tag do leiaute`}),_jsx(_components.th,{children:`Nosso campo`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`cClassTrib`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-ibs-cbs-c-class-trib`,children:_jsx(_components.code,{children:`ibsCbs.cClassTrib`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`cClassTribReg`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-ibs-cbs-g-trib-regular-c-class-trib-reg`,children:_jsx(_components.code,{children:`ibsCbs.gTribRegular.cClassTribReg`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`cCredPres`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-ibs-cbs-c-cred-pres`,children:_jsx(_components.code,{children:`ibsCbs.cCredPres`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`CEP`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-tomador-endereco-cep`,children:_jsx(_components.code,{children:`tomador.endereco.cep`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`cIndOp`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-ibs-cbs-c-ind-op`,children:_jsx(_components.code,{children:`ibsCbs.cIndOp`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`cLocPrestacao`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-servico-codigo-municipio`,children:_jsx(_components.code,{children:`servico.codigoMunicipio`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`cMun`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-tomador-endereco-codigo-municipio`,children:_jsx(_components.code,{children:`tomador.endereco.codigoMunicipio`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`cNBS`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-servico-codigo-nbs`,children:_jsx(_components.code,{children:`servico.codigoNBS`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`CNPJ|CPF`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-tomador-cnpj-cpf`,children:_jsx(_components.code,{children:`tomador.cnpjCpf`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`CST`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-dps-nacional-cst-pis-cofins`,children:_jsx(_components.code,{children:`dpsNacional.cstPisCofins`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`CST`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-ibs-cbs-cst`,children:_jsx(_components.code,{children:`ibsCbs.cst`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`CSTReg`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-ibs-cbs-g-trib-regular-cst-reg`,children:_jsx(_components.code,{children:`ibsCbs.gTribRegular.cstReg`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`cTribMun`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-dps-nacional-c-trib-mun`,children:_jsx(_components.code,{children:`dpsNacional.cTribMun`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`cTribMun`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-servico-codigo-tributacao-municipio`,children:_jsx(_components.code,{children:`servico.codigoTributacaoMunicipio`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`cTribNac`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-dps-nacional-c-trib-nac`,children:_jsx(_components.code,{children:`dpsNacional.cTribNac`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`dCompet`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-competencia`,children:_jsx(_components.code,{children:`competencia`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`email`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-tomador-email`,children:_jsx(_components.code,{children:`tomador.email`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`end`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-tomador-endereco`,children:_jsx(_components.code,{children:`tomador.endereco`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`finNFSe`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-ibs-cbs-fin-nf-se`,children:_jsx(_components.code,{children:`ibsCbs.finNFSe`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`fone`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-tomador-telefone`,children:_jsx(_components.code,{children:`tomador.telefone`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`gDif`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-ibs-cbs-g-dif`,children:_jsx(_components.code,{children:`ibsCbs.gDif`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`gTribRegular`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-ibs-cbs-g-trib-regular`,children:_jsx(_components.code,{children:`ibsCbs.gTribRegular`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`IBSCBS`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-ibs-cbs`,children:_jsx(_components.code,{children:`ibsCbs`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`IM`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-tomador-inscricao-municipal`,children:_jsx(_components.code,{children:`tomador.inscricaoMunicipal`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`indDest`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-ibs-cbs-ind-dest`,children:_jsx(_components.code,{children:`ibsCbs.indDest`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`indFinal`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-ibs-cbs-ind-final`,children:_jsx(_components.code,{children:`ibsCbs.indFinal`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`nro`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-tomador-endereco-numero`,children:_jsx(_components.code,{children:`tomador.endereco.numero`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`opSimpNac`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-dps-nacional-op-simp-nac`,children:_jsx(_components.code,{children:`dpsNacional.opSimpNac`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`pAliq`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-servico-aliquota-iss`,children:_jsx(_components.code,{children:`servico.aliquotaIss`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`pDifCBS`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-ibs-cbs-g-dif-p-dif-cbs`,children:_jsx(_components.code,{children:`ibsCbs.gDif.pDifCBS`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`pDifMun`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-ibs-cbs-g-dif-p-dif-mun`,children:_jsx(_components.code,{children:`ibsCbs.gDif.pDifMun`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`pDifUF`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-ibs-cbs-g-dif-p-dif-uf`,children:_jsx(_components.code,{children:`ibsCbs.gDif.pDifUF`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`pTotTribSN`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-dps-nacional-p-tot-trib-sn`,children:_jsx(_components.code,{children:`dpsNacional.pTotTribSN`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`regApTribSN`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-dps-nacional-reg-ap-trib-sn`,children:_jsx(_components.code,{children:`dpsNacional.regApTribSN`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`regEspTrib`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-dps-nacional-reg-esp-trib`,children:_jsx(_components.code,{children:`dpsNacional.regEspTrib`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`serie`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-serie`,children:_jsx(_components.code,{children:`serie`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`serv`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-servico`,children:_jsx(_components.code,{children:`servico`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`toma`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-tomador`,children:_jsx(_components.code,{children:`tomador`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`tpEnteGov`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-ibs-cbs-tp-ente-gov`,children:_jsx(_components.code,{children:`ibsCbs.tpEnteGov`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`tpOper`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-ibs-cbs-tp-oper`,children:_jsx(_components.code,{children:`ibsCbs.tpOper`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`tpRetISSQN`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-dps-nacional-tp-ret-issqn`,children:_jsx(_components.code,{children:`dpsNacional.tpRetISSQN`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`tpRetISSQN`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-retencoes-iss-retido-por`,children:_jsx(_components.code,{children:`retencoes.issRetidoPor`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`tpRetPisCofins`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-dps-nacional-tp-ret-pis-cofins`,children:_jsx(_components.code,{children:`dpsNacional.tpRetPisCofins`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`tribISSQN`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-dps-nacional-trib-issqn`,children:_jsx(_components.code,{children:`dpsNacional.tribISSQN`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`vDescCond`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-servico-desconto-condicionado`,children:_jsx(_components.code,{children:`servico.descontoCondicionado`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`vDescIncond`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-servico-desconto-incondicionado`,children:_jsx(_components.code,{children:`servico.descontoIncondicionado`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`vDR`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-servico-valor-deducoes`,children:_jsx(_components.code,{children:`servico.valorDeducoes`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`vRetCP`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-retencoes-inss`,children:_jsx(_components.code,{children:`retencoes.inss`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`vRetCSLL`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-retencoes-csll`,children:_jsx(_components.code,{children:`retencoes.csll`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`vRetIRRF`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-retencoes-irrf`,children:_jsx(_components.code,{children:`retencoes.irrf`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`vServ`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-servico-valor-servicos`,children:_jsx(_components.code,{children:`servico.valorServicos`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`xBairro`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-tomador-endereco-bairro`,children:_jsx(_components.code,{children:`tomador.endereco.bairro`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`xCpl`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-tomador-endereco-complemento`,children:_jsx(_components.code,{children:`tomador.endereco.complemento`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`xDescServ`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-servico-discriminacao`,children:_jsx(_components.code,{children:`servico.discriminacao`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`xInfComp`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-informacoes-complementares`,children:_jsx(_components.code,{children:`informacoesComplementares`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`xLgr`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-tomador-endereco-logradouro`,children:_jsx(_components.code,{children:`tomador.endereco.logradouro`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`xNome`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-tomador-razao-social`,children:_jsx(_components.code,{children:`tomador.razaoSocial`})})})]})]})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`estado-dos-campos`,children:`Estado dos campos do leiaute`}),`\n`,_jsxs(_components.p,{children:[`Todo campo listado acima é `,_jsx(_components.strong,{children:`suportado`}),`: está no contrato e a engineAPI o usa. Esta seção cobre o resto do leiaute: o que a API aceita com outro nome, o que ela recusa hoje e as ressalvas de campos que estão no contrato mas o leiaute trata de um jeito específico.`]}),`\n`,_jsx(Heading,{level:`3`,id:`preenchidos-automaticamente-ou-derivados`,children:`Preenchidos automaticamente ou derivados`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Campo`}),_jsx(_components.th,{children:`Como`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-dps-nacional-op-simp-nac`,children:_jsx(_components.code,{children:`dpsNacional.opSimpNac`})})}),_jsx(_components.td,{children:`preenchido automaticamente pela engineAPI`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-dps-nacional-c-trib-nac`,children:_jsx(_components.code,{children:`dpsNacional.cTribNac`})})}),_jsx(_components.td,{children:`preenchido automaticamente pela engineAPI`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-dps-nacional-trib-issqn`,children:_jsx(_components.code,{children:`dpsNacional.tribISSQN`})})}),_jsx(_components.td,{children:`preenchido automaticamente pela engineAPI`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-dps-nacional-tp-ret-issqn`,children:_jsx(_components.code,{children:`dpsNacional.tpRetISSQN`})})}),_jsx(_components.td,{children:`derivado de outros campos (calculado)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-dps-nacional-p-tot-trib-sn`,children:_jsx(_components.code,{children:`dpsNacional.pTotTribSN`})})}),_jsx(_components.td,{children:`preenchido automaticamente pela engineAPI`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-tomador-cnpj-cpf`,children:_jsx(_components.code,{children:`tomador.cnpjCpf`})})}),_jsx(_components.td,{children:`derivado de outros campos (calculado)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-tomador-telefone`,children:_jsx(_components.code,{children:`tomador.telefone`})})}),_jsx(_components.td,{children:`derivado de outros campos (calculado)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-tomador-endereco-cep`,children:_jsx(_components.code,{children:`tomador.endereco.cep`})})}),_jsx(_components.td,{children:`derivado de outros campos (calculado)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-servico-item-lista-servico`,children:_jsx(_components.code,{children:`servico.itemListaServico`})})}),_jsx(_components.td,{children:`preenchido automaticamente pela engineAPI`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-servico-codigo-nbs`,children:_jsx(_components.code,{children:`servico.codigoNBS`})})}),_jsx(_components.td,{children:`preenchido automaticamente pela engineAPI`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-ibs-cbs-fin-nf-se`,children:_jsx(_components.code,{children:`ibsCbs.finNFSe`})})}),_jsx(_components.td,{children:`preenchido automaticamente pela engineAPI`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-ibs-cbs-ind-dest`,children:_jsx(_components.code,{children:`ibsCbs.indDest`})})}),_jsx(_components.td,{children:`preenchido automaticamente pela engineAPI`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`#param-retencoes-iss-retido-por`,children:_jsx(_components.code,{children:`retencoes.issRetidoPor`})})}),_jsx(_components.td,{children:`derivado de outros campos (calculado)`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`aceitos-no-contrato-com-ressalva-do-leiaute`,children:`Aceitos no contrato, com ressalva do leiaute`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#param-rps-numero`,children:_jsx(_components.code,{children:`rps.numero`})}),`: O Padrão Nacional não tem RPS: a própria DPS é o documento de origem, e o número dela é alocado pela engineAPI por empresa e série. Enviar este campo na emissão nacional é recusado com 422, em vez de gerar uma nota sem o dado. Guarde a correspondência com o seu RPS pelo número da DPS devolvido na emissão.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#param-rps-serie`,children:_jsx(_components.code,{children:`rps.serie`})}),`: Série do RPS do modelo municipal, sem equivalente no Padrão Nacional. A série que vai para a DPS é o campo serie do topo do payload. Enviar este campo na emissão nacional é recusado com 422.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#param-rps-tipo`,children:_jsx(_components.code,{children:`rps.tipo`})}),`: Tipo de RPS do modelo municipal, sem equivalente no Padrão Nacional. Enviar este campo na emissão nacional é recusado com 422.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#param-rps`,children:_jsx(_components.code,{children:`rps`})}),`: Grupo do modelo municipal antigo. A DPS não possui contêiner de RPS porque a própria declaração é o documento de origem.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#param-dps-nacional`,children:_jsx(_components.code,{children:`dpsNacional`})}),`: Grupo lógico da API que organiza os campos fiscais do padrão nacional; no XML esses campos ficam distribuídos em prest/regTrib, serv/cServ e valores/trib.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#param-natureza-operacao`,children:_jsx(_components.code,{children:`naturezaOperacao`})}),`: Conceito do modelo municipal. No Padrão Nacional a natureza da operação é expressa pela tributação do ISSQN (dpsNacional.tribISSQN) e pelo local da prestação. Campo aceito por compatibilidade e não escrito no documento.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#param-regime-tributacao`,children:_jsx(_components.code,{children:`regimeTributacao`})}),`: Conceito do modelo municipal. No Padrão Nacional o regime vai no grupo prest/regTrib, alimentado por dpsNacional.opSimpNac, regApTribSN e regEspTrib. Campo aceito por compatibilidade e não escrito no documento.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#param-optante-simples`,children:_jsx(_components.code,{children:`optanteSimples`})}),`: Booleano do modelo municipal. O Padrão Nacional exige um código de três valores (não optante, MEI, ME/EPP), informado em dpsNacional.opSimpNac. Campo aceito por compatibilidade e não escrito no documento.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#param-exigibilidade-iss`,children:_jsx(_components.code,{children:`exigibilidadeISS`})}),`: Código do modelo municipal. No Padrão Nacional a exigibilidade se declara por dpsNacional.tribISSQN (tributável, imunidade, exportação, não incidência) e pelo grupo de exigibilidade suspensa, que este motor ainda não escreve. Campo aceito por compatibilidade e não escrito no documento.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#param-issuer-id`,children:_jsx(_components.code,{children:`issuerId`})}),`: Identificador da empresa emissora na engineAPI, não é campo do leiaute. É ele que determina o grupo prest (CNPJ ou CPF e regime) e o município emissor, lidos do cadastro.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#param-tomador-endereco-uf`,children:_jsx(_components.code,{children:`tomador.endereco.uf`})}),`: O endereço nacional da DPS tem apenas código do município e CEP: a UF é deduzida do código IBGE pelo sistema nacional. Campo aceito por compatibilidade e não escrito no documento.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#param-tomador-endereco`,children:_jsx(_components.code,{children:`tomador.endereco`})}),`: Grupo, não campo: end é o contêiner do endereço do tomador.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#param-tomador`,children:_jsx(_components.code,{children:`tomador`})}),`: Grupo, não campo: toma é o contêiner de identificação e endereço do tomador.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#param-servico-item-lista-servico`,children:_jsx(_components.code,{children:`servico.itemListaServico`})}),`: O Padrão Nacional identifica o serviço pelo código de tributação nacional de 6 dígitos (dpsNacional.cTribNac), não pelo item da lista no formato do modelo municipal. Este campo é a entrada do Cérebro Fiscal, que resolve o cTribNac quando resolverTributacao é true, mas não vira tag na DPS.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#param-servico-codigo-cnae`,children:_jsx(_components.code,{children:`servico.codigoCnae`})}),`: O leiaute da DPS não tem campo de CNAE. Campo aceito por compatibilidade com o modelo municipal e não escrito no documento.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#param-servico`,children:_jsx(_components.code,{children:`servico`})}),`: Grupo, não campo: serv é o contêiner dos dados do serviço.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#param-ibs-cbs-g-trib-regular`,children:_jsx(_components.code,{children:`ibsCbs.gTribRegular`})}),`: Grupo, não campo: gTribRegular é o contêiner dos campos CSTReg e cClassTribReg.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#param-ibs-cbs-g-dif`,children:_jsx(_components.code,{children:`ibsCbs.gDif`})}),`: Grupo, não campo: gDif é o contêiner dos três percentuais.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#param-ibs-cbs`,children:_jsx(_components.code,{children:`ibsCbs`})}),`: Grupo, não campo: IBSCBS é o contêiner do bloco da Reforma.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#param-retencoes-cofins`,children:_jsx(_components.code,{children:`retencoes.cofins`})}),`: A DPS não tem campo para o valor de COFINS retida. O vCofins do leiaute é o débito de apuração própria do prestador e fica fora do total de retenções da NFS-e. Valor diferente de zero recusa com 422 RETENCAO_SEM_CAMPO_NO_LEIAUTE: a retenção se declara pelo indicador dpsNacional.tpRetPisCofins.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#param-retencoes-pis`,children:_jsx(_components.code,{children:`retencoes.pis`})}),`: A DPS não tem campo para o valor de PIS retido. O vPis do leiaute é o débito de apuração própria do prestador e fica fora do total de retenções da NFS-e. Valor diferente de zero recusa com 422 RETENCAO_SEM_CAMPO_NO_LEIAUTE, nunca é descartado em silêncio: a retenção se declara pelo indicador dpsNacional.tpRetPisCofins.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#param-retencoes-outras-retencoes`,children:_jsx(_components.code,{children:`retencoes.outrasRetencoes`})}),`: A DPS só comporta valor retido de contribuição previdenciária, IRRF e CSLL. Não existe campo de outras retenções: valor diferente de zero recusa com 422 RETENCAO_SEM_CAMPO_NO_LEIAUTE.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#param-retencoes`,children:_jsx(_components.code,{children:`retencoes`})}),`: Grupo lógico da API para retenções. No XML da DPS os campos ficam em valores/trib/tribMun e valores/trib/tribFed.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#param-resolver-tributacao`,children:_jsx(_components.code,{children:`resolverTributacao`})}),`: Chave da engineAPI que liga a emissão assistida pelo Cérebro Fiscal. Não é campo do leiaute: muda quem preenche os códigos fiscais, não o conteúdo do documento.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`não-suportados-hoje-fora-do-contrato`,children:`Não suportados hoje (fora do contrato)`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Termo(s) do leiaute`}),_jsx(_components.th,{children:`Motivo`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`obra`}),`, `,_jsx(_components.code,{children:`ART`}),`, `,_jsx(_components.code,{children:`codigoobra`})]}),_jsx(_components.td,{children:`O grupo obra/ART (identificação da obra de construção civil e da Anotação de Responsabilidade Técnica do serviço) ainda não é suportado pela engineAPI. Serviço de construção civil que a prefeitura exige vincular a uma obra cadastrada não pode ser emitido com essa vinculação por enquanto.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`intermediario`})}),_jsxs(_components.td,{children:[`O grupo intermediario da NFS-e (identificação de quem intermediou a prestação do serviço, com CNPJ/CPF, nome e endereço) ainda não é suportado pela engineAPI. A RETENÇÃO pelo intermediário, essa sim, é suportada: informe `,_jsx(_components.code,{children:`retencoes.issRetidoPor: \"intermediario\"`}),` (vira tpRetISSQN=3 na DPS). O que não sai no documento é a identificação de quem reteve.`]})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`nif`}),`, `,_jsx(_components.code,{children:`tomadorexterior`})]}),_jsxs(_components.td,{children:[`nif (Número de Identificação Fiscal do tomador no exterior) e o restante dos dados de tomador estrangeiro ainda não são suportados pela engineAPI. O `,_jsx(_components.code,{children:`tomador`}),` aceita hoje só `,_jsx(_components.code,{children:`cnpjCpf`}),` nacional; serviço exportado para tomador sem CNPJ/CPF brasileiro não pode ser emitido por enquanto.`]})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`substituicaorps`}),`, `,_jsx(_components.code,{children:`substituicao`})]}),_jsxs(_components.td,{children:[`A substituição de RPS (nova DPS que substitui um RPS/NFS-e já emitido, referenciando o número original) ainda não é suportada pela engineAPI. No Padrão Nacional a própria DPS ocupa o lugar do RPS e o leiaute não tem campo para o número dele (por isso `,_jsx(_components.code,{children:`rps`}),` é recusado nesse caminho); para corrigir um RPS ou NFS-e já emitido, use o cancelamento (POST /v1/nfse/:id/cancelar) e emita um novo documento.`]})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Referência de campos: NFSe","description":"Todo campo do payload de emissão de NFSe (POST /v1/nfse): tipo, tamanho, tag do leiaute e obrigatoriedade.","href":"/api-reference/campos-nfse"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Navegação por grupo do leiaute","slug":"navegação-por-grupo-do-leiaute","depth":2,"children":[]},{"title":"Identificação","slug":"grupo-identificacao","depth":2,"children":[]},{"title":"Emitente","slug":"grupo-emitente","depth":2,"children":[]},{"title":"Destinatário","slug":"grupo-destinatario","depth":2,"children":[]},{"title":"Itens","slug":"grupo-itens","depth":2,"children":[]},{"title":"Totais","slug":"grupo-totais","depth":2,"children":[]},{"title":"Transporte","slug":"grupo-transporte","depth":2,"children":[]},{"title":"Cobrança","slug":"grupo-cobranca","depth":2,"children":[]},{"title":"Pagamento","slug":"grupo-pagamento","depth":2,"children":[]},{"title":"Informações adicionais","slug":"grupo-informacoes-adicionais","depth":2,"children":[]},{"title":"Tributação (Reforma e retenções)","slug":"grupo-tributacao-reforma","depth":2,"children":[]},{"title":"Índice reverso: tag do leiaute → nosso campo","slug":"indice-reverso","depth":2,"children":[]},{"title":"Estado dos campos do leiaute","slug":"estado-dos-campos","depth":2,"children":[{"title":"Preenchidos automaticamente ou derivados","slug":"preenchidos-automaticamente-ou-derivados","depth":3,"children":[]},{"title":"Aceitos no contrato, com ressalva do leiaute","slug":"aceitos-no-contrato-com-ressalva-do-leiaute","depth":3,"children":[]},{"title":"Não suportados hoje (fora do contrato)","slug":"não-suportados-hoje-fora-do-contrato","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"subdomain":"3xtec","siteName":"EngineAPI","title":"Referência de campos: NFSe - EngineAPI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-14T04:40:45.565Z","originalFileLocation":"api-reference/campos-nfse.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Todo campo do payload de emissão de NFSe (POST /v1/nfse): tipo, tamanho, tag do leiaute e obrigatoriedade.\">\u003cmeta data-mint-head name=\"application-name\" content=\"EngineAPI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/3xtec/e0fLCDQyVL4lj2rl/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/3xtec/e0fLCDQyVL4lj2rl/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/3xtec/e0fLCDQyVL4lj2rl/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/3xtec/e0fLCDQyVL4lj2rl/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/3xtec/e0fLCDQyVL4lj2rl/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/3xtec/e0fLCDQyVL4lj2rl/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/3xtec/e0fLCDQyVL4lj2rl/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/3xtec/e0fLCDQyVL4lj2rl/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/3xtec/e0fLCDQyVL4lj2rl/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Referência de campos: NFSe - EngineAPI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Todo campo do payload de emissão de NFSe (POST /v1/nfse): tipo, tamanho, tag do leiaute e obrigatoriedade.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"EngineAPI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.engineapi.com.br/api-reference/campos-nfse\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://3xtec.mintlify.site/_mintlify/api/og/v2?division=Cat%C3%A1logo+de+campos\u0026amp;title=Refer%C3%AAncia+de+campos%3A+NFSe\u0026amp;description=Todo+campo+do+payload+de+emiss%C3%A3o+de+NFSe+%28POST+%2Fv1%2Fnfse%29%3A+tipo%2C+tamanho%2C+tag+do+leiaute+e+obrigatoriedade.\u0026amp;theme=afc36279d6b62627aee2125d\u0026amp;signature=373185d1319841d1fc4215ab451c7203a5b8e07d0c0fe4e589e4928aba92bd10\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Referência de campos: NFSe - EngineAPI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Todo campo do payload de emissão de NFSe (POST /v1/nfse): tipo, tamanho, tag do leiaute e obrigatoriedade.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://3xtec.mintlify.site/_mintlify/api/og/v2?division=Cat%C3%A1logo+de+campos\u0026amp;title=Refer%C3%AAncia+de+campos%3A+NFSe\u0026amp;description=Todo+campo+do+payload+de+emiss%C3%A3o+de+NFSe+%28POST+%2Fv1%2Fnfse%29%3A+tipo%2C+tamanho%2C+tag+do+leiaute+e+obrigatoriedade.\u0026amp;theme=afc36279d6b62627aee2125d\u0026amp;signature=373185d1319841d1fc4215ab451c7203a5b8e07d0c0fe4e589e4928aba92bd10\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/3xtec/e0fLCDQyVL4lj2rl/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"EngineAPI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1E56B1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.engineapi.com.br/api-reference/campos-nfse\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/campos-nfse.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.engineapi.com.br/#organization\",\"name\":\"EngineAPI\",\"url\":\"https://docs.engineapi.com.br\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/3xtec/upxot-gn5enp24zf/logo/light.svg?fit=max\u0026auto=format\u0026n=upxot-gn5enp24zf\u0026q=85\u0026s=63aef46d17335e80239cdc40c74322e9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.engineapi.com.br#website\",\"name\":\"EngineAPI\",\"url\":\"https://docs.engineapi.com.br\",\"publisher\":{\"@id\":\"https://docs.engineapi.com.br/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.engineapi.com.br/api-reference/campos-nfse#webpage\",\"url\":\"https://docs.engineapi.com.br/api-reference/campos-nfse\",\"name\":\"Referência de campos: NFSe\",\"description\":\"Todo campo do payload de emissão de NFSe (POST /v1/nfse): tipo, tamanho, tag do leiaute e obrigatoriedade.\",\"dateModified\":\"2026-11-14T04:40:45.565Z\",\"isPartOf\":{\"@id\":\"https://docs.engineapi.com.br#website\"},\"breadcrumb\":{\"@id\":\"https://docs.engineapi.com.br/api-reference/campos-nfse#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.engineapi.com.br/api-reference/campos-nfse#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Catálogo de campos\",\"item\":\"https://docs.engineapi.com.br/api-reference/campos-nfe\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Referência de campos: NFSe\",\"item\":\"https://docs.engineapi.com.br/api-reference/campos-nfse\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.engineapi.com.br/api-reference/campos-nfse#article\",\"headline\":\"Referência de campos: NFSe\",\"name\":\"Referência de campos: NFSe\",\"description\":\"Todo campo do payload de emissão de NFSe (POST /v1/nfse): tipo, tamanho, tag do leiaute e obrigatoriedade.\",\"url\":\"https://docs.engineapi.com.br/api-reference/campos-nfse\",\"mainEntityOfPage\":{\"@id\":\"https://docs.engineapi.com.br/api-reference/campos-nfse#webpage\"},\"dateModified\":\"2026-11-14T04:40:45.565Z\",\"publisher\":{\"@id\":\"https://docs.engineapi.com.br/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.engineapi.com.br#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"EngineAPI\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"EngineAPI\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/campos-nfse.md","siteName":"EngineAPI","nav":{"global":null,"tabs":[{"tab":"Documentação","icon":"book-open","pages":[{"title":"Documentação","href":""}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Referência","icon":"list","pages":[{"title":"Referência da API","href":"/api-reference/overview"}]},{"group":"Endpoints","icon":"plug","pages":[{"group":"Saúde","pages":[{"title":"Raiz da API","deprecated":null,"version":null,"openapi":"/openapi.json get /v1","href":"/api-reference/saúde/raiz-da-api"},{"title":"Verificar liveness do processo","deprecated":null,"version":null,"openapi":"/openapi.json get /health/live","href":"/api-reference/saúde/verificar-liveness-do-processo"},{"title":"Sanidade de auth (API key / JWT): read-only","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/health/auth","href":"/api-reference/saúde/sanidade-de-auth-api-key-jwt:-read-only"},{"title":"Verificar readiness da aplicação","deprecated":null,"version":null,"openapi":"/openapi.json get /health","href":"/api-reference/saúde/verificar-readiness-da-aplicação"},{"title":"Consultar versão em execução","deprecated":null,"version":null,"openapi":"/openapi.json get /version","href":"/api-reference/saúde/consultar-versão-em-execução"}]},{"group":"Autenticação","pages":[{"title":"Autenticar usuário","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/login","href":"/api-reference/autenticação/autenticar-usuário"},{"title":"Concluir login com o segundo fator","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/2fa/verify","href":"/api-reference/autenticação/concluir-login-com-o-segundo-fator"},{"title":"Iniciar enrolamento do 2FA","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/2fa/setup","href":"/api-reference/autenticação/iniciar-enrolamento-do-2fa"},{"title":"Confirmar e ativar o 2FA","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/2fa/enable","href":"/api-reference/autenticação/confirmar-e-ativar-o-2fa"},{"title":"Desativar o 2FA","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/2fa/disable","href":"/api-reference/autenticação/desativar-o-2fa"},{"title":"Estado do 2FA da conta autenticada","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/auth/2fa/status","href":"/api-reference/autenticação/estado-do-2fa-da-conta-autenticada"},{"title":"Renovar a sessão","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/refresh","href":"/api-reference/autenticação/renovar-a-sessão"},{"title":"Encerrar a sessão","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/logout","href":"/api-reference/autenticação/encerrar-a-sessão"},{"title":"Login via Google OAuth","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/google","href":"/api-reference/autenticação/login-via-google-oauth"},{"title":"Alterar senha","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/change-password","href":"/api-reference/autenticação/alterar-senha"},{"title":"Registrar novo parceiro (SUPERADMIN)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/register-partner","href":"/api-reference/autenticação/registrar-novo-parceiro-superadmin"},{"title":"Cadastro pelo site cria a conta na hora (JOT-3540)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/register","href":"/api-reference/autenticação/cadastro-pelo-site-cria-a-conta-na-hora-jot-3540"},{"title":"Solicitar recuperação de senha","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/forgot-password","href":"/api-reference/autenticação/solicitar-recuperação-de-senha"},{"title":"Redefinir senha com token","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/reset-password","href":"/api-reference/autenticação/redefinir-senha-com-token"},{"title":"Verificar e-mail com token","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/verify-email","href":"/api-reference/autenticação/verificar-e-mail-com-token"},{"title":"Reenviar e-mail de verificação","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/resend-verification","href":"/api-reference/autenticação/reenviar-e-mail-de-verificação"},{"title":"Status de verificação de e-mail","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/auth/verification-status","href":"/api-reference/autenticação/status-de-verificação-de-e-mail"},{"title":"Gerar/regenerar API Key de PRODUÇÃO (ek_live_)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/api-keys/regenerate","href":"/api-reference/autenticação/gerarregenerar-api-key-de-produção-ek_live_"},{"title":"Gerar/regenerar API Key de TESTE (ek_test_)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/api-keys/test/regenerate","href":"/api-reference/autenticação/gerarregenerar-api-key-de-teste-ek_test_"},{"title":"Informações da API Key","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/auth/api-keys/info","href":"/api-reference/autenticação/informações-da-api-key"},{"title":"Pedir novo convite de dono","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/invite/resend","href":"/api-reference/autenticação/pedir-novo-convite-de-dono"}]},{"group":"Empresas","pages":[{"title":"Listar empresas emissoras","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/companies","href":"/api-reference/empresas/listar-empresas-emissoras"},{"title":"Cadastrar empresa emissora","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/companies","href":"/api-reference/empresas/cadastrar-empresa-emissora"},{"title":"Consultar CNPJ antes de cadastrar","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/companies/consult/{cnpj}","href":"/api-reference/empresas/consultar-cnpj-antes-de-cadastrar"},{"title":"Solicitar transferência de emissor","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/companies/transfer-request","href":"/api-reference/empresas/solicitar-transferência-de-emissor"},{"title":"Cancelar solicitação de transferência","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/companies/transfer-request/{id}/cancel","href":"/api-reference/empresas/cancelar-solicitação-de-transferência"},{"title":"Buscar empresa por ID","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/companies/{id}","href":"/api-reference/empresas/buscar-empresa-por-id"},{"title":"Excluir empresa emissora","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/companies/{id}","href":"/api-reference/empresas/excluir-empresa-emissora"},{"title":"Atualizar empresa emissora","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/companies/{id}","href":"/api-reference/empresas/atualizar-empresa-emissora"},{"title":"Promover o próprio emissor para homologação SEFAZ","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/companies/{id}/promover-homologacao","href":"/api-reference/empresas/promover-o-próprio-emissor-para-homologação-sefaz"},{"title":"Enviar certificado digital do emissor","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/companies/{id}/certificate","href":"/api-reference/empresas/enviar-certificado-digital-do-emissor"},{"title":"Trocar ambiente fiscal do emissor (Produção/Homologação)","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/companies/{id}/ambiente","href":"/api-reference/empresas/trocar-ambiente-fiscal-do-emissor-produçãohomologação"}]},{"group":"Consultas","pages":[{"title":"Consultar CNPJ","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/queries/cnpj/{cnpj}","href":"/api-reference/consultas/consultar-cnpj"},{"title":"Invalidar cache de CNPJ","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/queries/cnpj/{cnpj}/cache","href":"/api-reference/consultas/invalidar-cache-de-cnpj"},{"title":"Consultar CPF (LGPD)","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/queries/cpf/{cpf}","href":"/api-reference/consultas/consultar-cpf-lgpd"},{"title":"Excluir dados de CPF (LGPD)","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/queries/cpf/{cpf}","href":"/api-reference/consultas/excluir-dados-de-cpf-lgpd"}]},{"group":"NFSe","pages":[{"title":"Cobertura da NFS-e por município","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfse/cobertura/{ibge}","href":"/api-reference/nfse/cobertura-da-nfs-e-por-município"},{"title":"Listar NFS-e","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfse","href":"/api-reference/nfse/listar-nfs-e"},{"title":"Emitir NFS-e","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/nfse","href":"/api-reference/nfse/emitir-nfs-e"},{"title":"Exportar NFSe em CSV","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfse/export","href":"/api-reference/nfse/exportar-nfse-em-csv"},{"title":"Comprovante do cancelamento da NFS-e (PDF)","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfse/cancelamento/{id}/pdf","href":"/api-reference/nfse/comprovante-do-cancelamento-da-nfs-e-pdf"},{"title":"Detalhes da NFS-e","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfse/{id}","href":"/api-reference/nfse/detalhes-da-nfs-e"},{"title":"Cancelar NFS-e","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/nfse/{id}/cancelar","href":"/api-reference/nfse/cancelar-nfs-e"},{"title":"Consultar NFS-e na SEFIN","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfse/{id}/consultar","href":"/api-reference/nfse/consultar-nfs-e-na-sefin"},{"title":"Download PDF","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfse/pdf/{id}","href":"/api-reference/nfse/download-pdf"},{"title":"Download DANFSe (alias)","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfse/{id}/danfse","href":"/api-reference/nfse/download-danfse-alias"},{"title":"Download XML","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfse/xml/{id}","href":"/api-reference/nfse/download-xml"}]},{"group":"NFe","pages":[{"title":"Verificar status do serviço de emissão NF-e","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfe/status","href":"/api-reference/nfe/verificar-status-do-serviço-de-emissão-nf-e"},{"title":"Status SEFAZ por UF","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfe/sefaz-status/{uf}","href":"/api-reference/nfe/status-sefaz-por-uf"},{"title":"Status SEFAZ de todas as UFs","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfe/sefaz-status","href":"/api-reference/nfe/status-sefaz-de-todas-as-ufs"},{"title":"Listar NF-e","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfe","href":"/api-reference/nfe/listar-nf-e"},{"title":"Criar NF-e","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/nfe","href":"/api-reference/nfe/criar-nf-e"},{"title":"Exportar NF-e em CSV","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfe/export","href":"/api-reference/nfe/exportar-nf-e-em-csv"},{"title":"Listar fila de emissão em lote","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfe/queue","href":"/api-reference/nfe/listar-fila-de-emissão-em-lote"},{"title":"Buscar NF-e por ID","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfe/{id}","href":"/api-reference/nfe/buscar-nf-e-por-id"},{"title":"Excluir registro de NF-e","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/nfe/{id}","href":"/api-reference/nfe/excluir-registro-de-nf-e"},{"title":"Atualizar registro de NF-e","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/nfe/{id}","href":"/api-reference/nfe/atualizar-registro-de-nf-e"},{"title":"Inutilizar faixa de numeração de NF-e","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/nfe/inutilizar","href":"/api-reference/nfe/inutilizar-faixa-de-numeração-de-nf-e"},{"title":"Cancelar NF-e","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/nfe/{idOuChave}/cancelar","href":"/api-reference/nfe/cancelar-nf-e"},{"title":"Enfileirar notas para emissão em lote","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/nfe/batch","href":"/api-reference/nfe/enfileirar-notas-para-emissão-em-lote"},{"title":"Download do DANFE (PDF)","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfe/pdf/{accessKey}","href":"/api-reference/nfe/download-do-danfe-pdf"},{"title":"Download do XML da NF-e","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfe/xml/{chaveOuId}","href":"/api-reference/nfe/download-do-xml-da-nf-e"},{"title":"Download do XML da Carta de Correção","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfe/cce/{accessKey}/xml","href":"/api-reference/nfe/download-do-xml-da-carta-de-correção"},{"title":"Download do documento auxiliar da Carta de Correção","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfe/cce/{accessKey}/pdf","href":"/api-reference/nfe/download-do-documento-auxiliar-da-carta-de-correção"},{"title":"Comprovante do cancelamento da NF-e (PDF)","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfe/cancelamento/{accessKey}/pdf","href":"/api-reference/nfe/comprovante-do-cancelamento-da-nf-e-pdf"},{"title":"Carta de Correção (CC-e) por chave de acesso (JWT ou x-api-key)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/nfe/{accessKey}/carta-correcao","href":"/api-reference/nfe/carta-de-correção-cc-e-por-chave-de-acesso-jwt-ou-x-api-key"},{"title":"Cancelar NF-e pelo dashboard","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/nfe/{id}/cancelar-dashboard","href":"/api-reference/nfe/cancelar-nf-e-pelo-dashboard"},{"title":"Enviar Carta de Correção (CC-e) via dashboard","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/nfe/{id}/cce","href":"/api-reference/nfe/enviar-carta-de-correção-cc-e-via-dashboard"},{"title":"Listar eventos fiscais da NF-e","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfe/{id}/eventos","href":"/api-reference/nfe/listar-eventos-fiscais-da-nf-e"}]},{"group":"Webhooks","pages":[{"title":"Obter configuração de webhooks","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/webhooks/config","href":"/api-reference/webhooks/obter-configuração-de-webhooks"},{"title":"Atualizar configuração de webhooks","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/webhooks/config","href":"/api-reference/webhooks/atualizar-configuração-de-webhooks"},{"title":"Enviar webhook de teste","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/webhooks/test","href":"/api-reference/webhooks/enviar-webhook-de-teste"},{"title":"Histórico de entregas","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/webhooks/logs","href":"/api-reference/webhooks/histórico-de-entregas"},{"title":"Regenerar webhook secret","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/webhooks/secret/regenerate","href":"/api-reference/webhooks/regenerar-webhook-secret"},{"title":"Listar Dead Letter Queue","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/webhooks/dlq","href":"/api-reference/webhooks/listar-dead-letter-queue"},{"title":"Limpar DLQ","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/webhooks/dlq","href":"/api-reference/webhooks/limpar-dlq"},{"title":"Reenviar webhook da DLQ","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/webhooks/dlq/{deliveryId}/retry","href":"/api-reference/webhooks/reenviar-webhook-da-dlq"},{"title":"Reenviar TODOS da DLQ","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/webhooks/dlq/retry-all","href":"/api-reference/webhooks/reenviar-todos-da-dlq"}]},{"group":"Cérebro Fiscal","pages":[{"title":"Resolver classificação + tributação de um produto (assistido)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/fiscal/resolve","href":"/api-reference/cérebro-fiscal/resolver-classificação-+-tributação-de-um-produto-assistido"},{"title":"Resolver classificação + tributação de um serviço (NFS-e, assistido)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/fiscal/resolve-servico","href":"/api-reference/cérebro-fiscal/resolver-classificação-+-tributação-de-um-serviço-nfs-e-assistido"},{"title":"Sugerir atividade de serviço padrão (LC116/cTribNac) a partir do CNAE (consultivo)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/fiscal/resolve-servico-padrao","href":"/api-reference/cérebro-fiscal/sugerir-atividade-de-serviço-padrão-lc116ctribnac-a-partir-do-cnae-consultivo"},{"title":"Sugerir NCM a partir da descrição do produto (consultivo)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/fiscal/resolve-ncm","href":"/api-reference/cérebro-fiscal/sugerir-ncm-a-partir-da-descrição-do-produto-consultivo"},{"title":"Confirmar a classificação de um produto (loop de validação)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/fiscal/classification/confirm","href":"/api-reference/cérebro-fiscal/confirmar-a-classificação-de-um-produto-loop-de-validação"},{"title":"Corrigir a classificação de um produto (loop de validação)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/fiscal/classification/correct","href":"/api-reference/cérebro-fiscal/corrigir-a-classificação-de-um-produto-loop-de-validação"},{"title":"Comerciante confirma o NCM ou o código de serviço incerto (degrau 3 da cascata)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/fiscal/classification/confirm-merchant","href":"/api-reference/cérebro-fiscal/comerciante-confirma-o-ncm-ou-o-código-de-serviço-incerto-degrau-3-da-cascata"},{"title":"Corrigir a classificação lembrada de um produto SEM código de barras","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/fiscal/classification/description-memory/correct","href":"/api-reference/cérebro-fiscal/corrigir-a-classificação-lembrada-de-um-produto-sem-código-de-barras"},{"title":"Revogar a classificação lembrada de um produto SEM código de barras","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/fiscal/classification/description-memory/revoke","href":"/api-reference/cérebro-fiscal/revogar-a-classificação-lembrada-de-um-produto-sem-código-de-barras"},{"title":"Comerciante responde a pergunta de fato da classe IBS/CBS","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/fiscal/classification/classe/confirm-merchant","href":"/api-reference/cérebro-fiscal/comerciante-responde-a-pergunta-de-fato-da-classe-ibscbs"},{"title":"Confirmar a classe IBS/CBS de um produto neste emissor","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/fiscal/classification/classe","href":"/api-reference/cérebro-fiscal/confirmar-a-classe-ibscbs-de-um-produto-neste-emissor"},{"title":"Listar as classes IBS/CBS vigentes de um NCM (consultivo)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/fiscal/classes-por-ncm","href":"/api-reference/cérebro-fiscal/listar-as-classes-ibscbs-vigentes-de-um-ncm-consultivo"},{"title":"Itens com classe IBS/CBS pendente neste emissor","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/fiscal/classification/pendentes","href":"/api-reference/cérebro-fiscal/itens-com-classe-ibscbs-pendente-neste-emissor"},{"title":"Listar ciclos de mudança de regra fiscal","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/fiscal/changelog","href":"/api-reference/cérebro-fiscal/listar-ciclos-de-mudança-de-regra-fiscal"},{"title":"Prontidão fiscal do motor (emissão assistida)","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/fiscal/prontidao","href":"/api-reference/cérebro-fiscal/prontidão-fiscal-do-motor-emissão-assistida"},{"title":"Classificar a empresa em produto, serviço ou ambíguo pelos CNAEs (consultivo)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/fiscal/classificar-cnae","href":"/api-reference/cérebro-fiscal/classificar-a-empresa-em-produto-serviço-ou-ambíguo-pelos-cnaes-consultivo"}]},{"group":"NFCe","pages":[{"title":"Verificar status do serviço NFC-e","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfce/status","href":"/api-reference/nfce/verificar-status-do-serviço-nfc-e"},{"title":"Listar NFC-e","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfce","href":"/api-reference/nfce/listar-nfc-e"},{"title":"Emitir NFC-e (Modelo 65)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/nfce","href":"/api-reference/nfce/emitir-nfc-e-modelo-65"},{"title":"Download do DANFCE (PDF)","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfce/pdf/{accessKey}","href":"/api-reference/nfce/download-do-danfce-pdf"},{"title":"Comprovante do cancelamento da NFC-e (PDF)","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfce/cancelamento/{accessKey}/pdf","href":"/api-reference/nfce/comprovante-do-cancelamento-da-nfc-e-pdf"},{"title":"Download do XML da NFC-e","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfce/xml/{accessKey}","href":"/api-reference/nfce/download-do-xml-da-nfc-e"},{"title":"Inutilizar faixa de numeração de NFC-e","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/nfce/inutilizar","href":"/api-reference/nfce/inutilizar-faixa-de-numeração-de-nfc-e"},{"title":"Cancelar NFC-e autorizada","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/nfce/{idOuChave}/cancelar","href":"/api-reference/nfce/cancelar-nfc-e-autorizada"},{"title":"Exportar NFC-e em CSV","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfce/export","href":"/api-reference/nfce/exportar-nfc-e-em-csv"},{"title":"Buscar NFC-e por ID","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfce/{id}","href":"/api-reference/nfce/buscar-nfc-e-por-id"}]},{"group":"Cadastros","pages":[{"title":"Consultar créditos de cadastro","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cadastros/creditos","href":"/api-reference/cadastros/consultar-créditos-de-cadastro"},{"title":"Consultar cadastro por CNPJ","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cadastros/{cnpj}","href":"/api-reference/cadastros/consultar-cadastro-por-cnpj"}]},{"group":"Status","pages":[{"title":"Consultar status público por serviço","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/status","href":"/api-reference/status/consultar-status-público-por-serviço"},{"title":"Verificar saúde do servidor MCP","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/mcp/health","href":"/api-reference/status/verificar-saúde-do-servidor-mcp"}]}]},{"group":"Catálogo de campos","icon":"table-list","pages":[{"title":"Referência de campos: NFe","href":"/api-reference/campos-nfe"},{"title":"Referência de campos: NFCe","description":"Todo campo do payload de emissão de NFCe (POST /v1/nfce): tipo, tamanho, tag do leiaute e obrigatoriedade.","href":"/api-reference/campos-nfce"},{"title":"Referência de campos: NFSe","href":"/api-reference/campos-nfse"},{"title":"Referência de campos: Cérebro Fiscal (resolve-ncm)","description":"Todo campo do payload de consulta de Cérebro Fiscal (resolve-ncm) (POST /v1/fiscal/resolve-ncm): tipo, obrigatoriedade e condição de uso.","href":"/api-reference/campos-fiscal-resolve-ncm"},{"title":"Referência de campos: Cérebro Fiscal (resolve-servico-padrao)","href":"/api-reference/campos-fiscal-resolve-servico-padrao"},{"title":"Referência de campos: Cérebro Fiscal (resolve, produto)","href":"/api-reference/campos-fiscal-resolve"},{"title":"Referência de campos: Cérebro Fiscal (resolve-servico)","href":"/api-reference/campos-fiscal-resolve-servico"}]}]},{"tab":"SDKs","icon":"cube","pages":[{"title":"SDKs","href":"/sdks/typescript"}]},{"tab":"Changelog","icon":"clock-rotate-left","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Referência de campos: NFSe - EngineAPI","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":[],"chunks":[]}
