Skip to main content
Avalara Help Center

TTE data schema and data fields

  1. Last updated
  2. Save as PDF
This article applies to:Content Generation for Point of Sale (CGPOS)

 

A warning icon

 The information on this page is subject to change based on the latest upcoming updates for future releases.

 

TTE data schema - all

TTE_All.png

TTE tables and data fields - all

TTE_entity            
Field # Field name PK FK Null Type Width Description
1 AccountID X   N String 50 Unique identifier for the Avalara account
2 CompanyID X   N String 50 Unique identifier for the company
3 Company Code X   N String 50 Customer unique identifier for the company
4 CompanyName   X N String 60 Name of the company associated with the CompanyID
5 EffectiveDateTime   X N DateTime 23 Date and time the company goes into effect
6 EndDateTime   X N DateTime 23 Date and time the company expires
7 RecordCreatedTimestamp   X N DateTime 23 Date and time this record is created

 

TTE_physical_location_region            
Field # Field name PK FK Null Type Width Description
1 AccountID X   N String 50 Unique identifier for the Avalara account
2 CompanyID X   N String 50 Unique identifier for the company
3 CompanyCode X   N String 50 Customer unique identifier for the company
4 PhysicalLocationID X   N String 50 Unique identifier for the physical location (warehouse, store, kiosk, and so on)
5 PhysicalLocationName   X N String 60 Name of the physical location associated with the PhysicalLocationID
6 TaxRegionID   X N String 50 Unique identifier for the tax region
7 LastAssignTaxRegionID   X Y String 50 Previous TaxRegionID assigned to this PhysicalLocationID, if different
8 EffectiveDateTime   X N DateTime 23 Date and time the physical location to region mapping goes into effect
9 EndDateTime   X N DateTime 23 Date and time the physical location to region mapping expires
10 RecordCreatedTimestamp   X N DateTime 23 Date and time this record is created

 

TTE_postal_location_region            
Field # Field name PK FK Null Type Width Description
1 AccountID X   N String 50 Unique identifier for the Avalara account
2 CompanyID X   N String 50 Unique identifier for the company
3 CompanyCode X   N String 50

Customer unique identifier for the company
4 PostalLocationID X   N String 50 Unique identifier for the postal location (5-digit postal code (US), 6-digit postal code (CAN), and so on)
5 TaxRegionID   X N String 50 Unique identifier for the tax region
6 EffectiveDateTime   X N DateTime 23 Date and time the postal location to region mapping goes into effect
7 EndDateTime   X N DateTime 23 Date and time the postal location to region mapping expires
8 LastAssignTaxRegionID   X Y String 50 Previous TaxRegionID assigned to this PostalLocationID, if different
9 RecordCreatedTimestamp   X N DateTime 23 Date and time this record is created

 

TTE_tax_region_jurisdiction            
Field # Field name PK FK Null Type Width Description
1 AccountID X   N String 50 Unique identifier for the Avalara account
2 CompanyID X   N String 50 Unique identifier for the company
3 CompanyCode X   N String 50

Customer unique identifier for the company
4 TaxRegionID X   N String 50 Unique identifier for the tax region
5 TaxRegionName   X N String 254 Name of the tax region associated to the TaxRegionID (combined country, state/province, county/parish, city/township, and district)
6 TaxRegionCountry   X N String 50 Name of the country associated with the TaxRegionID
7 TaxRegionStateProvince   X N String 50 Name of the state or province associated with the TaxRegionID
8 TaxJurisdictionID X   N String 50 Unique identifier for the tax jurisdiction
9 EffectiveDateTime   X N DateTime 23 Date and time the tax region to tax authority mapping goes into effect
10 EndDateTime   X N DateTime 23 Date and time the tax region to tax authority mapping expires
11 RecordCreatedTimestamp   X N DateTime 23 Date and time this record is created

 

TTE_tax_jurisdiction            
Field # Field name PK FK Null Type Width Description
1 AccountID X   N String 50 Unique identifier for the Avalara account
2 CompanyID X   N String 50 Unique identifier for the company
3 CompanyCode X   N String 50

