REST API Reference Manual

User Manual:

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

DownloadREST API Reference Manual
Open PDF In BrowserView PDF
REST API Reference Manual

1 REST List of API Operations
1.1 V2 Specific Operations
1.1.1 V2 Jurisdiction Determination Operations
Operation
POST
POST

API URL Reference
/api/v2/geo/Geocode
/api/v2/afc/PCode

Description
Geocodes one or multiple street addresses and/or lat/long coordinates.
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
POST

/api/v2/afc/CalcTaxes
/api/v2/afc/Commit

Performs tax calculations on all invoices and line items.
Commits or un-commits a document code.

1.1.3 V2 Lookup Operations
Operation
GET
GET
GET
GET
GET

API URL Reference
/api/v2/afc/serviceinfo
/api/v2/afc/taxtype/{taxType}
/api/v2/afc/tspairs
/api/v2/afc/location/{pcode}
/api/v2/afc/primary/{pcode}

Description
Retrieves server time, service build version and engine version
Get the tax information (description and category) for a tax type ID
Get transaction/service pair information
Get location data associated with a Pcode
Get primary location data associated with a PCode

REST API Reference Manual

1.2 Common Operations
1.2.1 Application Operations
Operation
GET
GET
GET
GET

API URL Reference
/api/v1/Application/ServerTime
/api/v1/Application/AFCEngineVersion
/api/v1/Application/RESTVersion
/api/v1/Application/AFCDatabaseEngineVersion

Description
Get server time
Get the version of the AFC tax engine
Get the version of the Rest APIs
Get the AFC tax engine database version

1.2.2 Taxing Jurisdiction Operations
Operation
POST

API URL Reference
/api/v1/CalculateJurisdiction

Description
Determine taxing jurisdiction for transaction

1.2.3 Location Operations
Operation
POST
GET
GET
POST
GET
GET
GET

API URL Reference
/api/v1/Location/PCode
/api/v1/Location/PCodeToFips/{pCode}
/api/v1/Location/Address/{pCode}
/api/v1/Location/ZipAddressLookup
/api/v1/Location/Address
/api/v1/Location/Address/{countryIso}
/api/v1/Location/Address/{countryIso}/{stateCode}

Description
Determine PCode for a location
Convert a PCode to FIPS code
Get address information for a jurisdiction
Lookup jurisdictions by location name and/or postal code
Lookup all countries in AFC
Lookup all states in a given country
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
GET
GET
GET
GET

API URL Reference
/api/v1/TaxLookup/Category/{taxType}
/api/v1/TaxLookup/Description/{taxType}
/api/v1/TaxLookup/TaxRates/{pCode}
/api/v1/TaxLookup/TransactionServices

Description
Get tax category for a tax type
Get the tax description for a tax type
Get tax rates for a jurisdiction
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
POST
POST
POST
POST
POST
POST
POST
POST
POST
POST
POST
POST
POST

API URL Reference
/api/v1/BridgeConference/Taxes*
/api/v1/BridgeConference/Adjustments*
/api/v1/CalculateTaxes*
/api/v1/CalculateTaxesMulti*
/api/v1/CalculateTaxInclusive/Adjustments*
/api/v1/CalculateTaxInclusive/Taxes*
/api/v1/CalculateWithOverrides/Taxes*
/api/v1/CalculateWithOverrides/Adjustments*
/api/v1/CustMode/CalcTaxesInCustMode*
/api/v1/CalculateAdjustments*
/api/v1/CalculateProRated/Taxes*
/api/v1/CalculateProRated/Adjustments*
/api/v1/CommitTransactions*

Description
Calculate taxes on a bridge conference transaction
Calculate tax adjustments on a bridge conference transaction
Calculate taxes on a transaction
Calculates taxes on a transaction batch.
Perform a tax-inclusive tax adjustment
Perform a tax-inclusive tax calculation
Calculate taxes using overrides
Calculate tax adjustments using overrides
Process transactions and adjustments in customer mode
Calculate tax adjustments on transaction
Calculate taxes for a pro-rated transaction
Calculate tax adjustments for a pro-rated transaction
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
ref
cass
lat
long
addr
city
st
zip

Long name
Reference
ReturnCass
Latitude
Longitude
StreetAddress
CityName
StateAbbreviation
Zip Code

Type
String
Boolean
Double
Double
String
String
String
String

