AvaTax for VAT

Version v2
APConfigSetting
Accounts
Addresses
AvaFileForms
Batches
CertExpressInvites
Certificates
Clerk
CommunicationCertificates
Companies
Compliance
Contacts
CostCenter
Customers
DataSources
Definitions
DistanceThresholds
DomainControlVerification
ECommerceToken
EcmEventNotifications
EcoNexusThreshold
FirmClientLinkages
FormTypeMapping
FundingRequests
GLAccount
Items
ItemsReverseSync
Jobs
JurisdictionOverrides
Locations
MultiDocument
Nexus
Notices
Notifications
Provisioning
Registrar
Reports
Settings
Subscriptions
TaxCodes
TaxContent
TaxRules
Transactions
Upcs
UserDefinedFields
Users
Utilities
VendorCertificates
Vendors

TransactionLineDetailModel

An individual tax detail element. Represents the amount of tax calculated for a particular jurisdiction, for a particular line in an invoice.

Parameters
idOptional
integer

The unique ID number of this tax detail.

transactionLineIdOptional
integer

The unique ID number of the line within this transaction.

transactionIdOptional
integer

The unique ID number of this transaction.

addressIdOptional
integer

The unique ID number of the address used for this tax detail.

countryOptional
string

The two character ISO 3166 country code of the country where this tax detail is assigned.

regionOptional
string

The two-or-three character ISO region code for the region where this tax detail is assigned.

countyFIPSOptional
string

For U.S. transactions, the Federal Information Processing Standard (FIPS) code for the county where this tax detail is assigned.

stateFIPSOptional
string

For U.S. transactions, the Federal Information Processing Standard (FIPS) code for the state where this tax detail is assigned.

exemptAmountOptional
number

The amount of this line that was considered exempt in this tax detail.

exemptReasonIdOptional
integer

The unique ID number of the exemption reason for this tax detail.

exemptRuleIdOptional
integer

The rule according to which portion of this detail was considered exempt.

inStateOptional
boolean

True if this detail element represented an in-state transaction.

jurisCodeOptional
string

The code of the jurisdiction to which this tax detail applies.

jurisNameOptional
string

The name of the jurisdiction to which this tax detail applies.

jurisdictionIdOptional
integer

The unique ID number of the jurisdiction to which this tax detail applies.

signatureCodeOptional
string

The Avalara-specified signature code of the jurisdiction to which this tax detail applies.

stateAssignedNoOptional
string

The state assigned number of the jurisdiction to which this tax detail applies.

jurisTypeOptional
string

DEPRECATED - Date: 12/20/2017, Version: 18.1, Message: Use jurisdictionTypeId instead. The type of the jurisdiction to which this tax detail applies.

Enum: STA, CTY, CIT, STJ, CNT
jurisdictionTypeOptional
string

The type of the jurisdiction in which this tax detail applies.

Enum: Country, State, County, City, Special
nonTaxableAmountOptional
number

The amount of this line item that was considered nontaxable in this tax detail.

nonTaxableRuleIdOptional
integer

The rule according to which portion of this detail was considered nontaxable.

nonTaxableTypeOptional
string

The type of nontaxability that was applied to this tax detail.

Enum: RateRule, RateOverrideRule, BaseRule, ExemptEntityRule, ProductTaxabilityRule, NexusRule, RateCapRule, TaxOverrideRule, FeeRule, OtherRule
rateOptional
number

The rate at which this tax detail was calculated.

rateRuleIdOptional
integer

The unique ID number of the rule according to which this tax detail was calculated.

rateSourceIdOptional
integer

The unique ID number of the source of the rate according to which this tax detail was calculated.

serCodeOptional
string

For Streamlined Sales Tax customers, the SST Electronic Return code under which this tax detail should be applied.

sourcingOptional
string

Indicates whether this tax detail applies to the origin or destination of the transaction.

Enum: Mixed, Destination, Origin
taxOptional
number

The amount of tax for this tax detail.

taxableAmountOptional
number

The taxable amount of this tax detail.