Customer unique identifier for the company
4 TaxJurisdictionID X   N String 50 Unique identifier for the tax jurisdiction
5 TaxJurisdictionName   X N String 254 Name of the tax jurisdiction associated with the TaxJurisdictionID (country, state or province, county or parish, city or township, or district)
6 TaxJurisdictionLevel   X N String 50 Valid tax jurisdiction levels include: country, state or province, county or parish, city or township, and district
7 RoundingMethod   X N String 50 A method indicating how the rate should be rounded during calculation
8 RoundingDigits   X N Integer 1 The number of digits to which rounding is calculated
9 EffectiveDateTime   X N DateTime 23 Date and time the tax jurisdiction goes into effect
10 EndDateTime   X N DateTime 23 Date and time the tax jurisdiction expires
11 RecordCreatedTimestamp   X N DateTime 23 Date and time this record is created

 

TTE_discount            
Field # Field name PK FK Null Type Width Description
1 AccountID X   N String 50 Unique identifier for the Avalara account
2 CompanyID X   N String 50 Unique identifier for the company
3 CompanyCode X   N String 50

Customer unique identifier for the company
4 DiscountID X   N String 50 Unique identifier for the discount
5 DiscountName   X N String 60 Name of the discount associated with the DiscountID (retail, vendor, and so on)
6 DiscountAllIndicator   X Y Boolean 1 Indicates whether the discount applies to all tax authorities
7 GrossInd   X Y Boolean 1 Indicates that the discount is taxable at the full item price
8 TaxJusrisdictionID   X N String 50 Unique identifier for the tax jurisdiction. Identify the Avalara jurisdictions applying to the discount if DiscountAllIndicator is False.
9 EffectiveDateTime   X N DateTime 23 Date and time the discount goes into effect
10 EndDateTime   X N DateTime 23 Date and time the discount expires
11 RecordCreatedTimestamp   X N DateTime 23 Date and time this record is created

 

TTE_exemption_certificate            
Field # Field name PK FK Null Type Width Description
1 AccountID X   N String 50 Unique identifier for the Avalara account
2 CompanyID X   N String 50 Unique identifier for the company
3 CompanyCode X   N String 50

Customer unique identifier for the company
4 ExemptType X   N String 50 Unique identifier for the exemption type
5 CertificateNumber X   N String 50 The certificate number assigned by the tax authority
6 CertificateHolderName   X Y String 50 The name of the organization or individual identified on the certificate
7 CertificateCountry   X Y String 50 Issuing country
8 CertificateStateProvince   X Y String 50 Issuing state or province
9 CertificateExpirationDate   X N DateTime 23 Date and time the certificate expires
10 RecordCreatedTimestamp   X N DateTime 23 Date and time this record is created

 

TTE_exemption_type            
Field # Field name PK FK Null Type Width Description
1 AccountID X   N String 50 Unique identifier for the Avalara account
2 CompanyID X   N String 50 Unique identifier for the company
3 CompanyCode X   N String 50

Customer unique identifier for the company
4 ExemptType X   N String 50 Unique identifier for the exemption type
5 ExemptTypeName   X N String 50 Name of the exemption type associated with the ExemptTypeID (resale, not-for-profit, government, and so on)
6 ExtemptAllJusrisdictionIndicator   X Y Boolean 1 Indicates whether the exemption applies to all tax authorities
7 ExemptAllTaxGroupIndicator   X Y Boolean 1 Indicates whether the exemption applies to all tax codes
8 TaxJusrisdictionID   X Y String 50 Unique identifier for the tax jurisdiction. Identify the Avalara Jurisdiction ID applying to the exemption type if ExemptAllJurisdictionsIndicator is False.
9 TaxJusrisdictionName   X Y String 254

