Avalara Developer Network Developer communications

AvaTax for Communications

Documentation for using the AvaTax for Communication SOAP web service. The schemas and name spaces describe the BasicHttpBinding_IEZTaxWebService binding. Note: In most instances, the ezt Request Prefix may be overridden by changing the "xmlns:ezt=" string to "xmlns:xxx=" where xxx represents one or more characters. In addition, removing the xmlns:ezt="http://schemas.datacontract.org/2004/07/EZTaxWebService" string often (but not always) results in a default Request Prefix of "a".


Begin Customer Batch

This method flags the beginning of a customer transaction batch and returns a customer batch ID that can be used to submit each transaction and process the entire batch.

Api Endpoint
POST https://eztaxasp.billsoft.com/EZTaxWebService/EZTaxWebService.svc?BeginCustomerBatch

Headers
Content-Type: application/xmlSOAPAction: http://tempuri.org/IEZTaxWebService/BeginCustomerBatch

Post Body Parameters

Header
Security
UsernameToken
Username
Required

Username for accessing service.

string
Password
Required

Password for accessing service.

string
Body
BeginCustomerBatch
Transaction
AdjustmentMethod

Adjustment Method. "Please see AdjustmentMethod in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Adjustment Methods."

integer
BillToAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
BillToFipsCode
Required

Bill-to FIPS code. Select only one BillToxxx option.

string
BillToPCode
Required

Bill-to PCode. Select only one BillToxxx option.

integer
BillToNpaNxx
Required

Bill-to NPANXX. Select only one BillToxxx option.

integer
BusinessClass
Required

Business class. Please see BusinessClass in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Business Classes.

integer
Array[CategoryExemptions]
CountryISO

Three-character country ISO code. Required if State is not specified.

string
State

Two-character state abbreviation. Required if CountryISO is not specified.

string
TaxCategory
Required

Valid tax category ID

integer
Charge
Required

Charge amount to customer for transaction

number
CompanyIdentifier

Company identifier. Use the 3-character company identifier provided by Avalara to your organization in order to include this transaction in the monthly compliance reports. Otherwise, leave empty.

string
CountyExempt

True if transaction is exempt from County Tax, otherwise false.

boolean
CountyPCode

Jurisdiction for county exemption.

integer
CustomerNumber

User-defined customer number.

string
CustomerType
Required

Customer type. Please see CustomerType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Customer Types.

integer
Date
Required

Transaction date. Field is provided to allow rating and taxing to occur on a date other than the billing date.

string
Debit

Determines if this is a prepaid debit card transaction.

boolean
DiscountType

Discount type. Please see DiscountType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Discount Types.

integer
Array[Exemptions]
PCode
Required

PCode for jurisdiction to exempt.

integer
TaxLevel
Required

Tax level. "Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Tax Levels."

integer
TaxType
Required

One of the Avalara tax types.

integer
ExemptionType

Set to 0 - reserved for future use. See ExemptionType under TaxData in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf'.

integer
FacilitiesBased

Specifies if the carrier delivering the service has company owned facilities to provide the service.

boolean
FederalExempt

True if transaction is exempt from Federal Tax, otherwise false.

boolean
FederalPCode

Jurisdiction for Federal exemption.

integer
Franchise

Indicates if the company provides services sold pursuant to a franchise agreement between the carrier and jurisdiction.

boolean
Incorporated

True if this transaction is within an incorporated area of the local jurisdiction, otherwise False.

boolean
InvoiceNumber

User-defined invoice number.

integer
IsPrivateLine

Indicates if the transaction is a private line transaction.

boolean
Lines

Number of lines sold to customer when applicable.

integer
LocalExempt

True if transaction is exempt from Local Tax, otherwise false.

boolean
LocalPCode

Jurisdiction for local exemption.

integer
Locations

Number of customer locations.

integer
Minutes

Number of minutes for call when appropriate.

number
Optional

Optional user-defined value.

integer
Optional10

Optional user-defined value.

integer
Optional4

Optional user-defined value.

integer
Optional5

Optional user-defined value.

integer
Optional6

Optional user-defined value.

integer
Optional7

Optional user-defined value.

integer
Optional8

Optional user-defined value.

integer
Optional9

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value. 20-characters max.

string
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
OriginationAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
OriginationFipsCode
Required

Origination FIPS code. Select only one Origination option.

string
OriginationPCode
Required

Origination PCode. Select only one Origination option.

integer
OriginationNpaNxx
Required

Origination NPANXX. Select only one Origination option.

integer
PrivateLineSplit

For private line transactions, this is the split between the ending points of a private line. The value indicates how much the portion of the charge belongs to the origin user.

number
Regulated

True if regulated, otherwise false.

boolean
Sale
Required

Indicates if this is a retail sale. Use false for resale/wholesale transactions.

boolean
ServiceClass
Required

Service class. Please see ServiceClass in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Service Classes.

integer
ServiceLevelNumber

User-defined service level number.

integer
ServiceType
Required

Service type.

integer
StateExempt

True if transaction is exempt from State Tax, otherwise false.

boolean
StatePCode

Jurisdiction for state exemption.

integer
TerminationAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
TerminationFipsCode
Required

Termination FIPS code. Select only one Termination option.

string
TerminationPCode
Required

Termination PCode. Select only one Termination option.

integer
TerminationNpaNxx
Required

Termination NPANXX. Select only one Termination option.

integer
TransactionType
Required

Transaction type.

integer

Response

Header
Security
Timestamp
Created

Creation time and date.

string
Expires

Expiration time and date.

string
Body
BeginCustomerBatchResponse
BeginCustomerBatchResult

Batch ID for transaction submission and batch processing.

number

Calculate Adjustments with Fips Code

This method accepts transaction data and performs appropriate tax adjustment calculations. Origination, Termination, and Bill To information is passed using FIPS Codes. Adjustment transactions are primarily used to process refunds or credits. They rely on the AdjustmentMethod field. Discounts can also be processed by setting the DiscountType field in the adjustment transaction.

Api Endpoint
POST https://eztaxasp.billsoft.com/EZTaxWebService/EZTaxWebService.svc?CalcAdjWithFipsCode

Headers
Content-Type: application/xmlSOAPAction: http://tempuri.org/IEZTaxWebService/CalcAdjWithFipsCode

Post Body Parameters

Header
Security
UsernameToken
Username
Required

Username for accessing service.

string
Password
Required

Password for accessing service.

string
Body
CalcAdjWithFipsCode
AnAdjustment
AdjustmentMethod

Adjustment Method. "Please see AdjustmentMethod in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Adjustment Methods."

integer
BillToAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
BillToFipsCode
Required

Bill-to FIPS code. Select only one BillToxxx option.

string
BillToPCode
Required

Bill-to PCode. Select only one BillToxxx option.

integer
BillToNpaNxx
Required

Bill-to NPANXX. Select only one BillToxxx option.

integer
BusinessClass
Required

Business class. Please see BusinessClass in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Business Classes.

integer
Array[CategoryExemptions]
CountryISO

Three-character country ISO code. Required if State is not specified.

string
State

Two-character state abbreviation. Required if CountryISO is not specified.

string
TaxCategory
Required

Valid tax category ID

integer
Charge
Required

Charge amount to customer for transaction

number
CompanyIdentifier

Company identifier. Use the 3-character company identifier provided by Avalara to your organization in order to include this transaction in the monthly compliance reports. Otherwise, leave empty.

string
CountyExempt

True if transaction is exempt from County Tax, otherwise false.

boolean
CountyPCode

Jurisdiction for county exemption.

integer
CustomerNumber

User-defined customer number.

string
CustomerType
Required

Customer type. Please see CustomerType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Customer Types.

integer
Date
Required

Transaction date. Field is provided to allow rating and taxing to occur on a date other than the billing date.

string
Debit

Determines if this is a prepaid debit card transaction.

boolean
DiscountType

Discount type. Please see DiscountType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Discount Types.

integer
Array[Exemptions]
PCode
Required

PCode for jurisdiction to exempt.

integer
TaxLevel
Required

Tax level. "Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Tax Levels."

integer
TaxType
Required

One of the Avalara tax types.

integer
ExemptionType

Set to 0 - reserved for future use. See ExemptionType under TaxData in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf'.

integer
FacilitiesBased

Specifies if the carrier delivering the service has company owned facilities to provide the service.

boolean
FederalExempt

True if transaction is exempt from Federal Tax, otherwise false.

boolean
FederalPCode

Jurisdiction for Federal exemption.

integer
Franchise

Indicates if the company provides services sold pursuant to a franchise agreement between the carrier and jurisdiction.

boolean
Incorporated

True if this transaction is within an incorporated area of the local jurisdiction, otherwise False.

boolean
InvoiceNumber

User-defined invoice number.

integer
IsPrivateLine

Indicates if the transaction is a private line transaction.

boolean
Lines

Number of lines sold to customer when applicable.

integer
LocalExempt

True if transaction is exempt from Local Tax, otherwise false.

boolean
LocalPCode

Jurisdiction for local exemption.

integer
Locations

Number of customer locations.

integer
Minutes

Number of minutes for call when appropriate.

number
Optional

Optional user-defined value.

integer
Optional10

Optional user-defined value.

integer
Optional4

Optional user-defined value.

integer
Optional5

Optional user-defined value.

integer
Optional6

Optional user-defined value.

integer
Optional7

Optional user-defined value.

integer
Optional8

Optional user-defined value.

integer
Optional9

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value. 20-characters max.

string
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
OriginationAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
OriginationFipsCode
Required

Origination FIPS code. Select only one Origination option.

string
OriginationPCode
Required

Origination PCode. Select only one Origination option.

integer
OriginationNpaNxx
Required

Origination NPANXX. Select only one Origination option.

integer
PrivateLineSplit

For private line transactions, this is the split between the ending points of a private line. The value indicates how much the portion of the charge belongs to the origin user.

number
Regulated

True if regulated, otherwise false.

boolean
Sale
Required

Indicates if this is a retail sale. Use false for resale/wholesale transactions.

boolean
ServiceClass
Required

Service class. Please see ServiceClass in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Service Classes.

integer
ServiceLevelNumber

User-defined service level number.

integer
ServiceType
Required

Service type.

integer
StateExempt

True if transaction is exempt from State Tax, otherwise false.

boolean
StatePCode

Jurisdiction for state exemption.

integer
TerminationAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
TerminationFipsCode
Required

Termination FIPS code. Select only one Termination option.

string
TerminationPCode
Required

Termination PCode. Select only one Termination option.

integer
TerminationNpaNxx
Required

Termination NPANXX. Select only one Termination option.

integer
TransactionType
Required

Transaction type.

integer

Response

Header
Security
Timestamp
Created

Creation time and date.

string
Expires

Expiration time and date.

string
Body
CalcAdjWithFipsCodeResponse
CalcAdjWithFipsCodeResult
Array[TaxData]
AdjustmentType

