Matriz de cenários de emissão de NFS-e
Índice dos 32 cenários de emissão. Cada um é o payload base abaixo + os campos do seu eixo.
Payload base (tomador completo)
Padrão recomendado: os obrigatórios + o tomador completo com endereço (a plataforma calcula os impostos automaticamente, mas não completa o endereço do tomador):
{
"borrower": {
"type": "LegalEntity",
"name": "EMPRESA TOMADORA EXEMPLO LTDA",
"federalTaxNumber": 11222333000181,
"email": "contato@exemplo.com.br",
"address": {
"country": "BRA",
"postalCode": "01311-000",
"street": "Avenida Paulista",
"number": "1000",
"district": "Bela Vista",
"city": {
"code": "3550308",
"name": "São Paulo"
},
"state": "SP"
}
},
"cityServiceCode": "4444",
"description": "Serviço de consultoria (cenário exemplo).",
"servicesAmount": 1000.0
}
CNPJ/CPF dos exemplos têm dígito verificador válido e os códigos de cidade são IBGE reais. Substitua pelos dados reais da sua operação. issRate/taxationType são opcionais (padrão: cálculo automático).
Os 32 cenários
| Cenário | Guia |
|---|---|
| Emissão padrão (tomador completo) | Por regime e tomador |
| Tomador pessoa física (CPF) | Por regime e tomador |
| Tomador pessoa jurídica (CNPJ) | Por regime e tomador |
| IBS/CBS com cálculo automático (payload mínimo) | Reforma Tributária (IBS/CBS) |
| IBS/CBS regime geral (com valores) | Reforma Tributária (IBS/CBS) |
| IBS/CBS compra governamental | Reforma Tributária (IBS/CBS) |
| Cálculo manual do ISS (issRate) | ISS e local de prestação |
| ISS isento | ISS e local de prestação |
| ISS imune | ISS e local de prestação |
| ISS com exigibilidade suspensa | ISS e local de prestação |
| Informar local de prestação | ISS e local de prestação |
| Serviço prestado fora do município | ISS e local de prestação |
| Três municípios | ISS e local de prestação |
| Retenção de IRRF | Retenções |
| ISS retido pelo tomador | Retenções |
| Retenção de PIS/COFINS/CSLL | Retenções |
| Retenção de INSS | Retenções |
| Retenção plena (ISS + federais) | Retenções |
| Evento | Tipos de atividade |
| Construção civil | Tipos de atividade |
| Locação | Tipos de atividade |
| Comércio exterior | Cliente no exterior · Tipos de atividade |
| Substituição / nota referenciada | Tipos de atividade |
| Intermediário | Tipos de atividade |
| Com externalId | externalId e RPS |
| Com RPS (número + série) | externalId e RPS |
| São Paulo: total com documentos de reembolso (recomendado) | São Paulo: Valor Total Recebido e reembolsos |
São Paulo: valor recebido em paidAmount com documentos de reembolso | São Paulo: Valor Total Recebido e reembolsos |
São Paulo: valor recebido em paidAmount sem documentos de reembolso | São Paulo: Valor Total Recebido e reembolsos |
| São Paulo: multa e juros no valor recebido | São Paulo: Valor Total Recebido e reembolsos |
| São Paulo: Valor Inicial Cobrado (erro 640) | São Paulo: Valor Total Recebido e reembolsos |
| São Paulo: outros reembolsos (tipo 99) com documento não fiscal | São Paulo: Valor Total Recebido e reembolsos |
Cenários já documentados (guias dedicados)
- Cálculo automático de impostos — padrão da plataforma
- Cálculo manual de impostos
- Cliente no exterior — cenários de São Paulo (
location+taxationType) e Ambiente Nacional (foreignTrade) - Cliente não identificado
- São Paulo: Valor Total Recebido e documentos de reembolso — notas com IBS/CBS após os manuais 3.3.7 a 3.3.9 (
paidAmount, documentos de reembolso, Valor Inicial Cobrado)