Tax jurisdiction associated to the Avalara TaxJurisdictionID Country, state/province, county/parish, city/township, and district/special. Identify the Avalara Jurisdiction Name applying to the exemption type if ExemptAllJurisdictionsIndicator is False.
10 TaxJusrisdictionLevel   X Y String 50 Valid tax authority levels include: country, state or province, county or parish, city or township, and district. Identify the Avalara Jurisdiction Level applying to the exemption type if ExemptAllJurisdictionsIndicator is False.
11 ReducedBy   X Y Double 8,6 Tax percentage by which the rate should be reduced
12 TaxGroupID X   Y String 50 Unique identifier for the tax code. It is used if exemption type is assigned to the specific tax groups.
13 TaxGroupName   X Y String 254 Name of the tax code associated with the TaxGroupID. It is used if exemption type is assigned to the specific tax groups.
14 EffectiveDateTime   X N DateTime 23 Date and time the exemption type assignment goes into effect
15 EndDateTime   X N DateTime 23 Date and time the exemption type assignment expires
16 RecordCreatedTimestamp   X N DateTime 23 Date and time this record is created

 

TTE_taxgroup            
Field # Field name PK FK Null Type Width Description
1 AccountID X   N String 50 Unique identifier for the Avalara account
2 CompanyID X   N String 50 Avalara unique identifier for the company
3 CompanyCode X   N String 50 Customer unique identifier for the company
4 TaxGroupID X   N String 50 Unique identifier for the tax group (Item classification)
5 TaxCodeID X   N String 50 Unique identifier for the tax code
6 TaxCodeName   X N String 50 Avalara name for the Tax Code associated to the Avalara TaxCodeID
7 TaxCodeCreatedDate   X N DateTime 23

Avalara date for when the Tax Code was created
8 TaxGroupName   X Y String 254 Customer name for the tax group associated to the TaxGroupID
9 EffectiveDateTime   X N DateTime 23 Date and time the tax group goes into effect
10 EndDateTime   X N DateTime 23 Date and time the tax group expires
11 RecordCreatedTimestamp   X N DateTime 23 Date and time this record is created

 

TTE_taxgroup_rule            
Field # Field name PK FK Null Type Width Description
1 AccountID X   N String 50 Unique identifier for the Avalara account
2 CompanyID X   N String 50 Unique identifier for the company
3 CompanyCode X   N String 50 Customer unique identifier for the company
4 RuleName   X N String 254

Unique rule name (Concatenate CompanyID,  TaxRegionID, TaxJurisdictionID, TaxCodeID, TaxGroupID, TaxTypeID, and TaxCodeRuleSequenceNumber)
5 TaxRegionID X   N String 50 Unique identifier for the tax region (Geocode)
6 TaxJurisdictionID X   N String 50 Unique identifier for the tax jurisdiction
7 TaxGroupID X   N String 50 Unique identifier for the tax group
8 TaxTypeID X   N String 50 Unique identifier for the tax type
9 TaxTypeName   X N String 50 Name of the tax type associated with the TaxTypeID (sales, sellers use, rental, VAT, GST, and so on)
10 TaxName   X N String 50 The name of the tax or fee (for example, sales tax, 911 surcharge, PIF, and so on)
11 TaxGroupRuleSequenceNumber X   N Integer 3 Sequential number for the tax group rule indicating the order in which the rule should be considered
12 TaxabilityDecision   X N String 50 Taxable or non-taxable
13 TaxHolidayIndicator   X Y Boolean 1 Indicates if the tax group rule is for a sales  tax holiday
14 TaxAtTransactionLevelIndicator   X Y Boolean 1 Indicates if tax should be applied at transaction level; otherwise, tax should be applied at the item level
15 CalculationMethodCode   X N Integer 1 If tax to be applied at transaction level, then: Transaction Level = 1, else Item Level = 2
16 InclusiveTaxIndicator   X Y Boolean 1 Indicates whether the tax amount is already included in the price (VAT)
17 CompoundIndicator   X Y Boolean 1 Indicates whether the tax will be compounded with other tax
18 CompoundSequenceNumber   X Y Integer 3

Sequential number indicating the order where multiple related tax taxcode rules should be applied.

Example 1: No compounding will have Null within this field.

Example 2: PST and GST tax taxcode rules with Compounding needed. TaxTypeID for PST applied first and the field will contain 1 for its value, TaxTypeID for GST applied second and the field will have 2 for its value.
19 ReceiptPrintLanguage1   X Y String 254 User-defined field for receipt print language
20 ReceiptPrintLanguage2   X Y String 254 User-defined field for receipt print language
21 UserDefinedField1   X Y String 254 User-defined field
22 UserDefinedField2   X Y String 254 User-defined field
23 EffectiveDateTime   X N DateTime 23 Date and time the TaxGroup Rule goes into effect
24 EndDateTime   X N DateTime 23 Date and time the TaxGroup Rule expires
25 RecordCreatedTimestamp   X N DateTime 23 Date and time this record is created

 