0 if not an adjustment, otherwise one of the DiscountType enums based on user input. Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of Discount Types.

integer
Billable

Indicates if the tax is billable to the customer.

boolean
CalculationType

Calculation type. Please see CalculationType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list.

integer
CategoryDescription

Tax Category Description.

string
CategoryID

Tax category ID.

integer
CompanyIdentifier

Customer identifier from transaction input.

string
Compliance

Indicates if the tax is reportable to the jurisdiction.

boolean
CustomerNumber

User-defined customer number.

string
Description

Tax description.

string
ExemptSaleAmount

Amount of the charge exempt from taxes.

number
ExemptionType

Set to 0 - reserved for future use. See ExemptionType under TaxData in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf'.

integer
InvoiceNumber

User-defined invoice number.

integer
Lines

Number of lines used to calculate the tax (for per-line tax calculations).

integer
Locations

Number of locations from transaction input.

integer
Minutes

Number of minutes used to calculate the tax (for per-minute tax calculations).

number
Optional

Optional user-defined value.

integer
Optional10

Optional user-defined value.

integer
Optional4

Optional user-defined value.

integer
Optional5

Optional user-defined value.

integer
Optional6

Optional user-defined value.

integer
Optional7

Optional user-defined value.

integer
Optional8

Optional user-defined value.

integer
Optional9

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value.

string
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
PCode

PCode for the reporting jurisdiction.

integer
Rate

Tax rate.

number
RefundUncollect

Taxable measure if tax is smaller than 0 (tax adjustments).

number
ServiceLevelNumber

User-defined service level number.

integer
Surcharge

Indicates if tax is considered a surcharge.

boolean
TaxAmount

Calculated tax amount.

number
TaxLevel

Tax level. "Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Tax Levels."

integer
TaxType

One of the Avalara tax types.

integer
TaxableMeasure

Amount of sale subject to tax plus any taxed taxes.

number

Calculate Adjustments With NpaNxx

This method accepts transaction data and performs appropriate tax calculations. Origination, Termination, and Bill To information is passed using NpaNxx.

Api Endpoint
POST https://eztaxasp.billsoft.com/EZTaxWebService/EZTaxWebService.svc?CalcAdjWithNpaNxx

Headers
Content-Type: application/xmlSOAPAction: http://tempuri.org/IEZTaxWebService/CalcAdjWithNpaNxx

Post Body Parameters

Header
Security
UsernameToken
Username
Required

Username for accessing service.

string
Password
Required

Password for accessing service.

string
Body
CalcAdjWithNpaNxx
AnAdjustment
AdjustmentMethod

Adjustment Method. "Please see AdjustmentMethod in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Adjustment Methods."

integer
BillToAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
BillToFipsCode
Required

Bill-to FIPS code. Select only one BillToxxx option.

string
BillToPCode
Required

Bill-to PCode. Select only one BillToxxx option.

integer
BillToNpaNxx
Required

Bill-to NPANXX. Select only one BillToxxx option.

integer
BusinessClass
Required

Business class. Please see BusinessClass in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Business Classes.

integer
Array[CategoryExemptions]
CountryISO

Three-character country ISO code. Required if State is not specified.

string
State

Two-character state abbreviation. Required if CountryISO is not specified.

string
TaxCategory
Required

Valid tax category ID

integer
Charge
Required

Charge amount to customer for transaction

number
CompanyIdentifier

Company identifier. Use the 3-character company identifier provided by Avalara to your organization in order to include this transaction in the monthly compliance reports. Otherwise, leave empty.

string
CountyExempt

True if transaction is exempt from County Tax, otherwise false.

boolean
CountyPCode

Jurisdiction for county exemption.

integer
CustomerNumber

User-defined customer number.

string
CustomerType
Required

Customer type. Please see CustomerType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Customer Types.

integer
Date
Required

Transaction date. Field is provided to allow rating and taxing to occur on a date other than the billing date.

string
Debit

Determines if this is a prepaid debit card transaction.

boolean
DiscountType

Discount type. Please see DiscountType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Discount Types.

integer
Array[Exemptions]
PCode
Required

PCode for jurisdiction to exempt.

integer
TaxLevel
Required

Tax level. "Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Tax Levels."

integer
TaxType
Required

One of the Avalara tax types.

integer
ExemptionType

Set to 0 - reserved for future use. See ExemptionType under TaxData in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf'.

integer
FacilitiesBased

Specifies if the carrier delivering the service has company owned facilities to provide the service.

boolean
FederalExempt

True if transaction is exempt from Federal Tax, otherwise false.

boolean
FederalPCode

Jurisdiction for Federal exemption.

integer
Franchise

Indicates if the company provides services sold pursuant to a franchise agreement between the carrier and jurisdiction.

boolean
Incorporated

True if this transaction is within an incorporated area of the local jurisdiction, otherwise False.

boolean
InvoiceNumber

User-defined invoice number.

integer
IsPrivateLine

Indicates if the transaction is a private line transaction.

boolean
Lines

Number of lines sold to customer when applicable.

integer
LocalExempt

True if transaction is exempt from Local Tax, otherwise false.

boolean
LocalPCode

Jurisdiction for local exemption.

integer
Locations

Number of customer locations.

integer
Minutes

Number of minutes for call when appropriate.

number
Optional

Optional user-defined value.

integer
Optional10

Optional user-defined value.

integer
Optional4

Optional user-defined value.

integer
Optional5

Optional user-defined value.

integer
Optional6

Optional user-defined value.

integer
Optional7

Optional user-defined value.

integer
Optional8

Optional user-defined value.

integer
Optional9

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value. 20-characters max.

string
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
OriginationAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
OriginationFipsCode
Required

Origination FIPS code. Select only one Origination option.

string
OriginationPCode
Required

Origination PCode. Select only one Origination option.

integer
OriginationNpaNxx
Required

Origination NPANXX. Select only one Origination option.

integer
PrivateLineSplit

For private line transactions, this is the split between the ending points of a private line. The value indicates how much the portion of the charge belongs to the origin user.

number
Regulated

True if regulated, otherwise false.

boolean
Sale
Required

Indicates if this is a retail sale. Use false for resale/wholesale transactions.

boolean
ServiceClass
Required

Service class. Please see ServiceClass in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Service Classes.

integer
ServiceLevelNumber

User-defined service level number.

integer
ServiceType
Required

Service type.

integer
StateExempt

True if transaction is exempt from State Tax, otherwise false.

boolean
StatePCode

Jurisdiction for state exemption.

integer
TerminationAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
TerminationFipsCode
Required

Termination FIPS code. Select only one Termination option.

string
TerminationPCode
Required

Termination PCode. Select only one Termination option.

integer
TerminationNpaNxx
Required

Termination NPANXX. Select only one Termination option.

integer
TransactionType
Required

Transaction type.

integer

Response

Header
Security
Timestamp
Created

Creation time and date.

string
Expires

Expiration time and date.

string
Body
CalcAdjWithNpaNxxResponse
CalcAdjWithNpaNxxResult
Array[TaxData]
AdjustmentType

0 if not an adjustment, otherwise one of the DiscountType enums based on user input. Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of Discount Types.

integer
Billable

Indicates if the tax is billable to the customer.

boolean
CalculationType

Calculation type. Please see CalculationType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list.

integer
CategoryDescription

Tax Category Description.

string
CategoryID

Tax category ID.

integer
CompanyIdentifier

Customer identifier from transaction input.

string
Compliance

Indicates if the tax is reportable to the jurisdiction.

boolean
CustomerNumber

User-defined customer number.

string
Description

Tax description.

string
ExemptSaleAmount

Amount of the charge exempt from taxes.

number
ExemptionType

Set to 0 - reserved for future use. See ExemptionType under TaxData in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf'.

integer
InvoiceNumber

User-defined invoice number.

integer
Lines

Number of lines used to calculate the tax (for per-line tax calculations).

integer
Locations

Number of locations from transaction input.

integer
Minutes

Number of minutes used to calculate the tax (for per-minute tax calculations).

number
Optional

Optional user-defined value.

integer
Optional10

Optional user-defined value.

integer
Optional4

Optional user-defined value.

integer
Optional5

Optional user-defined value.

integer
Optional6

Optional user-defined value.

integer
Optional7

Optional user-defined value.

integer
Optional8

Optional user-defined value.

integer
Optional9

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value.

string
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
PCode

PCode for the reporting jurisdiction.

integer
Rate

Tax rate.

number
RefundUncollect

Taxable measure if tax is smaller than 0 (tax adjustments).

number
ServiceLevelNumber

User-defined service level number.

integer
Surcharge

Indicates if tax is considered a surcharge.

boolean
TaxAmount

Calculated tax amount.

number
TaxLevel

Tax level. "Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Tax Levels."

integer
TaxType

One of the Avalara tax types.

integer
TaxableMeasure

Amount of sale subject to tax plus any taxed taxes.

number

Calculate Adjustments with Overrides

Accepts transaction data and tax rate override data to perform tax adjustment calculations with provided override information.

Api Endpoint
POST https://eztaxasp.billsoft.com/EZTaxWebService/EZTaxWebService.svc?CalcAdjWithOverrides

Headers
Content-Type: application/xmlSOAPAction: http://tempuri.org/IEZTaxWebService/CalcAdjWithOverrides

Post Body Parameters

Header
Security
UsernameToken
Username
Required

Username for accessing service.

string
Password
Required

Password for accessing service.

string
Body
CalcAdjWithOverrides
ATransaction
AdjustmentMethod

Adjustment Method. "Please see AdjustmentMethod in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Adjustment Methods."

integer
BillToAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
BillToFipsCode
Required

Bill-to FIPS code. Select only one BillToxxx option.

string
BillToPCode
Required

Bill-to PCode. Select only one BillToxxx option.

integer
BillToNpaNxx
Required

Bill-to NPANXX. Select only one BillToxxx option.

integer
BusinessClass
Required

Business class. Please see BusinessClass in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Business Classes.

integer
Array[CategoryExemptions]
CountryISO

Three-character country ISO code. Required if State is not specified.

string
State

Two-character state abbreviation. Required if CountryISO is not specified.

string
TaxCategory
Required

Valid tax category ID

integer
Charge
Required

Charge amount to customer for transaction

number
CompanyIdentifier

Company identifier. Use the 3-character company identifier provided by Avalara to your organization in order to include this transaction in the monthly compliance reports. Otherwise, leave empty.

string
CountyExempt

True if transaction is exempt from County Tax, otherwise false.

boolean
CountyPCode

Jurisdiction for county exemption.

integer
CustomerNumber

User-defined customer number.

string
CustomerType
Required

Customer type. Please see CustomerType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Customer Types.

integer
Date
Required

Transaction date. Field is provided to allow rating and taxing to occur on a date other than the billing date.

string
Debit

