REST API Reference Manual

User Manual:

Open the PDF directly: View PDF PDF.
Page Count: 21

REST API Reference Manual
1 REST List of API Operations
1.1 V2 Specific Operations
1.1.1 V2 Jurisdiction Determination Operations
Operation
API URL Reference
Description
POST
/api/v2/geo/Geocode
Geocodes one or multiple street addresses and/or lat/long coordinates.
POST
/api/v2/afc/PCode
Get PCode(s) associated with a location - Ctry/State/County/City/Zip.
1.1.2 V2 Tax Calculation and Commit Operations
Operation
API URL Reference
Description
POST
/api/v2/afc/CalcTaxes
Performs tax calculations on all invoices and line items.
POST
/api/v2/afc/Commit
Commits or un-commits a document code.
1.1.3 V2 Lookup Operations
Operation
API URL Reference
Description
GET
/api/v2/afc/serviceinfo
Retrieves server time, service build version and engine version
GET
/api/v2/afc/taxtype/{taxType}
Get the tax information (description and category) for a tax type ID
GET
/api/v2/afc/tspairs
Get transaction/service pair information
GET
/api/v2/afc/location/{pcode}
Get location data associated with a Pcode
GET
/api/v2/afc/primary/{pcode}
Get primary location data associated with a PCode
REST API Reference Manual
1.2 Common Operations
1.2.1 Application Operations
Operation
Description
GET
Get server time
GET
Get the version of the AFC tax engine
GET
Get the version of the Rest APIs
GET
Get the AFC tax engine database version
1.2.2 Taxing Jurisdiction Operations
Operation
API URL Reference
Description
POST
/api/v1/CalculateJurisdiction
Determine taxing jurisdiction for transaction
1.2.3 Location Operations
Operation
API URL Reference
Description
POST
/api/v1/Location/PCode
Determine PCode for a location
GET
/api/v1/Location/PCodeToFips/{pCode}
Convert a PCode to FIPS code
GET
/api/v1/Location/Address/{pCode}
Get address information for a jurisdiction
POST
/api/v1/Location/ZipAddressLookup
Lookup jurisdictions by location name and/or postal code
GET
/api/v1/Location/Address
Lookup all countries in AFC
GET
/api/v1/Location/Address/{countryIso}
Lookup all states in a given country
GET
/api/v1/Location/Address/{countryIso}/{stateCode}
Lookup all cities for a given country and state/province/region.
REST API Reference Manual
GET
/api/v1/Location/Address/All
List of all addresses raw.
1.2.4 Tax Lookup Operations
Operation
API URL Reference
Description
GET
/api/v1/TaxLookup/Category/{taxType}
Get tax category for a tax type
GET
/api/v1/TaxLookup/Description/{taxType}
Get the tax description for a tax type
GET
/api/v1/TaxLookup/TaxRates/{pCode}
Get tax rates for a jurisdiction
GET
/api/v1/TaxLookup/TransactionServices
Get list of all Transaction-Service pairs.
REST API Reference Manual
1.3 V1 Specific Operations
1.3.1 V1 Calculate Taxes and Commit Operations
*Note that the V1 calculation and commit API’s have been replaced by the v2 calculation and commit API’s and are no longer being updated.
Operation
API URL Reference
Description
POST
/api/v1/BridgeConference/Taxes*
Calculate taxes on a bridge conference transaction
POST
/api/v1/BridgeConference/Adjustments*
Calculate tax adjustments on a bridge conference transaction
POST
/api/v1/CalculateTaxes*
Calculate taxes on a transaction
POST
/api/v1/CalculateTaxesMulti*
Calculates taxes on a transaction batch.
POST
/api/v1/CalculateTaxInclusive/Adjustments*
Perform a tax-inclusive tax adjustment
POST
/api/v1/CalculateTaxInclusive/Taxes*
Perform a tax-inclusive tax calculation
POST
/api/v1/CalculateWithOverrides/Taxes*
Calculate taxes using overrides
POST
/api/v1/CalculateWithOverrides/Adjustments*
Calculate tax adjustments using overrides
POST
/api/v1/CustMode/CalcTaxesInCustMode*
Process transactions and adjustments in customer mode
POST
/api/v1/CalculateAdjustments*
Calculate tax adjustments on transaction
POST
/api/v1/CalculateProRated/Taxes*
Calculate taxes for a pro-rated transaction
POST
/api/v1/CalculateProRated/Adjustments*
Calculate tax adjustments for a pro-rated transaction
POST
/api/v1/CommitTransactions*
Calculate taxes on a transaction
REST API Reference Manual
2 API Details
2.1 api/v2/geo/Geocode
Supports a list of geo code addresses. Actual limit varies depending on message size and client timeout values, but standard recommendation is
to process no more than 1000 entries per request.
2.1.1 Request Fields
Name
Long name
Type
Description
ref
Reference
String
User supplied reference string which ties results in response back to request
cass
ReturnCass
Boolean
True = return CASS certified address False = do not return CASS certified address
lat
Latitude
Double
Latitude value for lat/long geocode search (requires long value be supplied)
long
Longitude
Double
Longitude value for lat/long geocode search (requires lat value be supplied)
addr
StreetAddress
String
Street address for geocode search
city
CityName
String
City name for geocode search
st
StateAbbreviation
String
State abbreviation for geocode search
zip
Zip Code
String
5 digit (USA) zip code for geocode search
2.1.2 Response Fields
Name
Long name
Type
Description
ref
Reference
String
User supplied reference string which ties results in response back to request
cass
CassAddress
Object
Cass certified address from geo database
cBlk
CensusBlock
Integer
Census block for address
cTrc
CensusTract
Integer
Census tract for address
cnty
County
String
County for address
feat
FeatureId
Integer
Feature id for address
REST API Reference Manual
fips
FipsCode
String
10 digit USA FIPs code for address. Special taxing jurisdictions will start with “99” and do
not represent an actual FIPs code.
inc
Incorporated
Boolean
True = address is within city limits False = address is outside city limits (unincorporated)
jur
JurisdictionName
String
FIPs place name for jurisdiction
lat
Latitude
Double
Latitude for street location associated with the address
long
Longitude
Double
Longitude for street location associated with the address
pcd
PCode
Unsigned
Integer
Avalara for communications geocode identifying the taxing jurisdiction associated with the
address or lat/long lookup
scr
Score
Double
Confidence score for lookup. 1.01 = fallback lookup on State/County/City/zip used.
err
Error
String
Error message on lookup failures
2.1.2.1 Address Fields
Name
Long name
Type
Description
addr
StreetAddress
String
CASS certified street address
city
CityName
String
CASS certified City name
st
StateAbbreviation
String
CASS certified State abbreviation
zip
Zip Code
String
CASS certified 9 digit (USA) zip code
2.2 api/v2/afc/CalcTaxes
Supports a list of transactions and override options. Actual limit varies depending on message size and client timeout values, but standard
recommendation is to process no more than 1000 entries per request.
2.2.1 Request Fields
Name
Long name
Type
Description
cmpn
CompanyData
Object
Flags, settings and exclusions that applies to Seller
REST API Reference Manual
inv
Invoice
List
List of Invoices to be taxed
ovr
TaxOverride
List
List of overrides to be applied
sovr
SafeHarborOverride
List
List of Safe Harbor Traffic Study overrides to be applied
2.2.1.1 CompanyData Fields – Object
Name
Long name
Type
Description
bscl
BusinessClass
Integer
0 = ILEC 1=CLEC (or not an ILEC)
svcl
ServiceClass
Integer
0 = Primary Local, 1 = Primary Long Distance
fclt
Facilities
Boolean
true = seller is facilities based, false = seller is not facilities based
frch
Franchise
Boolean
true = seller has franchise agreement, false = franchise taxes do not apply to seller
reg
Regulated
Boolean
true = seller is regulated, false = seller is not regulated
excl
Exclusion
List
List of Countries and states/provinces/territories to be excluded
idnt
CompanyIdentifier
String
20 byte alpha-numeric reporting field for Company Identifier
2.2.1.1.1 Exclusion Fields
Name
Long name
Type
Description
ctry
Country
String
3 Byte Country ISO for exclusion
st
State
String
State abbreviation for exclusion
excl
ExclusionOn
Boolean
true = enable exclusion, false = disable exclusion
2.2.1.2 Invoice Fields
Name
Long name
Type
Description
doc
DocumentCode
String
Unique document code to be applied to invoice for Commit
cmmt
Commit
Boolean
False = uncommitted, True = committed
REST API Reference Manual
bill
Location
Location
BillTo location information
cust
CustomerType
Integer
0 = Residential, 1 = Business, 2 = Senior Citizen, 3 = Industrial
lfln
Lifeline
Boolean
false = customer is not a lifeline participant, true = customer is a lifeline
participant
date
InvoiceDate
Date
Date to be used to get tax rates and logic. Historical dates supported.
exms
TaxExemption
List
List of tax exemptions to be applied to invoice
itms
LineItem
List
List of line items for invoice
Invm
InvoiceMode
Boolean
false = line items are unrelated, true = line items are part of a single invoice
dtl
ReturnDetail
Boolean
If invm = true: false = disable tax details true = enable tax details
If invm = false: will always return tax details
summ
ReturnSummary
Boolean
If invm = true: false = disable tax summary, true = enable tax summary
If invm = false: summary of tax data not available
opt
OptionalField
List
Optional fields for reporting
2.2.1.2.1 TaxExemption Fields
Name
Long name
Type
Description
frc
Force
Boolean
Override level exempt flag on wildcard tax type exemptions
True (Default) - Tax type wildcard exemptions will exempt taxes tagged not level exemptible
False - Tax type wildcard exemptions will exclude taxes tagged not level exemptible from
consideration
loc
Location
Object
Location for exemption to be applied. Match will be at level specified by domain.
tpe
TaxType
Short
Tax type to exempt. Tax type exemptions and Category exemptions are mutually exclusive.
lvl
TaxLevel
Short
Obsolete - provided for legacy support. Use Domain and Scope instead.
cat
TaxCategory
Short
Tax category to exempt. Tax type exemptions and Category exemptions are mutually exclusive.
dom
Domain
Short
Exemption Domain. This is the jurisdiction level in which the exemption jurisdiction must match
the taxing jurisdiction. Will automatic level up to match exemption jurisdiction (if applicable).
0=Federal 1=State 2=County 3=City
scp
Scope
Short
Exemption Scope. This defines the tax levels in which the taxes will be considered as candidates
for exemption.
Combination of (128=Federal 256=State 512=County 1024=Local)
Example: 1920=All (Federal+State+County+Local)
REST API Reference Manual
exnb
ExemptNonbillable
Boolean
Exempt non-billable flag. Determines if non-billable taxes are to be considered as candidates for
exemption. Only applies to tax type wildcard and category exemptions.
True - nonbillable taxes can be exempted
False (Default)- nonbillable taxes can be exempted
2.2.1.2.2 Location Fields
Name
Long name
Type
Description
ctry
Country
String
3 Byte Country ISO
st
State
String
Location for exemption to be applied
cnty
County
String
County Name
city
City
String
City Name or Special Tax Jurisdiction Name
zip
PostalCode
String
Zip or Postal Code
Int
Incorporated
Boolean
True = address is within city limits False = address is outside city limits
(unincorporated)
pcd
PCode
Unsigned Integer
Avalara for communications geocode identifier for location
npa
NpaNxx
Unsigned Integer
First 6 digits of phone number
fips
FipsCode
String
10 digit USA FIPs code for location
geo
Geocode
Boolean
alse = do not use geo lookup, true = use geo lookup
addr
StreetAddress
String
Street address for location (used with geo = true)
2.2.1.2.3 OptionalField Fields
Name
Long name
Type
Description
key
Key
Integer
Numeric value 1-10 (Index)
val
Value
String
Alpha-numeric value up to 150 bytes
2.2.1.2.4 LineItem Request Fields
REST API Reference Manual
Name
Long name
Type
Description
ref
Reference
String
Reference to tie line item to tax details
from
Location
Object
Origination or From location
to
Location
Object
Destination or To location
chg
Charge
Double
Charge to be applied to line item
line
Lines
Integer
Line count to be applied to line item
loc
Locations
Integer
Number of locations to be applied to line item
min
Minutes
Double
Minutes to be applied to line item
sale
SaleType
Integer
0 = wholesale, 1 = retail, [SAU ONLY 2 = consumed, 3 = vendor use ]
plsp
PrivateLineSplit
Double
% of private line split A point (p2p) [ 0.25 = 25% point A - 75% point Z ]
incl
TaxInclusive
Boolean
false = not tax inclusive, true = is tax inclusive
pror
ProRatedPct
Double
% for pro-rated calculation of fixed taxes [ 0.5 = 50% ]
brdg
BridgeData
Object
Beta – Contact Avalara if you need information on this functionality
tran
TransactionType
Integer
Transaction Type (1st part of the t/s pair that defines the product to be taxed)
serv
ServiceType
Integer
Service Type (2nd part of the t/s pair that defines the product to be taxed)
dbt
Debit
Boolean
false = not a debit card transaction, true = apply debit card logic to transaction
adj
IsAdjustment
Boolean
false = not a credit/adjustment, true = is a credit/adjustment
adjm
AdjustmentMethod
Integer
0 = Default, 1 = Least favorable rate to customer, 2 = Most favorable rate to
customer
disc
DiscountType
Integer
Refer to manual for valid discount types and descriptions
opt
OptionalField
List
Optional fields for reporting
2.2.1.3 TaxOverride Fields
Name
Long name
Type
Description
loc
Location
Object
Location the override applies to
scp
Scope
Integer
Scope for override 0 = Country, 1 = State, 2 = County, 3 = City
tid
TaxType
Integer
Tax Type id for override
lvl
TaxLevel
Integer
Tax Level for override 0 = Federal, 1 = State, 2 = County, 3 = City
lvlExm
LevelExemptible
Boolean
false = not level exemptible, true = is level exemptible
brkt
TaxBracket
List
Tax Bracket(s)
REST API Reference Manual
2.2.1.3.1 TaxBracket Fields
Name
Long name
Type
Description
rate
Rate
Double
Tax rate for tax bracket
max
MaxBase
Integer
Maximum base for tax bracket (2147483647 = unlimited)
2.2.1.4 SafeHarborOverride Fields
Name
Long name
Type
Description
sh
SafeHarborType
Integer
1 = Cellular, 2 = VoIP, 4 = Paging
old
OriginalFederalTam
Double
Original Federal TAM. 0.649 = 64.9% State = (1.0 - Federal TAM)
new
NewFederalTam
Double
New Federal TAM. 0.371 = 37.1% State = (1.0 - Federal TAM)
2.2.2 Response Fields
Name
Long name
Type
Description
inv
InvoiceResults
List
List of invoices with tax results
err
Error
List
Error message(s) related to request processing
2.2.2.1 InvoiceResults Fields
Name
Long name
Type
Description
doc
DocumentCode
String
Unique document code applied to invoice for Commit
itms
DetailedTax
List
Detailed list of line item tax results
summ
SummarizedTax
List
Summarized taxes for invoice
err
Error
List
Error message(s) related to invoice calculation processing
REST API Reference Manual
2.2.2.1.1 DetailedTax Fields
Name
Long name
Type
Description
ref
Reference
String
Reference from request to tie line item to tax details
base
BaseSaleAmount
Double
Value for tax inclusive calls that represents the charge minus billable taxes
txs
Taxes
List
List of taxes for line item
brdg
BridgeParticipantResult
List
Beta – Contact Avalara if you need information on this functionality
err
Error
List
Error message(s) related to line item calculation processing
2.2.2.1.1.1 Taxes Fields
Name
Long name
Type
Description
bill
Billable
Boolean
false = non-billable tax, true = standard billable tax
cmpl
Compliance
Boolean
false = non-compliance tax, true = standard compliance tax
tm
TaxableMeasure
Double
Taxable Measure applicable to tax (can include tax-on-tax additions)
calc
CalculationType
Integer
1 = Rate, 2 = Fixed, 3 = PerMinute, 4 = PerLine, 5 = SelfTaxingRate, 6 =
PerBracket, 7 = FixedOnTier
cat
CategoryName
String
Tax Category Name
cid
CategoryID
Integer
Tax Category Numerical ID
name
TaxName
String
Tax Name
exm
ExemptSaleAmount
Double
Exempt Sale Amount
lns
Lines
Integer
Number of lines taxed
pcd
PCode
Unsigned Integer
PCode representing reporting tax jurisdiction
rate
Rate
Double
Applicable tax rate
sur
Surcharge
Boolean
false = not a surcharge, true = surcharge rules apply
tax
TaxAmount
Double
Tax Amount
lvl
TaxLevel
Integer
Tax Level 0 = Federal, 1 = State, 2 = County, 3 = City, 4 = Unincorporated
tid
TaxType
Integer
Tax Type ID
REST API Reference Manual
2.2.2.1.2 SummarizedTax Fields
Name
Long name
Type
Description
max
MaxBase
Integer
Maximum base for tax bracket
min
MinBase
Integer
Minimum base for tax bracket
tchg
TotalCharge
Double
Total charge amount for invoice
calc
CalculationType
Integer
1 = Rate, 2 = Fixed, 3 = PerMinute, 4 = PerLine, 5 = SelfTaxingRate, 6 =
PerBracket, 7 = FixedOnTier
cat
CategoryName
String
Tax Category Name
cid
CategoryID
Integer
Tax Category Numerical ID
name
TaxName
String
Tax Name
exm
ExemptSaleAmount
Double
Summarized Exempt Sale Amount
lns
Lines
Integer
Summarized Number of lines taxed
pcd
PCode
Unsigned Integer
PCode representing reporting tax jurisdiction
rate
Rate
Double
Applicable tax rate
sur
Surcharge
Boolean
false = not a surcharge, true = surcharge rules apply
tax
TaxAmount
Double
Summarized Tax Amount
lvl
TaxLevel
Integer
Tax Level 0 = Federal, 1 = State, 2 = County, 3 = City, 4 = Unincorporated
tid
TaxType
Integer
Tax Type ID
2.2.2.2 Error Fields
Name
Long name
Type
Description
code
ErrorCode
Integer
Numeric code associated with error
msg
ErrorMessage
String
Message associated with error
2.3 api/v2/afc/Pcode
Support pcode lookup based on location data (Country,State,County,Locality,Zip). Supports best match logic.
REST API Reference Manual
2.3.1 Request Fields
Name
Long name
Type
Description
CountryIso
CountryIsoCode
String
3-character country ISO code for jurisdiction
State
StateAbbreviation
String
State, province or territory 2-character abbreviation for jurisdiction
County
CountyName
String
County name for jurisdiction
City
CityName
String
City name for for jurisdiction
ZipCode
ZipCode
String
5 digit (USA) zip code or 6 byte (Canada) postal code.
BestMatch
BestMatchFlag
Boolean
Flag indicating whether to return the best matches (true) or exact matches only (false).
LimitResults
LimitResults
Int
Maximum number of results to return. 0 = unlimited.
2.3.2 Response Fields
Name
Long name
Type
Description
LocationData
n/a
List
List of LocationData objects
MatchCount
n/a
String
Number of matches found
InputMatchType
n/a
String
Requested match type (Exact or Best)
MatchTypeApplied
n/a
String
Match type applied (Exact or Best)
ResultsLimit
n/a
String
Limit applied to the number of locations returned
2.3.2.1 LocationData Fields
Name
Long name
Type
Description
CountryIso
CountryIsoCode
String
Location found
State
StateAbbreviation
String
State, province or territory 2-character abbreviation for jurisdiction
County
CountyName
String
County name for jurisdiction
Locality
CityName
String
City name for for jurisdiction
PCode
PersistedCode
Uint
Pcode associated with jurisdiction
REST API Reference Manual
2.4 api/v2/afc/Commit
Change the status of transactions associated with a Document Code
2.4.1 Request Fields
Name
Long name
Type
Description
doc
DocumentCode
String
150 byte document code to have the commit status changed
cmmt
CommitFlag
Boolean
True=Commit False=Uncommit
opt
OptionalField
Object
Optional Fields to be updated with the commit
2.4.1.1 OptionalField
Name
Long name
Type
Description
key
Key
String
Key for optional field – can range from 1-10
val
Value
String
New optional field value to be associated with key
2.4.2 Response Fields
Name
Long name
Type
Description
ok
SuccessStatus
Boolean
Indicates if document code's commit status was updated successfully
err
Error
List
Error message(s) related to commit request (as applicable)
2.5 api/v2/afc/serviceinfo
REST API Reference Manual
Retrieves server time, service build version and engine version
2.5.1 Response Fields
Name
Long name
Type
Description
ServerTime
n/a
DateTime
Date/Time value from the server
Versions
VersionInfo
Object
Server and Engine versions
Error
ErrorMessage
String
Error message from request (as applicable)
2.5.1.1 VersionInfo Fields
Name
Long name
Type
Description
AfcEngineVersion
EngineBuild
String
AFC Engine Version. Example: 20.1809.1
BuildVersion
ServerBuild
String
Service Build Version. Example: 5.23.0-310
2.6 api/v2/afc/taxtype/{taxType}
This method returns the description for the specified tax type ID. If tax type * is supplied it will return all tax types.
2.6.1 Request Fields
Name
Long name
Type
Description
taxType
TaxTypeId
String
Numeric tax type id for lookup or * for all tax types
2.6.2 Response Fields - List
REST API Reference Manual
Name
Long name
Type
Description
TaxType
n/a
Short
Numeric id for tax type
CategoryType
n/a
Short
Numeric id for category
TaxDescription
n/a
String
Description for tax type
CategoryDescription
n/a
String
Description for category
2.7 api/v2/afc/tspairs
This method returns the description for the transaction type, service type and the ts pairs. If the profile is provided and has bundled packages
associated with it, the ts pair(s) assigned to the bundle package(s) will also be returned.
2.7.1 Response Fields - List
Name
Type
Description
TransactionType
Short
Numeric id for transaction type
ServiceType
Short
Numeric id for service type
MarketType
Short
Numeric id for market type
InterfaceType
Short
Interface type: 0=Unassigned 1=Telecom 2=SAU 3=Both Telecom and SAU
InputType
Short
Input Type (mask) – combination of (0=Invoice, 1=Charge, 2=Lines, 4=Locations, 8=Minutes)
IsBundle
Boolean
True=Is associated with bundle False=Not associated with bundle
TransactionDescription
String
Transaction type description
ServiceDescription
String
Service type description
TSPairDescription
String
Transaction/Service pair description or Bundle package description
2.8 api/v2/afc/location/{pcode}
Request will return all jurisdictions associated with the PCode.
REST API Reference Manual
2.8.1 Request Fields
Name
Long name
Type
Description
pcode
PersistedCode
UInt
Pcode to retrieve location data for
2.8.2 Response Fields - List
Name
Type
Description
LocationData
List
List of LocationData objects
2.9 api/v2/afc/primary/{pcode}
Request will return primary jurisdiction associated with the PCode.
2.9.1 Request Fields
Name
Long name
Type
Description
pcode
PersistedCode
UInt
Pcode to retrieve primary location data for
2.9.2 Response Fields - List
Name
Type
Description
LocationData
List
List of LocationData objects (will never exceed one entry)
REST API Reference Manual
Quick Reference Links
1 REST List of API Operations ................................................................................................................................... 1
1.1 V2 Specific Operations ................................................................................................................. 1
1.1.1 V2 Jurisdiction Determination Operations ........................................................................... 1
1.1.2 V2 Tax Calculation and Commit Operations ......................................................................... 1
1.1.3 V2 Lookup Operations........................................................................................................... 1
1.2 Common Operations .................................................................................................................... 2
1.2.1 Application Operations ......................................................................................................... 2
1.2.2 Taxing Jurisdiction Operations .............................................................................................. 2
1.2.3 Location Operations .............................................................................................................. 2
1.2.4 Tax Lookup Operations ......................................................................................................... 3
1.3 V1 Specific Operations .................................................................................................................. 4
1.3.1 V1 Calculate Taxes and Commit Operations ......................................................................... 4
2 API Details ............................................................................................................................................................. 5
2.1 api/v2/geo/Geocode ..................................................................................................................... 5
2.1.1 Request Fields ....................................................................................................................... 5
2.1.2 Response Fields ..................................................................................................................... 5
2.1.2.1 Address Fields ................................................................................................................... 6
2.2 api/v2/afc/CalcTaxes ..................................................................................................................... 6
2.2.1 Request Fields ....................................................................................................................... 6
2.2.1.1 CompanyData Fields – Object ........................................................................................... 7
2.2.1.1.1 Exclusion Fields ........................................................................................................... 7
2.2.1.2 Invoice Fields ..................................................................................................................... 7
2.2.1.2.1 TaxExemption Fields ................................................................................................... 8
2.2.1.2.2 Location Fields ............................................................................................................ 9
2.2.1.2.3 OptionalField Fields .................................................................................................... 9
2.2.1.2.4 LineItem Request Fields .............................................................................................. 9
2.2.1.3 TaxOverride Fields ........................................................................................................... 10
2.2.1.3.1 TaxBracket Fields ...................................................................................................... 11
2.2.1.4 SafeHarborOverride Fields .............................................................................................. 11
2.2.2 Response Fields ................................................................................................................... 11
2.2.2.1 InvoiceResults Fields ....................................................................................................... 11
2.2.2.1.1 DetailedTax Fields ..................................................................................................... 12
2.2.2.1.1.1 Taxes Fields ........................................................................................................ 12
Quick Reference Links
2.2.2.1.2 SummarizedTax Fields .............................................................................................. 13
2.2.2.2 Error Fields ...................................................................................................................... 13
2.3 api/v2/afc/Pcode ........................................................................................................................ 13
2.3.1 Request Fields ..................................................................................................................... 14
2.3.2 Response Fields ................................................................................................................... 14
2.3.2.1 LocationData Fields ........................................................................................................ 14
2.4 api/v2/afc/Commit ..................................................................................................................... 15
2.4.1 Request Fields ..................................................................................................................... 15
2.4.1.1 OptionalField ................................................................................................................... 15
2.4.2 Response Fields ................................................................................................................... 15
2.5 api/v2/afc/serviceinfo ................................................................................................................. 15
2.5.1 Response Fields ................................................................................................................... 16
2.5.1.1 VersionInfo Fields ........................................................................................................... 16
2.6 api/v2/afc/taxtype/{taxType} ..................................................................................................... 16
2.6.1 Request Fields ..................................................................................................................... 16
2.6.2 Response Fields - List .......................................................................................................... 16
2.7 api/v2/afc/tspairs ........................................................................................................................ 17
2.7.1 Response Fields - List .......................................................................................................... 17
2.8 api/v2/afc/location/{pcode} ....................................................................................................... 17
2.8.1 Request Fields ..................................................................................................................... 18
2.8.2 Response Fields - List .......................................................................................................... 18
2.9 api/v2/afc/primary/{pcode} ........................................................................................................ 18
2.9.1 Request Fields ..................................................................................................................... 18
2.9.2 Response Fields - List .......................................................................................................... 18

Navigation menu