Description
User supplied reference string which ties results in response back to request
True = return CASS certified address False = do not return CASS certified address
Latitude value for lat/long geocode search (requires long value be supplied)
Longitude value for lat/long geocode search (requires lat value be supplied)
Street address for geocode search
City name for geocode search
State abbreviation for geocode search
5 digit (USA) zip code for geocode search

Type
String
Object
Integer
Integer
String
Integer

Description
User supplied reference string which ties results in response back to request
Cass certified address from geo database
Census block for address
Census tract for address
County for address
Feature id for address

2.1.2 Response Fields
Name
ref
cass
cBlk
cTrc
cnty
feat

Long name
Reference
CassAddress
CensusBlock
CensusTract
County
FeatureId

REST API Reference Manual
fips

FipsCode

String

inc
jur
lat
long
pcd

Incorporated
JurisdictionName
Latitude
Longitude
PCode

scr
err

Score
Error

Boolean
String
Double
Double
Unsigned
Integer
Double
String

10 digit USA FIPs code for address. Special taxing jurisdictions will start with “99” and do
not represent an actual FIPs code.
True = address is within city limits False = address is outside city limits (unincorporated)
FIPs place name for jurisdiction
Latitude for street location associated with the address
Longitude for street location associated with the address
Avalara for communications geocode identifying the taxing jurisdiction associated with the
address or lat/long lookup
Confidence score for lookup. 1.01 = fallback lookup on State/County/City/zip used.
Error message on lookup failures

Type
String
String
String
String

Description
CASS certified street address
CASS certified City name
CASS certified State abbreviation
CASS certified 9 digit (USA) zip code

2.1.2.1
Name
addr
city
st
zip

Address Fields
Long name
StreetAddress
CityName
StateAbbreviation
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
cmpn

Long name
CompanyData

Type
Object

Description
Flags, settings and exclusions that applies to Seller

REST API Reference Manual
inv
ovr
sovr
2.2.1.1
Name
bscl
svcl
fclt
frch
reg
excl
idnt

2.2.1.1.1
Name
ctry
st
excl
2.2.1.2
Name
doc
cmmt

Invoice

List
List
SafeHarborOverride List
TaxOverride

List of Invoices to be taxed
List of overrides to be applied
List of Safe Harbor Traffic Study overrides to be applied

CompanyData Fields – Object
Long name
BusinessClass
ServiceClass
Facilities
Franchise
Regulated

Type
Integer
Integer
Boolean
Boolean
Boolean
Exclusion
List
CompanyIdentifier String

Description
0 = ILEC 1=CLEC (or not an ILEC)
0 = Primary Local, 1 = Primary Long Distance
true = seller is facilities based, false = seller is not facilities based
true = seller has franchise agreement, false = franchise taxes do not apply to seller
true = seller is regulated, false = seller is not regulated
List of Countries and states/provinces/territories to be excluded
20 byte alpha-numeric reporting field for Company Identifier

Exclusion Fields
Long name
Country
State
ExclusionOn

Type
String
String
Boolean

Description
3 Byte Country ISO for exclusion
State abbreviation for exclusion
true = enable exclusion, false = disable exclusion

Invoice Fields
Long name
DocumentCode
Commit

Type
String
Boolean

Description
Unique document code to be applied to invoice for Commit
False = uncommitted, True = committed

REST API Reference Manual
bill
cust
lfln

Location
CustomerType
Lifeline

Location
Integer
Boolean

date
exms
itms
Invm
dtl

InvoiceDate
LineItem
InvoiceMode
ReturnDetail

Date
List
List
Boolean
Boolean

summ

ReturnSummary

Boolean

opt

OptionalField

List

2.2.1.2.1

TaxExemption

BillTo location information
0 = Residential, 1 = Business, 2 = Senior Citizen, 3 = Industrial
false = customer is not a lifeline participant, true = customer is a lifeline
participant
Date to be used to get tax rates and logic. Historical dates supported.
List of tax exemptions to be applied to invoice
List of line items for invoice
false = line items are unrelated, true = line items are part of a single invoice
If invm = true: false = disable tax details true = enable tax details
If invm = false: will always return tax details
If invm = true: false = disable tax summary, true = enable tax summary
If invm = false: summary of tax data not available
Optional fields for reporting

TaxExemption Fields

Name
frc

Long name
Force

Type
Boolean

loc
tpe
lvl
cat
dom

Location
TaxType
TaxLevel
TaxCategory
Domain

Object
Short
Short
Short
Short

scp

Scope

Short

