Após enviar uma requisição de cálculo ao AvaTax Brasil, a resposta da API retorna os tributos calculados em taxDetails[]. Use este conteúdo para consultar definições técnicas, interpretar os tributos apurados e entender como os parâmetros da Reforma Tributária afetam o retorno por linha da transação.
taxDetails – Campos comuns (padrões)
Campos retornados por item (base de cálculo, alíquota, valor e impactos).
| Atributo | Descrição |
|---|---|
| taxType | Identificador do tributo, exemplo: cbs, ibs, irrf, etc. |
| impactOnFinalPrice | Indica como o valor final da transação é impactado pelo tributo em questão. Valores possíveis: Add: o tributo é somado ao preço.Included: o tributo já está incluso no valor informado.Subtracted: o tributo reduz a base ou o valor líquido.Informative: o valor é apenas demonstrativo, sem efeito sobre o total. |
| impactOnNetAmount | Indica como o valor a receber ou pagar é impactado pelo tributo. Exemplo: uma retenção não afeta o valor de um serviço, mas afeta o valor a ser recebido. Valores possíveis: Add: o tributo é somado ao preço.Included: o tributo já está incluso no valor informado.Subtracted: o tributo reduz a base ou o valor líquido.Informative: o valor é apenas demonstrativo, sem efeito sobre o total. |
| accounting | Contabilização. Indica possibilidade de crédito, débito, ou transação sem impacto contábil. Valores possíveis: liability: devido, asset: crédito, none: informativo |
| citation | Referência legal que sustenta a alíquota utilizada no cálculo. |
| subtotalTaxable | Base cálculo do tributo. |
| rate | Alíquota, que pode ser percentual, ou valor (adrem). |
| tax | Valor do tributo calculado. |
| jurisdictionName | Nome da jurisdição. Exemplo: ‘Curitiba’. |
| jurisdictionType | Indica para que nível de jurisdição é devido o tributo. Valores possíveis: ‘City‘, ‘State‘, ‘Country‘. |
| ruleCode | Código da regra que identificou a citation usada. |
taxDetails – Campos específicos da Reforma Tributária
Campos criados para a Reforma Tributária.
| Atributo | Descrição |
|---|---|
| taxType | Identificador do tributo. Exemplo: cbs, ibs, is. Lista completa em [link âncora]. |
| cst | Retorna o Código de Situação Tributária, baseado no cenário do cálculo do tributo. Exemplo: 200 – Cálculo com alíquota reduzida. |
| cClassTrib | Retorna a classificação tributária da fundamentação relevante no cálculo do tributo. Exemplo: 510002 – Operações, sujeitas a diferimento, com insumos agropecuários e aquícolas destinados a produtor rural contribuinte (Anexo IX). |
| modBC | Retorna o modelo de cálculo, onde a alíquota pode ser: ‘ 0‘: cálculo baseado em porcentagem do valor da operação‘ 1‘: cálculo em função de alíquota ad rem.Consequentemente, a base de cálculo do tributo ( subtotalTaxable) será o valor da operação ou a quantidade na unidade tributária. Exemplo: numberOfItems * cbsIbsUnitFactor. |
| cMunFG | Código IBGE do Município de consumo, fato gerador do IBS Mun. Somente para IBS Mun. |
| pRedAliq | Percentual de redução da alíquota. |
| pGovRedAliq | Percentual de redução da alíquota em vendas para entidades governamentais. Corresponde ao atributo pRedutor da NFe. |
| pEffRate | Alíquota efetiva usada no cálculo. Exemplo: pEffRate = rate * (1-pRedAliq) * (1-pGovRedAliq). |
| uTrib | Retorna a Unidade Tributária, caso alíquota ad rem. |
Identificadores de tributos (taxType)
Lista os valores de taxType de cada tributo retornado.
| taxType | Nome |
|---|---|
| ‘is’ | Imposto Seletivo |
| ‘isSpecific’ | Imposto Seletivo Específico |
| ‘cbs’ | CBS |
| ‘ibs’ | IBS |
| ‘ibsUf’ | IBS UF |
| ‘ibsMun’ | IBS Mun |
| ‘cbsPresumed’ | Crédito presumido CBS |
| ‘ibsPresumed’ | Crédito presumido IBS |
| ‘cbsPresSusCond’ | Crédito presumido CBS em condição suspensiva |
| ‘ibsPresSusCond’ | Crédito presumido IBS em condição suspensiva |
| ‘cbsRegular’ | CBS regular |
| ‘ibsUfRegular’ | IBS UF regular |
| ‘ibsMunRegular’ | IBS Mun regular |
| ‘cbsDeferred’ | CBS diferido |
| ‘ibsDeferred’ | IBS diferido |
| ‘ibsUfDeferred’ | IBS UF diferido |
| ‘ibsMunDeferred’ | IBS Mun diferido |
| ‘cbsSbjWh’ | CBS sujeito à retenção |
| ‘cbsPrvWh’ | CBS retido anteriormente |
| ‘ibsSbjWh’ | IBS sujeito à retenção |
| ‘ibsPrvWh’ | IBS retido anteriormente |
| ‘cbsTaxReturn’ | CBS retornado (cashback) |
| ‘ibsUfTaxReturn’ | IBS UF retornado (cashback) |
| ‘ibsMunTaxReturn’ | IBS Mun retornado (cashback) |
| ‘cbsGovTaxComp’ | Informações da participação do CBS na composição do valor da CBS em compras governamentais |
| ‘ibsUfGovTaxComp’ | Informações da participação do IBS UF na composição do valor do IBS em compras governamentais |
| ‘ibsMunGovTaxComp’ | Informações da participação do IBS Mun na composição do valor do IBS em compras governamentais |
| ‘ibsPresCredZFM’ | Informações do crédito presumido de IBS para fornecimentos a partir da ZFM |
| ‘cbsTranferCred’ | Valor da CBS a ser transferido |
| ‘ibsTranferCred’ | Valor do IBS a ser transferido |