Determines if this is a prepaid debit card transaction.

boolean
DiscountType

Discount type. Please see DiscountType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Discount Types.

integer
Array[Exemptions]
PCode
Required

PCode for jurisdiction to exempt.

integer
TaxLevel
Required

Tax level. "Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Tax Levels."

integer
TaxType
Required

One of the Avalara tax types.

integer
ExemptionType

Set to 0 - reserved for future use. See ExemptionType under TaxData in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf'.

integer
FacilitiesBased

Specifies if the carrier delivering the service has company owned facilities to provide the service.

boolean
FederalExempt

True if transaction is exempt from Federal Tax, otherwise false.

boolean
FederalPCode

Jurisdiction for Federal exemption.

integer
Franchise

Indicates if the company provides services sold pursuant to a franchise agreement between the carrier and jurisdiction.

boolean
Incorporated

True if this transaction is within an incorporated area of the local jurisdiction, otherwise False.

boolean
InvoiceNumber

User-defined invoice number.

integer
IsPrivateLine

Indicates if the transaction is a private line transaction.

boolean
Lines

Number of lines sold to customer when applicable.

integer
LocalExempt

True if transaction is exempt from Local Tax, otherwise false.

boolean
LocalPCode

Jurisdiction for local exemption.

integer
Locations

Number of customer locations.

integer
Minutes

Number of minutes for call when appropriate.

number
Optional

Optional user-defined value.

integer
Optional10

Optional user-defined value.

integer
Optional4

Optional user-defined value.

integer
Optional5

Optional user-defined value.

integer
Optional6

Optional user-defined value.

integer
Optional7

Optional user-defined value.

integer
Optional8

Optional user-defined value.

integer
Optional9

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value. 20-characters max.

string
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
OriginationAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
OriginationFipsCode
Required

Origination FIPS code. Select only one Origination option.

string
OriginationPCode
Required

Origination PCode. Select only one Origination option.

integer
OriginationNpaNxx
Required

Origination NPANXX. Select only one Origination option.

integer
PrivateLineSplit

For private line transactions, this is the split between the ending points of a private line. The value indicates how much the portion of the charge belongs to the origin user.

number
Regulated

True if regulated, otherwise false.

boolean
Sale
Required

Indicates if this is a retail sale. Use false for resale/wholesale transactions.

boolean
ServiceClass
Required

Service class. Please see ServiceClass in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Service Classes.

integer
ServiceLevelNumber

User-defined service level number.

integer
ServiceType
Required

Service type.

integer
StateExempt

True if transaction is exempt from State Tax, otherwise false.

boolean
StatePCode

Jurisdiction for state exemption.

integer
TerminationAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
TerminationFipsCode
Required

Termination FIPS code. Select only one Termination option.

string
TerminationPCode
Required

Termination PCode. Select only one Termination option.

integer
TerminationNpaNxx
Required

Termination NPANXX. Select only one Termination option.

integer
TransactionType
Required

Transaction type.

integer
OverrideList
TaxRateOverrideInfo
Array[BracketInfo]
TaxBracketInfo
CountyOverrideOn

For sales and use taxes only (tax types 1 and 49), indicates that this tax replaces the tax at the county level.

boolean
CountyOverrideTax

For sales and use taxes only (tax types 1 and 49), overrides the rate for the tax at the county level.

number
MaxBase
Required

Maximum base that this rate applies to.

number
Rate
Required

Tax rate. Value cannot be negative. For rated taxes, value must be from 0 to 1. Otherwise, value may be larger.

number
StateOverrideOn

For sales and use taxes only (tax types 1 and 49) indicates that this tax replaces the tax at the state level.

boolean
StateOverrideTax

For sales and use taxes only (tax types 1 and 49), overrides the rate for the tax at the state level.

number
LevelExemptible
Required

Indicates if the tax can be exempted using level exemptions.

boolean
Pcode
Required

Jurisdiction PCode for this tax rate override.

integer
Scope
Required

Scope for override.

integer
TaxLevel
Required

Tax level. "Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Tax Levels."

integer
TaxType
Required

One of the Avalara tax types.

integer

Response

Header
Security
Timestamp
Created

Creation time and date.

string
Expires

Expiration time and date.

string
Body
CalcAdjWithOverridesResponse
CalcAdjWithOverridesResult
Array[TaxData]
AdjustmentType

0 if not an adjustment, otherwise one of the DiscountType enums based on user input. Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of Discount Types.

integer
Billable

Indicates if the tax is billable to the customer.

boolean
CalculationType

Calculation type. Please see CalculationType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list.

integer
CategoryDescription

Tax Category Description.

string
CategoryID

Tax category ID.

integer
CompanyIdentifier

Customer identifier from transaction input.

string
Compliance

Indicates if the tax is reportable to the jurisdiction.

boolean
CustomerNumber

User-defined customer number.

string
Description

Tax description.

string
ExemptSaleAmount

Amount of the charge exempt from taxes.

number
ExemptionType

Set to 0 - reserved for future use. See ExemptionType under TaxData in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf'.

integer
InvoiceNumber

User-defined invoice number.

integer
Lines

Number of lines used to calculate the tax (for per-line tax calculations).

integer
Locations

Number of locations from transaction input.

integer
Minutes

Number of minutes used to calculate the tax (for per-minute tax calculations).

number
Optional

Optional user-defined value.

integer
Optional10

Optional user-defined value.

integer
Optional4

Optional user-defined value.

integer
Optional5

Optional user-defined value.

integer
Optional6

Optional user-defined value.

integer
Optional7

Optional user-defined value.

integer
Optional8

Optional user-defined value.

integer
Optional9

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value.

string
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
PCode

PCode for the reporting jurisdiction.

integer
Rate

Tax rate.

number
RefundUncollect

Taxable measure if tax is smaller than 0 (tax adjustments).

number
ServiceLevelNumber

User-defined service level number.

integer
Surcharge

Indicates if tax is considered a surcharge.

boolean
TaxAmount

Calculated tax amount.

number
TaxLevel

Tax level. "Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Tax Levels."

integer
TaxType

One of the Avalara tax types.

integer
TaxableMeasure

Amount of sale subject to tax plus any taxed taxes.

number

Calculate Adjustment with PCode.

This method accepts transaction data and performs appropriate tax adjustment calculations. Origination, Termination, and Bill To information is passed using PCodes.

Api Endpoint
POST https://eztaxasp.billsoft.com/EZTaxWebService/EZTaxWebService.svc?CalcAdjWithPCode

Headers
Content-Type: application/xmlSOAPAction: http://tempuri.org/IEZTaxWebService/CalcAdjWithPCode

Post Body Parameters

Header
Security
UsernameToken
Username
Required

Username for accessing service.

string
Password
Required

Password for accessing service.

string
Body
CalcAdjWithPCode
AnAdjustment
AdjustmentMethod

Adjustment Method. "Please see AdjustmentMethod in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Adjustment Methods."

integer
BillToAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
BillToFipsCode
Required

Bill-to FIPS code. Select only one BillToxxx option.

string
BillToPCode
Required

Bill-to PCode. Select only one BillToxxx option.

integer
BillToNpaNxx
Required

Bill-to NPANXX. Select only one BillToxxx option.

integer
BusinessClass
Required

Business class. Please see BusinessClass in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Business Classes.

integer
Array[CategoryExemptions]
CountryISO

Three-character country ISO code. Required if State is not specified.

string
State

Two-character state abbreviation. Required if CountryISO is not specified.

string
TaxCategory
Required

Valid tax category ID

integer
Charge
Required

Charge amount to customer for transaction

number
CompanyIdentifier

Company identifier. Use the 3-character company identifier provided by Avalara to your organization in order to include this transaction in the monthly compliance reports. Otherwise, leave empty.

string
CountyExempt

True if transaction is exempt from County Tax, otherwise false.

boolean
CountyPCode

Jurisdiction for county exemption.

integer
CustomerNumber

User-defined customer number.

string
CustomerType
Required

Customer type. Please see CustomerType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Customer Types.

integer
Date
Required

Transaction date. Field is provided to allow rating and taxing to occur on a date other than the billing date.

string
Debit

Determines if this is a prepaid debit card transaction.

boolean
DiscountType

Discount type. Please see DiscountType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Discount Types.

integer
Array[Exemptions]
PCode
Required

PCode for jurisdiction to exempt.

integer
TaxLevel
Required

Tax level. "Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Tax Levels."

integer
TaxType
Required

One of the Avalara tax types.

integer
ExemptionType

Set to 0 - reserved for future use. See ExemptionType under TaxData in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf'.

integer
FacilitiesBased

Specifies if the carrier delivering the service has company owned facilities to provide the service.

boolean
FederalExempt

True if transaction is exempt from Federal Tax, otherwise false.

boolean
FederalPCode

Jurisdiction for Federal exemption.

integer
Franchise

Indicates if the company provides services sold pursuant to a franchise agreement between the carrier and jurisdiction.

boolean
Incorporated

True if this transaction is within an incorporated area of the local jurisdiction, otherwise False.

boolean
InvoiceNumber

User-defined invoice number.

integer
IsPrivateLine

Indicates if the transaction is a private line transaction.

boolean
Lines

Number of lines sold to customer when applicable.

integer
LocalExempt

True if transaction is exempt from Local Tax, otherwise false.

boolean
LocalPCode

Jurisdiction for local exemption.

integer
Locations

Number of customer locations.

integer
Minutes

Number of minutes for call when appropriate.

number
Optional

Optional user-defined value.

integer
Optional10

Optional user-defined value.

integer
Optional4

Optional user-defined value.

integer
Optional5

Optional user-defined value.

integer
Optional6

Optional user-defined value.

integer
Optional7

Optional user-defined value.

integer
Optional8

Optional user-defined value.

integer
Optional9

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value. 20-characters max.

string
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
OriginationAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
OriginationFipsCode
Required

Origination FIPS code. Select only one Origination option.

string
OriginationPCode
Required

Origination PCode. Select only one Origination option.

integer
OriginationNpaNxx
Required

Origination NPANXX. Select only one Origination option.

integer
PrivateLineSplit

For private line transactions, this is the split between the ending points of a private line. The value indicates how much the portion of the charge belongs to the origin user.

number
Regulated

True if regulated, otherwise false.

boolean
Sale
Required

Indicates if this is a retail sale. Use false for resale/wholesale transactions.

boolean
ServiceClass
Required

Service class. Please see ServiceClass in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Service Classes.

integer
ServiceLevelNumber

User-defined service level number.

integer
ServiceType
Required

Service type.

integer
StateExempt

True if transaction is exempt from State Tax, otherwise false.

boolean
StatePCode

Jurisdiction for state exemption.

integer
TerminationAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
TerminationFipsCode
Required

Termination FIPS code. Select only one Termination option.

string
TerminationPCode
Required

Termination PCode. Select only one Termination option.