TTE_tax_rate_rule            
Field # Field name PK FK Null Type Width Description
1 AccountID X   N String 50 Unique identifier for the Avalara account
2 CompanyID X   N String 50 Unique identifier for the company
3 CompanyCode X   N String 50 Customer unique identifier for the Company
4 TaxRegionID X   N String 50 Unique identifier for the tax region
5 TaxJurisdictionID X   N String 50 Unique identifier for the tax jurisdiction
6 TaxGroupID X   N String 50 Unique identifier for the tax group
7 TaxTypeID X   N String 50 Unique identifier for the tax type
8 TaxRateRuleSequenceNumber X   N Integer 3 Sequential number for the tax rate rule indicating the order in which multiple tax rates should be applied when MinimumTaxableAmount and MaximumTaxableAmount apply (min/max, tier, and so on)
9 TaxGroupRuleSequenceNumber X   N Integer 3 Sequential number for the tax group rule indicating the order in which the rule should be considered
10 TaxRateStructure   X N String 50 The structure of the tax type (such as simple rate, flat tax amount, tier tax, bracket tax, and so on)
11 TaxRateClass   X N String 50 The classification of the rate (such as standard, luxury, reduced, and so on)
12 BracketNumber   X Y Integer 3 Use if TaxRateStructure contains Bracket; the number assigned to the bracket. If either TPPDefaultIndicator or ZeroRateDefaultIndicator is true, then assign 1, and then number sequentially starting with 2. Otherwise, start with 1 and number sequentially.
13 AmountRateSelect   X N Integer 1 When Rate = 1; when Amount = 2
14 Amount   X Y Double 8,2 The flat amount to apply
15 Rate   X Y Double 8,6 The percentage rate to apply
16 BreakPointType   X N String 50 Breakpoint to use when calculating tax. Values include PART and FULL: PART = tax part of the dollar amount for min/max or tier tax structures. FULL = tax entire dollar amount
17 TaxAboveThresholdAmountIndicator   X Y Boolean 1 Indicates tax applied to the amount over the dollar amount within MinimumTaxableAmount.
18 MinimumTaxableAmount   X Y Double 10,2 Use if there is a minimum taxable amount or tier tax. If amount is present, then TaxAboveThresholdAmountIndicator should be set to true
19 MaximumTaxableAmount   X Y Double 10,2 Use if there is a maximum tax amount or tier tax
20 EffectiveDateTime   X N DateTime 23 Date and time the tax rate rule goes into effect
21 EndDateTime   X N DateTime 23 Date and time the tax rate rule expires
22 RecordCreatedTimestamp   X N DateTime 23 Date and time this record is created

 

