NFS-e

Machine translation, not yet reviewed.

NFS-e JSON — fields and structures reference

Endpoint: GET /api/integration/dfe/nfse/inbound/documentos (with json=true) OpenAPI reference: NFS-e Public API

Reference document -- Field-by-field dictionary of the JSON representation of an NFS-e returned by the inbound listing endpoint.

Endpoint: GET /api/integration/dfe/nfse/inbound/documentos (with json=true) OpenAPI reference: NFS-e Public API

NFS-e public APIGET/api/integration/dfe/nfse/inbound/documentosSign in to see the host and reference

Conventions used in this document

  • Lists are represented with [*] in the path (e.g.: dps.valores.vDedRed.documentos[*].tpDedRed).
  • Monetary values are strings with 2 decimal places (e.g.: "150.00").
  • Rates/percentages are strings with up to 4 decimal places.
  • Dates follow the UTC format AAAA-MM-DDThh:mm:ssTZD unless otherwise indicated.

1. Root

FieldDescription
versaoNFS-e schema version (e.g.: "1.00", "1.01").
idUnique identifier of the NFS-e. Composition: "NFS" + municipality code (7) + generation environment (1) + federal registration type (1) + federal registration number (14) + NFS-e number (13) + issuance year-month (4) + numeric code (9) + check digit (1) = 53 positions.
xLocEmiDescription of the IBGE code of the NFS-e issuing municipality.
xLocPrestacaoDescription of the place where the service was provided.
nNFSeSequential NFS-e number per issuer type. Generated by Sefin Nacional (national NFS-e authority) with no reuse of numbers.
cLocIncidIBGE code of the municipality where ISSQN is levied, determined automatically according to LC 116/03.
xLocIncidDescription of the municipality where ISSQN is levied.
xTribNacDescription of the national ISSQN taxation code.
xTribMunDescription of the municipal ISSQN taxation code.
xNBSDescription of the NBS code (Nomenclatura Brasileira de Serviços — Brazilian Services Nomenclature).
verAplicVersion of the application that generated the NFS-e.
ambGerNFS-e generation environment: "1" = Municipality (Prefeitura); "2" = Sefin Nacional.
tpEmisIssuance type: "1" = Taxpayer application (Web Service); "2" = Public application (Web); "3" = Public application (App).
procEmiIssuance process (same values as tpEmis).
cStatProcessing status code.
dhProcDate/time of DPS validation and NFS-e generation (UTC).
nDFSeSequential DFS-e number generated by the municipality's generation environment.
emitIssuer data group. See section 2.
valoresGroup of calculated NFS-e values. See section 3.
xOutInfAdditional information for use by the municipal tax administration.
ibscbsIBS/CBS group of the Brazilian tax reform (calculated by the system). See section 4.
dpsDPS -- Declaração de Prestação de Serviços (Service Provision Declaration). See section 5.

2. Issuer -- emit

Data of the NFS-e issuer.

FieldDescription
emit.cnpjIssuer's CNPJ (mutually exclusive with cpf).
emit.cpfIssuer's CPF (mutually exclusive with cnpj).
emit.imIssuer's Inscrição Municipal (municipal registration number).
emit.xNomeIssuer's legal name / name.
emit.xFantTrade name.
emit.enderNacIssuer's national address. See section 2.1.
emit.fonePhone number (format area code + number, or international code + area code + number).
emit.emailIssuer's e-mail.

2.1. Issuer address -- emit.enderNac

FieldDescription
emit.enderNac.xLgrStreet type and name.
emit.enderNac.nroBuilding number.
emit.enderNac.xCplAddress complement.
emit.enderNac.xBairroNeighborhood.
emit.enderNac.cMunIBGE municipality code.
emit.enderNac.ufState (UF) abbreviation (e.g.: "SP", "RJ").
emit.enderNac.cepCEP (postal code).

3. NFS-e values -- valores

Values calculated by the system from the DPS data.

