AvaTax Brazil

Version v1
Batch Calculations
Calculations
Filter Subscription Rule Set List
Generic Rules
Invoice Goods
Invoice Service
Invoice Settings
PING
Subscription Analysis
Subscription Citations
Subscription Location
Subscription Operation Type
Subscription Rule Set
Subscription Usage
processFile

DetailTaxBase

Parameters
jurisdictionNameOptional
string

(en) Jurisdiction used for the calc tax amount (pt) Jurisdição usada para calcular o valor do imposto

jurisdictionTypeOptional
string

(en) Type of jurisdiction (country is a default option)

  • 'City'
  • 'State'
  • 'Country' (pt) Tipo de jurisdição (país é uma opção predefinida)
  • 'Cidade'
  • 'Estado'
  • 'País'
Enum: City, State, Country
taxImpactOptional
DetailsCalculatedTaxImpact
taxTypeOptional
string

Identificador do tipo de imposto/Tax type identifier

  • 'icms' (en) Tax on operations related to the circulation of Goods and Services of Interstate and Inter-municipal Transport, and Communication Services. (pt) Imposto sobre Operações relativas à Circulação de Mercadorias e sobre Prestações de Serviços de Transporte Interestadual e Intermunicipal e de Comunicação.
  • 'icmsFCP' (en) FCP (Fund to Combat the Poverty) is a complement to the ICMS, levied on commercial transactions, in accordance with the legislation of each state. (pt) O FCP (Fundo de Combate à Pobreza) é um complemento do ICMS, incidindo sobre transações comerciais, de acordo com a legislação de cada estado.
  • 'icmsSt' (en) ICMS due for tax substitution (when the ICMS is fully paid in advance, and it is not necessary to charge it again in future transactions of goods.) (pt) ICMS devido por substituição tributária (quando o ICMS é pago em seu valor total de forma antecipada, não sendo necessário cobrá-lo novamente em próximas transações de uma mercadoria.).
  • 'icmsStFCP' (en) ICMS complement (FCP - Fund to Combat the Poverty) related to Tax Substitution. (pt) Complemento do ICMS (FCP - Fundo de Combate à pobreza) relativo à Substituição Tributária.
  • 'icmsPart' (en) ICMS sharing. (pt) Partilha de ICMS.
  • 'icmsStPart' (en) ICMS due for tax substitution with ICMS sharing. (pt) ICMS devido por substituição tributária com partilha de ICMS.
  • 'icmsStFCPPart' (en) ICMS complement (FCP - Fund to Combat the Poverty) related to Tax Substitution with ICMS sharing. (pt) Complemento do ICMS (FCP - Fundo de Combate à pobreza) relativo à Substituição Tributária com partilha de ICMS.
  • 'icmsStSd' (en) ICMS related to tax substitution in the Substitution condition (CST 60). (pt) ICMS relativo à substituição tributária na condição de Substituído (CST 60).
  • 'icmsStSdFCP' (en)ICMS related to tax substitution in the Substitution condition (CST 60) with additional FCP to the ICMS. (pt)ICMS relativo à substituição tributária na condição de Substituído (CST 60) com adicional FCP ao ICMS.
  • 'icmsDifaFCP' (en) ICMS Difal (ICMS rate differential, when the purchase of goods/services is interstate;) is the Tax on the Circulation of Goods and Services with additional FCP to the ICMS. (pt) ICMS Difal (Diferencial de alíquota do ICMS, quando a compra da mercadoria/serviço é feita de forma interestadual) é o Imposto sobre Circulação de Mercadorias e Serviços com adicional FCP ao ICMS.
  • 'icmsDifaDest' (en) ICMS rate differential attributed to the final consumer recipient. (If the recipient is a non-taxpayer, then he is necessarily a final consumer and then there will be ICMS dest, in which the calculation is basically the difference in rates. If the recipient is a taxpayer, there will be no ICMS dest.) (pt) Diferencial de alíquota do ICMS atribuída ao destinatário consumidor final. (Se o destinatário é não-contribuinte, então necessariamente é consumidor final e então haverá ICMS dest, em que o cálculo é basicamente a diferença de alíquotas. Se o destinatário é contribuinte, não haverá ICMS dest.)
  • 'icmsDifaRemet' (en) ICMS rate differential attributed to the sender. (The responsibility for collection is assigned to the sender when the recipient is not a tax payer.) (pt) Diferencial de alíquota do ICMS atribuída ao remetente. (A responsabilidade pelo recolhimento é atribuída ao remetente, quando o destinatário não for contribuinte do imposto.)
  • 'icmsRf' (en) ICMS to be withheld over Service Freight value. (pt) ICMS a ser retido sobre o valor do Serviço de Frete.
  • 'icmsDeson' (en) ICMS tax relief, consists of a tax discount corresponding to the amount of tax waived in exempt, non-taxed or suspended operations, where all ICMS is exempted. (pt) O ICMS desonerado consiste em um desconto tributário correspondente ao valor do imposto dispensado nas operações com redução de base, isentas, não tributadas ou suspensas, onde todo o ICMS é desonerado.
  • 'icmsCredsn' (en) The ICMS credit system allows tax compensation (guarantees the right to credit the tax that was previously charged on operations involving the entry of goods to those who receive the goods or products) for those opting for the Simples Nacional regime, a tax regime exclusive for micro and small companies. (pt) O sistema de crédito do ICMS permite que haja compensação do imposto (garante a àquele que recebe as mercadorias ou produtos o direito de se creditar do imposto que foi anteriormente cobrado em operações envolvendo a entrada de mercadorias) aos optantes do regime Simples Nacional, regime tributário exclusivo para micro e pequenas empresas.
  • 'icmsEff' (en) The Effective ICMS is the reimbursement of the difference in the amount paid (if it is the highest) by the industry, when sold to the final consumer. (pt) O ICMS Efetivo é o ressarcimento da diferença do valor pago (caso for a maior) pela indústria, quando vendido para consumidor final.
  • 'icmsOwnPayer' (en) ICMS of the substitute charged in a previous operation. This amount is only received, it is not calculated. (pt) ICMS próprio do substituto cobrado em operação anterior. Este valor é apenas recebido, não é calculado.
  • 'pis' (en) Social Integration Program (pt) Programa de Integração Social
  • 'pisRf' (en) Process of withholding PIS at source for taxes involving legal entities. (CST 5979) (pt) Processo de retenção do PIS na fonte para tributos que envolvem pessoa jurídica. (CST 5979)
  • 'pisSt' (en) PIS due for tax substitution. (pt) PIS devido por substituição tributária.
  • 'pisDeson' (en) PIS tax relief. (pt) PIS desonerado.
  • 'cofins' (en) Contribution to Social Security Financing. (pt) Contribuição para o Financiamento da Seguridade Social.
  • 'cofinsRf' (en) COFINS withholding process for taxes involving legal entities. (CST 5960) (pt) Processo de retenção do COFINS na fonte para tributos que envolvem pessoa jurídica. (CST 5960)
  • 'cofinsSt' (en) COFINS due for tax substitution. (pt) COFINS devido por substituição tributária.
  • 'cofinsDeson' (en) COFINS tax relief. (pt) COFINS desonerado.
  • 'csllRf' (en) CSLL withholding for taxes involving legal entities. (CST 5987). (pt) CSLL retido na fonte para tributos que envolvem pessoa jurídica. (CST 5987).
  • 'irrf' (en) Withholding income tax. This is a tax liability for the Federal Revenue and is charged from individuals (PF) and legal entities (PJ). (pt) Imposto de Renda Retido na Fonte. Essa é uma obrigação tributária destinada à Receita Federal e é cobrada de pessoas físicas (PF) e pessoas jurídicas (PJ).
  • 'cprb' (en) Social Security Contribution on Gross Revenue. It is based on the Article 195 of the Federal Constitution. It states: “social security will be financed by the whole society, directly and indirectly, under the terms of the law”. (pt) Contribuição Previdenciária sobre a Receita Bruta. É baseada no artigo 195 da Constituição Federal. Nela, afirma-se: “a seguridade social será financiada por toda a sociedade, de forma direta e indireta, nos termos da lei”.
  • 'cprbRf' (en) CPRB withholding process. (pt) Processo de retenção do CPRB na fonte.
  • 'inssAr' (en) INSS to be collected. In MEI services, for example, INSS is not withheld but 20% must be collected. (pt) INSS a Recolher. Em tomadas de serviço de MEI por exemplo, não se retêm INSS, mas 20% deve ser recolhido.
  • 'inssRf' (en) INSS withholding process. (pt) Processo de retenção do INSS na fonte.
  • 'iss' (en) Tax over services. It is a tax applicable to companies and self-employed professionals who provide services. (pt) Imposto sobre Serviços. É um tributo aplicável a empresas e profissionais autônomos que realizam prestação de serviços.
  • 'issRf' (en) ISS withholding process. (pt) ISS retido na fonte.
  • 'ipi' (en) Taxes over industrialized products. (pt) Imposto sobre Produtos Industrializados.
  • 'ipiReturned' (en) IPI returned. (pt) IPI devolvido.
  • 'ii' (en) Tax on the importation of foreign products and is levied on the importation of foreign goods and on the luggage of travelers coming from abroad. In the case of foreign goods, the calculation basis is the customs value, and the rate is indicated in the Common External Tariff (TEC). (pt) Imposto sobre a importação de produtos estrangeiros e incide sobre a importação de mercadorias estrangeiras e sobre a bagagem de viajante procedente do exterior. No caso de mercadorias estrangeiras, a base de cálculo é o valor aduaneiro e a alíquota está indicada na Tarifa Externa Comum (TEC).
  • 'iof' (en) Financial transaction tax. This tax is levied on financial operations such as credit, exchange, and insurance. (pt) Imposto sobre Operações Financeiras. Esse imposto é cobrado em operações financeiras como crédito, câmbio e seguros.
  • 'fust' (en) Fund for the Universalization of Telecommunications Services. Its purpose is to bring telephony and internet access to isolated regions, with inadequate or non-existent infrastructure. (pt) Fundo de Universalização dos Serviços de Telecomunicações. Tem a finalidade de levar acesso à telefonia e internet para regiões isoladas, com infraestrutura inadequada ou inexistente.
  • 'funttel' (en) Fund for the Technological Development of Telecommunications. It is an accounting fund with the objective of stimulating the process of technological innovation, encouraging the training of human resources, fostering job creation and promoting access to resources for small and medium-sized companies. (pt) Fundo para o Desenvolvimento Tecnológico das Telecomunicações. É um fundo de natureza contábil com o objetivo de estimular o processo de inovação tecnológica, incentivar a capacitação de recursos humanos, fomentar a geração de empregos e promover o acesso de pequenas e médias empresas a recursos.
  • 'aproxtrib' (en) Approximate Tax Value is the information on the average value of taxes that influence the price of a product or service. (pt) Valor aproximado dos Tributos é a informação sobre o valor médio dos impostos que influenciam o preço de um produto ou serviço.
  • 'aproxtribCity' (en) Approximate value of Municipal Taxes. (pt) Valor aproximado dos Tributos Municipais.
  • 'aproxtribState' (en) Approximate value of State Taxes. (pt) Valor aproximado dos Tributos Estaduais.
  • 'aproxtribFed' (en) Approximate value of Federal Taxes. (pt)Valor aproximado dos Tributos federais.
  • 'cprb' (en) Social Security Contribution on Gross Revenue (pt) Contribuição Previdenciária sobre a Receita Bruta
  • 'is' (en) Selective Tax (pt) Imposto Seletivo
  • 'isSpecific' (en) Specific Selective Tax (pt) Imposto Seletivo Específico
  • 'cbs' (en) Contribution on Goods and Services (pt) Contribuição sobre Bens e Serviços
  • 'ibs' (en) IBS Goods and Services Tax (pt) IBS Imposto sobre Bens e Serviços
  • 'ibsUf' (en) IBS State Jurisdiction (pt) IBS Juristição Estadual
  • 'ibsMun' (en) IBSMunicipal Jurisdiction (pt) IBS Juristição Municipal
  • 'cbsPresumed' (en) Presumed CBS Credit (pt) Crédito Presumido de CBS
  • 'ibsPresumed' (en) Presumed IBS Credit (pt) Crédito Presumido de IBS
  • 'cbsPresSusCond' (en) Presumed Under Suspensive Condition CBS Credit (pt) Crédito Presumido em condição Suspensiva de CBS
  • 'ibsPresSusCond'
    (en) Presumed Under Suspensive Condition IBS Credit (pt) Crédito Presumido em condição Suspensiva de IBS
  • 'cbsRegular' (en) CBS Regular (pt) CBS Regular
  • 'ibsUfRegular' (en) IBS Regular, State Jurisdiction (pt) IBS Regular, Jurisdição Estadual
  • 'ibsMunRegular' (en) IBS Regular, Municipal Jurisdiction (pt) IBS Regular, Jurisdição Municipal
  • 'cbsDeferred' (en) CBS Deferred (pt) CBS Diferido
  • 'ibsUfDeferred' (en) IBS Defered State Jurisdiction (pt) IBS Diferido Jurisdiçao Estadual
  • 'ibsMunDeferred' (en) IBS Defered Municipal Jurisdiction (pt) IBS Diferido Jurisdiçao Municipal
  • 'ibsDeferred' (en) IBS Defered Monofasico (pt) IBS Diferido Monofasico
  • 'cbsSbjWh' (en) CBS single-phase subject to withholding (pt) CBS monofásico sujeito a retenção
  • 'ibsSbjWh' (en) IBS single-phase subject to withholding (pt) IBS monofásico sujeito a retenção
  • 'cbsPrvWh' (en) CBS single-phase previously withheld (pt) CBS monofásico retido anteriormente
  • 'ibsPrvWh' (en) IBS single-phase previously withheld (pt) IBS monofásico retido anteriormente
  • 'cbsTaxReturn' (en) Cashback discount on CBS (pt) Cashback abatimento no CBS
  • 'ibsUfTaxReturn' (en) Cashback discount on IBS State Jurisdiction (pt) Cashback abatimento no IBS Jurisdiçao Estadual
  • 'ibsMunTaxReturn' (en) Cashback discount on IBS Municipal Jurisdiction (pt) Cashback abatimento no IBS Jurisdiçao Municipal
  • 'cbsGovTaxComp' (en) Information on the participation of CBS in the composition of the value of IBS and CBS in government purchases, which would be due to the municipality, without the application of Art. 473 of LC 214/2025 (pt) Informações da participação do CBS na composição do valor do IBS e da CBS em compras governamentais, que seria devido ao município, sem aplicação do Art. 473. da LC 214/2025
  • 'ibsUfGovTaxComp' (en) Information on the participation of IBS UF in the composition of the value of IBS and CBS in government purchases, which would be due to the municipality, without the application of Art. 473 of LC 214/2025 (pt) Informações da participação do IBS UF na composição do valor do IBS e da CBS em compras governamentais, que seria devido ao município, sem aplicação do Art. 473. da LC 214/2025
  • 'ibsMunGovTaxComp' (en) Information on the participation of IBS Mun in the composition of the value of IBS and CBS in government purchases, which would be due to the municipality, without the application of Art. 473 of LC 214/2025 (pt) Informações da participação do IBS Mun na composição do valor do IBS e da CBS em compras governamentais, que seria devido ao município, sem aplicação do Art. 473. da LC 214/2025
  • 'cbsTranferCred' (en) IBS amount to be transferred (pt) Valor do CBS a ser transferido
  • 'ibsTranferCred' (en) IBS amount to be transferred (pt) Valor do IBS a ser transferido
  • 'ibsPresCredZFM' (en) Information on presumed IBS credit for supplies from the ZFM (pt) Informações do crédito presumido de IBS para fornecimentos a partir da ZFM
  • 'ibsSettlementAdj' (en) IBS for settlement period (pt) CBS de ajuste de competência
  • 'cbsSettlementAdj' (en) CBS for settlement period (pt) CBS de ajuste de competência
  • 'ibsCreditReversal' (en) IBS Credit REversal (pt) Estorno de Crédito de IBS
  • 'cbsCreditReversal' (en) CBS Credit REversal (pt) Estorno de Crédito de CBS Usage purpose: Calculation/Invoice/Do not apply for services
