Servicios · municipio de São Paulo
NFS-e São Paulo
La NFS-e de São Paulo usa la ruta municipal `/nfse`. El contrato es el de la API de servicio; las reglas de ISS y TributacaoRPS siguen el estándar de la Prefectura.
Reglas específicas de São Paulo →Primera emisión en São Paulo
- 1Confirme que el municipio 3550308 está habilitado para la empresa.
- 2Registre el certificado digital cuando la Prefectura lo exija.
- 3Registre la empresa prestadora y active la NFS-e.
- 4Envíe el JSON con tomador, servicio e ISS. Use un `idIntegracao` único.
- 5Consulte `/nfse/consultar/{id}` o espere el webhook con el estado final.
Notas de operación
- El procesamiento depende de la disponibilidad del webservice de la Prefectura.
- Si el prestador nunca emitió por webservice, es habitual una homologación previa en São Paulo.
- El lote máximo es de 500 notas por solicitud.
- El campo `numero` en la consulta es el RPS enviado. `numeroNfse` es el número asignado por la Prefectura — trátalo como texto.
Cuerpo del envío
El POST `/nfse` recibe un array. Para São Paulo, informe el prestador, el tomador con dirección y el servicio con 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
}
}
]
}
]Diccionario de datos
Campos del JSON de emisión de la NFS-e.
| Campo | Tipo | Descripción |
|---|---|---|
idIntegracao | string | — |
modoEnvio | string | Modo de envio da emisión. * assincrono |
versao | string | Versão do esquema de envio. |
versaoEsquema | string | Versão de esquema a ser utilizada. **Valores aceptados:** * `RTC` (Reforma Tributária - IBS/CBS) * `RTC007` - Ativa o modelo NT007 para separação de apuração própria e retención de PIS/COFINS. **Quando usar:** * Informe `"versaoEsquema": "RTC"` quando quiser utilizar os campos da **Reforma Trib |
prestador obligatorio | object | Datos de la empresa emisora. |
prestador.cpfCnpj obligatorio | string | CPF o CNPJ de la empresa. |
prestador.codigoEstrangeiro | string | Identificação do Estrangeiro (Passaporte, etc.) |
prestador.endereco | object | Detalhamento do dirección. |
prestador.endereco.bairro obligatorio | string | Nombre del barrio. |
prestador.endereco.cep obligatorio | string | CEP. |
prestador.endereco.codigoCidade obligatorio | string | Código IBGE da ciudad. Caso NFSe para exterior: * Informar 9999999 |
prestador.endereco.estado obligatorio | 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 obligatorio | string | Vía. |
prestador.endereco.numero obligatorio | string | Número de la vía. |
prestador.endereco.tipoLogradouro obligatorio | 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 vía: * 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 | Código do pais. Para o predeterminado Nacional, deve ser informado o código ISO de 2 dígitos, em vez do código BACEN. |
prestador.endereco.complemento | string | Complemento. |
prestador.endereco.descricaoCidade | string | Nome da ciudad. |
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 barrio: * Barrio * 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 | Inscripción estadual do Emisor. Informe solo los dígitos, sin caracteres de formatação (ponto, barra, hífen, etc.). Na emisión de NF-e Avulsa pode ser informado o literal ISENTO para os contribuintes do ICMS isentos de inscripción no Cadastro de Contribuintes de ICMS. Em caso de nota conjugad |
prestador.inscricaoMunicipal | string | Inscripción municipal da empresa. Utilize pontuação quando necessário. Para emissões de NFS-e, este campo torna-se obligatorio. |
prestador.inscricaoEmitenteSuframa | string | Inscripción do emitente da Suframa. Informar o número do Cadastro do emitente na Suframa. Campo obligatorio nas operações que se beneficiam de incentivos fiscais existentes nas áreas sob controle da SUFRAMA com alícuota 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) Nota: **Ao preencher com o valor 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 | teléfono |
prestador.telefone.numero obligatorio | string | Número de teléfono |
prestador.telefone.ddd | string | DDD |
prestador.codigoDistrito | integer | Código da Localidade (usado no predeterminado 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 tomador/destinatario. |
tomador.cpfCnpj | string | CPF ou CNPJ do tomador/destinatario. Obs: Si se informa codigoIdentificacaoDestino = 3 esse campo nao deve ser informado. |
tomador.razaoSocial | string | Razão social do tomador/destinatario. |
tomador.endereco | object | Detalhamento do dirección. |
tomador.endereco.bairro | string | Nombre del barrio. |
tomador.endereco.cep | string | CEP. |
tomador.endereco.codigoCidade | string | Código IBGE da ciudad. 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 | Vía. |
tomador.endereco.numero | string | Número de la vía. |
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 vía: * 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 | Código do pais (BACEN). Para o predeterminado Nacional, deve ser informado o código ISO de 2 dígitos, em vez do código BACEN. |
tomador.endereco.complemento | string | Complemento. |
tomador.endereco.descricaoCidade | string | Nome da ciudad. |
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 barrio: * Barrio * 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 | Dirección de email do tomador/destinatario. Para municípios que aceitam mais de um email do tomador no XML de **NFS-e**, enviá-los separados por ponto e vírgula (**;**). Exemplo: tomador1@a API.com;tomador2@a API.com |
tomador.inscricaoEstadual | string | Inscripción estadual do tomador/destinatario. |
tomador.inscricaoMunicipal | string | Inscripción municipal do tomador/destinatario. |
tomador.nomeFantasia | string | Nome fantasia do tomador/destinatario. |
tomador.orgaoPublico | boolean | **Solo para NFS-e** Si se informa en otros documentos, no genera ningún error. Sinaliza se o Tomador do servicio é um orgão público. |
tomador.telefone | object | teléfono |
tomador.telefone | telefone | Ref: teléfono |
tomador.codigoEstrangeiro | string | Identificação do Estrangeiro (Passaporte, etc.) |
tomador.nif | string | NIF do tomador. |
tomador.naoNif | string | **Solo para tomador extranjero del estándar nacional** Motivo para no informarção do NIF: * `0` - Não informado na nota de origem * `1` - Dispensado do NIF * `2` - Não exigência do NIF |
servico obligatorio | array | — |
servico[].codigo obligatorio | string | Código de servicio, también conocido como código de ítem de la lista de servicioegue a LC116, podendo váriar de acordo com a Prefectura. Você pode encontrar esse dado no portal da Prefectura, em uma nota emitida, ou junto ao contador. |
servico[].codigoContribuinte | string | Código interno do contribuinte. |
servico[].idIntegracao | string | Código EXTERNO de integração do servicio. Utilizado **SOMENTE** quando se cadastra previamente um servicio. |
servico[].discriminacao obligatorio | string | Detalle del servicio prestado. |
servico[].codigoTributacao | string | Código tributación no Municipio |
servico[].cnae | string | O código 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 | Código NBS (Nomenclatura Brasileira de Serviços, Intangíveis e outras Operações que produzam Variações no Patrimônio) correspondente ao servicio prestado. Consulte valores aceitos através do link. |
servico[].codigoServicoNacional | string | Código Servicio Nacional |
servico[].codigoCidadeIncidencia | string | Código IBGE da ciudad de incidência do ISS. |
servico[].descricaoCidadeIncidencia | string | Nome da ciudad de incidência do ISS. |
servico[].unidade | string | Unidade do servicio prestado. |
servico[].quantidade | number | Cantidad dos servicios prestados. |
servico[].iss obligatorio | object | Detalle del ISS. |
servico[].iss.tipoTributacao | integer 0 · 1 · 2 · 3 · 4 · 5 · 6 · 7 · 8 | Tipo de Tributación do Servicio, valores: * `0` - Não definido * `1` - Isento de ISS * `2` - Imune * `3` - Não Incidência no Municipio * `4` - Não Tributável * `5` - Retido * `6` - Tributável Dentro do Municipio * `7` - Tributável Fora do Municipio * `8` - Tributável Dentro do Municí |
servico[].iss.tipoRetencao | integer 1 · 2 · 3 | Tipo de Retención do Iss, valores: * `1` - Não Retido * `2` - Retido pelo Tomador * `3` - Retido pelo Intermediário |
servico[].iss.exigibilidade | integer 1 · 2 · 3 · 4 · 5 · 6 · 7 | Exigibilidad 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 obligatorio | number | Alícuota do ISS do servicio prestado. Você pode encontrar esse dado no portal da Prefectura, ou junto ao contador. |
servico[].iss.valor | number | Valor do ISS, caso você não informe esse campo, vamos calcular automáticamente. |
servico[].iss.valorRetido | number | Valor ISS retenido, caso você não informe esse campo, vamos calcular automáticamente. |
servico[].iss.processoSuspensao | string | Número do Processo de Suspensão da Exigibilidad |
servico[].iss.situacaoTributaria | integer 0 · 1 · 2 · 3 · 4 · 5 · 6 · 7 · 8 · 9 · 10 · 15 | Código da Situação Tributária para IPM20. Valores aceptados: * `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 | Inscripción imobiliária fiscal (código fornecido pela Prefectura Municipal para a identificação da obra ou para fins de recolhimento do IPTU) |
servico[].obra.art | string | Código da ART. |
servico[].obra.codigo | string | Código da obra (CO). |
servico[].obra.cei | string | Cadastro específico do INSS. |
servico[].obra.opcao | string | — |
servico[].obra.inf | string | — |
servico[].obra.inscricaoImobFisc | string | Inscripción imobiliária fiscal (código fornecido pela Prefectura Municipal para a identificação da obra ou para fins de recolhimento do IPTU) |
servico[].obra.endereco | object | Grupo de informações do dirección da obra. |
servico[].obra.endereco.bairro | object | barrio |
servico[].obra.endereco.cep | object | cep |
servico[].obra.endereco.codigoCidade | object | codigoCidade |
servico[].obra.endereco.estado | object | estado |
servico[].obra.endereco.logradouro | object | vía |
servico[].obra.endereco.numero | object | numero |
servico[].obra.endereco.tipoLogradouro | object | tipoLogradouro |
servico[].obra.endereco.codigoPais | object | codigoPais |
servico[].obra.endereco.complemento | object | complemento |
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 (código identificador de evento determinado pela Administração Tributária Municipal) |
servico[].evento.descricao | string | Descripción 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 dirección |
servico[].evento.endereco.bairro | object | barrio |
servico[].evento.endereco.bairro | bairro | Ref: barrio |
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 | estado |
servico[].evento.endereco.estado | estado | Ref: estado |
servico[].evento.endereco.logradouro | object | vía |
servico[].evento.endereco.logradouro | logradouro | Ref: vía |
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 | complemento |
servico[].evento.endereco.complemento | complemento | Ref: complemento |
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 obligatorio | object | — |
servico[].valor.servico obligatorio | number | Valor bruto do servicio prestado. |
servico[].valor.baseCalculo | number | Valor da base de cálculo dos impostos. |
servico[].valor.deducoes | number | Valor deduções. |
servico[].valor.descontoCondicionado | number | Valor do descuento condicionado. |
servico[].valor.descontoIncondicionado | number | Valor do descuento incondicionado. |
servico[].valor.liquido | number | Valor liquido do servicio, caso você não informe esse campo, vamos calcular automáticamente. |
servico[].valor.unitario | number | Valor unitário do servicio, referente a unidade informada. |
servico[].valor.ipi | number | Valor 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 | Descripción da dedução. |
servico[].retencao | object | Detalhamento das retenções. Este grupo possui **dois comportamentos**, conforme o emissor/ciudad: **1) Legado (demais emissores, enquanto não adotarem NT007):** - `pis.retenido` e `cofins.retenido` controlam se há retención. - `pis.valor` e `cofins.valor` representam os valores retenidos 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.retenido` e `cofins.retenido`. Tipo de retención 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 | Código de Situação Tributária do PIS (CST). Comportamentos: - **Legado (demais emissores):** pode haver aceitação parcial da tabela (comum: `00` a `09`), conforme regras da Prefectura/predeterminado. - **NT007 (NFSe Nacional e emissores aderentes):** segue a tabela nacional abaixo. Valores aceptados: * `0 |
servico[].retencao.pis.baseCalculo | number | Base de cálculo do PIS. - **Legado:** base de cálculo para PIS retenido. - **NT007:** base de cálculo para liquidación propia de PIS (`vPis`). * Caso não informada, será utilizado o valor da base de cálculo do servicio. |
servico[].retencao.pis.retido | boolean | Reter PIS no comportamento legado. ⚠️ **NT007:** este campo é ignorado; utilize `tipoRetencaoPisCofinsCSLL`. |
servico[].retencao.pis.aliquota | number | Alícuota do PIS. - **Legado:** alícuota de PIS retenido. - **NT007:** alícuota de PIS para liquidación propia (`vPis`). |
servico[].retencao.pis.valor | number | Valor de PIS. - **Legado:** valor do PIS retenido (caso não informado, pode ser calculado automaticamente). - **NT007:** valor do PIS para liquidación propia (`vPis`). Se houver retención de PIS, informe o valor retenido agregado em `csll.valor` 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 | Código de Situação Tributária do COFINS (CST). Comportamentos: - **Legado (demais emissores):** pode haver aceitação parcial da tabela (comum: `00` a `09`), conforme regras da Prefectura/predeterminado. - **NT007 (NFSe Nacional e emissores aderentes):** segue a tabela nacional abaixo. Valores aceptados: * |
servico[].retencao.cofins.baseCalculo | number | Base de cálculo do COFINS. - **Legado:** base de cálculo para COFINS retenido. - **NT007:** base de cálculo para liquidación propia de COFINS (`vCofins`). * Caso não informada, será utilizado o valor da base de cálculo do servicio. |
servico[].retencao.cofins.retido | boolean | Reter COFINS no comportamento legado. ⚠️ **NT007:** este campo é ignorado; utilize `tipoRetencaoPisCofinsCSLL`. |
servico[].retencao.cofins.aliquota | number | Alícuota do COFINS. - **Legado:** alícuota de COFINS retenido. - **NT007:** alícuota de COFINS para liquidación propia (`vCofins`). |
servico[].retencao.cofins.valor | number | Valor de COFINS. - **Legado:** valor do COFINS retenido (caso não informado, pode ser calculado automaticamente). - **NT007:** valor do COFINS para liquidación propia (`vCofins`). Se houver retención de COFINS, informe o valor retenido agregado em `csll.valor` conforme `tipoRetencaoPisCofinsCSLL`. |
servico[].retencao.csll | object | — |
servico[].retencao.csll.aliquota | number | Aliquota CSLL retenido. |
servico[].retencao.csll.baseCalculo | number | Base de cálculo da CSLL retida. * Caso não informada, será utilizado o valor da base de cálculo do servicio. |
servico[].retencao.csll.valor | number | Valor de CSLL. - **Legado:** valor da CSLL retida (caso não informado, pode ser calculado automaticamente). - **NT007:** valor agregado das retenções sociais (`vRetCSLL`), somando CSLL retida e também PIS/COFINS retenidos conforme `tipoRetencaoPisCofinsCSLL`. |
servico[].retencao.inss | object | — |
servico[].retencao.inss.aliquota | number | Alícuota INSS retenido. |
servico[].retencao.inss.baseCalculo | number | Base de cálculo do INSS retenido. * Caso não informada, será utilizado o valor da base de cálculo do servicio. |
servico[].retencao.inss.valor | number | Valor INSS retenido, caso você não informe esse campo, vamos calcular automáticamente. |
servico[].retencao.irrf | object | — |
servico[].retencao.irrf.aliquota | number | Alícuota IR retenido. |
servico[].retencao.irrf.baseCalculo | number | Base de cálculo do IR retenido. * Caso não informada, será utilizado o valor da base de cálculo do servicio. |
servico[].retencao.irrf.valor | number | Valor IR retenido, caso você não informe esse campo, vamos calcular automáticamente. |
servico[].retencao.outrasRetencoes | number | Valor de outras retenções. |
servico[].retencao.cpp | object | — |
servico[].retencao.cpp.aliquota | number | Alícuota CPP retenido. |
servico[].retencao.cpp.baseCalculo | number | Base de cálculo do CPP retenido. * Caso não informada, será utilizado o valor da base de cálculo do servicio. |
servico[].retencao.cpp.valor | number | Valor CPP retenido, caso você não informe 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 retención (que deduz o valor líquido da nota), a apuração própria representa o débito tributário do próprio prestador - não impacta o valor 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 | Código de Situação Tributária do PIS/COFINS (CST). Default: `"00"` (Nenhum) quando não informado. Valores aceptados: * `00` - Nenhum * `01` - Operação Tributável com Alícuota Básica * `02` - Operação Tributável com Alícuota Diferenciada * `03` - Operação Tributável com Alícuota por Unidade d |
servico[].apuracaoPropria.baseCalculoPisCofins | number | Base de cálculo da apuração própria (R$). Caso não informada, será utilizado o valor do servicio. |
servico[].apuracaoPropria.pis | object | PIS - apuração própria do prestador. |
servico[].apuracaoPropria.pis.aliquota | number | Alícuota do PIS para liquidación propia (%). |
servico[].apuracaoPropria.pis.valor | number | Valor 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 | Alícuota da COFINS para liquidación propia (%). |
servico[].apuracaoPropria.cofins.valor | number | Valor 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 | Descripción do objeto de locação |
servico[].locacao.quantidade | number | Cantidad de objetos de locação |
servico[].tributacaoTotal | object | Valor total aproximado das tributações |
servico[].tributacaoTotal.aliquotaSimplesNacional | number | Valor percentual aproximado do total dos tributos da alícuota do Simples Nacional |
servico[].tributacaoTotal.federal | object | — |
servico[].tributacaoTotal.federal.valor | number | Valor total aproximado dos tributos federais |
servico[].tributacaoTotal.federal.valorPercentual | number | Decimal percentual do tributo federal aplicado sobre o servicio |
servico[].tributacaoTotal.estadual | object | — |
servico[].tributacaoTotal.estadual.valor | number | Valor total aproximado dos tributos estaduais |
servico[].tributacaoTotal.estadual.valorPercentual | number | Decimal percentual do tributo estadual aplicado sobre o servicio |
servico[].tributacaoTotal.municipal | object | — |
servico[].tributacaoTotal.municipal.valor | number | Valor total aproximado dos tributos municipais |
servico[].tributacaoTotal.municipal.valorPercentual | number | Decimal percentual do tributo municipal aplicado sobre o servicio |
servico[].tributavel | boolean | Indica se o servicio está sujeito a tributación. |
servico[].ibpt | object | Gera automaticamente uma mensagem com o valor total dos tributos, junto a discriminação do servicio. |
servico[].ibpt.simplificado | object | — |
servico[].ibpt.simplificado.aliquota | number | Alícuota geral de impostos. |
servico[].ibpt.detalhado | object | — |
servico[].ibpt.detalhado.aliquota | object | — |
servico[].ibpt.detalhado.aliquota.municipal | number | Alícuota municipal de impostos. |
servico[].ibpt.detalhado.aliquota.estadual | number | Alícuota estadual de impostos. |
servico[].ibpt.detalhado.aliquota.federal | number | Alícuota federal de impostos. |
servico[].responsavelRetencao | string | Valores aceptados: * `1` - Tomador * `2` - Intermediário Caso o responsável pela retención seja o próprio prestador, no generar o campo. |
servico[].ibscbs | object | Grupo de tributación do Impuesto 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 emisión de NFS-e * `0` - Normal; |
servico[].ibscbs.operacaoPessoal | number | Indica se é operação pessoal. * `0` - Não; * `1` - Sim; |
servico[].ibscbs.codigoOperacao | string | Código indicador da operação de fornecimento, conforme tabela 'código indicador de operação'. |
servico[].ibscbs.tipoOperacao | number | Tipo de Operação com Entes Governamentais ou outros servicios 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` – Municipio |
servico[].ibscbs.descTipoEnteGovernamental | string | Descripción 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 | Municipio de incidência do IBS CBS. Para a ciudad 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 Destinatario. |
servico[].ibscbs.destinatario.indicador | number | Indicador do destinatario. * `0` – o destinatario é o próprio tomador/adquirente identificado na NFS-e (default); * `1` – o destinatario não é o próprio adquirente, podendo ser outra pessoa, física ou jurídica, ou um estabelecimento diferente do indicado como tomador (obs.: caso seja informado 1, o |
servico[].ibscbs.destinatario.cpfCnpj | string | CNPJ ou CPF do destinatario. |
servico[].ibscbs.destinatario.codigoEstrangeiro | string | Código de identificação de estrangeiro do destinatario. |
servico[].ibscbs.destinatario.nif | number | Tipo NIF (Número de Identificação Fiscal) - fornecido por um órgão de administração tributária no exterior. |
servico[].ibscbs.destinatario.naoNif | number | Motivo para no informarçã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 destinatario. |
servico[].ibscbs.destinatario.endereco | object | Grupo de informações do dirección do destinatario. |
servico[].ibscbs.destinatario.endereco.codigoCidade obligatorio | number | Código IBGE da ciudad do destinatario. |
servico[].ibscbs.destinatario.endereco.cep obligatorio | string | CEP do dirección do destinatario. |
servico[].ibscbs.destinatario.endereco.codigoPais | string | Código do país do destinatario. |
servico[].ibscbs.destinatario.endereco.codigoPostalExterior | string | Código de endereçamento postal exterior. |
servico[].ibscbs.destinatario.endereco.estadoProvinciaRegiao | string | Estado, província ou região da ciudad no exterior. |
servico[].ibscbs.destinatario.endereco.descricaoCidade | string | Descripción da ciudad do destinatario. |
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 destinatario. |
servico[].ibscbs.destinatario.endereco.logradouro obligatorio | string | Vía do destinatario. |
servico[].ibscbs.destinatario.endereco.numero obligatorio | string | Número do vía do destinatario. |
servico[].ibscbs.destinatario.endereco.complemento | string | Complemento do dirección do destinatario. |
servico[].ibscbs.destinatario.endereco.bairro | string | Barrio do dirección do destinatario. |
servico[].ibscbs.destinatario.telefone | object | Grupo de informações do teléfono do destinatario. |
servico[].ibscbs.destinatario.telefone.ddd | number | DDD do teléfono do destinatario. |
servico[].ibscbs.destinatario.telefone.numero | number | Número do teléfono do destinatario. |
servico[].ibscbs.destinatario.email | string | Email do destinatario. |
servico[].ibscbs.imovel | object | Grupo de informações de operações relacionadas a bens imóveis. |
servico[].ibscbs.imovel.inscricaoFiscal | string | Inscripción imobiliária fiscal do imóvel. |
servico[].ibscbs.imovel.codigoCIB | string | Código do Cadastro Imobiliário Brasileiro (CIB) do imóvel. |
servico[].ibscbs.imovel.codigoObra | string | Código da obra do imóvel. |
servico[].ibscbs.imovel.endereco | object | Grupo de informações do dirección do imóvel. |
servico[].ibscbs.imovel.endereco.codigoCidade obligatorio | number | Código IBGE da ciudad do destinatario. |
servico[].ibscbs.imovel.endereco.cep obligatorio | string | CEP do imóvel. |
servico[].ibscbs.imovel.endereco.descricaoCidade obligatorio | string | Nome da ciudad do imóvel. |
servico[].ibscbs.imovel.endereco.estado obligatorio | 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 obligatorio | string | Vía do imóvel. |
servico[].ibscbs.imovel.endereco.numero obligatorio | string | Número do vía do imóvel. |
servico[].ibscbs.imovel.endereco.complemento | string | Complemento do imóvel. |
servico[].ibscbs.imovel.endereco.bairro obligatorio | string | Barrio do imóvel. |
servico[].ibscbs.valores | object | Grupo de informações relativas aos valores do servicio prestado para IBS e CBS |
servico[].ibscbs.valores.baseCalculo | number | Base de cálculo do IBS e CBS. |
servico[].ibscbs.valores.aliquotaIbsMunicipal | number | Alícuota do IBS Municipal. |
servico[].ibscbs.valores.aliquotaIbsEstadual | number | Alícuota do IBS Estadual. |
servico[].ibscbs.valores.aliquotaCbs | number | Alícuota da CBS. |
servico[].ibscbs.valores.valorIbsMunicipal | number | Valor do IBS Municipal. |
servico[].ibscbs.valores.valorIbsEstadual | number | Valor do IBS Estadual. |
servico[].ibscbs.valores.valorCbs | number | Valor 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 | Descripción 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 | Código IBGE da ciudad emissora. |
servico[].ibscbs.valores.operacao.documentosReferenciados[].fiscal.numero | string | Número do documento fiscal. |
servico[].ibscbs.valores.operacao.documentosReferenciados[].fiscal.descricao | string | Descripción 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 | Número do documento não fiscal. |
servico[].ibscbs.valores.operacao.documentosReferenciados[].naoFiscal.descricao | string | Descripción 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 | Código de identificação de estrangeiro do fornecedor. |
servico[].ibscbs.valores.operacao.documentosReferenciados[].fornecedor.nif | number | NIF (Número de Identificação Fiscal) do fornecedor. |
servico[].ibscbs.valores.operacao.documentosReferenciados[].fornecedor.naoNif | number | Motivo para no informarçã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 dirección do fornecedor. |
servico[].ibscbs.valores.operacao.documentosReferenciados[].dataEmissao | string | Data de emisión 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 valor 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 | Descripción 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 | Valor 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 | Código de Situação Tributária (CST). |
servico[].ibscbs.valores.tributacao.cct | string | Código de Classificação de Tributación (CCT). |
servico[].ibscbs.valores.tributacao.codigoCreditoPresumido | string | Código e classificação do crédito presumido. |
servico[].ibscbs.valores.tributacao.regular | object | Grupo de informações da Tributación Regular |
servico[].ibscbs.valores.tributacao.regular.cst | string | Código de Situação Tributária (CST) de tributación regular. |
servico[].ibscbs.valores.tributacao.regular.cct | string | Código de Classificação de Tributación (CCT) de tributación 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 estadual. |
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 | Alícuota 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 | Alícuota 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 | Alícuota 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 | Valor total consolidado do IBS e CBS. |
servico[].ibscbs.valores.resumo.totalizador.percentualReducaoIbsCbs | number | Percentual de redução de alícuota em compra governamental. |
servico[].ibscbs.valores.resumo.totalizador.valorDeducoesIbsCbs | number | Valor 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 | Valor total do IBS (municipal + estadual). |
servico[].ibscbs.valores.resumo.totalizador.ibs.valorDiferimentoMunicipal | number | Valor do diferimento do IBS Municipal. |
servico[].ibscbs.valores.resumo.totalizador.ibs.valorDiferimentoEstadual | number | Valor 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 | Valor do crédito presumido do IBS. |
servico[].ibscbs.valores.resumo.totalizador.cbs | object | Totalizador da CBS. |
servico[].ibscbs.valores.resumo.totalizador.cbs.valorDiferimento | number | Valor 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 | Valor do crédito presumido da CBS. |
servico[].ibscbs.valores.resumo.totalizador.regular | object | Valores da tributación regular. |
servico[].ibscbs.valores.resumo.totalizador.regular.aliquotaEfetivaEstadual | number | Alícuota efetiva estadual da tributación regular. |
servico[].ibscbs.valores.resumo.totalizador.regular.aliquotaEfetivaMunicipal | number | Alícuota efetiva municipal da tributación regular. |
servico[].ibscbs.valores.resumo.totalizador.regular.valorIbsMunicipal | number | Valor do IBS Municipal na tributación regular. |
servico[].ibscbs.valores.resumo.totalizador.regular.valorIbsEstadual | number | Valor do IBS Estadual na tributación regular. |
servico[].ibscbs.valores.resumo.totalizador.regular.aliquotaEfetivaCbs | number | Alícuota efetiva da CBS na tributación regular. |
servico[].ibscbs.valores.resumo.totalizador.regular.valorCbs | number | Valor da CBS na tributación 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 | Valor 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 | Valor 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 | Valor 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 tomador/Prestador * `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 código da moeda |
servico[].infExterior.valorServicos | number | Valor do servicio prestado expresso em moeda estrangeira especificada em tpmoeda |
servico[].infExterior.tipoFomentoPrestador | string | Mecanismo de apoio/fomento ao Comércio Exterior utilizado pelo prestador do servicio: * 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 tomador do servicio: * 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 | Número da Declaração de Importação (DI/DSI/DA/DRI-E) |
servico[].infExterior.numeroRegistroExp | string | Número 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 servicio: * `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 | Número 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` - Valor |
deducao[].tipo | integer | Tipo de dedução: * `1` - Despesas com Materiais * `2` - Despesas com Sub-empreitada |
deducao[].numeroNFReferencia | string | Número da Nota Fiscal de Referência. |
deducao[].dataNFReferencia | date | Data da emisión do documento dedutível. Ano, mês e dia (AAAA-MM-DD) |
deducao[].valorTotalReferencia | number | Valor total da Nota Fiscal de Referência. |
deducao[].percentualDeduzir | number | Percentual a Deduzir. |
deducao[].valorDeduzir | number | Valor a Deduzir. |
deducao[].razaoSocialReferencia | string | Razão social da Empresa. |
deducao[].cpfCnpjReferencia | string | CPF o CNPJ de la empresa. |
deducao[].itens | array | Itens da Nota Fiscal de Referência |
deducao[].itens[].idItem | string | ID do item. |
deducao[].itens[].descricao | string | Descripción do item. |
deducao[].itens[].idUnidade | string | ID unidade de medida. |
deducao[].itens[].unidade | string | Descripción da unidade de medida. |
deducao[].itens[].quantidade | number | Cantidad do item. |
deducao[].itens[].valor | number | Valor 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 | Valor da carga tributária. |
beneficioMunicipal | object | Dados dos Benefícios Municipais |
beneficioMunicipal.numero | number | Identificador do benefício municipal parametrizado pelo municipio |
beneficioMunicipal.reducao | object | Dados para redução na Base de Cálculo. Informe apenas um entre valor ou valorPercentual. |
beneficioMunicipal.reducao.valor | number | Valor 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 | Valor 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 valor. |
paisPrestacao | string | Código do pais (BACEN). Para o predeterminado Nacional, deve ser informado o código ISO de 2 dígitos, em vez do código BACEN. |
cidadePrestacao | object | Dados da ciudad de prestação do servicio. |
cidadePrestacao.codigo | string | Código da ciudad de prestação do servicio * Se não for preenchido, utilizaremos o código da ciudad do prestador * Para exterior, informar 9999999 |
cidadePrestacao.descricao | string | Descripción da ciudad de prestação do servicio |
cidadePrestacao.bairro | string | Nombre del barrio. |
cidadePrestacao.cep | string | CEP. |
cidadePrestacao.complemento | string | Complemento. |
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 | Vía. |
cidadePrestacao.numero | string | Número de la vía. |
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 barrio: * Barrio * 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 | *Usado solo para NFS-e* Si se informa en otros documentos, no genera ningún error. Tipo do vía: * Alameda * Avenida * Chácara * Colônia * Condomínio * Eqnp * Estância * Estrada * Fazenda * Praça * Prolongamento * Rodovia * Rua * Sítio * Travessa * Vicin |
descricao | string | Descripción do RPS e servicios 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 tomador |
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 predeterminado no layout da NFSe. Estes campos podem mudar de acordo com a Prefectura. |
impressao.camposCustomizados.inscricaoMunicipalTomador | string | IM do Tomador |
camposPrefeitura | object | Campos personalizados para emisión. Este objeto contém os campos personalizados utilizados para gerar valores específicos na comunicação com a Prefectura. Esses campos podem variar de acordo com o predeterminado ou municipio. |
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 | Inscripción estadual do intermediário. |
intermediario.endereco | object | Detalhamento do dirección. |
intermediario.endereco.bairro | object | barrio |
intermediario.endereco.bairro | bairro | Ref: barrio |
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 | estado |
intermediario.endereco.estado | estado | Ref: estado |
intermediario.endereco.logradouro | object | vía |
intermediario.endereco.logradouro | logradouro | Ref: vía |
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 | complemento |
intermediario.endereco.complemento | complemento | Ref: complemento |
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 Tributación, valores aceitos: * `1` - Simples Nacional * `2` - Fixo * `3` - Depósito em Juízo * `4` - Exigibilidad suspensa por decisão judicial * `5` - Exigibilidad 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 emisión 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 Prefectura. 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 | Número a ser utilizado para a numeração do RPS. Campo obligatorio 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 | Número da parcela. |
parcelas[].tipoPagamento | number | Valores aceptados: * `1` À vista * `2` Apresentação * `3` Prazo * `4` Débito * `5` Crédito * `6` Boleto (Apenas Barueri) |
parcelas[].valor | number | Valor da parcela. |
despesas | array | Grupo de despesas. |
despesas[].data | string | Data da despesa. |
despesas[].valor | number | Valor da despesa. |
despesas[].descricao | string | Descripción da despesa. |
camposExtras | object | Grupo de campos adicionais. |
camposExtras.copiasEmail | array | Dirección(s) de e-mail para envio do XML e PDF. |
camposExtras.copiasEmail[] | string | — |
458 / 458
Rutas
Emisión
Consulta
GET/nfse/{idNotaOrProtocol}Consultar una nota→GET/nfse/consultar/{idNotaOrProtocol}Consultar el resumen de la nota→GET/nfse/consultar/{idIntegracao}/{cnpj}Consultar el resumen por ID de integración→GET/nfse/consultar/periodoConsultar notas por período→GET/nfse/historico/{idNota}Descargar el historial de la nota→GET/nfse/historico/{idIntegracao}/{cnpj}Descargar el historial de la nota→
PDF, XML y correo
GET/nfse/pdf/{idNota}Descargar el PDF de la nota→POST/nfse/pdf/{idNota}Regenerar el PDF de la nota por ID→POST/nfse/pdf/{idIntegracao}/{cnpj}Regenerar el PDF por ID de integración y CNPJ→GET/nfse/xml/{idNota}Descargar el XML de la nota→POST/nfse/email/{idNota}Enviar correo→GET/nfse/rps/pdf/{idNota}Descargar el Recibo Provisorio de Servicio→GET/nfse/rps/pdf/{idIntegracao}/{cnpj}Descargar el Recibo Provisorio de Servicio→
Cancelación
Tomador y servicio
POST/nfse/tomadorRegistrar un tomador→GET/nfse/tomador/{cpfCnpj}Consultar un tomador→PATCH/nfse/tomador/{cpfCnpj}Actualizar un tomador parcialmente→PUT/nfse/tomador/{cpfCnpj}Reemplazar un tomador→DELETE/nfse/tomador/{cpfCnpj}Eliminar un tomador→POST/nfse/servicoRegistrar un servicio→GET/nfse/servico/{idServico}Consultar un servicio→PATCH/nfse/servico/{idServico}Actualizar un servicio→DELETE/nfse/servico/{idServico}Eliminar un servicio→
Operaciones auxiliares
GET/nfse/cidadesListar municipios atendidos y metadatos→GET/nfse/cidades/{codigoIbge}Consultar disponibilidad del municipio y metadatos→POST/nfse/resolve/{idNota}Resolver una nota→POST/nfse/interromperInterrumpir el procesamiento de NFS-e→GET/nfse/interromper/status/{protocol}Consultar el estado de una interrupción de NFS-e→POST/nfse/sincronizarReanudar el procesamiento de NFS-e→GET/nfse/sincronizar/status/{protocol}Consultar el estado de una sincronización de NFS-e→GET/nfse/upload/{protocolo}Descargar el archivo de upload→POST/nfse/governa/numeracao/Enviar un archivo AIDF estándar Governa→GET/nfse/governa/numeracao/{cnpj}/{protocolo}Consultar el envío de un archivo AIDF Governa→