TTE_tax_combined            
Field # Field name PK FK Null Type Width Description
1 AccountID X   N String 50 Unique identifier for the Avalara account
2 CompanyID X   N String 50 Unique identifier for the company
3 CompanyCode X   N String 50 Customer unique identifier for the Company
4 TaxRegionID X   N String 50 Unique identifier for the tax region
5 TaxGroupID X   N String 50 Unique identifier for the tax group
6 TaxTypeID X   N String 50 Unique identifier for the tax type
7 TaxCombinedSequenceNumber X   N Integer 3 Sequential number for the combined tax  indicating the order of one or multiple tax rates should be applied when MinimumTaxableAmount and MaximumTaxableAmount apply (min/max, tier tax, and so on.)
8 BracketIndicator X   N Boolean 1 Indicates whether the TTE Configuration Document or the TTE Amended Configuration Document allows Bracket capability where combined rates are used
9 BracketNumber   X N Integer 3 The number assigned to the bracket if BracketIndicator set to True
10 AmountRateSelect   X N Integer 2 When Rate = 1; when Amount = 2
11 CombinedAmount   X Y Double 8,2 The combined flat amount to apply
12 CombinedRate   X Y Double 8,6 The combined percentage rate to apply
13 TaxRateClass   X N String 50 The Avalara classification of rate (for example, Standard, Luxury, Reduced, and so on)
14 BreakPointType   X N String 50 Breakpoint to use when calculating tax. Values include PART and FULL; PART = tax part of the dollar amount for min/max or tier tax structures and FULL = tax entire dollar amount
15 TaxAboveThresholdAmountIndicator   X Y Boolean 1 Indicates tax applied to the amount over the dollar amount within MinimumTaxableAmount
16 MinimumTaxableAmount   X Y Double 10,2 Use if there is a minimum taxable amount or tier tax. If amount is present, then TaxAboveThresholdAmountIndicator should be set to true
17 MaximumTaxableAmount   X Y Double 10,2 Use if there is a maximum tax amount or tier tax
18 TaxabilityDecision   X N String 50 Taxable or nontaxable
19 TaxHolidayIndicator   X Y Boolean 1 Indicates if the tax code rule is for a tax holiday
20 CalculationMethodCode   X N Integer 2 If tax to be applied at transaction level, then: Transaction Level = 1, else Item Level = 2
21 InclusiveTaxIndicator   X Y Boolean 1 Indicates whether the tax amount is already included in the price (VAT)
22 CompoundIndicator   X Y Boolean 1 Indicates that multiple tax taxcode rules apply
23 CompoundSequenceNumber   X Y Integer 3 Sequential number indicating the order where multiple related tax taxcode rules should be applied. Example 1: No Compounding will contain Null within this field. Example 2: PST and GST tax taxcode rules with Compounding needed. TaxTypeID for PST applied first and the field will contain 1 for its value, TaxTypeID for GST applied second and the field will contain 2 for its value
24 CombinedReceiptPrintLanguage1   X Y String 254 User-defined field for receipt print language
25 CombinedUserDefinedField1   X Y String 254 User-defined field
26 EffectiveDateTime   X N DateTime 23 Date and time the tax combined goes into effect
27 EndDateTime   X N DateTime 23 Date and time the tax combined expires
28 RecordCreatedTimestamp   X N DateTime 23 Date and time this record is created

 

TTE_tax_bracket_assignment            
Field # Field name PK FK Null Type Width Description
1 AccountID X   N String 50 Unique identifier for the Avalara account
2 CompanyID X   N String 50 Unique identifier for the company
3 CompanyCode X   N String 50 Customer unique identifier for the company
4 TaxRegionID X   N String 50 Unique identifier for the tax region
5 TaxGroupID X   N String 50 Unique identifier for the tax group
6 TaxTypeID X   N String 50 Unique identifier for the tax type
7 BracketNumber X   N Integer 3 The number assigned to the bracket. If either TPPDefaultIndicator or ZeroRateDefaultIndicator is true, then assign 1, and then number sequentially starting with 2. Otherwise, start with 1 and number sequentially
8 BracketFlagAssignment   X N String 50 Associated with the BracketNumber. Represents the position based on "flag" on/off indicators. The number of positions available is based on the bracket position number identified within TTE Configuration file (default is 4 positions). Example: If BracketNumber equals 2, then output equals 0,1,0,0 using the Bracket Position Number default
9 TaxabilityDecision   X N String 50 Taxable or nontaxable
10 CombinedRate   X Y Double 8,6 The combined percentage rate to apply
11 TaxRateClass   X N String 50 The classification of the rate (such as standard, luxury, reduced, and so on)
12 EffectiveDateTime   X N DateTime 23 Date and time the bracket assignment goes into effect
13 EndDateTime   X N DateTime 23 Date and time the bracket assignment expires
14 RecordCreatedTimestamp   X N DateTime 23 Date and time this record is created
15 TaxCombinedSequenceNumber   X N Integer 3 Sequential number for the combined tax  indicating the order of one or multiple tax rates must be applied when MinimumTaxableAmount and MaximumTaxableAmount apply (min/max, tier tax, and so on)

 

