A API do AvaTax Brasil usa atributos específicos para aplicar corretamente as regras da Reforma Tributária. Estes parâmetros devem ser enviados no payload das requisições de cálculo.
Dica
Esta página reúne os campos de entrada por área funcional do payload (Header, Participantes, ItemDescriptor e Lines) com exemplos de uso e observações importantes para cada cenário.
Header
Campos que definem o cenário da operação e ajudam a determinar o local do fato gerador.
| Atributo | Tipo | Obrigatório | Valores possíveis | Descrição |
|---|---|---|---|---|
| enableCalcICBS (em header.goods ou header.services) | boolean | Condicional (janela de ativação) | true/false | Ativa o cálculo da RT por tipo de item: defina em $.header.goods.enableCalcICBS (bens) e/ou $.header.services.enableCalcICBS (serviços). A aplicação segue a matriz de datas da RT. |
| transactionDate | string (date-time) | Obrigatório | ISO 8601 (date-time, e.g. 2026-01-15T00:00:00Z) | Data da operação, usada para aplicar a legislação vigente. |
| indPres (NFe/NFCe) | string (enum) | Condicional (local do FG) | “0”,”1″,”2″,”3″, “4”,”5″,”9″ | Indicador de presença (NFe/NFCe). Segue o conceito definido na NT 2020.006. Contexto: $.header.goods.indPres.Observação: usar somente em transações com produtos (goods). |
| idDest (NFe/NFCe) | integer (enum) | Condicional (local do FG) | 0,1,2,3 | Indicador do local de destino da operação. Contexto: $.header.goods.idDest.Segue o conceito definido na NT 2020.006. Observação: usar somente em transações com produtos (goods). |
| cMunFGIBS (NFe/NFCe) | integer (IBGE cityCode) | Condicional (NFe/NFCe; indPres=5 sem entrega) | IBGE cityCode (7 dígitos) | Município do fato gerador do IBS em operação presencial fora do estabelecimento. Use apenas quando indPres=5 e não houver entrega; quando informado, o AvaTax Brasil fixa o local do FG do IBS por este código. Contexto: $.header.goods.cMunFGIBS. Observação: usar somente em transações com produtos (goods). |
| govProcurement.tpOperGov (NFe) | string | Opcional | — | Indicador de compra governamental na emissão NFe e NFSe. Não altera o cálculo; quando houver redutor no DFe, o impacto aparece como pGovRedAliq no response. Contexto: $.header.goods.govProcurement.tpOperGov.$.header.services.govProcurement.tpOperGov. |
| locations.*.address | object | Condicional (local do FG) | — | Endereços das localidades envolvidas na transação, usados para determinar o local do fato gerador: $.header.locations.delivery.address, $.header.locations.entity.address, $.header.locations.establishment.address e, para NFSe, $.header.locations.rendered.address. |
Participantes
Perfis, regimes e elegibilidades das entidades; ativam benefícios, créditos e comportamentos.
| Atributo | Tipo | Obrigatório | Valores possíveis | Descrição |
|---|---|---|---|---|
| type | string (enum) | Obrigatório | business, individual, cityGovernment, stateGovernment, federalGovernment | Tipo de entidade participante da operação. |
| taxRegime | string (enum) | Obrigatório | realProfit, estimatedProfit, simplified, simplifiedHybrid, simplifiedOverGrossthreshold, simplifiedEntrepreneur, notApplicable, individual, variable | Regime tributário da entidade. realProfit: Lucro Real.estimatedProfit: Lucro Presumido.simplified: optante do Simples.simplifiedHybrid: Simples Nacional, mas que opera em regime híbrido. Ou seja, continua sujeito à tributação regular de CBS e IBS.simplifiedOverGrossthreshold: Simples Nacional, excesso de sublimite de receita bruta.simplifiedEntrepreneur: Micro Empreendedor Individual.notApplicable: não aplicávelindividual: indivíduo.variable: variável. |
| taxesSettings.applyCashback | boolean | Opcional | true/false | Solicita e aplica o cashback conforme previsto em lei. AvaTax Brasil não valida outros critérios (como renda, CadÚnico, etc.). |
| taxesSettings.notCbsIbsTaxPayer | boolean | Opcional | true/false | Marca a localidade como não contribuinte de CBS/IBS (atributo negativo). Contexto: $.header.locations.entity.taxesSettings.notCbsIbsTaxPayer ou $.header.locations.establishment.taxesSettings.notCbsIbsTaxPayer. |
| taxesSettings.pCredCBSSN | number | Opcional | número (percentual) | Percentual de crédito CBS para Simples Nacional quando não for Regime Hibrido. Ou seja, quando recolhimento é feito via DAS. |
| taxesSettings.pCredIBSSN | number | Opcional | número (percentual) | Percentual de crédito IBS para Simples Nacional quando não for do regime hibrido. Ou seja, quando recolhimento é feito via DAS. |
| activitySector.type | string (enum) | Opcional | activityLine;CNAE | Tipo de classificação do setor. Pode ser uma palavra-chave pré-definida ou o código CNAE. |
| activitySector.code | string | Opcional | – | Código do CNAE ou código atividade conforme lista definida em (path swagger) |
Lines
Ajustes por linha: exclusões, deduções e indicadores de regimes.
| Atributo | Tipo | Obrigatório | Valores possíveis | Descrição |
| goods.notSubjectToIsTax | boolean | Condicional (IS) | true/false | Exclusão explícita do IS para a linha de bens (não se aplica a services). Atributo negativo: quando true, o IS não é calculado. |
| goods.customsCapitalRegimeIndicator | string | Condicional (regimes) | — | Atributo regime aduaneiro/bens de capital. É usado pelas regras do AvaTax Brasil para determinar cenários com benefícios relacionados a, por exemplo, áreas de incentivo ou regimes específicos de importação. |
| taxDeductions.cbsIbs | number | Opcional | número | Dedução aplicável a base de cálculo do CBS/IBS na linha (valor na moeda corrente). |
ItemDescriptor
Classificação fiscal do item e fatores de unidade (ad rem) usados no cálculo.
| Atributo | Tipo | Obrigatório | Valores possíveis | Descrição |
|---|---|---|---|---|
| hsCode | string | Obrigatório | — | Classificação fiscal do item. Para produtos: NCM. Para serviços: NBS. Observação: no modelo da RT, serviços usam NBS em hsCode e o código da LC‑116 vai em lc116Code. |
| lc116Code | string | Obrigatório quando serviços | — | Código da LC‑116 do serviço. Nas regras da Reforma Tributária, é informado em campo próprio, diferente de hsCode/NBS. |
| legalReference | string | Opcional | — | Palavra‑chave/referência legal para enquadrar benefícios/regimes quando a classificação (NCM/NBS) não é suficiente. |
| usedMovableSupplyInd | boolean | Condicional (revenda de usado) | true/false | Indica fornecimento de bem móvel usado adquirido de pessoa física não contribuinte ou MEI. Mapeia para indBemMovelUsado na NFe/NFCe. |
| cbsIbsUnitFactor | number | Condicional (ad rem) | número | Fator de conversão para a unidade tributável de CBS/IBS em cenários ad rem (modBC = “1”). Multiplica a quantidade comercial para formar a quantidade tributável. Exemplo: 1.5 |
| isUnitFactor | number | Condicional (ad rem IS) | — | Fator de conversão para a unidade tributável do IS em cenários ad rem (modBC = “1”). |
| appropriateCBSIBScreditWhenInBound | boolean | Opcional | true/false | Solicita apropriação de crédito de CBS/IBS. Para crédito presumido/condição suspensiva, deve haver fundamentação legal válida (regra/citation), eventualmente indicada via legalReference. |
| donationInd | boolean | Opcional | true/false | Indica operação de doação; quando true, a NFe recebe indDoacao=1 |
| tpCredPresIBSZFM | string (enum) | Opcional | — | Classificação conforme percentuais definidos no art. 450, § 1º, da LC 214/25 para o cálculo do crédito presumido: 0 – Sem Crédito Presumido 1 – Bens de consumo final (55%) 2 – Bens de capital (75%) 3 – Bens intermediários (90,25%) 4 – Bens de informática e outros definidos em legislação (100%) |