integer
TerminationNpaNxx
Required

Termination NPANXX. Select only one Termination option.

integer
TransactionType
Required

Transaction type.

integer

Response

Header
Security
Timestamp
Created

Creation time and date.

string
Expires

Expiration time and date.

string
Body
CalcAdjWithPCodeResponse
CalcAdjWithPCodeResult
Array[TaxData]
AdjustmentType

0 if not an adjustment, otherwise one of the DiscountType enums based on user input. Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of Discount Types.

integer
Billable

Indicates if the tax is billable to the customer.

boolean
CalculationType

Calculation type. Please see CalculationType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list.

integer
CategoryDescription

Tax Category Description.

string
CategoryID

Tax category ID.

integer
CompanyIdentifier

Customer identifier from transaction input.

string
Compliance

Indicates if the tax is reportable to the jurisdiction.

boolean
CustomerNumber

User-defined customer number.

string
Description

Tax description.

string
ExemptSaleAmount

Amount of the charge exempt from taxes.

number
ExemptionType

Set to 0 - reserved for future use. See ExemptionType under TaxData in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf'.

integer
InvoiceNumber

User-defined invoice number.

integer
Lines

Number of lines used to calculate the tax (for per-line tax calculations).

integer
Locations

Number of locations from transaction input.

integer
Minutes

Number of minutes used to calculate the tax (for per-minute tax calculations).

number
Optional

Optional user-defined value.

integer
Optional10

Optional user-defined value.

integer
Optional4

Optional user-defined value.

integer
Optional5

Optional user-defined value.

integer
Optional6

Optional user-defined value.

integer
Optional7

Optional user-defined value.

integer
Optional8

Optional user-defined value.

integer
Optional9

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value.

string
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
PCode

PCode for the reporting jurisdiction.

integer
Rate

Tax rate.

number
RefundUncollect

Taxable measure if tax is smaller than 0 (tax adjustments).

number
ServiceLevelNumber

User-defined service level number.

integer
Surcharge

Indicates if tax is considered a surcharge.

boolean
TaxAmount

Calculated tax amount.

number
TaxLevel

Tax level. "Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Tax Levels."

integer
TaxType

One of the Avalara tax types.

integer
TaxableMeasure

Amount of sale subject to tax plus any taxed taxes.

number

Calculate Adjustment with Zip Address

This method accepts transaction data and performs appropriate tax adjustment calculations. Origination, Termination, and Bill To information is passed using Zip addresses.

Api Endpoint
POST https://eztaxasp.billsoft.com/EZTaxWebService/EZTaxWebService.svc?CalcAdjWithZipAddress

Headers
Content-Type: application/xmlSOAPAction: http://tempuri.org/IEZTaxWebService/CalcAdjWithZipAddress

Post Body Parameters

Header
Security
UsernameToken
Username
Required

Username for accessing service.

string
Password
Required

Password for accessing service.

string
Body
CalcAdjWithZipAddress
AnAdjustment
AdjustmentMethod

Adjustment Method. "Please see AdjustmentMethod in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Adjustment Methods."

integer
BillToAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
BillToFipsCode
Required

Bill-to FIPS code. Select only one BillToxxx option.

string
BillToPCode
Required

Bill-to PCode. Select only one BillToxxx option.

integer
BillToNpaNxx
Required

Bill-to NPANXX. Select only one BillToxxx option.

integer
BusinessClass
Required

Business class. Please see BusinessClass in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Business Classes.

integer
Array[CategoryExemptions]
CountryISO

Three-character country ISO code. Required if State is not specified.

string
State

Two-character state abbreviation. Required if CountryISO is not specified.

string
TaxCategory
Required

Valid tax category ID

integer
Charge
Required

Charge amount to customer for transaction

number
CompanyIdentifier

Company identifier. Use the 3-character company identifier provided by Avalara to your organization in order to include this transaction in the monthly compliance reports. Otherwise, leave empty.

string
CountyExempt

True if transaction is exempt from County Tax, otherwise false.

boolean
CountyPCode

Jurisdiction for county exemption.

integer
CustomerNumber

User-defined customer number.

string
CustomerType
Required

Customer type. Please see CustomerType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Customer Types.

integer
Date
Required

Transaction date. Field is provided to allow rating and taxing to occur on a date other than the billing date.

string
Debit

Determines if this is a prepaid debit card transaction.

boolean
DiscountType

Discount type. Please see DiscountType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Discount Types.

integer
Array[Exemptions]
PCode
Required

PCode for jurisdiction to exempt.

integer
TaxLevel
Required

Tax level. "Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Tax Levels."

integer
TaxType
Required

One of the Avalara tax types.

integer
ExemptionType

Set to 0 - reserved for future use. See ExemptionType under TaxData in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf'.

integer
FacilitiesBased

Specifies if the carrier delivering the service has company owned facilities to provide the service.

boolean
FederalExempt

True if transaction is exempt from Federal Tax, otherwise false.

boolean
FederalPCode

Jurisdiction for Federal exemption.

integer
Franchise

Indicates if the company provides services sold pursuant to a franchise agreement between the carrier and jurisdiction.

boolean
Incorporated

True if this transaction is within an incorporated area of the local jurisdiction, otherwise False.

boolean
InvoiceNumber

User-defined invoice number.

integer
IsPrivateLine

Indicates if the transaction is a private line transaction.

boolean
Lines

Number of lines sold to customer when applicable.

integer
LocalExempt

True if transaction is exempt from Local Tax, otherwise false.

boolean
LocalPCode

Jurisdiction for local exemption.

integer
Locations

Number of customer locations.

integer
Minutes

Number of minutes for call when appropriate.

number
Optional

Optional user-defined value.

integer
Optional10

Optional user-defined value.

integer
Optional4

Optional user-defined value.

integer
Optional5

Optional user-defined value.

integer
Optional6

Optional user-defined value.

integer
Optional7

Optional user-defined value.

integer
Optional8

Optional user-defined value.

integer
Optional9

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value. 20-characters max.

string
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
OriginationAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
OriginationFipsCode
Required

Origination FIPS code. Select only one Origination option.

string
OriginationPCode
Required

Origination PCode. Select only one Origination option.

integer
OriginationNpaNxx
Required

Origination NPANXX. Select only one Origination option.

integer
PrivateLineSplit

For private line transactions, this is the split between the ending points of a private line. The value indicates how much the portion of the charge belongs to the origin user.

number
Regulated

True if regulated, otherwise false.

boolean
Sale
Required

Indicates if this is a retail sale. Use false for resale/wholesale transactions.

boolean
ServiceClass
Required

Service class. Please see ServiceClass in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Service Classes.

integer
ServiceLevelNumber

User-defined service level number.

integer
ServiceType
Required

Service type.

integer
StateExempt

True if transaction is exempt from State Tax, otherwise false.

boolean
StatePCode

Jurisdiction for state exemption.

integer
TerminationAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
TerminationFipsCode
Required

Termination FIPS code. Select only one Termination option.

string
TerminationPCode
Required

Termination PCode. Select only one Termination option.

integer
TerminationNpaNxx
Required

Termination NPANXX. Select only one Termination option.

integer
TransactionType
Required

Transaction type.

integer

Response

Header
Security
Timestamp
Created

Creation time and date.

string
Expires

Expiration time and date.

string
Body
CalcAdjWithZipAddressResponse
CalcAdjWithZipAddressResult
Array[TaxData]
AdjustmentType

0 if not an adjustment, otherwise one of the DiscountType enums based on user input. Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of Discount Types.

integer
Billable

Indicates if the tax is billable to the customer.

boolean
CalculationType

Calculation type. Please see CalculationType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list.

integer
CategoryDescription

Tax Category Description.

string
CategoryID

Tax category ID.

integer
CompanyIdentifier

Customer identifier from transaction input.

string
Compliance

Indicates if the tax is reportable to the jurisdiction.

boolean
CustomerNumber

User-defined customer number.

string
Description

Tax description.

string
ExemptSaleAmount

Amount of the charge exempt from taxes.

number
ExemptionType

Set to 0 - reserved for future use. See ExemptionType under TaxData in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf'.

integer
InvoiceNumber

User-defined invoice number.

integer
Lines

Number of lines used to calculate the tax (for per-line tax calculations).

integer
Locations

Number of locations from transaction input.

integer
Minutes

Number of minutes used to calculate the tax (for per-minute tax calculations).

number
Optional

Optional user-defined value.

integer
Optional10

Optional user-defined value.

integer
Optional4

Optional user-defined value.

integer
Optional5

Optional user-defined value.

integer
Optional6

Optional user-defined value.

integer
Optional7

Optional user-defined value.

integer
Optional8

Optional user-defined value.

integer
Optional9

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value.

string
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
PCode

PCode for the reporting jurisdiction.

integer
Rate

Tax rate.

number
RefundUncollect

Taxable measure if tax is smaller than 0 (tax adjustments).

number
ServiceLevelNumber

User-defined service level number.

integer
Surcharge

Indicates if tax is considered a surcharge.

boolean
TaxAmount

Calculated tax amount.

number
TaxLevel

Tax level. "Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Tax Levels."

integer
TaxType

One of the Avalara tax types.

integer
TaxableMeasure

Amount of sale subject to tax plus any taxed taxes.

number

Calc Cust Adj

Submits an adjustment for the specified customer batch.

Api Endpoint
POST https://eztaxasp.billsoft.com/EZTaxWebService/EZTaxWebService.svc?CalcCustAdj

Headers
Content-Type: application/xmlSOAPAction: http://tempuri.org/IEZTaxWebService/CalcCustAdj

Post Body Parameters

Header
Security
UsernameToken
Username
Required

Username for accessing service.

string
Password
Required

Password for accessing service.

string
Body
CalcCustAdj
custBatchId
Required
number
Adjustment
AdjustmentMethod

Adjustment Method. "Please see AdjustmentMethod in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Adjustment Methods."

integer
BillToAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
BillToFipsCode
Required

Bill-to FIPS code. Select only one BillToxxx option.

string
BillToPCode
Required

Bill-to PCode. Select only one BillToxxx option.

integer
BillToNpaNxx
Required

Bill-to NPANXX. Select only one BillToxxx option.

integer
BusinessClass
Required

Business class. Please see BusinessClass in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Business Classes.

integer
Array[CategoryExemptions]
CountryISO

Three-character country ISO code. Required if State is not specified.

string
State

Two-character state abbreviation. Required if CountryISO is not specified.

string
TaxCategory
Required

Valid tax category ID

integer
Charge
Required

Charge amount to customer for transaction

number
CompanyIdentifier

Company identifier. Use the 3-character company identifier provided by Avalara to your organization in order to include this transaction in the monthly compliance reports. Otherwise, leave empty.

string
CountyExempt

True if transaction is exempt from County Tax, otherwise false.

boolean
CountyPCode

Jurisdiction for county exemption.