TTE_tax_bracket            
Field # Field name PK FK Null Type Width Description
1 AccountID X   N String 50 Unique identifier for the Avalara account
2 CompanyID X   N String 50 Unique identifier for the company
3 CompanyCode X   N String 50 Customer unique identifier for the company
4 TaxRegionID X   N String 50 Unique identifier for the tax region
5 TaxRegionName   X N String 254 Name of the tax region associated with the TaxRegionID (combined country, state or province, county or parish, city or township, and district)
6 TaxRegionCountry   X N String 50 Name of the country assigned to the tax region
7 TaxRegionStateProvince   X N String 50 Name of the state or province assigned to the tax region
8 TaxGroupID X   N String 50 Unique identifier for the tax group
9 TaxTypeID X   N String 50 Unique identifier for the tax type
10 BracketNumber X   N Integer 3 The number assigned to the bracket. If either TPPDefaultIndicator or ZeroRateDefaultIndicator is true, then assign 1, and then number sequentially starting with 2. Otherwise, start with 1 and number sequentially
11 TPPDefaultIndicator   X Y Boolean 1 Indicates whether a default bracket number is assigned for standard TPP sales tax rate. If true, the BracketNumber will equal 1. Note: Indication of a default bracket for TPP is within the TTE Configuration file
12 ZeroRateDefaultIndicator   X Y Boolean 1 Indicates whether a default bracket number is assigned for zero tax rate and a Bracket is created. If true, the BracketNumber will equal 1 and a Zero Rate Bracket is created. Note: Indication of a default bracket for Zero Rate is within the TTE Configuration file
13 BracketLineCount   X N Integer 3 The end count of the RangeLineNumber for the bracket
14 CombinedRate   X Y Double 8,6 The combined percentage rate to apply
15 TaxRateClass   X N String 50 The classification of the rate (such as standard, luxury, reduced, and so on)
16 RangeLineNumber   X N Integer 3 The range line number in sequential order
17 StartRangeAmount   X N Double 10,2 Minimum taxable amount of the range
18 EndRangeAmount   X N Double 10,2 Maximum taxable amount of the range
19 RangeTaxAmount   X N Double 8,2 The flat amount to apply to the range, which is always 0.01
20 RangeTaxAmount2   X N Integer 3 The RangeTaxAmount expressed as a whole number (for example, 0.01 becomes 1)
21 RangeTaxAmount3   X N Double 8,2 The accumulated RangeTaxAmount
22 RepeatRange   X N Integer 3 The difference between the StartRangeAmount and EndRangeAmount expressed as a whole number (for example, StartRangeAmount = 0.00 and EndRangeAmount = 0.07, then RangeCount = 7)
23 RepeatRangeIndicator   X N Boolean 1 Indicates when a number pattern is found for the RepeatRange (RR) within the bracket (for example, RR1 = 12, RR2 = 13, RR3 = 13, RR4 = 12, RR5 = 13, RR6 = 13 -- repeat range pattern found at RR6)
24 EffectiveDateTime   X N DateTime 23 Date and time the bracket goes into effect
25 EndDateTime   X N DateTime 23 Date and time the bracket expires
26 RecordCreatedTimestamp   X N DateTime 23 Date and time this record is created

 

TTE table relationships - all

Parent entity Child entity
TTE_entity TTE_discount
TTE_entity TTE_taxgroup
TTE_entity TTE_exemption_certificate
TTE_entity TTE_exemption_type
TTE_entity TTE_postal_location_region
TTE_entity TTE_physical_location_region
TTE_postal_location_region TTE_tax_region_tax_jurisdiction
TTE_physical_location_region TTE_tax_region_tax_jurisdiction
TTE_tax_region_tax_jurisdiction TTE_tax_jurisdiction
TTE_taxgroup TTE_taxgroup_rule
TTE_tax_jurisdiction TTE_taxgroup_rule
TTE_taxgroup_rule TTE_tax_rate_rule
TTE_taxgroup_rule TTE_tax_combined
TTE_tax_rate_rule TTE_tax_combined
TTE_tax_combined TTE_tax_rate_rule
TTE_tax_combined TTE_tax_bracket_assignment
TTE_tax_combined TTE_tax_rate_rule
TTE_tax_bracket_assignment TTE_tax_bracket
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Article type
    Reference
  2. Tags
    This page has no tags.