Description
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
Location for exemption to be applied. Match will be at level specified by domain.
Tax type to exempt. Tax type exemptions and Category exemptions are mutually exclusive.
Obsolete - provided for legacy support. Use Domain and Scope instead.
Tax category to exempt. Tax type exemptions and Category exemptions are mutually exclusive.
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
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

2.2.1.2.2

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

Location Fields

Name
ctry
st
cnty
city
zip
Int

Long name
Country
State
County
City
PostalCode
Incorporated

Type
String
String
String
String
String
Boolean

pcd
npa
fips
geo
addr

PCode
NpaNxx
FipsCode
Geocode
StreetAddress

Unsigned Integer
Unsigned Integer
String
Boolean
String

Description
3 Byte Country ISO
Location for exemption to be applied
County Name
City Name or Special Tax Jurisdiction Name
Zip or Postal Code
True = address is within city limits False = address is outside city limits
(unincorporated)
Avalara for communications geocode identifier for location
First 6 digits of phone number
10 digit USA FIPs code for location
alse = do not use geo lookup, true = use geo lookup
Street address for location (used with geo = true)

2.2.1.2.3

OptionalField Fields
Type
Integer
String

Description
Numeric value 1-10 (Index)
Alpha-numeric value up to 150 bytes

Name
key
val
2.2.1.2.4

Long name
Key
Value
LineItem Request Fields

REST API Reference Manual
Name
ref
from
to
chg
line
loc
min
sale
plsp
incl
pror
brdg
tran
serv
dbt
adj
adjm

Long name
Reference
Location
Location
Charge
Lines
Locations
Minutes
SaleType
PrivateLineSplit
TaxInclusive
ProRatedPct
BridgeData
TransactionType
ServiceType
Debit
IsAdjustment
AdjustmentMethod

Type
String
Object
Object
Double
Integer
Integer
Double
Integer
Double
Boolean
Double
Object
Integer
Integer
Boolean
Boolean
Integer

disc
opt

DiscountType
OptionalField

Integer
List

2.2.1.3
Name
loc
scp
tid
lvl
lvlExm
brkt

Description
Reference to tie line item to tax details
Origination or From location
Destination or To location
Charge to be applied to line item
Line count to be applied to line item
Number of locations to be applied to line item
Minutes to be applied to line item
0 = wholesale, 1 = retail, [SAU ONLY 2 = consumed, 3 = vendor use ]
% of private line split A point (p2p) [ 0.25 = 25% point A - 75% point Z ]
false = not tax inclusive, true = is tax inclusive
% for pro-rated calculation of fixed taxes [ 0.5 = 50% ]
Beta – Contact Avalara if you need information on this functionality
Transaction Type (1st part of the t/s pair that defines the product to be taxed)
Service Type (2nd part of the t/s pair that defines the product to be taxed)
false = not a debit card transaction, true = apply debit card logic to transaction
false = not a credit/adjustment, true = is a credit/adjustment
0 = Default, 1 = Least favorable rate to customer, 2 = Most favorable rate to
customer
Refer to manual for valid discount types and descriptions
Optional fields for reporting

TaxOverride Fields
Long name
Location
Scope
TaxType
TaxLevel
LevelExemptible
TaxBracket

Type
Object
Integer
Integer
Integer
Boolean
List

Description
Location the override applies to
Scope for override 0 = Country, 1 = State, 2 = County, 3 = City
Tax Type id for override
Tax Level for override 0 = Federal, 1 = State, 2 = County, 3 = City
false = not level exemptible, true = is level exemptible
Tax Bracket(s)

REST API Reference Manual
2.2.1.3.1

TaxBracket Fields

Name
rate
max

Long name
Rate
MaxBase

2.2.1.4
Name
sh
old
new

Type
Double
Integer

Description
Tax rate for tax bracket
Maximum base for tax bracket (2147483647 = unlimited)

SafeHarborOverride Fields
Long name
SafeHarborType
OriginalFederalTam
NewFederalTam

Type
Integer
Double
Double

Description
1 = Cellular, 2 = VoIP, 4 = Paging
Original Federal TAM. 0.649 = 64.9% State = (1.0 - Federal TAM)
New Federal TAM. 0.371 = 37.1% State = (1.0 - Federal TAM)

Type
List
List

Description
List of invoices with tax results
Error message(s) related to request processing

Type
String
List
List
List

Description
Unique document code applied to invoice for Commit
Detailed list of line item tax results
Summarized taxes for invoice
Error message(s) related to invoice calculation processing

2.2.2 Response Fields
Name
inv
err
2.2.2.1
Name
doc
itms
summ
err