taxTypeOptional
string

The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.

taxSubTypeIdOptional
string

The id of the tax subtype.

taxTypeGroupIdOptional
string

The id of the tax type group.

taxNameOptional
string

The name of the tax against which this tax amount was calculated. Note: This output field is informational, and the values in this field may change. As such, we discourage hardcoding any string matching on this field.

taxAuthorityTypeIdOptional
integer

The type of the tax authority to which this tax will be remitted.

taxRegionIdOptional
integer

The unique ID number of the tax region.

taxCalculatedOptional
number

The amount of tax that AvaTax calculated. If an override for tax amount is used, there may be a difference between the tax field which applies your override, and the this amount that is calculated without override.

taxOverrideOptional
number

The amount of tax override that was specified for this tax line.

rateTypeOptional
string

DEPRECATED - Date: 12/20/2017, Version: 18.1, Message: Please use rateTypeCode instead. The rate type for this tax detail.

Enum: ReducedA, ReducedB, Food, General, IncreasedStandard, LinenRental, Medical, Construction, Parking, SuperReduced, ReducedR, Standard, Leasing, LeasingLow, Services, Zero
rateTypeCodeOptional
string

Indicates the code of the rate type that was used to calculate this tax detail. Use ListRateTypesByCountry API for a full list of rate type codes.

taxableUnitsOptional
number

Number of units in this line item that were calculated to be taxable according to this rate detail.

nonTaxableUnitsOptional
number

Number of units in this line item that were calculated to be nontaxable according to this rate detail.

exemptUnitsOptional
number

Number of units in this line item that were calculated to be exempt according to this rate detail.

unitOfBasisOptional
string

When calculating units, what basis of measurement did we use for calculating the units?

isNonPassThruOptional
boolean

True if this value is a non-passthrough tax.

A non-passthrough tax is a tax that may not be charged to a customer; it must be paid directly by the company.

isFeeOptional
boolean

The Taxes/Fee component. True if the fee is applied. When isFee is false, this represents a tax rate percentage. For example, "rate": 0.022500 represents a 2.25% tax rate. When isFee is true, this represents a specific monetary amount. For example, for "currencyCode": "USD" and "isFee": true, the "rate": 15 represents a fee of $15.00 USD.

reportingTaxableUnitsOptional
number

Number of units in this line item that were calculated to be taxable according to this rate detail in the reporting currency.

reportingNonTaxableUnitsOptional
number

Number of units in this line item that were calculated to be nontaxable according to this rate detail in the reporting currency.

reportingExemptUnitsOptional
number

Number of units in this line item that were calculated to be exempt according to this rate detail in the reporting currency.

reportingTaxOptional
number

The amount of tax for this tax detail in the reporting currency.

reportingTaxCalculatedOptional
number

The amount of tax that AvaTax calculated in the reporting currency. If an override for tax amount is used, there may be a difference between the tax field which applies your override, and the this amount that is calculated without override.

liabilityTypeOptional
string

LiabilityType identifies the party liable to file the tax. This field is used to filter taxes from reports and tax filings as appropriate.

Enum: Seller, BuyersAgent, Buyer, ThirdParty
chargedToOptional
string

ChargedTo identifies the party responsible for covering the tax. This field is used to filter taxes from reports and tax filings as appropriate.

Enum: Buyer, Seller, ThirdParty
avtUserBINOptional
string

ID of the AvaTax user creating the transaction. This field will be calculated by AvaTax based on the Company settings and the transaction details.

recoverabilityPercentageOptional
number

The percentage of input VAT/GST that is recoverable.

recoverableAmountOptional
number

The amount of input VAT/GST that is recoverable based on the recoverability percentage.

nonRecoverableAmountOptional
number

The amount of input VAT/GST that is not recoverable.

vatCodeOptional
string

Indicates the VAT code for this detail.

granularDutyDetailsOptional
array

Contains granular duty details as a list of key-value pairs. This field provides additional detailed information about duty calculations specific to TCS (Tax Calculation Service) operations.