Enum: icms, icmsFCP, icmsSt, icmsStDeson, icmsStFCP, icmsPart, icmsStPart, icmsStFCPPart, icmsStSd, icmsStSdFCP, icmsDifaFCP, icmsDifaDest, icmsDifaRemet, icmsRf, icmsDeson, icmsCredsn, icmsEff, icmsOwnPayer, pis, pisRf, pisSt, pisDeson, cofins, cofinsRf, cofinsSt, cofinsDeson, cofinsSurcharge, csll, csllRf, irrf, cprb, cprbRf, inssAr, inssRf, iss, issRf, irpj, ipi, ipiReturned, ii, iof, fust, funttel, aproxtrib, aproxtribCity, aproxtribState, aproxtribFed, is, isSpecific, cbs, ibs, ibsUf, ibsMun, cbsPresumed, ibsPresumed, cbsPresSusCond, ibsPresSusCond, cbsRegular, ibsUfRegular, ibsMunRegular, cbsDeferred, ibsUfDeferred, ibsMunDeferred, ibsDeferred, cbsSbjWh, cbsPrvWh, ibsSbjWh, ibsPrvWh, cbsTaxReturn, ibsUfTaxReturn, ibsMunTaxReturn, cbsGovTaxComp, ibsUfGovTaxComp, ibsMunGovTaxComp, cbsTranferCred, ibsTranferCred, ibsPresCredZFM, ibsSettlementAdj, cbsSettlementAdj, ibsCreditReversal, cbsCreditReversal
citationOptional
string