Long name
InvoiceResults
Error
InvoiceResults Fields
Long name
DocumentCode
DetailedTax
SummarizedTax
Error

REST API Reference Manual
2.2.2.1.1
Name
ref
base
txs
brdg
err

DetailedTax Fields
Long name
Reference
BaseSaleAmount
Taxes
BridgeParticipantResult
Error

Type
String
Double
List
List
List

Description
Reference from request to tie line item to tax details
Value for tax inclusive calls that represents the charge minus billable taxes
List of taxes for line item
Beta – Contact Avalara if you need information on this functionality
Error message(s) related to line item calculation processing

Description
false = non-billable tax, true = standard billable tax
false = non-compliance tax, true = standard compliance tax
Taxable Measure applicable to tax (can include tax-on-tax additions)
1 = Rate, 2 = Fixed, 3 = PerMinute, 4 = PerLine, 5 = SelfTaxingRate, 6 =
PerBracket, 7 = FixedOnTier
Tax Category Name
Tax Category Numerical ID
Tax Name
Exempt Sale Amount
Number of lines taxed
PCode representing reporting tax jurisdiction
Applicable tax rate
false = not a surcharge, true = surcharge rules apply
Tax Amount
Tax Level 0 = Federal, 1 = State, 2 = County, 3 = City, 4 = Unincorporated
Tax Type ID

2.2.2.1.1.1 Taxes Fields
Name
bill
cmpl
tm
calc

Long name
Billable
Compliance
TaxableMeasure
CalculationType

Type
Boolean
Boolean
Double
Integer

cat
cid
name
exm
lns
pcd
rate
sur
tax
lvl
tid

CategoryName
CategoryID
TaxName
ExemptSaleAmount
Lines
PCode
Rate
Surcharge
TaxAmount
TaxLevel
TaxType

String
Integer
String
Double
Integer
Unsigned Integer
Double
Boolean
Double
Integer
Integer

REST API Reference Manual
2.2.2.1.2

SummarizedTax Fields

Name
max
min
tchg
calc

Long name
MaxBase
MinBase
TotalCharge
CalculationType

Type
Integer
Integer
Double
Integer

cat
cid
name
exm
lns
pcd
rate
sur
tax
lvl
tid

CategoryName
CategoryID
TaxName
ExemptSaleAmount
Lines
PCode
Rate
Surcharge
TaxAmount
TaxLevel
TaxType

String
Integer
String
Double
Integer
Unsigned Integer
Double
Boolean
Double
Integer
Integer

2.2.2.2
Name
code
msg

Description
Maximum base for tax bracket
Minimum base for tax bracket
Total charge amount for invoice
1 = Rate, 2 = Fixed, 3 = PerMinute, 4 = PerLine, 5 = SelfTaxingRate, 6 =
PerBracket, 7 = FixedOnTier
Tax Category Name
Tax Category Numerical ID
Tax Name
Summarized Exempt Sale Amount
Summarized Number of lines taxed
PCode representing reporting tax jurisdiction
Applicable tax rate
false = not a surcharge, true = surcharge rules apply
Summarized Tax Amount
Tax Level 0 = Federal, 1 = State, 2 = County, 3 = City, 4 = Unincorporated
Tax Type ID

Error Fields
Long name
ErrorCode
ErrorMessage

Type
Integer
String

Description
Numeric code associated with error
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
CountryIso
State
County
City
ZipCode
BestMatch
LimitResults

Long name
CountryIsoCode
StateAbbreviation
CountyName
CityName
ZipCode
BestMatchFlag
LimitResults

Type
String
String
String
String
String
Boolean
Int

Description
3-character country ISO code for jurisdiction
State, province or territory 2-character abbreviation for jurisdiction
County name for jurisdiction
City name for for jurisdiction
5 digit (USA) zip code or 6 byte (Canada) postal code.
Flag indicating whether to return the best matches (true) or exact matches only (false).
Maximum number of results to return. 0 = unlimited.

2.3.2 Response Fields
Name
LocationData
MatchCount
InputMatchType
MatchTypeApplied
ResultsLimit
2.3.2.1

Long name
n/a
n/a
n/a
n/a
n/a

Type
List
String
String
String
String

Description
List of LocationData objects
Number of matches found
Requested match type (Exact or Best)
Match type applied (Exact or Best)
Limit applied to the number of locations returned

LocationData Fields

Name
CountryIso
State
County
Locality
PCode

