Services · City of São Paulo
São Paulo NFS-e
São Paulo NFS-e uses the municipal `/nfse` route. The contract is the standard service API; ISS and TributacaoRPS follow City Hall rules.
São Paulo-specific rules →First issuance in São Paulo
- 1Confirm municipality 3550308 is enabled for the company.
- 2Register the digital certificate when City Hall requires it.
- 3Register the service provider and enable NFS-e.
- 4Send JSON with the customer, service, and ISS. Use a unique `idIntegracao`.
- 5Query `/nfse/consultar/{id}` or wait for the webhook with the final status.
Operational notes
- Processing time depends on the City Hall webservice.
- Providers that have never issued via webservice usually need prior homologation in São Paulo.
- Maximum batch size is 500 invoices per request.
- The `numero` field in queries is the RPS we sent. `numeroNfse` is the number assigned by City Hall — treat it as a string.
Request body
POST `/nfse` accepts an array. For São Paulo, send the provider, the customer with address, and the service with ISS.
POST /nfse
[
{
"idIntegracao": "XXXYY999",
"prestador": {
"cpfCnpj": "08187168000160"
},
"tomador": {
"cpfCnpj": "99999999999999",
"razaoSocial": "Empresa de Teste LTDA",
"inscricaoMunicipal": "8214100099",
"email": "teste@a API.com.br",
"endereco": {
"descricaoCidade": "Maringa",
"cep": "87020100",
"tipoLogradouro": "Rua",
"logradouro": "Barao do rio branco",
"tipoBairro": "Centro",
"codigoCidade": "4115200",
"complemento": "sala 01",
"estado": "PR",
"numero": "1001",
"bairro": "Centro"
}
},
"servico": [
{
"codigo": "14.10",
"codigoTributacao": "14.10",
"discriminacao": "Descrição dos serviços prestados, utilize | para quebra de linha na impressão.",
"cnae": "7490104",
"iss": {
"tipoTributacao": 7,
"exigibilidade": 1,
"aliquota": 3
},
"valor": {
"servico": 1,
"descontoCondicionado": 0,
"descontoIncondicionado": 0
}
}
]
}
]Data dictionary
NFS-e issuance JSON fields.
| Field | Type | Description |
|---|---|---|
idIntegracao | string | — |
modoEnvio | string | Modo de envio da issuance. * assincrono |
versao | string | Versão do esquema de envio. |
versaoEsquema | string | Versão de esquema a ser utilizada. **Accepted values:** * `RTC` (Reforma Tributária - IBS/CBS) * `RTC007` - Ativa o modelo NT007 para separação de apuração própria e withholding de PIS/COFINS. **Quando usar:** * Enter `"versaoEsquema": "RTC"` quando quiser utilizar os campos da **Reforma Trib |
prestador required | object | Issuing company data. |
prestador.cpfCnpj required | string | Company CPF or CNPJ. |
prestador.codigoEstrangeiro | string | Identificação do Estrangeiro (Passaporte, etc.) |
prestador.endereco | object | Detalhamento do address. |
prestador.endereco.bairro required | string | District name. |
prestador.endereco.cep required | string | CEP. |
prestador.endereco.codigoCidade required | string | Code IBGE da city. Caso NFSe para exterior: * Informar 9999999 |
prestador.endereco.estado required | string AC · AL · AM · AP · BA · CE · DF · ES · GO · MA · MG · MS · MT · PA · PB · PE · PI · PR · RJ · RN · RO · RR · RS · SC · SE · SP · TO | Sigla do Estado: * AC * AL * AM * AP * BA * CE * DF * ES * GO * MA * MG * MS * MT * PA * PB * PE * PI * PR * RJ * RN * RO * RR * RS * SC * SE * SP * TO |
prestador.endereco.logradouro required | string | Street. |
prestador.endereco.numero required | string | Street number. |
prestador.endereco.tipoLogradouro required | string Alameda · Avenida · Chácara · Colônia · Condomínio · Estância · Estrada · Fazenda · Praça · Prolongamento · Rodovia · Rua · Sítio · Travessa · Vicinal · Eqnp | Tipo do street: * Alameda * Avenida * Chácara * Colônia * Condomínio * Eqnp * Estância * Estrada * Fazenda * Praça * Prolongamento * Rodovia * Rua * Sítio * Travessa * Vicinal |
prestador.endereco.codigoPais | string | Code do pais. Para o default Nacional, deve ser informado o code ISO de 2 dígitos, em vez do code BACEN. |
prestador.endereco.complemento | string | Complement. |
prestador.endereco.descricaoCidade | string | Nome da city. |
prestador.endereco.descricaoPais | string | Nome do pais. |
prestador.endereco.tipoBairro | string Bairro · Bosque · Chácara · Conjunto · Desmembramento · Distrito · Favela · Fazenda · Gleba · Horto · Jardim · Loteamento · Núcleo · Parque · Residencial · Sítio · Tropical · Vila · Zona · Centro · Setor | Tipo do district: * District * Bosque * Chácara * Conjunto * Desmembramento * Distrito * Favela * Fazenda * Gleba * Horto * Jardim * Loteamento * Núcleo * Parque * Residencial * Sítio * Tropical * Vila * Zona * Centro * Setor |
prestador.email | string | Email da empresa. |
prestador.incentivadorCultural | boolean | É incentivador cultural? * `true` - Sim. * `false` - Não. |
prestador.incentivoFiscal | boolean | Possuí algum tipo de incentivo fiscal? * `true` - Possuí. * `false` - Não possuí. |
prestador.inscricaoEstadual | string | Registration state do Issuer. Enter digits only, without caracteres de formatação (ponto, barra, hífen, etc.). Na issuance de NF-e Avulsa pode ser informado o literal ISENTO para os contribuintes do ICMS isentos de registration no Cadastro de Contribuintes de ICMS. Em caso de nota conjugad |
prestador.inscricaoMunicipal | string | Registration municipal da empresa. Utilize pontuação quando necessário. Para emissões de NFS-e, este campo torna-se required. |
prestador.inscricaoEmitenteSuframa | string | Registration do emitente da Suframa. Informar o number do Cadastro do emitente na Suframa. Campo required nas operações que se beneficiam de incentivos fiscais existentes nas áreas sob controle da SUFRAMA com rate zero da CBS referente aos arts. 451 e 466 da LC 214/25 |
prestador.nomeFantasia | string | Nome fantasia da empresa. |
prestador.razaoSocial | string | Razão social da empresa. |
prestador.regimeTributario | integer | Regime Tributário, valores: * `0` - Nenhum * `1` - Simples Nacional * `2` - Simples Nacional - Excesso * `3` - Regime Normal - Lucro Presumido * `4` - Normal - Lucro Real * `5` - MEI (Microempreendedor individual) Note: **Ao preencher com o amount 5, a tag CRT no XML será atribuída |
prestador.regimeTributarioEspecial | integer | Regime tributário adotado pela empresa: * `0` - Sem Regime Tributário Especial * `1` - Micro Empresa Municipal * `2` - Estimativa * `3` - Sociedade de Profissionais * `4` - Cooperativa * `5` - Microempresário Individual - MEI * `6` - Microempresa ou Pequeno Porte - ME EPP * `7` - Luc |
prestador.simplesNacional | boolean | Optante pelo simples nacional: * `true` - É optante. * `false` - Não é optante. |
prestador.anexoSimplesNacional | integer | Anexo/Tabela em que a empresa se enquadra (Somente para empresas do Simples Nacional). |
prestador.dataVigenciaSimplesNacional | string | Data do início da Atividade (Somente para empresas do Simples Nacional). |
prestador.telefone | object | phone |
prestador.telefone.numero required | string | Number de phone |
prestador.telefone.ddd | string | DDD |
prestador.codigoDistrito | integer | Code da Localidade (usado no default SEMFAZONLINE da NFS-e) : * `1` - MUNICIPIO PORTO VELHO - SEDE * `15` - CALAMA * `33` - DEMARCAÇÃO * `40` - UNIÃO BANDEIRANTE * `43` - EXTREMA * `44` - VISTA ALEGRE DO ABUNÃ * `48` - NAZARE * `50` - NOVA CALIFORNIA * `51` - FORTALEZA DO ABUNÃ |
tomador | object | Dados do customer/recipient. |
tomador.cpfCnpj | string | CPF ou CNPJ do customer/recipient. Obs: If provided codigoIdentificacaoDestino = 3 esse campo nao deve ser informado. |
tomador.razaoSocial | string | Razão social do customer/recipient. |
tomador.endereco | object | Detalhamento do address. |
tomador.endereco.bairro | string | District name. |
tomador.endereco.cep | string | CEP. |
tomador.endereco.codigoCidade | string | Code IBGE da city. Caso NFSe para exterior: * Informar 9999999 |
tomador.endereco.estado | string AC · AL · AM · AP · BA · CE · DF · ES · GO · MA · MG · MS · MT · PA · PB · PE · PI · PR · RJ · RN · RO · RR · RS · SC · SE · SP · TO | Sigla do Estado: * AC * AL * AM * AP * BA * CE * DF * ES * GO * MA * MG * MS * MT * PA * PB * PE * PI * PR * RJ * RN * RO * RR * RS * SC * SE * SP * TO |
tomador.endereco.logradouro | string | Street. |
tomador.endereco.numero | string | Street number. |
tomador.endereco.tipoLogradouro | string Alameda · Avenida · Chácara · Colônia · Condomínio · Estância · Estrada · Fazenda · Praça · Prolongamento · Rodovia · Rua · Sítio · Travessa · Vicinal · Eqnp | Tipo do street: * Alameda * Avenida * Chácara * Colônia * Condomínio * Eqnp * Estância * Estrada * Fazenda * Praça * Prolongamento * Rodovia * Rua * Sítio * Travessa * Vicinal |
tomador.endereco.codigoPais | string | Code do pais (BACEN). Para o default Nacional, deve ser informado o code ISO de 2 dígitos, em vez do code BACEN. |
tomador.endereco.complemento | string | Complement. |
tomador.endereco.descricaoCidade | string | Nome da city. |
tomador.endereco.descricaoPais | string | Nome do pais. |
tomador.endereco.tipoBairro | string Bairro · Bosque · Chácara · Conjunto · Desmembramento · Distrito · Favela · Fazenda · Gleba · Horto · Jardim · Loteamento · Núcleo · Parque · Residencial · Sítio · Tropical · Vila · Zona · Centro · Setor | Tipo do district: * District * Bosque * Chácara * Conjunto * Desmembramento * Distrito * Favela * Fazenda * Gleba * Horto * Jardim * Loteamento * Núcleo * Parque * Residencial * Sítio * Tropical * Vila * Zona * Centro * Setor |
tomador.email | string | Address de email do customer/recipient. Para municípios que aceitam mais de um email do customer no XML de **NFS-e**, enviá-los separados por ponto e vírgula (**;**). Exemplo: customer1@a API.com;customer2@a API.com |
tomador.inscricaoEstadual | string | Registration state do customer/recipient. |
tomador.inscricaoMunicipal | string | Registration municipal do customer/recipient. |
tomador.nomeFantasia | string | Nome fantasia do customer/recipient. |
tomador.orgaoPublico | boolean | **Only for NFS-e** If sent on other documents, it does not generate an error. Sinaliza se o Customer do service é um orgão público. |
tomador.telefone | object | phone |
tomador.telefone | telefone | Ref: phone |
tomador.codigoEstrangeiro | string | Identificação do Estrangeiro (Passaporte, etc.) |
tomador.nif | string | NIF do customer. |
tomador.naoNif | string | **Only for a foreign customer on the national standard** Reason for not informingção do NIF: * `0` - Não informado na nota de origem * `1` - Dispensado do NIF * `2` - Não exigência do NIF |
servico required | array | — |
servico[].codigo required | string | Service code, also known as the service list item codeegue a LC116, podendo váriar de acordo com a City Hall. Você pode encontrar esse dado no portal da City Hall, em uma nota emitida, ou junto ao contador. |
servico[].codigoContribuinte | string | Code interno do contribuinte. |
servico[].idIntegracao | string | Code EXTERNO de integração do service. Utilizado **SOMENTE** quando se cadastra previamente um service. |
servico[].discriminacao required | string | Description of the service provided. |
servico[].codigoTributacao | string | Code taxation no Municipality |
servico[].cnae | string | O code CNAE ou, por extenso, Classificação Nacional de Atividades Econômicas, é uma forma de padronizar, em todo o território nacional, os códigos de atividades econômicas e os critérios de enquadramento usados pelos mais diversos órgãos da administração tributária do Brasil. |
servico[].codigoNbs | string | Code NBS (Nomenclatura Brasileira de Serviços, Intangíveis e outras Operações que produzam Variações no Patrimônio) correspondente ao service prestado. Consulte valores aceitos através do link. |
servico[].codigoServicoNacional | string | Code Service Nacional |
servico[].codigoCidadeIncidencia | string | Code IBGE da city de incidência do ISS. |
servico[].descricaoCidadeIncidencia | string | Nome da city de incidência do ISS. |
servico[].unidade | string | Unidade do service prestado. |
servico[].quantidade | number | Quantity dos services prestados. |
servico[].iss required | object | ISS tax details. |
servico[].iss.tipoTributacao | integer 0 · 1 · 2 · 3 · 4 · 5 · 6 · 7 · 8 | Tipo de Taxation do Service, valores: * `0` - Não definido * `1` - Isento de ISS * `2` - Imune * `3` - Não Incidência no Municipality * `4` - Não Tributável * `5` - Retido * `6` - Tributável Dentro do Municipality * `7` - Tributável Fora do Municipality * `8` - Tributável Dentro do Municí |
servico[].iss.tipoRetencao | integer 1 · 2 · 3 | Tipo de Withholding do Iss, valores: * `1` - Não Retido * `2` - Retido pelo Customer * `3` - Retido pelo Intermediário |
servico[].iss.exigibilidade | integer 1 · 2 · 3 · 4 · 5 · 6 · 7 | Enforceability do ISS, valores: * `1` - Exigível * `2` - Não Incidência * `3` - Isenção * `4` - Exportação * `5` - Imunidade * `6` - Supenso por Ação Judicial * `7` - Suspenso por Ação Administrativa |
servico[].iss.retido | boolean | Reter ISS |
servico[].iss.aliquota required | number | Rate do ISS do service prestado. Você pode encontrar esse dado no portal da City Hall, ou junto ao contador. |
servico[].iss.valor | number | Amount do ISS, caso você não enter esse campo, vamos calcular automáticamente. |
servico[].iss.valorRetido | number | Amount ISS withheld, caso você não enter esse campo, vamos calcular automáticamente. |
servico[].iss.processoSuspensao | string | Number do Processo de Suspensão da Enforceability |
servico[].iss.situacaoTributaria | integer 0 · 1 · 2 · 3 · 4 · 5 · 6 · 7 · 8 · 9 · 10 · 15 | Code da Situação Tributária para IPM20. Accepted values: * `0` - Tributada Integralmente (TI) * `1` - Tributada Integralmente com ISSRF (TIRF) * `2` - Tributada Integralmente e sujeita à Substituição Tributária (TIST) * `3` - Tributada com redução da base de cálculo (TRBC) * `4` - Tribut |
servico[].obra | object | Grupo de informações da obra, utilizado somente no contexto da construção cívil. |
servico[].obra.nome | string | Registration imobiliária fiscal (code fornecido pela City Hall Municipal para a identificação da obra ou para fins de recolhimento do IPTU) |
servico[].obra.art | string | Code da ART. |
servico[].obra.codigo | string | Code da obra (CO). |
servico[].obra.cei | string | Cadastro específico do INSS. |
servico[].obra.opcao | string | — |
servico[].obra.inf | string | — |
servico[].obra.inscricaoImobFisc | string | Registration imobiliária fiscal (code fornecido pela City Hall Municipal para a identificação da obra ou para fins de recolhimento do IPTU) |
servico[].obra.endereco | object | Grupo de informações do address da obra. |
servico[].obra.endereco.bairro | object | district |
servico[].obra.endereco.cep | object | cep |
servico[].obra.endereco.codigoCidade | object | codigoCidade |
servico[].obra.endereco.estado | object | state |
servico[].obra.endereco.logradouro | object | street |
servico[].obra.endereco.numero | object | numero |
servico[].obra.endereco.tipoLogradouro | object | tipoLogradouro |
servico[].obra.endereco.codigoPais | object | codigoPais |
servico[].obra.endereco.complemento | object | complement |
servico[].obra.endereco.descricaoCidade | object | descricaoCidade |
servico[].obra.endereco.descricaoPais | object | descricaoPais |
servico[].obra.endereco.tipoBairro | object | tipoBairro |
servico[].evento | object | Detalhamento das informações do evento |
servico[].evento.id | string | Identificação da Atividade de Evento (code identificador de evento determinado pela Administração Tributária Municipal) |
servico[].evento.descricao | string | Description do evento Artístico, Cultural, Esportivo, etc |
servico[].evento.atividade | string | — |
servico[].evento.dataInicio | date | Data de início da atividade de evento. Ano, Mês e Dia (AAAA-MM-DD) |
servico[].evento.dataFim | date | Data de fim da atividade de evento. Ano, Mês e Dia (AAAA-MM-DD) |
servico[].evento.endereco | object | Detalhamento do address |
servico[].evento.endereco.bairro | object | district |
servico[].evento.endereco.bairro | bairro | Ref: district |
servico[].evento.endereco.cep | object | cep |
servico[].evento.endereco.cep | cep | Ref: cep |
servico[].evento.endereco.codigoCidade | object | codigoCidade |
servico[].evento.endereco.codigoCidade | codigoCidade | Ref: codigoCidade |
servico[].evento.endereco.estado | object | state |
servico[].evento.endereco.estado | estado | Ref: state |
servico[].evento.endereco.logradouro | object | street |
servico[].evento.endereco.logradouro | logradouro | Ref: street |
servico[].evento.endereco.numero | object | numero |
servico[].evento.endereco.numero | numero | Ref: numero |
servico[].evento.endereco.tipoLogradouro | object | tipoLogradouro |
servico[].evento.endereco.tipoLogradouro | tipoLogradouro | Ref: tipoLogradouro |
servico[].evento.endereco.codigoPais | object | codigoPais |
servico[].evento.endereco.codigoPais | codigoPais | Ref: codigoPais |
servico[].evento.endereco.complemento | object | complement |
servico[].evento.endereco.complemento | complemento | Ref: complement |
servico[].evento.endereco.descricaoCidade | object | descricaoCidade |
servico[].evento.endereco.descricaoCidade | descricaoCidade | Ref: descricaoCidade |
servico[].evento.endereco.descricaoPais | object | descricaoPais |
servico[].evento.endereco.descricaoPais | descricaoPais | Ref: descricaoPais |
servico[].evento.endereco.tipoBairro | object | tipoBairro |
servico[].evento.endereco.tipoBairro | tipoBairro | Ref: tipoBairro |
servico[].valor required | object | — |
servico[].valor.servico required | number | Amount bruto do service prestado. |
servico[].valor.baseCalculo | number | Amount da base de cálculo dos impostos. |
servico[].valor.deducoes | number | Amount deduções. |
servico[].valor.descontoCondicionado | number | Amount do discount condicionado. |
servico[].valor.descontoIncondicionado | number | Amount do discount incondicionado. |
servico[].valor.liquido | number | Amount liquido do service, caso você não enter esse campo, vamos calcular automáticamente. |
servico[].valor.unitario | number | Amount unitário do service, referente a unidade informada. |
servico[].valor.ipi | number | Amount do IPI. |
servico[].deducao | object | — |
servico[].deducao.tipo | integer | Tipo de dedução: * `0` - Sem Deduções * `1` - Materiais * `2` - Subempreitada de Mão de Obra * `3` - Serviços * `4` - Produção Externa * `5` - Alimentação e Bebidas * `6` - Reembolso de Despesas * `7` - Repasse Consorciado * `8` - Repasse Plano de Saúde * `99` - Outras Deduções |
servico[].deducao.descricao | string | Description da dedução. |
servico[].retencao | object | Detalhamento das retenções. Este grupo possui **dois comportamentos**, conforme o emissor/city: **1) Legacy (demais emissores, enquanto não adotarem NT007):** - `pis.withheld` e `cofins.withheld` controlam se há withholding. - `pis.amount` e `cofins.amount` representam os valores withhelds de cada tributo |
servico[].retencao.tipoRetencaoPisCofinsCSLL | string 0 · 1 · 2 · 3 · 4 · 5 · 6 · 7 · 8 · 9 | ⚠️ Use este campo apenas no comportamento NT007. Em emissores legados, siga `pis.withheld` e `cofins.withheld`. Tipo de withholding de PIS/COFINS/CSLL no modelo NT007 (documentação) para NFSe Nacional e emissores aderentes. Campo en |
servico[].retencao.pis | object | — |
servico[].retencao.pis.cst | string 00 · 01 · 02 · 03 · 04 · 05 · 06 · 07 · 08 · 09 · 49 · 50 · 51 · 52 · 53 · 54 · 55 · 56 · 60 · 61 · 62 · 63 · 64 · 65 · 66 · 67 · 70 · 71 · 72 · 73 · 74 · 75 · 98 · 99 | Code de Situação Tributária do PIS (CST). Comportamentos: - **Legacy (demais emissores):** pode haver aceitação parcial da tabela (comum: `00` a `09`), conforme regras da City Hall/default. - **NT007 (NFSe Nacional e emissores aderentes):** segue a tabela nacional abaixo. Accepted values: * `0 |
servico[].retencao.pis.baseCalculo | number | Base de cálculo do PIS. - **Legacy:** base de cálculo para PIS withheld. - **NT007:** base de cálculo for own assessment de PIS (`vPis`). * Caso não informada, será utilizado o amount da base de cálculo do service. |
servico[].retencao.pis.retido | boolean | Reter PIS no comportamento legado. ⚠️ **NT007:** este campo é ignorado; utilize `tipoRetencaoPisCofinsCSLL`. |
servico[].retencao.pis.aliquota | number | Rate do PIS. - **Legacy:** rate de PIS withheld. - **NT007:** rate de PIS for own assessment (`vPis`). |
servico[].retencao.pis.valor | number | Amount de PIS. - **Legacy:** amount do PIS withheld (caso não informado, pode ser calculado automaticamente). - **NT007:** amount do PIS for own assessment (`vPis`). Se houver withholding de PIS, enter o amount withheld agregado em `csll.amount` conforme `tipoRetencaoPisCofinsCSLL`. |
servico[].retencao.cofins | object | — |
servico[].retencao.cofins.cst | string 00 · 01 · 02 · 03 · 04 · 05 · 06 · 07 · 08 · 09 · 49 · 50 · 51 · 52 · 53 · 54 · 55 · 56 · 60 · 61 · 62 · 63 · 64 · 65 · 66 · 67 · 70 · 71 · 72 · 73 · 74 · 75 · 98 · 99 | Code de Situação Tributária do COFINS (CST). Comportamentos: - **Legacy (demais emissores):** pode haver aceitação parcial da tabela (comum: `00` a `09`), conforme regras da City Hall/default. - **NT007 (NFSe Nacional e emissores aderentes):** segue a tabela nacional abaixo. Accepted values: * |
servico[].retencao.cofins.baseCalculo | number | Base de cálculo do COFINS. - **Legacy:** base de cálculo para COFINS withheld. - **NT007:** base de cálculo for own assessment de COFINS (`vCofins`). * Caso não informada, será utilizado o amount da base de cálculo do service. |
servico[].retencao.cofins.retido | boolean | Reter COFINS no comportamento legado. ⚠️ **NT007:** este campo é ignorado; utilize `tipoRetencaoPisCofinsCSLL`. |
servico[].retencao.cofins.aliquota | number | Rate do COFINS. - **Legacy:** rate de COFINS withheld. - **NT007:** rate de COFINS for own assessment (`vCofins`). |
servico[].retencao.cofins.valor | number | Amount de COFINS. - **Legacy:** amount do COFINS withheld (caso não informado, pode ser calculado automaticamente). - **NT007:** amount do COFINS for own assessment (`vCofins`). Se houver withholding de COFINS, enter o amount withheld agregado em `csll.amount` conforme `tipoRetencaoPisCofinsCSLL`. |
servico[].retencao.csll | object | — |
servico[].retencao.csll.aliquota | number | Aliquota CSLL withheld. |
servico[].retencao.csll.baseCalculo | number | Base de cálculo da CSLL retida. * Caso não informada, será utilizado o amount da base de cálculo do service. |
servico[].retencao.csll.valor | number | Amount de CSLL. - **Legacy:** amount da CSLL retida (caso não informado, pode ser calculado automaticamente). - **NT007:** amount agregado das retenções sociais (`vRetCSLL`), somando CSLL retida e também PIS/COFINS withhelds conforme `tipoRetencaoPisCofinsCSLL`. |
servico[].retencao.inss | object | — |
servico[].retencao.inss.aliquota | number | Rate INSS withheld. |
servico[].retencao.inss.baseCalculo | number | Base de cálculo do INSS withheld. * Caso não informada, será utilizado o amount da base de cálculo do service. |
servico[].retencao.inss.valor | number | Amount INSS withheld, caso você não enter esse campo, vamos calcular automáticamente. |
servico[].retencao.irrf | object | — |
servico[].retencao.irrf.aliquota | number | Rate IR withheld. |
servico[].retencao.irrf.baseCalculo | number | Base de cálculo do IR withheld. * Caso não informada, será utilizado o amount da base de cálculo do service. |
servico[].retencao.irrf.valor | number | Amount IR withheld, caso você não enter esse campo, vamos calcular automáticamente. |
servico[].retencao.outrasRetencoes | number | Amount de outras retenções. |
servico[].retencao.cpp | object | — |
servico[].retencao.cpp.aliquota | number | Rate CPP withheld. |
servico[].retencao.cpp.baseCalculo | number | Base de cálculo do CPP withheld. * Caso não informada, será utilizado o amount da base de cálculo do service. |
servico[].retencao.cpp.valor | number | Amount CPP withheld, caso você não enter esse campo, vamos calcular automáticamente. |
servico[].apuracaoPropria | object | Apuração própria de PIS/COFINS pelo prestador. Os valores deste grupo são considerados pela API apenas quando `versaoEsquema=RTC007`. Diferente da withholding (que deduz o amount líquido da nota), a apuração própria representa o débito tributário do próprio prestador - não impacta o amount líquido. NT0 |
servico[].apuracaoPropria.cstPisCofins | string 00 · 01 · 02 · 03 · 04 · 05 · 06 · 07 · 08 · 09 · 49 · 50 · 51 · 52 · 53 · 54 · 55 · 56 · 60 · 61 · 62 · 63 · 64 · 65 · 66 · 67 · 70 · 71 · 72 · 73 · 74 · 75 · 98 · 99 | Code de Situação Tributária do PIS/COFINS (CST). Default: `"00"` (Nenhum) quando não informado. Accepted values: * `00` - Nenhum * `01` - Operação Tributável com Rate Básica * `02` - Operação Tributável com Rate Diferenciada * `03` - Operação Tributável com Rate por Unidade d |
servico[].apuracaoPropria.baseCalculoPisCofins | number | Base de cálculo da apuração própria (R$). Caso não informada, será utilizado o amount do service. |
servico[].apuracaoPropria.pis | object | PIS - apuração própria do prestador. |
servico[].apuracaoPropria.pis.aliquota | number | Rate do PIS for own assessment (%). |
servico[].apuracaoPropria.pis.valor | number | Amount do débito de PIS - apuração própria (R$). Enviado como `vPis` no XML. |
servico[].apuracaoPropria.cofins | object | COFINS - apuração própria do prestador. |
servico[].apuracaoPropria.cofins.aliquota | number | Rate da COFINS for own assessment (%). |
servico[].apuracaoPropria.cofins.valor | number | Amount do débito de COFINS - apuração própria (R$). Enviado como `vCofins` no XML. |
servico[].locacao | object | Detalhamento do objeto de locação. |
servico[].locacao.descricao | string | Description do objeto de locação |
servico[].locacao.quantidade | number | Quantity de objetos de locação |
servico[].tributacaoTotal | object | Amount total aproximado das tributações |
servico[].tributacaoTotal.aliquotaSimplesNacional | number | Amount percentual aproximado do total dos tributos da rate do Simples Nacional |
servico[].tributacaoTotal.federal | object | — |
servico[].tributacaoTotal.federal.valor | number | Amount total aproximado dos tributos federais |
servico[].tributacaoTotal.federal.valorPercentual | number | Decimal percentual do tributo federal aplicado sobre o service |
servico[].tributacaoTotal.estadual | object | — |
servico[].tributacaoTotal.estadual.valor | number | Amount total aproximado dos tributos estaduais |
servico[].tributacaoTotal.estadual.valorPercentual | number | Decimal percentual do tributo state aplicado sobre o service |
servico[].tributacaoTotal.municipal | object | — |
servico[].tributacaoTotal.municipal.valor | number | Amount total aproximado dos tributos municipais |
servico[].tributacaoTotal.municipal.valorPercentual | number | Decimal percentual do tributo municipal aplicado sobre o service |
servico[].tributavel | boolean | Indica se o service está sujeito a taxation. |
servico[].ibpt | object | Gera automaticamente uma mensagem com o amount total dos tributos, junto a discriminação do service. |
servico[].ibpt.simplificado | object | — |
servico[].ibpt.simplificado.aliquota | number | Rate geral de impostos. |
servico[].ibpt.detalhado | object | — |
servico[].ibpt.detalhado.aliquota | object | — |
servico[].ibpt.detalhado.aliquota.municipal | number | Rate municipal de impostos. |
servico[].ibpt.detalhado.aliquota.estadual | number | Rate state de impostos. |
servico[].ibpt.detalhado.aliquota.federal | number | Rate federal de impostos. |
servico[].responsavelRetencao | string | Accepted values: * `1` - Customer * `2` - Intermediário Caso o responsável pela withholding seja o próprio prestador, does not generater o campo. |
servico[].ibscbs | object | Grupo de taxation do Tax de Bens e Serviços - IBS e da Contribuição de Bens e Serviços - CBS **Disponível na versão 1.01 da NT Reforma Tributária do Consumo.** |
servico[].ibscbs.finalidadeNFSe | number | Finalidade da issuance de NFS-e * `0` - Normal; |
servico[].ibscbs.operacaoPessoal | number | Indica se é operação pessoal. * `0` - Não; * `1` - Sim; |
servico[].ibscbs.codigoOperacao | string | Code indicador da operação de fornecimento, conforme tabela 'code indicador de operação'. |
servico[].ibscbs.tipoOperacao | number | Tipo de Operação com Entes Governamentais ou outros services sobre bens imóveis: * `1` – Fornecimento com pagamento posterior; * `2` – Recebimento do pagamento com fornecimento já realizado; * `3` – Fornecimento com pagamento já realizado; * `4` – Recebimento do pagamento com fornecimento posterior |
servico[].ibscbs.indicadorOperacao | boolean | Indica se a operação é onerosa (com contraprestação financeira) ou não onerosa (sem contraprestação, como doações e cessões gratuitas). |
servico[].ibscbs.tipoEnteGovernamental | number | Tipo de ente governamental. Para administração pública direta e suas autarquias e fundações: * `1` – União * `2` – Estado * `3` – Distrito Federal * `4` – Municipality |
servico[].ibscbs.descTipoEnteGovernamental | string | Description do tipo de ente governamental, só deve ser informado quando tipoEnteGovernamental for igual a 9 = outro |
servico[].ibscbs.pagamentoParceladoAntecipado | boolean | Indica se o pagamento foi parcelado ou antecipado. |
servico[].ibscbs.municipioIncidenciaIbsCbs | string | Municipality de incidência do IBS CBS. Para a city de Osasco esse campo segue uma tabela de codigos propria de 1 digito. Para mais detalhes, acesse: |
servico[].ibscbs.referenciasNFSe | array | Grupo de NFS-e referenciadas. |
servico[].ibscbs.referenciasNFSe[].chave | string | Chave da NFSe referenciada. |
servico[].ibscbs.destinatario | object | Grupo de informações relativas ao Recipient. |
servico[].ibscbs.destinatario.indicador | number | Indicador do recipient. * `0` – o recipient é o próprio customer/adquirente identificado na NFS-e (default); * `1` – o recipient não é o próprio adquirente, podendo ser outra pessoa, física ou jurídica, ou um estabelecimento diferente do indicado como customer (obs.: caso seja informado 1, o |
servico[].ibscbs.destinatario.cpfCnpj | string | CNPJ ou CPF do recipient. |
servico[].ibscbs.destinatario.codigoEstrangeiro | string | Code de identificação de estrangeiro do recipient. |
servico[].ibscbs.destinatario.nif | number | Tipo NIF (Number de Identificação Fiscal) - fornecido por um órgão de administração tributária no exterior. |
servico[].ibscbs.destinatario.naoNif | number | Reason for not informingção do NIF: * `0` - Não informado na nota de origem; * `1` - Dispensado do NIF; * `2` - Não exigência do NIF; |
servico[].ibscbs.destinatario.razaoSocial | string | Razão social do recipient. |
servico[].ibscbs.destinatario.endereco | object | Grupo de informações do address do recipient. |
servico[].ibscbs.destinatario.endereco.codigoCidade required | number | Code IBGE da city do recipient. |
servico[].ibscbs.destinatario.endereco.cep required | string | CEP do address do recipient. |
servico[].ibscbs.destinatario.endereco.codigoPais | string | Code do país do recipient. |
servico[].ibscbs.destinatario.endereco.codigoPostalExterior | string | Code de endereçamento postal exterior. |
servico[].ibscbs.destinatario.endereco.estadoProvinciaRegiao | string | Estado, província ou região da city no exterior. |
servico[].ibscbs.destinatario.endereco.descricaoCidade | string | Description da city do recipient. |
servico[].ibscbs.destinatario.endereco.estado | string AC · AL · AM · AP · BA · CE · DF · ES · GO · MA · MG · MS · MT · PA · PB · PE · PI · PR · RJ · RN · RO · RR · RS · SC · SE · SP · TO | Sigla do Estado do recipient. |
servico[].ibscbs.destinatario.endereco.logradouro required | string | Street do recipient. |
servico[].ibscbs.destinatario.endereco.numero required | string | Number do street do recipient. |
servico[].ibscbs.destinatario.endereco.complemento | string | Complement do address do recipient. |
servico[].ibscbs.destinatario.endereco.bairro | string | District do address do recipient. |
servico[].ibscbs.destinatario.telefone | object | Grupo de informações do phone do recipient. |
servico[].ibscbs.destinatario.telefone.ddd | number | DDD do phone do recipient. |
servico[].ibscbs.destinatario.telefone.numero | number | Number do phone do recipient. |
servico[].ibscbs.destinatario.email | string | Email do recipient. |
servico[].ibscbs.imovel | object | Grupo de informações de operações relacionadas a bens imóveis. |
servico[].ibscbs.imovel.inscricaoFiscal | string | Registration imobiliária fiscal do imóvel. |
servico[].ibscbs.imovel.codigoCIB | string | Code do Cadastro Imobiliário Brasileiro (CIB) do imóvel. |
servico[].ibscbs.imovel.codigoObra | string | Code da obra do imóvel. |
servico[].ibscbs.imovel.endereco | object | Grupo de informações do address do imóvel. |
servico[].ibscbs.imovel.endereco.codigoCidade required | number | Code IBGE da city do recipient. |
servico[].ibscbs.imovel.endereco.cep required | string | CEP do imóvel. |
servico[].ibscbs.imovel.endereco.descricaoCidade required | string | Nome da city do imóvel. |
servico[].ibscbs.imovel.endereco.estado required | string AC · AL · AM · AP · BA · CE · DF · ES · GO · MA · MG · MS · MT · PA · PB · PE · PI · PR · RJ · RN · RO · RR · RS · SC · SE · SP · TO | Sigla do Estado do imóvel. |
servico[].ibscbs.imovel.endereco.logradouro required | string | Street do imóvel. |
servico[].ibscbs.imovel.endereco.numero required | string | Number do street do imóvel. |
servico[].ibscbs.imovel.endereco.complemento | string | Complement do imóvel. |
servico[].ibscbs.imovel.endereco.bairro required | string | District do imóvel. |
servico[].ibscbs.valores | object | Grupo de informações relativas aos valores do service prestado para IBS e CBS |
servico[].ibscbs.valores.baseCalculo | number | Base de cálculo do IBS e CBS. |
servico[].ibscbs.valores.aliquotaIbsMunicipal | number | Rate do IBS Municipal. |
servico[].ibscbs.valores.aliquotaIbsEstadual | number | Rate do IBS Estadual. |
servico[].ibscbs.valores.aliquotaCbs | number | Rate da CBS. |
servico[].ibscbs.valores.valorIbsMunicipal | number | Amount do IBS Municipal. |
servico[].ibscbs.valores.valorIbsEstadual | number | Amount do IBS Estadual. |
servico[].ibscbs.valores.valorCbs | number | Amount da CBS. |
servico[].ibscbs.valores.operacao | object | Grupo de informações relativas a valores incluídos neste documento e recebidos por motivo de estarem relacionadas a operações de terceiros, objeto de reembolso, repasse ou ressarcimento pelo recebedor, já tributados e aqui referenciados. |
servico[].ibscbs.valores.operacao.documentosReferenciados | array | Grupo relativo aos documentos referenciados nos casos de reembolso, repasse e ressarcimento que serão considerados na base de cálculo do ISSQN, do IBS e da CBS. |
servico[].ibscbs.valores.operacao.documentosReferenciados[].nacional | object | Grupo de informações de documentos fiscais eletrônicos que se encontram no repositório nacional. |
servico[].ibscbs.valores.operacao.documentosReferenciados[].nacional.tipoChave | number | Documento fiscal a que se refere o campo chave que seja um dos documentos do Repositório Nacional: *`1` = NFS-e; *`2` = NF-e; *`3` = CT-e; *`9` = Outro |
servico[].ibscbs.valores.operacao.documentosReferenciados[].nacional.descricaoChave | string | Description do documento fiscal, caso o campo tipoChave seja igual a 9 (Outro). |
servico[].ibscbs.valores.operacao.documentosReferenciados[].nacional.chave | string | Chave de acesso do documento fiscal eletrônico. |
servico[].ibscbs.valores.operacao.documentosReferenciados[].fiscal | object | Grupo de informações de documento fiscais, eletrônicos ou não, que não se encontram no repositório nacional. |
servico[].ibscbs.valores.operacao.documentosReferenciados[].fiscal.codigoCidade | number | Code IBGE da city emissora. |
servico[].ibscbs.valores.operacao.documentosReferenciados[].fiscal.numero | string | Number do documento fiscal. |
servico[].ibscbs.valores.operacao.documentosReferenciados[].fiscal.descricao | string | Description do documento fiscal. |
servico[].ibscbs.valores.operacao.documentosReferenciados[].naoFiscal | object | Grupo de informações de documento não fiscal. |
servico[].ibscbs.valores.operacao.documentosReferenciados[].naoFiscal.numero | string | Number do documento não fiscal. |
servico[].ibscbs.valores.operacao.documentosReferenciados[].naoFiscal.descricao | string | Description do documento não fiscal. |
servico[].ibscbs.valores.operacao.documentosReferenciados[].fornecedor | object | Grupo de informações do fornecedor do documento referenciado |
servico[].ibscbs.valores.operacao.documentosReferenciados[].fornecedor.cpfCnpj | string | CPF ou CNPJ do fornecedor. |
servico[].ibscbs.valores.operacao.documentosReferenciados[].fornecedor.codigoEstrangeiro | string | Code de identificação de estrangeiro do fornecedor. |
servico[].ibscbs.valores.operacao.documentosReferenciados[].fornecedor.nif | number | NIF (Number de Identificação Fiscal) do fornecedor. |
servico[].ibscbs.valores.operacao.documentosReferenciados[].fornecedor.naoNif | number | Reason for not informingção do NIF: * `0` - Não informado na nota de origem; * `1` - Dispensado do NIF; * `2` - Não exigência do NIF; |
servico[].ibscbs.valores.operacao.documentosReferenciados[].fornecedor.razaoSocial | string | Razão social do fornecedor. |
servico[].ibscbs.valores.operacao.documentosReferenciados[].fornecedor.endereco | object | Grupo de informações do address do fornecedor. |
servico[].ibscbs.valores.operacao.documentosReferenciados[].dataEmissao | string | Data de issuance do documento no formato AAAA-MM-DD. |
servico[].ibscbs.valores.operacao.documentosReferenciados[].competencia | string | Competência do documento no formato AAAA-MM-DD. |
servico[].ibscbs.valores.operacao.documentosReferenciados[].tipoOperacao | string | Tipo de amount incluído neste documento, recebido por motivo de estarem relacionadas a operações de terceiros, objeto de reembolso, repasse ou ressarcimento pelo recebedor, já tributados e aqui referenciados. * `01` - Repasse de remuneração por intermediação de imóveis a demais corretores envolvidos |
servico[].ibscbs.valores.operacao.documentosReferenciados[].descricaoOperacao | string | Description do reembolso ou ressarcimento quando tipoOperacao é '99 - Outros reembolsos ou ressarcimentosrecebidos por valores pagos relativos a operações por conta e ordem de terceiro'. |
servico[].ibscbs.valores.operacao.documentosReferenciados[].valorOperacao | number | Amount monetário (total ou parcial) utilizado para não inclusão na base de cálculo do ISS e do IBS e da CBS da NFS-e que está sendo emitida. |
servico[].ibscbs.valores.tributacao | object | Grupo de informações relacionados aos tributos IBS e CBS |
servico[].ibscbs.valores.tributacao.cst | string | Code de Situação Tributária (CST). |
servico[].ibscbs.valores.tributacao.cct | string | Code de Classificação de Taxation (CCT). |
servico[].ibscbs.valores.tributacao.codigoCreditoPresumido | string | Code e classificação do crédito presumido. |
servico[].ibscbs.valores.tributacao.regular | object | Grupo de informações da Taxation Regular |
servico[].ibscbs.valores.tributacao.regular.cst | string | Code de Situação Tributária (CST) de taxation regular. |
servico[].ibscbs.valores.tributacao.regular.cct | string | Code de Classificação de Taxation (CCT) de taxation regular. |
servico[].ibscbs.valores.tributacao.diferimento | object | Grupo de informações relacionadas ao diferimento para IBS e CBS. |
servico[].ibscbs.valores.tributacao.diferimento.percentualEstadual | number | Percentual de diferimento para o IBS state. |
servico[].ibscbs.valores.tributacao.diferimento.percentualMunicipal | number | Percentual de diferimento para o IBS municipal. |
servico[].ibscbs.valores.tributacao.diferimento.percentualCBS | number | Percentual de diferimento para a CBS. |
servico[].ibscbs.valores.resumo | object | Grupo de informações consolidadas e totalizadoras do IBS e CBS. |
servico[].ibscbs.valores.resumo.ibsMunicipal | object | Resumo do IBS Municipal. |
servico[].ibscbs.valores.resumo.ibsMunicipal.percentualReducao | number | Percentual de redução aplicado ao IBS Municipal. |
servico[].ibscbs.valores.resumo.ibsMunicipal.aliquotaEfetiva | number | Rate efetiva do IBS Municipal após aplicação de redução. |
servico[].ibscbs.valores.resumo.ibsEstadual | object | Resumo do IBS Estadual. |
servico[].ibscbs.valores.resumo.ibsEstadual.percentualReducao | number | Percentual de redução aplicado ao IBS Estadual. |
servico[].ibscbs.valores.resumo.ibsEstadual.aliquotaEfetiva | number | Rate efetiva do IBS Estadual após aplicação de redução. |
servico[].ibscbs.valores.resumo.cbsFederal | object | Resumo da CBS Federal. |
servico[].ibscbs.valores.resumo.cbsFederal.percentualReducao | number | Percentual de redução aplicado à CBS Federal. |
servico[].ibscbs.valores.resumo.cbsFederal.aliquotaEfetiva | number | Rate efetiva da CBS Federal após aplicação de redução. |
servico[].ibscbs.valores.resumo.totalizador | object | Grupo totalizador com valores consolidados do IBS e CBS. |
servico[].ibscbs.valores.resumo.totalizador.valorIbsCbs | number | Amount total consolidado do IBS e CBS. |
servico[].ibscbs.valores.resumo.totalizador.percentualReducaoIbsCbs | number | Percentual de redução de rate em compra governamental. |
servico[].ibscbs.valores.resumo.totalizador.valorDeducoesIbsCbs | number | Amount total utilizado para não inclusão na base de cálculo do ISS e do IBS e da CBS da NFS-e que está sendo emitida. |
servico[].ibscbs.valores.resumo.totalizador.ibs | object | Totalizador do IBS. |
servico[].ibscbs.valores.resumo.totalizador.ibs.valor | number | Amount total do IBS (municipal + state). |
servico[].ibscbs.valores.resumo.totalizador.ibs.valorDiferimentoMunicipal | number | Amount do diferimento do IBS Municipal. |
servico[].ibscbs.valores.resumo.totalizador.ibs.valorDiferimentoEstadual | number | Amount do diferimento do IBS Estadual. |
servico[].ibscbs.valores.resumo.totalizador.ibs.percentualCreditoPresumido | number | Percentual de crédito presumido do IBS. |
servico[].ibscbs.valores.resumo.totalizador.ibs.valorCreditoPresumido | number | Amount do crédito presumido do IBS. |
servico[].ibscbs.valores.resumo.totalizador.cbs | object | Totalizador da CBS. |
servico[].ibscbs.valores.resumo.totalizador.cbs.valorDiferimento | number | Amount do diferimento da CBS. |
servico[].ibscbs.valores.resumo.totalizador.cbs.percentualCreditoPresumido | number | Percentual de crédito presumido da CBS. |
servico[].ibscbs.valores.resumo.totalizador.cbs.valorCreditoPresumido | number | Amount do crédito presumido da CBS. |
servico[].ibscbs.valores.resumo.totalizador.regular | object | Valores da taxation regular. |
servico[].ibscbs.valores.resumo.totalizador.regular.aliquotaEfetivaEstadual | number | Rate efetiva state da taxation regular. |
servico[].ibscbs.valores.resumo.totalizador.regular.aliquotaEfetivaMunicipal | number | Rate efetiva municipal da taxation regular. |
servico[].ibscbs.valores.resumo.totalizador.regular.valorIbsMunicipal | number | Amount do IBS Municipal na taxation regular. |
servico[].ibscbs.valores.resumo.totalizador.regular.valorIbsEstadual | number | Amount do IBS Estadual na taxation regular. |
servico[].ibscbs.valores.resumo.totalizador.regular.aliquotaEfetivaCbs | number | Rate efetiva da CBS na taxation regular. |
servico[].ibscbs.valores.resumo.totalizador.regular.valorCbs | number | Amount da CBS na taxation regular. |
servico[].ibscbs.valores.resumo.totalizador.compraGovernamental | object | Valores específicos para compras governamentais. |
servico[].ibscbs.valores.resumo.totalizador.compraGovernamental.percentualIbsMunicipal | number | Percentual do IBS Municipal para compra governamental. |
servico[].ibscbs.valores.resumo.totalizador.compraGovernamental.valorIbsMunicipal | number | Amount do IBS Municipal para compra governamental. |
servico[].ibscbs.valores.resumo.totalizador.compraGovernamental.percentualIbsEstadual | number | Percentual do IBS Estadual para compra governamental. |
servico[].ibscbs.valores.resumo.totalizador.compraGovernamental.valorIbsEstadual | number | Amount do IBS Estadual para compra governamental. |
servico[].ibscbs.valores.resumo.totalizador.compraGovernamental.percentualCbs | number | Percentual da CBS para compra governamental. |
servico[].ibscbs.valores.resumo.totalizador.compraGovernamental.valorCbs | number | Amount da CBS para compra governamental. |
servico[].infExterior | object | Detalhamento das informações do exterior |
servico[].infExterior.modoPrestacao | number | Modo de Prestação: * `0` - Desconhecido (tipo não informado na nota de origem); * `1` - Transfronteiriço * `2` - Consumo no Brasil * `3` - Presença Comercial no Exterior * `4` - Movimento Temporário de Pessoas Físicas |
servico[].infExterior.vinculoPrestacao | number | Vínculo entre as partes no negócio: * `0` - Sem vínculo com o customer/Provider * `1` - Controlada * `2` - Controladora * `3` - Coligada * `4` - Matriz * `5` - Filial ou sucursal * `6` - Outro vínculo |
servico[].infExterior.tipoMoeda | string | Identifica a moeda da transação comercial. Deve-se informar o code da moeda |
servico[].infExterior.valorServicos | number | Amount do service prestado expresso em moeda estrangeira especificada em tpmoeda |
servico[].infExterior.tipoFomentoPrestador | string | Mecanismo de apoio/fomento ao Comércio Exterior utilizado pelo prestador do service: * 00 - Desconhecido (tipo não informado na nota de origem) * 01 - Nenhum * 02 - ACC - Adiantamento sobre Contrato de Câmbio – Redução a Zero do IR e do IOF * 03 - ACE – Adiantamento sobre Cambiais Entregues - R |
servico[].infExterior.tipoFomentoTomador | string | Mecanismo de apoio/fomento ao Comércio Exterior utilizado pelo customer do service: * 00 - Desconhecido (tipo não informado na nota de origem) * 01 - Nenhum * 02 - Adm. Pública e Repr. Internacional * 03 - Alugueis e Arrend. Mercantil de maquinas, equip., embarc. e aeronaves * 04 - Arrendamento |
servico[].infExterior.tipoMovimentacaoBens | number | Operação está vinculada à Movimentação Temporária de Bens: * `0` - Desconhecido (tipo não informado na nota de origem) * `1` - Não * `2` - Vinculada - Declaração de Importação * `3` - Vinculada - Declaração de Exportação |
servico[].infExterior.numeroDeclaracaoImp | string | Number da Declaração de Importação (DI/DSI/DA/DRI-E) |
servico[].infExterior.numeroRegistroExp | string | Number do Registro de Exportação (RE) |
servico[].infExterior.tipoMDIC | number | Compartilhar as informações da NFS-e gerada a partir desta DPS com a Secretaria de Comércio Exterior: * `0` - Não enviar para o MDIC * `1` - Enviar para o MDIC |
servico[].infExterior.categoriaServico | number | Categorias do service: * `1` - Locação * `2` - Sublocação * `3` - Arrendamento * `4` - Direito de passagem * `5` - Permissão de uso |
servico[].infExterior.tipoObjeto | number | Tipo de objetos da locação, sublocação, arrendamento, direito de passagem ou permissão de uso * `1` - Ferrovia * `2` - Rodovia * `3` - Postes * `4` - Cabos * `5` - Dutos * `6` - Condutos de qualquer natureza |
servico[].infExterior.extensaoObjeto | string | Extensão total da ferrovia, rodovia, cabos, dutos ou condutos |
servico[].infExterior.numeroPostes | number | Number total de postes |
envioPrioritario | boolean | Prioriza o envio da NFS-e em relação às demais notas que estão aguardando serem processadas na fila. Campo válido somente para cidades que controlam a sequência de RPS e que estejam com o envio em lote habilitado na API. |
deducao | array | — |
deducao[].forma | integer | Forma de dedução: * `1` - Percentual * `2` - Amount |
deducao[].tipo | integer | Tipo de dedução: * `1` - Despesas com Materiais * `2` - Despesas com Sub-empreitada |
deducao[].numeroNFReferencia | string | Number da Nota Fiscal de Referência. |
deducao[].dataNFReferencia | date | Data da issuance do documento dedutível. Ano, mês e dia (AAAA-MM-DD) |
deducao[].valorTotalReferencia | number | Amount total da Nota Fiscal de Referência. |
deducao[].percentualDeduzir | number | Percentual a Deduzir. |
deducao[].valorDeduzir | number | Amount a Deduzir. |
deducao[].razaoSocialReferencia | string | Razão social da Empresa. |
deducao[].cpfCnpjReferencia | string | Company CPF or CNPJ. |
deducao[].itens | array | Itens da Nota Fiscal de Referência |
deducao[].itens[].idItem | string | ID do item. |
deducao[].itens[].descricao | string | Description do item. |
deducao[].itens[].idUnidade | string | ID unidade de medida. |
deducao[].itens[].unidade | string | Description da unidade de medida. |
deducao[].itens[].quantidade | number | Quantity do item. |
deducao[].itens[].valor | number | Amount total do item. |
cargaTributaria | object | Detalhamento da carga tributária. |
cargaTributaria.fonte | string | Fonte da carga tributária. |
cargaTributaria.percentual | number | Percentual carga tributária. |
cargaTributaria.valor | number | Amount da carga tributária. |
beneficioMunicipal | object | Dados dos Benefícios Municipais |
beneficioMunicipal.numero | number | Identificador do benefício municipal parametrizado pelo municipality |
beneficioMunicipal.reducao | object | Dados para redução na Base de Cálculo. Enter apenas um entre amount ou valorPercentual. |
beneficioMunicipal.reducao.valor | number | Amount monetário informado pelo emitente para redução da base de cálculo (BC) do ISSQN devido a um Benefício Municipal (BM). Não informar junto com valorPercentual. |
beneficioMunicipal.reducao.valorPercentual | number | Amount percentual informado pelo emitente para redução da base de cálculo (BC) do ISSQN devido a um Benefício Municipal (BM). Não informar junto com amount. |
paisPrestacao | string | Code do pais (BACEN). Para o default Nacional, deve ser informado o code ISO de 2 dígitos, em vez do code BACEN. |
cidadePrestacao | object | Dados da city de prestação do service. |
cidadePrestacao.codigo | string | Code da city de prestação do service * Se não for preenchido, utilizaremos o code da city do prestador * Para exterior, informar 9999999 |
cidadePrestacao.descricao | string | Description da city de prestação do service |
cidadePrestacao.bairro | string | District name. |
cidadePrestacao.cep | string | CEP. |
cidadePrestacao.complemento | string | Complement. |
cidadePrestacao.estado | string AC · AL · AM · AP · BA · CE · DF · ES · GO · MA · MG · MS · MT · PA · PB · PE · PI · PR · RJ · RN · RO · RR · RS · SC · SE · SP · TO | Sigla do Estado |
cidadePrestacao.logradouro | string | Street. |
cidadePrestacao.numero | string | Street number. |
cidadePrestacao.tipoBairro | string Bairro · Bosque · Chácara · Conjunto · Desmembramento · Distrito · Favela · Fazenda · Gleba · Horto · Jardim · Loteamento · Núcleo · Parque · Residencial · Sítio · Tropical · Vila · Zona · Centro · Setor | *Tipo do district: * District * Bosque * Chácara * Conjunto * Desmembramento * Distrito * Favela * Fazenda * Gleba * Horto * Jardim * Loteamento * Núcleo * Parque * Residencial * Sítio * Tropical * Vila * Zona * Centro * Setor |
cidadePrestacao.tipoLogradouro | string Alameda · Avenida · Chácara · Colônia · Condomínio · Estância · Estrada · Fazenda · Praça · Prolongamento · Rodovia · Rua · Sítio · Travessa · Vicinal · Eqnp | *Used only for NFS-e* If sent on other documents, it does not generate an error. Tipo do street: * Alameda * Avenida * Chácara * Colônia * Condomínio * Eqnp * Estância * Estrada * Fazenda * Praça * Prolongamento * Rodovia * Rua * Sítio * Travessa * Vicin |
descricao | string | Description do RPS e services prestados. Usar o Pipe '|' para quebra de linha |
enviarEmail | boolean | Define se o PDF e o XML da NFSe serão enviados por email para o customer |
idNotaSubstituida | string | ID da nota que será substituída. |
impressao | object | — |
impressao.camposCustomizados | object | Campos customizados para impressão. Utilizado quando determinadas informações não são impressas por default no layout da NFSe. Estes campos podem mudar de acordo com a City Hall. |
impressao.camposCustomizados.inscricaoMunicipalTomador | string | IM do Customer |
camposPrefeitura | object | Campos personalizados para issuance. Este objeto contém os campos personalizados utilizados para gerar valores específicos na comunicação com a City Hall. Esses campos podem variar de acordo com o default ou municipality. |
camposPrefeitura.naturezaTributacao | string | — |
camposPrefeitura.codigoSubItemListaServico | string | — |
informacoesComplementares | string | Informações complementares a nota. |
intermediario | object | Dados do intermediário. |
intermediario.cpfCnpj | string | — |
intermediario.razaoSocial | string | — |
intermediario.inscricaoMunicipal | string | — |
intermediario.inscricaoEstadual | string | Registration state do intermediário. |
intermediario.endereco | object | Detalhamento do address. |
intermediario.endereco.bairro | object | district |
intermediario.endereco.bairro | bairro | Ref: district |
intermediario.endereco.cep | object | cep |
intermediario.endereco.cep | cep | Ref: cep |
intermediario.endereco.codigoCidade | object | codigoCidade |
intermediario.endereco.codigoCidade | codigoCidade | Ref: codigoCidade |
intermediario.endereco.estado | object | state |
intermediario.endereco.estado | estado | Ref: state |
intermediario.endereco.logradouro | object | street |
intermediario.endereco.logradouro | logradouro | Ref: street |
intermediario.endereco.numero | object | numero |
intermediario.endereco.numero | numero | Ref: numero |
intermediario.endereco.tipoLogradouro | object | tipoLogradouro |
intermediario.endereco.tipoLogradouro | tipoLogradouro | Ref: tipoLogradouro |
intermediario.endereco.codigoPais | object | codigoPais |
intermediario.endereco.codigoPais | codigoPais | Ref: codigoPais |
intermediario.endereco.complemento | object | complement |
intermediario.endereco.complemento | complemento | Ref: complement |
intermediario.endereco.descricaoCidade | object | descricaoCidade |
intermediario.endereco.descricaoCidade | descricaoCidade | Ref: descricaoCidade |
intermediario.endereco.descricaoPais | object | descricaoPais |
intermediario.endereco.descricaoPais | descricaoPais | Ref: descricaoPais |
intermediario.endereco.tipoBairro | object | tipoBairro |
intermediario.endereco.tipoBairro | tipoBairro | Ref: tipoBairro |
naturezaTributacao | number | Natureza da Taxation, valores aceitos: * `1` - Simples Nacional * `2` - Fixo * `3` - Depósito em Juízo * `4` - Enforceability suspensa por decisão judicial * `5` - Enforceability suspensa por procedimento administrativo * `6` - Isenção parcial |
regimeApuracaoTributaria | number | Regime de Apuração Tributária, valores aceitos: * `1` - Regime de apuração dos tributos federais e municipal pelo SN * `2` - Regime de apuração dos tributos federais pelo SN e ISSQN por fora do SN conforme respectiva legislação municipal do tributo * `3` - Regime de apuração dos tributos fede |
rps | object | Dados do RPS. |
rps.competencia | string | Competência |
rps.dataEmissao | string | Data de issuance do RPS. Se você não enviar o fuso-horário, vamos considerar que o horário está em -03:00, enviando isso na requisição para a City Hall. Caso opere com um fuso diferente, será necessário enviar em seu JSON. |
rps.dataVencimento | string | Se você não enviar o fuso-horário, vamos considerar que o horário está em -03:00. |
rps.serie | string | Série a ser utilizada para a numeração do RPS |
rps.numero | number | Number a ser utilizado para a numeração do RPS. Campo required apenas se a numeração automática estiver desativada. |
parcelas | array | Grupo de parcelas. Utilizado somente para os padrões: * BARUERISP * BETHA * INFISC * IPM * PUBLICA * SIL |
parcelas[].dataVencimento | string | Data de vencimento da parcela. |
parcelas[].numero | number | Number da parcela. |
parcelas[].tipoPagamento | number | Accepted values: * `1` À vista * `2` Apresentação * `3` Prazo * `4` Débito * `5` Crédito * `6` Boleto (Apenas Barueri) |
parcelas[].valor | number | Amount da parcela. |
despesas | array | Grupo de despesas. |
despesas[].data | string | Data da despesa. |
despesas[].valor | number | Amount da despesa. |
despesas[].descricao | string | Description da despesa. |
camposExtras | object | Grupo de campos adicionais. |
camposExtras.copiasEmail | array | Address(s) de e-mail para envio do XML e PDF. |
camposExtras.copiasEmail[] | string | — |
458 / 458
Routes
Issuance
Query
GET/nfse/{idNotaOrProtocol}Retrieve an invoice→GET/nfse/consultar/{idNotaOrProtocol}Retrieve an invoice summary→GET/nfse/consultar/{idIntegracao}/{cnpj}Retrieve an invoice summary by integration ID→GET/nfse/consultar/periodoList invoices by period→GET/nfse/historico/{idNota}Download the invoice history→GET/nfse/historico/{idIntegracao}/{cnpj}Download the invoice history→
PDF, XML, and email
GET/nfse/pdf/{idNota}Download the invoice PDF→POST/nfse/pdf/{idNota}Regenerate the invoice PDF by ID→POST/nfse/pdf/{idIntegracao}/{cnpj}Regenerate the invoice PDF by integration ID and CNPJ→GET/nfse/xml/{idNota}Download the invoice XML→POST/nfse/email/{idNota}Send email→GET/nfse/rps/pdf/{idNota}Download the provisional service receipt→GET/nfse/rps/pdf/{idIntegracao}/{cnpj}Download the provisional service receipt→
Cancellation
Customer and service
POST/nfse/tomadorRegister a customer→GET/nfse/tomador/{cpfCnpj}Retrieve a customer→PATCH/nfse/tomador/{cpfCnpj}Partially update a customer→PUT/nfse/tomador/{cpfCnpj}Replace a customer→DELETE/nfse/tomador/{cpfCnpj}Delete a customer→POST/nfse/servicoRegister a service→GET/nfse/servico/{idServico}Retrieve a service→PATCH/nfse/servico/{idServico}Update a service→DELETE/nfse/servico/{idServico}Delete a service→
Auxiliary operations
GET/nfse/cidadesList supported municipalities and metadata→GET/nfse/cidades/{codigoIbge}Check municipality availability and metadata→POST/nfse/resolve/{idNota}Resolve an invoice→POST/nfse/interromperInterrupt NFS-e processing→GET/nfse/interromper/status/{protocol}Check an NFS-e interruption request→POST/nfse/sincronizarResume NFS-e processing→GET/nfse/sincronizar/status/{protocol}Check an NFS-e sync request→GET/nfse/upload/{protocolo}Download the upload file→POST/nfse/governa/numeracao/Submit a Governa AIDF file→GET/nfse/governa/numeracao/{cnpj}/{protocolo}Check a Governa AIDF upload→