integer
CustomerNumber

User-defined customer number.

string
CustomerType
Required

Customer type. Please see CustomerType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Customer Types.

integer
Date
Required

Transaction date. Field is provided to allow rating and taxing to occur on a date other than the billing date.

string
Debit

Determines if this is a prepaid debit card transaction.

boolean
DiscountType

Discount type. Please see DiscountType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Discount Types.

integer
Array[Exemptions]
PCode
Required

PCode for jurisdiction to exempt.

integer
TaxLevel
Required

Tax level. "Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Tax Levels."

integer
TaxType
Required

One of the Avalara tax types.

integer
ExemptionType

Set to 0 - reserved for future use. See ExemptionType under TaxData in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf'.

integer
FacilitiesBased

Specifies if the carrier delivering the service has company owned facilities to provide the service.

boolean
FederalExempt

True if transaction is exempt from Federal Tax, otherwise false.

boolean
FederalPCode

Jurisdiction for Federal exemption.

integer
Franchise

Indicates if the company provides services sold pursuant to a franchise agreement between the carrier and jurisdiction.

boolean
Incorporated

True if this transaction is within an incorporated area of the local jurisdiction, otherwise False.

boolean
InvoiceNumber

User-defined invoice number.

integer
IsPrivateLine

Indicates if the transaction is a private line transaction.

boolean
Lines

Number of lines sold to customer when applicable.

integer
LocalExempt

True if transaction is exempt from Local Tax, otherwise false.

boolean
LocalPCode

Jurisdiction for local exemption.

integer
Locations

Number of customer locations.

integer
Minutes

Number of minutes for call when appropriate.

number
Optional

Optional user-defined value.

integer
Optional10

Optional user-defined value.

integer
Optional4

Optional user-defined value.

integer
Optional5

Optional user-defined value.

integer
Optional6

Optional user-defined value.

integer
Optional7

Optional user-defined value.

integer
Optional8

Optional user-defined value.

integer
Optional9

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value. 20-characters max.

string
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
OriginationAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
OriginationFipsCode
Required

Origination FIPS code. Select only one Origination option.

string
OriginationPCode
Required

Origination PCode. Select only one Origination option.

integer
OriginationNpaNxx
Required

Origination NPANXX. Select only one Origination option.

integer
PrivateLineSplit

For private line transactions, this is the split between the ending points of a private line. The value indicates how much the portion of the charge belongs to the origin user.

number
Regulated

True if regulated, otherwise false.

boolean
Sale
Required

Indicates if this is a retail sale. Use false for resale/wholesale transactions.

boolean
ServiceClass
Required

Service class. Please see ServiceClass in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Service Classes.

integer
ServiceLevelNumber

User-defined service level number.

integer
ServiceType
Required

Service type.

integer
StateExempt

True if transaction is exempt from State Tax, otherwise false.

boolean
StatePCode

Jurisdiction for state exemption.

integer
TerminationAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
TerminationFipsCode
Required

Termination FIPS code. Select only one Termination option.

string
TerminationPCode
Required

Termination PCode. Select only one Termination option.

integer
TerminationNpaNxx
Required

Termination NPANXX. Select only one Termination option.

integer
TransactionType
Required

Transaction type.

integer

Response

Header
Security
Timestamp
Created

Creation time and date.

string
Expires

Expiration time and date.

string
Body
CalcCustAdjResponse
CalcCustAdjResult

Boolean indicating success (true) or failure (false).

boolean

Calculate Customer Taxes in Batch Mode.

Submits a single transaction to be processed for a customer batch.

Api Endpoint
POST https://eztaxasp.billsoft.com/EZTaxWebService/EZTaxWebService.svc?CalcCustTaxes

Headers
Content-Type: application/xmlSOAPAction: http://tempuri.org/IEZTaxWebService/CalcCustTaxes

Post Body Parameters

Header
Security
UsernameToken
Username
Required

Username for accessing service.

string
Password
Required

Password for accessing service.

string
Body
CalcCustTaxes
custBatchId
Required
number
Transaction
AdjustmentMethod

Adjustment Method. "Please see AdjustmentMethod in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Adjustment Methods."

integer
BillToAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
BillToFipsCode
Required

Bill-to FIPS code. Select only one BillToxxx option.

string
BillToPCode
Required

Bill-to PCode. Select only one BillToxxx option.

integer
BillToNpaNxx
Required

Bill-to NPANXX. Select only one BillToxxx option.

integer
BusinessClass
Required

Business class. Please see BusinessClass in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Business Classes.

integer
Array[CategoryExemptions]
CountryISO

Three-character country ISO code. Required if State is not specified.

string
State

Two-character state abbreviation. Required if CountryISO is not specified.

string
TaxCategory
Required

Valid tax category ID

integer
Charge
Required

Charge amount to customer for transaction

number
CompanyIdentifier

Company identifier. Use the 3-character company identifier provided by Avalara to your organization in order to include this transaction in the monthly compliance reports. Otherwise, leave empty.

string
CountyExempt

True if transaction is exempt from County Tax, otherwise false.

boolean
CountyPCode

Jurisdiction for county exemption.

integer
CustomerNumber

User-defined customer number.

string
CustomerType
Required

Customer type. Please see CustomerType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Customer Types.

integer
Date
Required

Transaction date. Field is provided to allow rating and taxing to occur on a date other than the billing date.

string
Debit

Determines if this is a prepaid debit card transaction.

boolean
DiscountType

Discount type. Please see DiscountType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Discount Types.

integer
Array[Exemptions]
PCode
Required

PCode for jurisdiction to exempt.

integer
TaxLevel
Required

Tax level. "Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Tax Levels."

integer
TaxType
Required

One of the Avalara tax types.

integer
ExemptionType

Set to 0 - reserved for future use. See ExemptionType under TaxData in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf'.

integer
FacilitiesBased

Specifies if the carrier delivering the service has company owned facilities to provide the service.

boolean
FederalExempt

True if transaction is exempt from Federal Tax, otherwise false.

boolean
FederalPCode

Jurisdiction for Federal exemption.

integer
Franchise

Indicates if the company provides services sold pursuant to a franchise agreement between the carrier and jurisdiction.

boolean
Incorporated

True if this transaction is within an incorporated area of the local jurisdiction, otherwise False.

boolean
InvoiceNumber

User-defined invoice number.

integer
IsPrivateLine

Indicates if the transaction is a private line transaction.

boolean
Lines

Number of lines sold to customer when applicable.

integer
LocalExempt

True if transaction is exempt from Local Tax, otherwise false.

boolean
LocalPCode

Jurisdiction for local exemption.

integer
Locations

Number of customer locations.

integer
Minutes

Number of minutes for call when appropriate.

number
Optional

Optional user-defined value.

integer
Optional10

Optional user-defined value.

integer
Optional4

Optional user-defined value.

integer
Optional5

Optional user-defined value.

integer
Optional6

Optional user-defined value.

integer
Optional7

Optional user-defined value.

integer
Optional8

Optional user-defined value.

integer
Optional9

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value. 20-characters max.

string
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
OriginationAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
OriginationFipsCode
Required

Origination FIPS code. Select only one Origination option.

string
OriginationPCode
Required

Origination PCode. Select only one Origination option.

integer
OriginationNpaNxx
Required

Origination NPANXX. Select only one Origination option.

integer
PrivateLineSplit

For private line transactions, this is the split between the ending points of a private line. The value indicates how much the portion of the charge belongs to the origin user.

number
Regulated

True if regulated, otherwise false.

boolean
Sale
Required

Indicates if this is a retail sale. Use false for resale/wholesale transactions.

boolean
ServiceClass
Required

Service class. Please see ServiceClass in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Service Classes.

integer
ServiceLevelNumber

User-defined service level number.

integer
ServiceType
Required

Service type.

integer
StateExempt

True if transaction is exempt from State Tax, otherwise false.

boolean
StatePCode

Jurisdiction for state exemption.

integer
TerminationAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
TerminationFipsCode
Required

Termination FIPS code. Select only one Termination option.

string
TerminationPCode
Required

Termination PCode. Select only one Termination option.

integer
TerminationNpaNxx
Required

Termination NPANXX. Select only one Termination option.

integer
TransactionType
Required

Transaction type.

integer

Response

Header
Security
Timestamp
Created

Creation time and date.

string
Expires

Expiration time and date.

string
Body
CalcCustTaxesResponse
CalcCustTaxesResult

Boolean indicating success (true) or failure(false).

boolean

Calculate Jurisdiction

Determines the taxing jurisdiction for a transaction and returns the PCode at the lowest jurisdiction level.

Api Endpoint
POST https://eztaxasp.billsoft.com/EZTaxWebService/EZTaxWebService.svc?CalcJurisdiction

Headers
Content-Type: application/xmlSOAPAction: http://tempuri.org/IEZTaxWebService/CalcJurisdiction

Post Body Parameters

Header
Security
UsernameToken
Username
Required

Username for accessing service.

string
Password
Required

Password for accessing service.

string
Body
CalcJurisdiction
Transaction
AdjustmentMethod

Adjustment Method. "Please see AdjustmentMethod in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Adjustment Methods."

integer
BillToAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
BillToFipsCode
Required

Bill-to FIPS code. Select only one BillToxxx option.

string
BillToPCode
Required

Bill-to PCode. Select only one BillToxxx option.

integer
BillToNpaNxx
Required

Bill-to NPANXX. Select only one BillToxxx option.

integer
BusinessClass
Required

Business class. Please see BusinessClass in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Business Classes.

integer
Array[CategoryExemptions]
CountryISO

Three-character country ISO code. Required if State is not specified.

string
State

Two-character state abbreviation. Required if CountryISO is not specified.

string
TaxCategory
Required

Valid tax category ID

integer
Charge
Required

Charge amount to customer for transaction

number
CompanyIdentifier

Company identifier. Use the 3-character company identifier provided by Avalara to your organization in order to include this transaction in the monthly compliance reports. Otherwise, leave empty.

string
CountyExempt

True if transaction is exempt from County Tax, otherwise false.

boolean
CountyPCode

Jurisdiction for county exemption.

integer
CustomerNumber

User-defined customer number.

string
CustomerType
Required

Customer type. Please see CustomerType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Customer Types.

integer
Date
Required

Transaction date. Field is provided to allow rating and taxing to occur on a date other than the billing date.

string
Debit

Determines if this is a prepaid debit card transaction.

boolean
DiscountType

Discount type. Please see DiscountType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Discount Types.

integer
Array[Exemptions]
PCode
Required

PCode for jurisdiction to exempt.

integer
TaxLevel
Required

Tax level. "Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Tax Levels."

integer
TaxType
Required

One of the Avalara tax types.

integer
ExemptionType

Set to 0 - reserved for future use. See ExemptionType under TaxData in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf'.

integer
FacilitiesBased