FieldDescription
valores.vCalcDRMonetary amount (R$) of the deduction/reduction of the ISSQN tax base.
valores.tpBMMunicipal Benefit Type: "1" = Exemption; "2" = Tax base reduction by %; "3" = Tax base reduction in R$; "4" = Differentiated rate.
valores.vCalcBMMonetary amount (R$) of the percentage reduction of the tax base due to a municipal benefit.
valores.vBCISSQN tax base (R$) = Service amount - Unconditional discount - Deductions - Municipal benefit.
valores.pAliqAplicRate (%) applied to the tax base to calculate ISSQN.
valores.vISSQNISSQN amount (R$) = vBC x pAliqAplic.
valores.vTotalRetTotal withholdings (R$) = sum of CP + IRRF + CSLL + withheld ISSQN.
valores.vLiqNFS-e net amount (R$) = Service amount - Discounts - Withholdings.

4. IBS/CBS -- ibscbs

Brazilian tax reform group (IBS/CBS), calculated by the system.

FieldDescription
ibscbs.cLocalidadeIncidIBGE code of the locality where IBS/CBS is levied.
ibscbs.xLocalidadeIncidName of the locality where the tax is levied.
ibscbs.pRedutorRate reduction percentage for government purchases.
ibscbs.valoresGross rates per jurisdiction. See section 4.1.
ibscbs.totCIBSAccumulated IBS/CBS totals. See section 4.2.

4.1. IBS/CBS rates -- ibscbs.valores

FieldDescription
ibscbs.valores.vBCTax base for IBS/CBS.
ibscbs.valores.vCalcReeRepResAmount (R$) of material supply/linked operations subject to reimbursement/pass-through/refund, already taxed and outside the tax base.

ibscbs.valores.uf -- State IBS

FieldDescription
ibscbs.valores.uf.pIBSUFState IBS rate for the locality of incidence (parameterized).
ibscbs.valores.uf.pRedAliqUFReduction percentage of the state rate.
ibscbs.valores.uf.pAliqEfetUFEffective rate = pIBSUF x (1 - pRedAliqUF) x (1 - pRedutor).

ibscbs.valores.mun -- Municipal IBS

FieldDescription
ibscbs.valores.mun.pIBSMunMunicipal IBS rate for the locality of incidence (parameterized).
ibscbs.valores.mun.pRedAliqMunReduction percentage of the municipal rate.
ibscbs.valores.mun.pAliqEfetMunEffective rate = pIBSMun x (1 - pRedAliqMun) x (1 - pRedutor).

ibscbs.valores.fed -- Federal CBS

FieldDescription
ibscbs.valores.fed.pCBSFederal (União) CBS rate (parameterized).
ibscbs.valores.fed.pRedAliqCBSReduction percentage of the CBS rate.
ibscbs.valores.fed.pAliqEfetCBSEffective rate = pCBS x (1 - pRedAliqCBS) x (1 - pRedutor).

4.2. IBS/CBS totals -- ibscbs.totCIBS

FieldDescription
ibscbs.totCIBS.vTotNFTotal invoice amount considering taxes outside the price (IBS/CBS). In 2026: vTotNF = vLiq. From 2027 onwards: vTotNF = vLiq + vCBS + vIBSTot.

ibscbs.totCIBS.gIBS -- IBS totals

FieldDescription
ibscbs.totCIBS.gIBS.vIBSTotTotal IBS amount = vIBSUF + vIBSMun.
ibscbs.totCIBS.gIBS.gIBSCredPres.pCredPresIBSIBS presumed credit rate.
ibscbs.totCIBS.gIBS.gIBSCredPres.vCredPresIBSIBS presumed credit amount = vBC x pCredPresIBS.
ibscbs.totCIBS.gIBS.gIBSUFTot.vDifUFTotal state IBS deferral = vIBSUF x pDifUF.
ibscbs.totCIBS.gIBS.gIBSUFTot.vIBSUFTotal state IBS amount = vBC x effective state rate.
ibscbs.totCIBS.gIBS.gIBSMunTot.vDifMunTotal municipal IBS deferral = vIBSMun x pDifMun.
ibscbs.totCIBS.gIBS.gIBSMunTot.vIBSMunTotal municipal IBS amount = vBC x effective municipal rate.

ibscbs.totCIBS.gCBS -- CBS totals