Long name
CountryIsoCode
StateAbbreviation
CountyName
CityName
PersistedCode

Type
String
String
String
String
Uint

Description
Location found
State, province or territory 2-character abbreviation for jurisdiction
County name for jurisdiction
City name for for jurisdiction
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
doc
cmmt
opt
2.4.1.1
Name
key
val

Long name
DocumentCode
CommitFlag
OptionalField

Type
String
Boolean
Object

Description
150 byte document code to have the commit status changed
True=Commit False=Uncommit
Optional Fields to be updated with the commit

Type
String
String

Description
Key for optional field – can range from 1-10
New optional field value to be associated with key

Type
Boolean
List

Description
Indicates if document code's commit status was updated successfully
Error message(s) related to commit request (as applicable)

OptionalField
Long name
Key
Value

2.4.2 Response Fields
Name
ok
err

Long name
SuccessStatus
Error

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
ServerTime
Versions
Error
2.5.1.1

Long name
n/a
VersionInfo
ErrorMessage

Type
DateTime
Object
String

Description
Date/Time value from the server
Server and Engine versions
Error message from request (as applicable)

VersionInfo Fields

Name
Long name
AfcEngineVersion EngineBuild
BuildVersion
ServerBuild

Type
String
String

Description
AFC Engine Version. Example: 20.1809.1
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
taxType

Long name
TaxTypeId

2.6.2 Response Fields - List

Type
String

Description
Numeric tax type id for lookup or * for all tax types

REST API Reference Manual
Name
TaxType
CategoryType
TaxDescription
CategoryDescription

Long name
n/a
n/a
n/a
n/a

Type
Short
Short
String
String

Description
Numeric id for tax type
Numeric id for category
Description for tax type
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
TransactionType
ServiceType
MarketType
InterfaceType
InputType
IsBundle
TransactionDescription
ServiceDescription
TSPairDescription

Type
Short
Short
Short
Short
Short
Boolean
String
String
String

Description
Numeric id for transaction type
Numeric id for service type
Numeric id for market type
Interface type: 0=Unassigned 1=Telecom 2=SAU 3=Both Telecom and SAU
Input Type (mask) – combination of (0=Invoice, 1=Charge, 2=Lines, 4=Locations, 8=Minutes)
True=Is associated with bundle False=Not associated with bundle
Transaction type description
Service type description
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
pcode

Long name
PersistedCode

Type
UInt

Description
Pcode to retrieve location data for

2.8.2 Response Fields - List
Name
LocationData

Type
List

Description
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
pcode

Long name
PersistedCode

Type
UInt

Description
Pcode to retrieve primary location data for

2.9.2 Response Fields - List
Name
LocationData

Type
List

Description
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
2

V1 Calculate Taxes and Commit Operations ......................................................................... 4

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
2.2

Address Fields ................................................................................................................... 6

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
2.2.2

SafeHarborOverride Fields .............................................................................................. 11
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
2.3

Error Fields ...................................................................................................................... 13

api/v2/afc/Pcode ........................................................................................................................ 13

2.3.1

Request Fields ..................................................................................................................... 14

2.3.2

Response Fields ................................................................................................................... 14

2.3.2.1
2.4

api/v2/afc/Commit ..................................................................................................................... 15

2.4.1
2.4.1.1
2.4.2
2.5

Request Fields ..................................................................................................................... 15
OptionalField ................................................................................................................... 15
Response Fields ................................................................................................................... 15

api/v2/afc/serviceinfo ................................................................................................................. 15

2.5.1
2.5.1.1
2.6

LocationData Fields ........................................................................................................ 14

Response Fields ................................................................................................................... 16
VersionInfo Fields ........................................................................................................... 16

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
2.8

Response Fields - List .......................................................................................................... 17

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



Source Exif Data:
File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.7
Linearized                      : No
Page Count                      : 21
Language                        : en-US
Tagged PDF                      : Yes
XMP Toolkit                     : 3.1-701
Producer                        : Microsoft® Word 2016
Creator                         : Ryan Robinson
Creator Tool                    : Microsoft® Word 2016
Create Date                     : 2018:09:05 16:08:58-04:00
Modify Date                     : 2018:09:05 16:08:58-04:00
Document ID                     : uuid:C4DAB500-9D87-4F3D-A52A-188B8E486C66
Instance ID                     : uuid:C4DAB500-9D87-4F3D-A52A-188B8E486C66
Author                          : Ryan Robinson
EXIF Metadata provided by EXIF.tools

Navigation menu