Specifies if the carrier delivering the service has company owned facilities to provide the service.

boolean
FederalExempt

True if transaction is exempt from Federal Tax, otherwise false.

boolean
FederalPCode

Jurisdiction for Federal exemption.

integer
Franchise

Indicates if the company provides services sold pursuant to a franchise agreement between the carrier and jurisdiction.

boolean
Incorporated

True if this transaction is within an incorporated area of the local jurisdiction, otherwise False.

boolean
InvoiceNumber

User-defined invoice number.

integer
IsPrivateLine

Indicates if the transaction is a private line transaction.

boolean
Lines

Number of lines sold to customer when applicable.

integer
LocalExempt

True if transaction is exempt from Local Tax, otherwise false.

boolean
LocalPCode

Jurisdiction for local exemption.

integer
Locations

Number of customer locations.

integer
Minutes

Number of minutes for call when appropriate.

number
Optional

Optional user-defined value.

integer
Optional10

Optional user-defined value.

integer
Optional4

Optional user-defined value.

integer
Optional5

Optional user-defined value.

integer
Optional6

Optional user-defined value.

integer
Optional7

Optional user-defined value.

integer
Optional8

Optional user-defined value.

integer
Optional9

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value. 20-characters max.

string
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
OriginationAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
OriginationFipsCode
Required

Origination FIPS code. Select only one Origination option.

string
OriginationPCode
Required

Origination PCode. Select only one Origination option.

integer
OriginationNpaNxx
Required

Origination NPANXX. Select only one Origination option.

integer
PrivateLineSplit

For private line transactions, this is the split between the ending points of a private line. The value indicates how much the portion of the charge belongs to the origin user.

number
Regulated

True if regulated, otherwise false.

boolean
Sale
Required

Indicates if this is a retail sale. Use false for resale/wholesale transactions.

boolean
ServiceClass
Required

Service class. Please see ServiceClass in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Service Classes.

integer
ServiceLevelNumber

User-defined service level number.

integer
ServiceType
Required

Service type.

integer
StateExempt

True if transaction is exempt from State Tax, otherwise false.

boolean
StatePCode

Jurisdiction for state exemption.

integer
TerminationAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
TerminationFipsCode
Required

Termination FIPS code. Select only one Termination option.

string
TerminationPCode
Required

Termination PCode. Select only one Termination option.

integer
TerminationNpaNxx
Required

Termination NPANXX. Select only one Termination option.

integer
TransactionType
Required

Transaction type.

integer

Response

Header
Security
Timestamp
Created

Creation time and date.

string
Expires

Expiration time and date.

string
Body
CalcJurisdictionResponse
CalcJurisdictionResult
myValue

PCode for taxing jurisdiction.

number

Calculate Pro-rated Adjustments

Accepts a pro-rated percentage that is used to calculate the adjustment amount on the transaction and perform tax calculations. Bill To, Origination and Termination may be entered as PCode, FIPS Codes, Zip Address or NpaNxx.

Api Endpoint
POST https://eztaxasp.billsoft.com/EZTaxWebService/EZTaxWebService.svc?CalcProRatedAdj

Headers
Content-Type: application/xmlSOAPAction: http://tempuri.org/IEZTaxWebService/CalcProRatedAdj

Post Body Parameters

Header
Security
UsernameToken
Username
Required

Username for accessing service.

string
Password
Required

Password for accessing service.

string
Body
CalcProRatedAdj
ATransaction
AdjustmentMethod

Adjustment Method. "Please see AdjustmentMethod in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Adjustment Methods."

integer
BillToAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
BillToFipsCode
Required

Bill-to FIPS code. Select only one BillToxxx option.

string
BillToPCode
Required

Bill-to PCode. Select only one BillToxxx option.

integer
BillToNpaNxx
Required

Bill-to NPANXX. Select only one BillToxxx option.

integer
BusinessClass
Required

Business class. Please see BusinessClass in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Business Classes.

integer
Array[CategoryExemptions]
CountryISO

Three-character country ISO code. Required if State is not specified.

string
State

Two-character state abbreviation. Required if CountryISO is not specified.

string
TaxCategory
Required

Valid tax category ID

integer
Charge
Required

Charge amount to customer for transaction

number
CompanyIdentifier

Company identifier. Use the 3-character company identifier provided by Avalara to your organization in order to include this transaction in the monthly compliance reports. Otherwise, leave empty.

string
CountyExempt

True if transaction is exempt from County Tax, otherwise false.

boolean
CountyPCode

Jurisdiction for county exemption.

integer
CustomerNumber

User-defined customer number.

string
CustomerType
Required

Customer type. Please see CustomerType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Customer Types.

integer
Date
Required

Transaction date. Field is provided to allow rating and taxing to occur on a date other than the billing date.

string
Debit

Determines if this is a prepaid debit card transaction.

boolean
DiscountType

Discount type. Please see DiscountType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Discount Types.

integer
Array[Exemptions]
PCode
Required

PCode for jurisdiction to exempt.

integer
TaxLevel
Required

Tax level. "Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Tax Levels."

integer
TaxType
Required

One of the Avalara tax types.

integer
ExemptionType

Set to 0 - reserved for future use. See ExemptionType under TaxData in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf'.

integer
FacilitiesBased

Specifies if the carrier delivering the service has company owned facilities to provide the service.

boolean
FederalExempt

True if transaction is exempt from Federal Tax, otherwise false.

boolean
FederalPCode

Jurisdiction for Federal exemption.

integer
Franchise

Indicates if the company provides services sold pursuant to a franchise agreement between the carrier and jurisdiction.

boolean
Incorporated

True if this transaction is within an incorporated area of the local jurisdiction, otherwise False.

boolean
InvoiceNumber

User-defined invoice number.

integer
IsPrivateLine

Indicates if the transaction is a private line transaction.

boolean
Lines

Number of lines sold to customer when applicable.

integer
LocalExempt

True if transaction is exempt from Local Tax, otherwise false.

boolean
LocalPCode

Jurisdiction for local exemption.

integer
Locations

Number of customer locations.

integer
Minutes

Number of minutes for call when appropriate.

number
Optional

Optional user-defined value.

integer
Optional10

Optional user-defined value.

integer
Optional4

Optional user-defined value.

integer
Optional5

Optional user-defined value.

integer
Optional6

Optional user-defined value.

integer
Optional7

Optional user-defined value.

integer
Optional8

Optional user-defined value.

integer
Optional9

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value. 20-characters max.

string
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
OriginationAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
OriginationFipsCode
Required

Origination FIPS code. Select only one Origination option.

string
OriginationPCode
Required

Origination PCode. Select only one Origination option.

integer
OriginationNpaNxx
Required

Origination NPANXX. Select only one Origination option.

integer
PrivateLineSplit

For private line transactions, this is the split between the ending points of a private line. The value indicates how much the portion of the charge belongs to the origin user.

number
Regulated

True if regulated, otherwise false.

boolean
Sale
Required

Indicates if this is a retail sale. Use false for resale/wholesale transactions.

boolean
ServiceClass
Required

Service class. Please see ServiceClass in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Service Classes.

integer
ServiceLevelNumber

User-defined service level number.

integer
ServiceType
Required

Service type.

integer
StateExempt

True if transaction is exempt from State Tax, otherwise false.

boolean
StatePCode

Jurisdiction for state exemption.

integer
TerminationAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
TerminationFipsCode
Required

Termination FIPS code. Select only one Termination option.

string
TerminationPCode
Required

Termination PCode. Select only one Termination option.

integer
TerminationNpaNxx
Required

Termination NPANXX. Select only one Termination option.

integer
TransactionType
Required

Transaction type.

integer
percent

Pro-rated percent specified as a decimal.

number

Response

Header
Security
Timestamp
Created

Creation time and date.

string
Expires

Expiration time and date.

string
Body
CalcProRatedAdjResponse
CalcProRatedAdjResult
Array[TaxData]
AdjustmentType

0 if not an adjustment, otherwise one of the DiscountType enums based on user input. Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of Discount Types.

integer
Billable

Indicates if the tax is billable to the customer.

boolean
CalculationType

Calculation type. Please see CalculationType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list.

integer
CategoryDescription

Tax Category Description.

string
CategoryID

Tax category ID.

integer
CompanyIdentifier

Customer identifier from transaction input.

string
Compliance

Indicates if the tax is reportable to the jurisdiction.

boolean
CustomerNumber

User-defined customer number.

string
Description

Tax description.

string
ExemptSaleAmount

Amount of the charge exempt from taxes.

number
ExemptionType

Set to 0 - reserved for future use. See ExemptionType under TaxData in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf'.

integer
InvoiceNumber

User-defined invoice number.

integer
Lines

Number of lines used to calculate the tax (for per-line tax calculations).

integer
Locations

Number of locations from transaction input.

integer
Minutes

Number of minutes used to calculate the tax (for per-minute tax calculations).

number
Optional

Optional user-defined value.

integer
Optional10

Optional user-defined value.

integer
Optional4

Optional user-defined value.

integer
Optional5

Optional user-defined value.

integer
Optional6

Optional user-defined value.

integer
Optional7

Optional user-defined value.

integer
Optional8

Optional user-defined value.

integer
Optional9

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value.

string
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
PCode

PCode for the reporting jurisdiction.

integer
Rate

Tax rate.

number
RefundUncollect

Taxable measure if tax is smaller than 0 (tax adjustments).

number
ServiceLevelNumber

User-defined service level number.

integer
Surcharge

Indicates if tax is considered a surcharge.

boolean
TaxAmount

Calculated tax amount.

number
TaxLevel

Tax level. "Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Tax Levels."

integer
TaxType

One of the Avalara tax types.

integer
TaxableMeasure

Amount of sale subject to tax plus any taxed taxes.

number

Calculate Pro-rated Taxes

Accepts a pro-rated percentage that is used to calculate the taxable amount on the transaction and perform tax calculations. Bill To, Origination and Termination may be entered as PCode, FIPS Codes, Zip Address or NpaNxx.

Api Endpoint
POST https://eztaxasp.billsoft.com/EZTaxWebService/EZTaxWebService.svc?CalcProRatedTaxes

Headers
Content-Type: application/xmlSOAPAction: http://tempuri.org/IEZTaxWebService/CalcProRatedTaxes

Post Body Parameters

Header
Security
UsernameToken
Username
Required

Username for accessing service.

string
Password
Required

Password for accessing service.

string
Body
CalcProRatedTaxes
ATransaction
AdjustmentMethod

Adjustment Method. "Please see AdjustmentMethod in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Adjustment Methods."

integer
BillToAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
BillToFipsCode
Required

Bill-to FIPS code. Select only one BillToxxx option.

string
BillToPCode
Required

Bill-to PCode. Select only one BillToxxx option.

integer
BillToNpaNxx
Required

Bill-to NPANXX. Select only one BillToxxx option.

integer
BusinessClass
Required