FieldDescription
ibscbs.totCIBS.gCBS.gCBSCredPres.pCredPresCBSCBS presumed credit rate.
ibscbs.totCIBS.gCBS.gCBSCredPres.vCredPresCBSCBS presumed credit amount = vBC x pCredPresCBS.
ibscbs.totCIBS.gCBS.vDifCBSTotal CBS deferral = vCBS x pDifCBS.
ibscbs.totCIBS.gCBS.vCBSTotal CBS amount for the Federal Government = vBC x effective CBS rate.

ibscbs.totCIBS.gTribRegular -- Regular taxation

FieldDescription
ibscbs.totCIBS.gTribRegular.pAliqEfeRegIBSUFEffective regular taxation rate for state IBS.
ibscbs.totCIBS.gTribRegular.vTribRegIBSUFState IBS regular taxation amount = vBC x pAliqEfeRegIBSUF.
ibscbs.totCIBS.gTribRegular.pAliqEfeRegIBSMunEffective regular taxation rate for municipal IBS.
ibscbs.totCIBS.gTribRegular.vTribRegIBSMunMunicipal IBS regular taxation amount = vBC x pAliqEfeRegIBSMun.
ibscbs.totCIBS.gTribRegular.pAliqEfeRegCBSEffective regular taxation rate for CBS.
ibscbs.totCIBS.gTribRegular.vTribRegCBSCBS regular taxation amount = vBC x pAliqEfeRegCBS.

ibscbs.totCIBS.gTribCompraGov -- Government purchases

FieldDescription
ibscbs.totCIBS.gTribCompraGov.pIBSUFState IBS rate in a government purchase.
ibscbs.totCIBS.gTribCompraGov.vIBSUFCalculated state IBS amount.
ibscbs.totCIBS.gTribCompraGov.pIBSMunMunicipal IBS rate in a government purchase.
ibscbs.totCIBS.gTribCompraGov.vIBSMunCalculated municipal IBS amount.
ibscbs.totCIBS.gTribCompraGov.pCBSCBS rate in a government purchase.
ibscbs.totCIBS.gTribCompraGov.vCBSCalculated CBS amount.

5. DPS -- dps

Declaração de Prestação de Serviços (Service Provision Declaration) -- data reported by the taxpayer.

FieldDescription
dps.idUnique identifier of the DPS. Composition: "DPS" + municipality code (7) + federal registration type (1) + federal registration number (14) + series (5) + DPS number (15) = 45 positions.
dps.tpAmbEnvironment: "1" = Production; "2" = Homologation (testing).
dps.dhEmiDPS issuance date/time (UTC).
dps.verAplicVersion of the application that generated the DPS.
dps.serieIssuing device number or DPS series.
dps.nDPSDPS number.
dps.dCompetService provision start date (competence period, format AAAAMMDD).
dps.tpEmitIssuer type: "1" = Service provider; "2" = Service recipient (tomador); "3" = Intermediary.
dps.cMotivoEmisTIReason for issuance by the recipient/intermediary: "1" = Service import; "2" = Municipal obligation; "3" = Refusal by the provider; "4" = Rejection of the provider's NFS-e.
dps.chNFSeRejAccess key of the NFS-e rejected by the recipient/intermediary.
dps.cLocEmiIBGE code of the DPS issuer's municipality (municipality of registration/authorization for issuance).
dps.substNFS-e substitution data. See section 5.1.
dps.prestService provider data. See section 6.
dps.tomaService recipient data. See section 7.
dps.intermIntermediary data. See section 7.
dps.servService information. See section 8.
dps.valoresValues and taxation. See section 9.
dps.ibscbsIBS/CBS declared by the issuer. See section 10.

5.1. Substitution -- dps.subst

NFS-e substitution data.

FieldDescription
dps.subst.chSubstdaAccess key of the NFS-e to be replaced.
dps.subst.cMotivoJustification code: "01" = Exclusion from Simples Nacional; "02" = Inclusion in Simples Nacional; "03" = Retroactive inclusion of immunity/exemption; "04" = Retroactive exclusion of immunity/exemption; "05" = Rejection of NFS-e by the recipient/intermediary; "99" = Other.
dps.subst.xMotivoDescription of the reason for the substitution.