(en) This string captures the transaction scenario used to calculate the tax for this tax type. Scenarios are specific to the tax type. This field provides information about how the tax engine interpreted the transaction information that was passed in. (pt) Esta sequência captura o cenário de transação usado para calcular o imposto para este tipo de imposto. Os cenários são específicos para o tipo de imposto. Este campo fornece informações sobre como o mecanismo fiscal interpretou as informações da transação que foram repassadas. Usage purpose: Calculation/Invoice/Do not apply for services

citationIdOptional
string

(en) Citation Id for this tax scenario. (pt) Id de citação para este cenário de imposto. Usage purpose: Calculation/Invoice/Do not apply for services

isCustomCitationOptional
boolean

(en) This attribute informs that the citation is custom. (pt) Este atributo informa que a citação é customizada. Usage purpose: Calculation/Invoice/Do not apply for services

ruleIdOptional
string

(en) Rule Id used to identify the Citation. (pt) Id de regra usado para identificar a citação. Usage purpose: Calculation/Invoice/Do not apply for services

ruleCodeOptional
string

(en) Rule Code used to identify the Citation. (pt) Código de regra usado para identificar a citação. Usage purpose: Calculation/Invoice/Do not apply for services

subtotalTaxableOptional
number

(en) This decimal captures how much of the lineAmount was taxable by this tax, calc base. (pt) Este decimal captura quanto do valor do item (em linha) era tributável por este imposto, base de cálculo. Usage purpose: Calculation/Invoice/Do not apply for services

rateOptional
number

(en) Tax rate (pt) Alíquota Usage purpose: Calculation/Invoice/Do not apply for services

taxOptional
number

(en) Tax amount. (pt) Valor do imposto. Usage purpose: Calculation/Invoice

exemptionCodeOptional
string

(en) Official Benefit Code (pt) Código de benefício oficial

traceCodeOptional
string

(en) Trace code of the reason for this result. (pt) Código de rastreamento do motivo para esse resultado. Usage purpose: Calculation/Invoice/Do not apply for services