Business class. Please see BusinessClass in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Business Classes.

integer
Array[CategoryExemptions]
CountryISO

Three-character country ISO code. Required if State is not specified.

string
State

Two-character state abbreviation. Required if CountryISO is not specified.

string
TaxCategory
Required

Valid tax category ID

integer
Charge
Required

Charge amount to customer for transaction

number
CompanyIdentifier

Company identifier. Use the 3-character company identifier provided by Avalara to your organization in order to include this transaction in the monthly compliance reports. Otherwise, leave empty.

string
CountyExempt

True if transaction is exempt from County Tax, otherwise false.

boolean
CountyPCode

Jurisdiction for county exemption.

integer
CustomerNumber

User-defined customer number.

string
CustomerType
Required

Customer type. Please see CustomerType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Customer Types.

integer
Date
Required

Transaction date. Field is provided to allow rating and taxing to occur on a date other than the billing date.

string
Debit

Determines if this is a prepaid debit card transaction.

boolean
DiscountType

Discount type. Please see DiscountType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Discount Types.

integer
Array[Exemptions]
PCode
Required

PCode for jurisdiction to exempt.

integer
TaxLevel
Required

Tax level. "Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Tax Levels."

integer
TaxType
Required

One of the Avalara tax types.

integer
ExemptionType

Set to 0 - reserved for future use. See ExemptionType under TaxData in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf'.

integer
FacilitiesBased

Specifies if the carrier delivering the service has company owned facilities to provide the service.

boolean
FederalExempt

True if transaction is exempt from Federal Tax, otherwise false.

boolean
FederalPCode

Jurisdiction for Federal exemption.

integer
Franchise

Indicates if the company provides services sold pursuant to a franchise agreement between the carrier and jurisdiction.

boolean
Incorporated

True if this transaction is within an incorporated area of the local jurisdiction, otherwise False.

boolean
InvoiceNumber

User-defined invoice number.

integer
IsPrivateLine

Indicates if the transaction is a private line transaction.

boolean
Lines

Number of lines sold to customer when applicable.

integer
LocalExempt

True if transaction is exempt from Local Tax, otherwise false.

boolean
LocalPCode

Jurisdiction for local exemption.

integer
Locations

Number of customer locations.

integer
Minutes

Number of minutes for call when appropriate.

number
Optional

Optional user-defined value.

integer
Optional10

Optional user-defined value.

integer
Optional4

Optional user-defined value.

integer
Optional5

Optional user-defined value.

integer
Optional6

Optional user-defined value.

integer
Optional7

Optional user-defined value.

integer
Optional8

Optional user-defined value.

integer
Optional9

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value. 20-characters max.

string
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
OriginationAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
OriginationFipsCode
Required

Origination FIPS code. Select only one Origination option.

string
OriginationPCode
Required

Origination PCode. Select only one Origination option.

integer
OriginationNpaNxx
Required

Origination NPANXX. Select only one Origination option.

integer
PrivateLineSplit

For private line transactions, this is the split between the ending points of a private line. The value indicates how much the portion of the charge belongs to the origin user.

number
Regulated

True if regulated, otherwise false.

boolean
Sale
Required

Indicates if this is a retail sale. Use false for resale/wholesale transactions.

boolean
ServiceClass
Required

Service class. Please see ServiceClass in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Service Classes.

integer
ServiceLevelNumber

User-defined service level number.

integer
ServiceType
Required

Service type.

integer
StateExempt

True if transaction is exempt from State Tax, otherwise false.

boolean
StatePCode

Jurisdiction for state exemption.

integer
TerminationAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
TerminationFipsCode
Required

Termination FIPS code. Select only one Termination option.

string
TerminationPCode
Required

Termination PCode. Select only one Termination option.

integer
TerminationNpaNxx
Required

Termination NPANXX. Select only one Termination option.

integer
TransactionType
Required

Transaction type.

integer
percent

Pro-rated percent specified as a decimal.

number

Response

Header
Security
Timestamp
Created

Creation time and date.

string
Expires

Expiration time and date.

string
Body
CalcProRatedTaxesResponse
CalcProRatedTaxesResult
Array[TaxData]
AdjustmentType

0 if not an adjustment, otherwise one of the DiscountType enums based on user input. Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of Discount Types.

integer
Billable

Indicates if the tax is billable to the customer.

boolean
CalculationType

Calculation type. Please see CalculationType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list.

integer
CategoryDescription

Tax Category Description.

string
CategoryID

Tax category ID.

integer
CompanyIdentifier

Customer identifier from transaction input.

string
Compliance

Indicates if the tax is reportable to the jurisdiction.

boolean
CustomerNumber

User-defined customer number.

string
Description

Tax description.

string
ExemptSaleAmount

Amount of the charge exempt from taxes.

number
ExemptionType

Set to 0 - reserved for future use. See ExemptionType under TaxData in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf'.

integer
InvoiceNumber

User-defined invoice number.

integer
Lines

Number of lines used to calculate the tax (for per-line tax calculations).

integer
Locations

Number of locations from transaction input.

integer
Minutes

Number of minutes used to calculate the tax (for per-minute tax calculations).

number
Optional

Optional user-defined value.

integer
Optional10

Optional user-defined value.

integer
Optional4

Optional user-defined value.

integer
Optional5

Optional user-defined value.

integer
Optional6

Optional user-defined value.

integer
Optional7

Optional user-defined value.

integer
Optional8

Optional user-defined value.

integer
Optional9

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value.

string
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
PCode

PCode for the reporting jurisdiction.

integer
Rate

Tax rate.

number
RefundUncollect

Taxable measure if tax is smaller than 0 (tax adjustments).

number
ServiceLevelNumber

User-defined service level number.

integer
Surcharge

Indicates if tax is considered a surcharge.

boolean
TaxAmount

Calculated tax amount.

number
TaxLevel

Tax level. "Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Tax Levels."

integer
TaxType

One of the Avalara tax types.

integer
TaxableMeasure

Amount of sale subject to tax plus any taxed taxes.

number

Calculate Reverse Adjustments with FIPS Code

This method accepts transaction data and performs reverse adjustments in order to arrive at the base sale amount and taxes for the desired total charge. Origination, Termination, and Bill To information is passed using FIPS Codes.

Api Endpoint
POST https://eztaxasp.billsoft.com/EZTaxWebService/EZTaxWebService.svc?CalcReverseAdjWithFipsCode

Headers
Content-Type: application/xmlSOAPAction: http://tempuri.org/IEZTaxWebService/CalcReverseAdjWithFipsCode

Post Body Parameters

Header
Security
UsernameToken
Username
Required

Username for accessing service.

string
Password
Required

Password for accessing service.

string
Body
CalcReverseAdjWithFipsCode
AnAdjustment
AdjustmentMethod

Adjustment Method. "Please see AdjustmentMethod in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Adjustment Methods."

integer
BillToAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
BillToFipsCode
Required

Bill-to FIPS code. Select only one BillToxxx option.

string
BillToPCode
Required

Bill-to PCode. Select only one BillToxxx option.

integer
BillToNpaNxx
Required

Bill-to NPANXX. Select only one BillToxxx option.

integer
BusinessClass
Required

Business class. Please see BusinessClass in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Business Classes.

integer
Array[CategoryExemptions]
CountryISO

Three-character country ISO code. Required if State is not specified.

string
State

Two-character state abbreviation. Required if CountryISO is not specified.

string
TaxCategory
Required

Valid tax category ID

integer
Charge
Required

Charge amount to customer for transaction

number
CompanyIdentifier

Company identifier. Use the 3-character company identifier provided by Avalara to your organization in order to include this transaction in the monthly compliance reports. Otherwise, leave empty.

string
CountyExempt

True if transaction is exempt from County Tax, otherwise false.

boolean
CountyPCode

Jurisdiction for county exemption.

integer
CustomerNumber

User-defined customer number.

string
CustomerType
Required

Customer type. Please see CustomerType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Customer Types.

integer
Date
Required

Transaction date. Field is provided to allow rating and taxing to occur on a date other than the billing date.

string
Debit

Determines if this is a prepaid debit card transaction.

boolean
DiscountType

Discount type. Please see DiscountType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Discount Types.

integer
Array[Exemptions]
PCode
Required

PCode for jurisdiction to exempt.

integer
TaxLevel
Required

Tax level. "Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Tax Levels."

integer
TaxType
Required

One of the Avalara tax types.

integer
ExemptionType

Set to 0 - reserved for future use. See ExemptionType under TaxData in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf'.

integer
FacilitiesBased

Specifies if the carrier delivering the service has company owned facilities to provide the service.

boolean
FederalExempt

True if transaction is exempt from Federal Tax, otherwise false.

boolean
FederalPCode

Jurisdiction for Federal exemption.

integer
Franchise

Indicates if the company provides services sold pursuant to a franchise agreement between the carrier and jurisdiction.

boolean
Incorporated

True if this transaction is within an incorporated area of the local jurisdiction, otherwise False.

boolean
InvoiceNumber

User-defined invoice number.

integer
IsPrivateLine

Indicates if the transaction is a private line transaction.

boolean
Lines

Number of lines sold to customer when applicable.

integer
LocalExempt

True if transaction is exempt from Local Tax, otherwise false.

boolean
LocalPCode

Jurisdiction for local exemption.

integer
Locations

Number of customer locations.

integer
Minutes

Number of minutes for call when appropriate.

number
Optional

Optional user-defined value.

integer
Optional10

Optional user-defined value.

integer
Optional4

Optional user-defined value.

integer
Optional5

Optional user-defined value.

integer
Optional6

Optional user-defined value.

integer
Optional7

Optional user-defined value.

integer
Optional8

Optional user-defined value.

integer
Optional9

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value. 20-characters max.

string
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
OriginationAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
OriginationFipsCode
Required

Origination FIPS code. Select only one Origination option.

string
OriginationPCode
Required

Origination PCode. Select only one Origination option.

integer
OriginationNpaNxx
Required

Origination NPANXX. Select only one Origination option.

integer
PrivateLineSplit

For private line transactions, this is the split between the ending points of a private line. The value indicates how much the portion of the charge belongs to the origin user.

number
Regulated

True if regulated, otherwise false.

boolean
Sale
Required

Indicates if this is a retail sale. Use false for resale/wholesale transactions.

boolean
ServiceClass
Required

Service class. Please see ServiceClass in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Service Classes.

integer
ServiceLevelNumber

User-defined service level number.

integer
ServiceType
Required

Service type.

integer
StateExempt

True if transaction is exempt from State Tax, otherwise false.

boolean
StatePCode

Jurisdiction for state exemption.

integer
TerminationAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
TerminationFipsCode
Required

Termination FIPS code. Select only one Termination option.

string
TerminationPCode
Required

Termination PCode. Select only one Termination option.

integer
TerminationNpaNxx
Required