6. Provider -- dps.prest

Service provider data.

FieldDescription
dps.prest.cnpjCNPJ (mutually exclusive with cpf/nif/cNaoNIF).
dps.prest.cpfCPF.
dps.prest.nifNIF -- foreign Tax Identification Number.
dps.prest.cNaoNIFReason for not having a NIF: "0" = Not provided at origin; "1" = Waived; "2" = Not required.
dps.prest.caepfCAEPF -- Cadastro de Atividade Econômica da Pessoa Física (Individual Economic Activity Registry).
dps.prest.imInscrição Municipal (municipal registration number).
dps.prest.xNomeLegal name / name.
dps.prest.endAddress. See Endereco.
dps.prest.fonePhone number.
dps.prest.emailE-mail.
dps.prest.regTribTax regime. See section 6.1.

6.1. Tax regime -- dps.prest.regTrib

FieldDescription
dps.prest.regTrib.opSimpNacSimples Nacional option: "1" = Not opted in; "2" = MEI; "3" = ME/EPP.
dps.prest.regTrib.regApTribSNApplicable tax assessment regime (when opSimpNac = "3" and sub-limits were exceeded): "1" = SN federal/municipal; "2" = SN federal + ISSQN outside SN; "3" = Both outside SN.
dps.prest.regTrib.regEspTribSpecial Tax Regime: "0" = None; "1" = Cooperative Act; "2" = Estimate; "3" = Municipal Micro-enterprise; "4" = Notary/Registrar; "5" = Self-employed Professional; "6" = Professional Partnership; "9" = Other.

7. Recipient and Intermediary -- dps.toma / dps.interm

Structure reused for recipient, intermediary and supplier.

FieldDescription
*.cnpjCNPJ (mutually exclusive with cpf/nif/cNaoNIF).
*.cpfCPF.
*.nifForeign NIF.
*.cNaoNIFReason for not having a NIF.
*.caepfCAEPF.
*.imInscrição Municipal (municipal registration number).
*.xNomeLegal name / name.
*.endAddress. See Endereco.
*.fonePhone number.
*.emailE-mail.

Where * = dps.toma, dps.interm, or any other field of type InfoPessoa (e.g.: dps.valores.vDedRed.documentos[*].fornec).


8. Service -- dps.serv

8.1. Place of provision -- dps.serv.locPrest

FieldDescription
dps.serv.locPrest.cLocPrestacaoIBGE code of the municipality of provision (used when provided in Brazil).
dps.serv.locPrest.cPaisPrestacaoISO code of the country of provision (used when provided abroad).

8.2. Service code -- dps.serv.cServ

FieldDescription
dps.serv.cServ.cTribNacNational ISSQN taxation code according to LC 116/2003 -- 6 digits: Item (2) + Sub-item (2) + National Breakdown (2).
dps.serv.cServ.cTribMunMunicipal ISSQN taxation code.
dps.serv.cServ.xDescServFull description of the service provided.
dps.serv.cServ.cNBSNBS code (Nomenclatura Brasileira de Serviços), version 2.0.
dps.serv.cServ.cIntContribTaxpayer's internal code.

8.3. Foreign trade -- dps.serv.comExt

FieldDescription
dps.serv.comExt.mdPrestacaoMode of provision: "0" = Unknown; "1" = Cross-border; "2" = Consumption in Brazil; "3" = Temporary presence of a person; "4" = Consumption abroad.
dps.serv.comExt.vincPrestRelationship between the parties: "0" = No relationship; "1" = Controlled; "2" = Controlling; "3" = Affiliate; "4" = Head office; "5" = Branch; "6" = Other; "9" = Unknown.
dps.serv.comExt.tpMoedaTransaction currency code.
dps.serv.comExt.vServMoedaService amount in the foreign currency.
dps.serv.comExt.mecAFComexPForeign trade support/promotion mechanism (provider).
dps.serv.comExt.mecAFComexTForeign trade support/promotion mechanism (recipient).
dps.serv.comExt.movTempBensLink to temporary movement of goods: "0" = Unknown; "1" = No; "2" = Linked to DI; "3" = Linked to DE.
dps.serv.comExt.nDIImport Declaration number (DI/DSI/DA/DRI-E).
dps.serv.comExt.nREExport Registration number (RE).
dps.serv.comExt.mdicShare NFS-e with the Secretariat of Foreign Trade: "0" = Do not send; "1" = Send to MDIC.

8.4. Civil construction -- dps.serv.obra

FieldDescription
dps.serv.obra.inscImobFiscFiscal real estate registration (property identification code in the municipality).
dps.serv.obra.cObraConstruction project code in the Cadastro Nacional de Obras (CNO — National Construction Registry) or CEI.
dps.serv.obra.cCIBCadastro Imobiliário Brasileiro (CIB — Brazilian Real Estate Registry) code.
dps.serv.obra.endConstruction site address. See EnderecoObraEvento.

8.5. Event activity -- dps.serv.atvEvento

FieldDescription
dps.serv.atvEvento.xNomeName/description of the event (artistic, cultural, sports, etc.).
dps.serv.atvEvento.dtIniActivity start date (AAAA-MM-DD).
dps.serv.atvEvento.dtFimActivity end date (AAAA-MM-DD).
dps.serv.atvEvento.idAtvEvtIdentification code of the event activity.
dps.serv.atvEvento.endEvent address. See EnderecoSimples.

8.6. Additional information -- dps.serv.infoCompl

FieldDescription
dps.serv.infoCompl.idDocTecIdentifier of the Technical Responsibility Document (ART, RRT, DRT).
dps.serv.infoCompl.docRefDocument reference (NFS-e key, contract number, etc.).
dps.serv.infoCompl.xPedPurchase order/service order/project number (B2B).
dps.serv.infoCompl.xItemPed[*]List of order items.
dps.serv.infoCompl.xInfCompFurther additional information.

9. DPS values -- dps.valores

9.1. Service amount -- dps.valores.vServPrest

FieldDescription
dps.valores.vServPrest.vRecebAmount (R$) received by the service intermediary.
dps.valores.vServPrest.vServService amount (R$).

9.2. Discounts -- dps.valores.vDescCondIncond

FieldDescription
dps.valores.vDescCondIncond.vDescIncondUnconditional discount amount (R$).
dps.valores.vDescCondIncond.vDescCondConditional discount amount (R$).

9.3. Deductions/reductions -- dps.valores.vDedRed

FieldDescription
dps.valores.vDedRed.pDRStandard deduction/reduction percentage.
dps.valores.vDedRed.vDRStandard deduction/reduction amount (R$).
dps.valores.vDedRed.documentos[*]List of deduction/reduction documents. See section 9.3.1.

9.3.1. Deduction/reduction documents

Up to 1000 occurrences.

FieldDescription
documentos[*].chNFSeAccess key of a national-standard NFS-e.
documentos[*].chNFeNF-e access key.
documentos[*].nfSeMunNFS-e from another municipality. See section 9.3.2.
documentos[*].nfNFSNon-electronic NF/NFS. See section 9.3.3.
documentos[*].nDocFiscNumber of another fiscal document.
documentos[*].nDocNumber of a non-fiscal document.
documentos[*].tpDedRedDeduction/reduction type: "1" = Food/beverages/minibar; "2" = Materials; "3" = External production; "4" = Expense reimbursement; "5" = Consortium pass-through; "6" = Health plan pass-through; "7" = Services; "8" = Labor subcontracting; "9" = Partner professional; "99" = Other deductions.
documentos[*].xDescOutDedDescription for tpDedRed = "99".
documentos[*].dtEmiDocDocument issuance date (AAAA-MM-DD).
documentos[*].vDedutivelRedutivelTotal deductible/reducible amount of the document (R$).
documentos[*].vDeducaoReducaoAmount used for deduction/reduction in this NFS-e (R$). Must be <= vDedutivelRedutivel.
documentos[*].fornecSupplier data. InfoPessoa structure (see section 7).

9.3.2. NFS-e from another municipality