Termination NPANXX. Select only one Termination option.

integer
TransactionType
Required

Transaction type.

integer

Response

Header
Security
Timestamp
Created

Creation time and date.

string
Expires

Expiration time and date.

string
Body
CalcReverseAdjWithFipsCodeResponse
CalcReverseAdjWithFipsCodeResult
BaseSaleAmount

The calculated base sale amount for the transaction.

number
Taxes
Array[TaxData]
AdjustmentType

0 if not an adjustment, otherwise one of the DiscountType enums based on user input. Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of Discount Types.

integer
Billable

Indicates if the tax is billable to the customer.

boolean
CalculationType

Calculation type. Please see CalculationType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list.

integer
CategoryDescription

Tax Category Description.

string
CategoryID

Tax category ID.

integer
CompanyIdentifier

Customer identifier from transaction input.

string
Compliance

Indicates if the tax is reportable to the jurisdiction.

boolean
CustomerNumber

User-defined customer number.

string
Description

Tax description.

string
ExemptSaleAmount

Amount of the charge exempt from taxes.

number
ExemptionType

Set to 0 - reserved for future use. See ExemptionType under TaxData in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf'.

integer
InvoiceNumber

User-defined invoice number.

integer
Lines

Number of lines used to calculate the tax (for per-line tax calculations).

integer
Locations

Number of locations from transaction input.

integer
Minutes

Number of minutes used to calculate the tax (for per-minute tax calculations).

number
Optional

Optional user-defined value.

integer
Optional10

Optional user-defined value.

integer
Optional4

Optional user-defined value.

integer
Optional5

Optional user-defined value.

integer
Optional6

Optional user-defined value.

integer
Optional7

Optional user-defined value.

integer
Optional8

Optional user-defined value.

integer
Optional9

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value.

string
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
PCode

PCode for the reporting jurisdiction.

integer
Rate

Tax rate.

number
RefundUncollect

Taxable measure if tax is smaller than 0 (tax adjustments).

number
ServiceLevelNumber

User-defined service level number.

integer
Surcharge

Indicates if tax is considered a surcharge.

boolean
TaxAmount

Calculated tax amount.

number
TaxLevel

Tax level. "Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Tax Levels."

integer
TaxType

One of the Avalara tax types.

integer
TaxableMeasure

Amount of sale subject to tax plus any taxed taxes.

number

Calculate Reverse Adjustment With NpaNxx

This method accepts transaction data and performs reverse adjustments in order to arrive at the base sale amount and taxes for the desired total charge. Origination, Termination, and Bill To information is passed using NpaNxx values.

Api Endpoint
POST https://eztaxasp.billsoft.com/EZTaxWebService/EZTaxWebService.svc?CalcReverseAdjWithNpaNxx

Headers
Content-Type: application/xmlSOAPAction: http://tempuri.org/IEZTaxWebService/CalcReverseAdjWithNpaNxx

Post Body Parameters

Header
Security
UsernameToken
Username
Required

Username for accessing service.

string
Password
Required

Password for accessing service.

string
Body
CalcReverseAdjWithNpaNxx
AnAdjustment
AdjustmentMethod

Adjustment Method. "Please see AdjustmentMethod in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Adjustment Methods."

integer
BillToAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
BillToFipsCode
Required

Bill-to FIPS code. Select only one BillToxxx option.

string
BillToPCode
Required

Bill-to PCode. Select only one BillToxxx option.

integer
BillToNpaNxx
Required

Bill-to NPANXX. Select only one BillToxxx option.

integer
BusinessClass
Required

Business class. Please see BusinessClass in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Business Classes.

integer
Array[CategoryExemptions]
CountryISO

Three-character country ISO code. Required if State is not specified.

string
State

Two-character state abbreviation. Required if CountryISO is not specified.

string
TaxCategory
Required

Valid tax category ID

integer
Charge
Required

Charge amount to customer for transaction

number
CompanyIdentifier

Company identifier. Use the 3-character company identifier provided by Avalara to your organization in order to include this transaction in the monthly compliance reports. Otherwise, leave empty.

string
CountyExempt

True if transaction is exempt from County Tax, otherwise false.

boolean
CountyPCode

Jurisdiction for county exemption.

integer
CustomerNumber

User-defined customer number.

string
CustomerType
Required

Customer type. Please see CustomerType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Customer Types.

integer
Date
Required

Transaction date. Field is provided to allow rating and taxing to occur on a date other than the billing date.

string
Debit

Determines if this is a prepaid debit card transaction.

boolean
DiscountType

Discount type. Please see DiscountType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Discount Types.

integer
Array[Exemptions]
PCode
Required

PCode for jurisdiction to exempt.

integer
TaxLevel
Required

Tax level. "Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Tax Levels."

integer
TaxType
Required

One of the Avalara tax types.

integer
ExemptionType

Set to 0 - reserved for future use. See ExemptionType under TaxData in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf'.

integer
FacilitiesBased

Specifies if the carrier delivering the service has company owned facilities to provide the service.

boolean
FederalExempt

True if transaction is exempt from Federal Tax, otherwise false.

boolean
FederalPCode

Jurisdiction for Federal exemption.

integer
Franchise

Indicates if the company provides services sold pursuant to a franchise agreement between the carrier and jurisdiction.

boolean
Incorporated

True if this transaction is within an incorporated area of the local jurisdiction, otherwise False.

boolean
InvoiceNumber

User-defined invoice number.

integer
IsPrivateLine

Indicates if the transaction is a private line transaction.

boolean
Lines

Number of lines sold to customer when applicable.

integer
LocalExempt

True if transaction is exempt from Local Tax, otherwise false.

boolean
LocalPCode

Jurisdiction for local exemption.

integer
Locations

Number of customer locations.

integer
Minutes

Number of minutes for call when appropriate.

number
Optional

Optional user-defined value.

integer
Optional10

Optional user-defined value.

integer
Optional4

Optional user-defined value.

integer
Optional5

Optional user-defined value.

integer
Optional6

Optional user-defined value.

integer
Optional7

Optional user-defined value.

integer
Optional8

Optional user-defined value.

integer
Optional9

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value. 20-characters max.

string
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
OriginationAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
OriginationFipsCode
Required

Origination FIPS code. Select only one Origination option.

string
OriginationPCode
Required

Origination PCode. Select only one Origination option.

integer
OriginationNpaNxx
Required

Origination NPANXX. Select only one Origination option.

integer
PrivateLineSplit

For private line transactions, this is the split between the ending points of a private line. The value indicates how much the portion of the charge belongs to the origin user.

number
Regulated

True if regulated, otherwise false.

boolean
Sale
Required

Indicates if this is a retail sale. Use false for resale/wholesale transactions.

boolean
ServiceClass
Required

Service class. Please see ServiceClass in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Service Classes.

integer
ServiceLevelNumber

User-defined service level number.

integer
ServiceType
Required

Service type.

integer
StateExempt

True if transaction is exempt from State Tax, otherwise false.

boolean
StatePCode

Jurisdiction for state exemption.

integer
TerminationAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
TerminationFipsCode
Required

Termination FIPS code. Select only one Termination option.

string
TerminationPCode
Required

Termination PCode. Select only one Termination option.

integer
TerminationNpaNxx
Required

Termination NPANXX. Select only one Termination option.

integer
TransactionType
Required

Transaction type.

integer

Response

Header
Security
Timestamp
Created

Creation time and date.

string
Expires

Expiration time and date.

string
Body
CalcReverseAdjWithNpaNxxResponse
CalcReverseAdjWithNpaNxxResult
BaseSaleAmount

The calculated base sale amount for the transaction.

number
Taxes
Array[TaxData]
AdjustmentType

0 if not an adjustment, otherwise one of the DiscountType enums based on user input. Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of Discount Types.

integer
Billable

Indicates if the tax is billable to the customer.

boolean
CalculationType

Calculation type. Please see CalculationType in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list.

integer
CategoryDescription

Tax Category Description.

string
CategoryID

Tax category ID.

integer
CompanyIdentifier

Customer identifier from transaction input.

string
Compliance

Indicates if the tax is reportable to the jurisdiction.

boolean
CustomerNumber

User-defined customer number.

string
Description

Tax description.

string
ExemptSaleAmount

Amount of the charge exempt from taxes.

number
ExemptionType

Set to 0 - reserved for future use. See ExemptionType under TaxData in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf'.

integer
InvoiceNumber

User-defined invoice number.

integer
Lines

Number of lines used to calculate the tax (for per-line tax calculations).

integer
Locations

Number of locations from transaction input.

integer
Minutes

Number of minutes used to calculate the tax (for per-minute tax calculations).

number
Optional

Optional user-defined value.

integer
Optional10

Optional user-defined value.

integer
Optional4

Optional user-defined value.

integer
Optional5

Optional user-defined value.

integer
Optional6

Optional user-defined value.

integer
Optional7

Optional user-defined value.

integer
Optional8

Optional user-defined value.

integer
Optional9

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value.

string
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
PCode

PCode for the reporting jurisdiction.

integer
Rate

Tax rate.

number
RefundUncollect

Taxable measure if tax is smaller than 0 (tax adjustments).

number
ServiceLevelNumber

User-defined service level number.

integer
Surcharge

Indicates if tax is considered a surcharge.

boolean
TaxAmount

Calculated tax amount.

number
TaxLevel

Tax level. "Please see 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Tax Levels."

integer
TaxType

One of the Avalara tax types.

integer
TaxableMeasure

Amount of sale subject to tax plus any taxed taxes.

number

Calculate Reverse Adjustment with PCode

This method accepts transaction data and performs reverse adjustments in order to arrive at the base sale amount and taxes for the desired total charge. Origination, Termination, and Bill To information is passed using PCodes.

Api Endpoint
POST https://eztaxasp.billsoft.com/EZTaxWebService/EZTaxWebService.svc?CalcReverseAdjWithPCode

Headers
Content-Type: application/xmlSOAPAction: http://tempuri.org/IEZTaxWebService/CalcReverseAdjWithPCode

Post Body Parameters

Header
Security
UsernameToken
Username
Required

Username for accessing service.

string
Password
Required

Password for accessing service.

string
Body
CalcReverseAdjWithPCode
AnAdjustment
AdjustmentMethod

Adjustment Method. "Please see AdjustmentMethod in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Adjustment Methods."

integer
BillToAddress
CountryISO
Required

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
ZipCode

Zip code for location.

string
ZipP4

Zip + 4 for location.

string
BillToFipsCode
Required

Bill-to FIPS code. Select only one BillToxxx option.

string
BillToPCode
Required

Bill-to PCode. Select only one BillToxxx option.

integer
BillToNpaNxx
Required

Bill-to NPANXX. Select only one BillToxxx option.

integer
BusinessClass
Required

Business class. Please see BusinessClass in either 'TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf' or 'TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf' for a list of valid Business Classes.

integer