FieldDescription
nfSeMun.cMunNFSeMunIBGE code of the municipality that issued the municipal invoice.
nfSeMun.nNFSeMunNumber of the municipal service invoice.
nfSeMun.cVerifNFSeMunVerification code of the municipal invoice.

9.3.3. Non-electronic NF/NFS

FieldDescription
nfNFS.nNFSNF/NFS number.
nfNFS.modNFSNF/NFS model.
nfNFS.serieNFSNF/NFS series.

9.4. Municipal taxation (ISSQN) -- dps.valores.trib.tribMun

FieldDescription
dps.valores.trib.tribMun.tribISSQNISSQN taxation: "1" = Taxable operation; "2" = Immunity; "3" = Service export; "4" = Non-incidence.
dps.valores.trib.tribMun.cPaisResultISO code of the country where the result of the service is verified (for export).
dps.valores.trib.tribMun.tpImunidadeISSQN immunity type: "0" = Unknown immunity; "1" = Public property (CF Art 150 VI a); "2" = Religious temples (CF Art 150 VI b); "3" = Political parties/unions/education/social assistance (CF Art 150 VI c); "4" = Books/newspapers (CF Art 150 VI d); "5" = Phonograms/videophonograms (CF Art 150 VI e).
dps.valores.trib.tribMun.exigSusp.tpSuspSuspension type: "1" = Court decision; "2" = Administrative proceeding.
dps.valores.trib.tribMun.exigSusp.nProcessoNumber of the judicial or administrative proceeding.
dps.valores.trib.tribMun.bm.nBMMunicipal benefit identifier: IBGE code (7) + type (2) + sequence number (5).
dps.valores.trib.tribMun.bm.vRedBCBMAmount (R$) of the benefit's tax base reduction (mutually exclusive with pRedBCBM).
dps.valores.trib.tribMun.bm.pRedBCBMPercentage of the benefit's tax base reduction (mutually exclusive with vRedBCBM).
dps.valores.trib.tribMun.tpRetISSQNISSQN withholding type: "1" = Not withheld; "2" = Withheld by the recipient; "3" = Withheld by the intermediary.
dps.valores.trib.tribMun.pAliqISSQN rate (%) for the municipality that is the active subject of the service. Parameterized if in Sefin Nacional; declared by the taxpayer otherwise.

9.5. Federal taxation -- dps.valores.trib.tribFed

FieldDescription
dps.valores.trib.tribFed.pisCofins.cstPIS/COFINS Tax Situation Code (CST).
dps.valores.trib.tribFed.pisCofins.vBCPisCofinsPIS/COFINS tax base (R$).
dps.valores.trib.tribFed.pisCofins.pAliqPisPIS rate (%).
dps.valores.trib.tribFed.pisCofins.pAliqCofinsCOFINS rate (%).
dps.valores.trib.tribFed.pisCofins.vPisPIS debit amount (R$).
dps.valores.trib.tribFed.pisCofins.vCofinsCOFINS debit amount (R$).
dps.valores.trib.tribFed.pisCofins.tpRetPisCofinsPIS/COFINS withholding type.
dps.valores.trib.tribFed.vRetCPSocial Security Contribution withholding amount (R$).
dps.valores.trib.tribFed.vRetIRRFIncome Tax withholding amount (R$).
dps.valores.trib.tribFed.vRetCSLLCSLL withholding amount (R$).

9.6. Tax totals -- dps.valores.trib.totTrib

The fields below are mutually exclusive (only one group is filled in).

FieldDescription
dps.valores.trib.totTrib.vTotTrib.vTotTribFedApproximate total of federal taxes (R$).
dps.valores.trib.totTrib.vTotTrib.vTotTribEstApproximate total of state taxes (R$).
dps.valores.trib.totTrib.vTotTrib.vTotTribMunApproximate total of municipal taxes (R$).
dps.valores.trib.totTrib.pTotTrib.pTotTribFedApproximate total of federal taxes (%).
dps.valores.trib.totTrib.pTotTrib.pTotTribEstApproximate total of state taxes (%).
dps.valores.trib.totTrib.pTotTrib.pTotTribMunApproximate total of municipal taxes (%).
dps.valores.trib.totTrib.indTotTribIndicator of tax total with a fixed zero value (Decree 8.264/2014).
dps.valores.trib.totTrib.pTotTribSNSimples Nacional rate percentage.

10. DPS IBS/CBS -- dps.ibscbs

IBS/CBS information declared by the issuer (unlike section 4, which is calculated by the system).

FieldDescription
dps.ibscbs.finNFSeNFS-e purpose.
dps.ibscbs.indFinalFinal consumer indicator.
dps.ibscbs.cIndOpOperation indicator code.
dps.ibscbs.tpOperOperation type.
dps.ibscbs.gRefNFSe[*]List of referenced NFS-e keys.
dps.ibscbs.tpEnteGovGovernment entity type.
dps.ibscbs.indDestDestination indicator.
dps.ibscbs.destRecipient (destinatário). See section 10.1.
dps.ibscbs.imovelLinked property. See section 10.2.
dps.ibscbs.valoresDeclared IBS/CBS values. See section 10.3.

10.1. Recipient -- dps.ibscbs.dest

Same structure as InfoPessoa, but without caepf and im.

FieldDescription
dps.ibscbs.dest.cnpjCNPJ.
dps.ibscbs.dest.cpfCPF.
dps.ibscbs.dest.nifForeign NIF.
dps.ibscbs.dest.cNaoNIFReason for not having a NIF.
dps.ibscbs.dest.xNomeName / legal name.
dps.ibscbs.dest.endAddress. See Endereco.
dps.ibscbs.dest.fonePhone number.
dps.ibscbs.dest.emailE-mail.

10.2. Property -- dps.ibscbs.imovel

FieldDescription
dps.ibscbs.imovel.inscImobFiscFiscal real estate registration.
dps.ibscbs.imovel.cCIBCIB code.
dps.ibscbs.imovel.endProperty address. See EnderecoObraEvento.

10.3. Reimbursement/Pass-through -- dps.ibscbs.valores

dps.ibscbs.valores.gReeRepRes -- Reimbursement/Pass-through/Refund

FieldDescription
dps.ibscbs.valores.gReeRepRes.documentos[*].dFeNacional.tipoChaveDFeDFe key type.
dps.ibscbs.valores.gReeRepRes.documentos[*].dFeNacional.xTipoChaveDFeType description.
dps.ibscbs.valores.gReeRepRes.documentos[*].dFeNacional.chaveDFeDFe key.
dps.ibscbs.valores.gReeRepRes.documentos[*].docFiscalOutro.cMunDocFiscalIBGE municipality code.
dps.ibscbs.valores.gReeRepRes.documentos[*].docFiscalOutro.nDocFiscalFiscal document number.
dps.ibscbs.valores.gReeRepRes.documentos[*].docFiscalOutro.xDocFiscalDocument description.
dps.ibscbs.valores.gReeRepRes.documentos[*].docOutro.nDocDocument number.
dps.ibscbs.valores.gReeRepRes.documentos[*].docOutro.xDocDocument description.
dps.ibscbs.valores.gReeRepRes.documentos[*].fornec.cnpjSupplier's CNPJ.
dps.ibscbs.valores.gReeRepRes.documentos[*].fornec.cpfSupplier's CPF.
dps.ibscbs.valores.gReeRepRes.documentos[*].fornec.nifSupplier's NIF.
dps.ibscbs.valores.gReeRepRes.documentos[*].fornec.cNaoNIFReason for not having a NIF.
dps.ibscbs.valores.gReeRepRes.documentos[*].fornec.xNomeName / legal name.
dps.ibscbs.valores.gReeRepRes.documentos[*].dtEmiDocDocument issuance date.
dps.ibscbs.valores.gReeRepRes.documentos[*].dtCompDocDocument competence date.
dps.ibscbs.valores.gReeRepRes.documentos[*].tpReeRepResReimbursement/pass-through/refund type.
dps.ibscbs.valores.gReeRepRes.documentos[*].xTpReeRepResType description.
dps.ibscbs.valores.gReeRepRes.documentos[*].vlrReeRepResAmount (R$).

dps.ibscbs.valores.trib -- IBS/CBS taxation

FieldDescription
dps.ibscbs.valores.trib.gIBSCBS.cstIBS/CBS Tax Situation Code (CST).
dps.ibscbs.valores.trib.gIBSCBS.cClassTribTax classification code.
dps.ibscbs.valores.trib.gIBSCBS.cCredPresPresumed credit code.
dps.ibscbs.valores.trib.gIBSCBS.gTribRegular.cSTRegRegular taxation CST.
dps.ibscbs.valores.trib.gIBSCBS.gTribRegular.cClassTribRegRegular tax classification code.
dps.ibscbs.valores.trib.gIBSCBS.gDif.pDifUFState deferral percentage.
dps.ibscbs.valores.trib.gIBSCBS.gDif.pDifMunMunicipal deferral percentage.
dps.ibscbs.valores.trib.gIBSCBS.gDif.pDifCBSCBS deferral percentage.

Reusable address structures

Endereco structure

Used by prest.end, toma.end, interm.end, dest.end, and fornec.end.

FieldDescription
end.endNac.cMunIBGE municipality code (national address).
end.endNac.cepCEP (national address).
end.endExt.cPaisISO country code (foreign address).
end.endExt.cEndPostForeign postal code.
end.endExt.xCidadeForeign city name.
end.endExt.xEstProvRegForeign state/province/region.
end.xLgrStreet type and name.
end.nroBuilding number.
end.xCplComplement.
end.xBairroNeighborhood.

endNac and endExt are mutually exclusive.

EnderecoObraEvento structure

Used by obra.end and imovel.end.

FieldDescription
end.cepCEP (national address).
end.endExt.cEndPostForeign postal code.
end.endExt.xCidadeForeign city.
end.endExt.xEstProvRegForeign state/province/region.
end.xLgrStreet.
end.nroNumber.
end.xCplComplement.
end.xBairroNeighborhood.

EnderecoSimples structure

Used by atvEvento.end. Same structure as EnderecoObraEvento.

On this page

Conventions used in this document1. Root2. Issuer -- emit2.1. Issuer address -- emit.enderNac3. NFS-e values -- valores4. IBS/CBS -- ibscbs4.1. IBS/CBS rates -- ibscbs.valoresibscbs.valores.uf -- State IBSibscbs.valores.mun -- Municipal IBSibscbs.valores.fed -- Federal CBS4.2. IBS/CBS totals -- ibscbs.totCIBSibscbs.totCIBS.gIBS -- IBS totalsibscbs.totCIBS.gCBS -- CBS totalsibscbs.totCIBS.gTribRegular -- Regular taxationibscbs.totCIBS.gTribCompraGov -- Government purchases5. DPS -- dps5.1. Substitution -- dps.subst6. Provider -- dps.prest6.1. Tax regime -- dps.prest.regTrib7. Recipient and Intermediary -- dps.toma / dps.interm8. Service -- dps.serv8.1. Place of provision -- dps.serv.locPrest8.2. Service code -- dps.serv.cServ8.3. Foreign trade -- dps.serv.comExt8.4. Civil construction -- dps.serv.obra8.5. Event activity -- dps.serv.atvEvento8.6. Additional information -- dps.serv.infoCompl9. DPS values -- dps.valores9.1. Service amount -- dps.valores.vServPrest9.2. Discounts -- dps.valores.vDescCondIncond9.3. Deductions/reductions -- dps.valores.vDedRed9.3.1. Deduction/reduction documents9.3.2. NFS-e from another municipality9.3.3. Non-electronic NF/NFS9.4. Municipal taxation (ISSQN) -- dps.valores.trib.tribMun9.5. Federal taxation -- dps.valores.trib.tribFed9.6. Tax totals -- dps.valores.trib.totTrib10. DPS IBS/CBS -- dps.ibscbs10.1. Recipient -- dps.ibscbs.dest10.2. Property -- dps.ibscbs.imovel10.3. Reimbursement/Pass-through -- dps.ibscbs.valoresdps.ibscbs.valores.gReeRepRes -- Reimbursement/Pass-through/Refunddps.ibscbs.valores.trib -- IBS/CBS taxationReusable address structuresEndereco structureEnderecoObraEvento structureEnderecoSimples structure