Avalara Developer Network Developer communications

Saas Pro

The AFC REST service provides APIs to calculate taxes on communiations transactions and lookup tax rate and jurisdiction information.


Calculate taxes on a transaction

This method accepts transaction data and performs appropriate tax calculations.

Api Endpoint
POST https://communications.avalara.net/api/v1/CalculateTaxes

Headers
Authorization: Basic aHR0cHdhdGNoOmY=Content-Type: text/json

Post Body Parameters

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

Origination FIPS code.

string
OriginationPCode

Origination PCode.

integer
OriginationNpaNxx

Origination NPANXX.

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

Termination FIPS code.

string
TerminationPCode

Termination PCode.

integer
TerminationNpaNxx

Termination NPANXX.

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

Bill-to FIPS code.

string
BillToPCode

Bill-to PCode.

integer
BillToNpaNxx

Bill-to NPANXX

integer
IsPrivateLine

Indicates if the transaction is a private line transaction.

boolean
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
CustomerType
Required

Customer type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid customer types.

integer
BusinessClass

Business class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid business classes.

integer
Sale
Required

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

boolean
TransactionType
Required

Transaction type.

integer
ServiceType
Required

Service type.

integer
ServiceClass

Service class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid Service Classes.

integer
Date
Required

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

string
Charge
Required

Charge amount to customer for transaction

number
Incorporated
Required

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

boolean
FederalExempt

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

boolean
StateExempt

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

boolean
CountyExempt

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

boolean
LocalExempt

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

boolean
FederalPCode

Jurisdiction for Federal exemption.

integer
StatePCode

Jurisdiction for state exemption.

integer
CountyPCode

Jurisdiction for county exemption.

integer
LocalPCode

Jurisdiction for local exemption.

integer
Array[Exemptions]
PCode
Required

PCode for jurisdiction to exempt.

integer
TaxLevel
Required

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
TaxType
Required

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
ExemptionType

Exemtion type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid exemption types.

integer
InvoiceNumber

User-defined invoice number.

integer
Optional

Optional user-defined value.

integer
CustomerNumber

User-defined customer number.

string
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
OptionalAlpha1

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

string
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
Optional10

Optional user-defined value.

integer
AdjustmentMethod

Adjustment method. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid adjustment methods.

integer
Lines

Number of lines sold to customer when applicable.

integer
Locations

Number of customer locations.

integer
Minutes

Number of minutes for call when appropriate.

double float
Debit

Determines if this is a prepaid debit card transaction.

boolean
AdjustmentDiscount

Adjustment discount type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid discount types.

integer
FacilitiesBased

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

boolean
Franchise

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

boolean
Lifeline

Indicates if customer is a Lifeline participant.

boolean
Regulated

True if regulated, otherwise false.

boolean
ServiceLevelNumber

User-defined service level number.

integer
Array[Exclusions]
CountryISO

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

string
State

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

string
ExclusionOn
Required

True if entity exclusion applies in the state, otherwise false.

boolean
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

Tax Category. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for valid tax categories.

integer
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
TaxInclusive

Indicates if the charge of this transaction is tax-inclusive (reverse tax calculation).

boolean
Array[SafeHarborOverrides]
SafeHarborType

Safe harbor type (1 = Cellular, 2 = VoIP, 4 = Paging).

integer
OriginalFederalTam

Original Federal TAM value to override.

number
NewFederalTam

New TAM value that will replace the original TAM value.

number
DocumentCode

Document code.

string
Commit

Indicates if the transaction should be committed as soon at it is processed.

boolean

Response[Array]

AdjustmentType

Adjustmnet type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid adjustment types.

integer
Billable

Indicates if the tax is billable to the customer.

boolean
CalculationType

Calculation type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid calculation types.

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
ExemptionType

Exemption type from transaction input.

integer
ExemptSaleAmount

Amount of the charge exempt from taxes.

number
InvoiceNumber

User-defined invoice number.

integer
Optional

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value.

string
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
Optional10

Optional user-defined value.

integer
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
TaxableMeasure

Amount of sale subject to tax plus any taxed taxes.

number
TaxAmount

Calculated tax amount.

number
TaxLevel

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
TaxType

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
Lines

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

integer
Minutes

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

double float
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
TransCharge

Transaction charge amount.

number

Calculate tax adjustments on transaction

This method accepts transaction data and performs appropriate tax adjustment calculations.

Api Endpoint
POST https://communications.avalara.net/api/v1/CalculateAdjustments

Headers
Authorization: Basic aHR0cHdhdGNoOmY=Content-Type: text/json

Post Body Parameters

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

Origination FIPS code.

string
OriginationPCode

Origination PCode.

integer
OriginationNpaNxx

Origination NPANXX.

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

Termination FIPS code.

string
TerminationPCode

Termination PCode.

integer
TerminationNpaNxx

Termination NPANXX.

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

Bill-to FIPS code.

string
BillToPCode

Bill-to PCode.

integer
BillToNpaNxx

Bill-to NPANXX

integer
IsPrivateLine

Indicates if the transaction is a private line transaction.

boolean
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
CustomerType
Required

Customer type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid customer types.

integer
BusinessClass

Business class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid business classes.

integer
Sale
Required

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

boolean
TransactionType
Required

Transaction type.

integer
ServiceType
Required

Service type.

integer
ServiceClass

Service class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid Service Classes.

integer
Date
Required

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

string
Charge
Required

Charge amount to customer for transaction

number
Incorporated
Required

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

boolean
FederalExempt

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

boolean
StateExempt

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

boolean
CountyExempt

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

boolean
LocalExempt

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

boolean
FederalPCode

Jurisdiction for Federal exemption.

integer
StatePCode

Jurisdiction for state exemption.

integer
CountyPCode

Jurisdiction for county exemption.

integer
LocalPCode

Jurisdiction for local exemption.

integer
Array[Exemptions]
PCode
Required

PCode for jurisdiction to exempt.

integer
TaxLevel
Required

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
TaxType
Required

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
ExemptionType

Exemtion type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid exemption types.

integer
InvoiceNumber

User-defined invoice number.

integer
Optional

Optional user-defined value.

integer
CustomerNumber

User-defined customer number.

string
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
OptionalAlpha1

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

string
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
Optional10

Optional user-defined value.

integer
AdjustmentMethod

Adjustment method. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid adjustment methods.

integer
Lines

Number of lines sold to customer when applicable.

integer
Locations

Number of customer locations.

integer
Minutes

Number of minutes for call when appropriate.

double float
Debit

Determines if this is a prepaid debit card transaction.

boolean
AdjustmentDiscount

Adjustment discount type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid discount types.

integer
FacilitiesBased

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

boolean
Franchise

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

boolean
Lifeline

Indicates if customer is a Lifeline participant.

boolean
Regulated

True if regulated, otherwise false.

boolean
ServiceLevelNumber

User-defined service level number.

integer
Array[Exclusions]
CountryISO

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

string
State

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

string
ExclusionOn
Required

True if entity exclusion applies in the state, otherwise false.

boolean
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

Tax Category. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for valid tax categories.

integer
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
TaxInclusive

Indicates if the charge of this transaction is tax-inclusive (reverse tax calculation).

boolean
Array[SafeHarborOverrides]
SafeHarborType

Safe harbor type (1 = Cellular, 2 = VoIP, 4 = Paging).

integer
OriginalFederalTam

Original Federal TAM value to override.

number
NewFederalTam

New TAM value that will replace the original TAM value.

number
DocumentCode

Document code.

string
Commit

Indicates if the transaction should be committed as soon at it is processed.

boolean

Response[Array]

AdjustmentType

Adjustmnet type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid adjustment types.

integer
Billable

Indicates if the tax is billable to the customer.

boolean
CalculationType

Calculation type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid calculation types.

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
ExemptionType

Exemption type from transaction input.

integer
ExemptSaleAmount

Amount of the charge exempt from taxes.

number
InvoiceNumber

User-defined invoice number.

integer
Optional

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value.

string
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
Optional10

Optional user-defined value.

integer
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
TaxableMeasure

Amount of sale subject to tax plus any taxed taxes.

number
TaxAmount

Calculated tax amount.

number
TaxLevel

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
TaxType

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
Lines

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

integer
Minutes

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

double float
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
TransCharge

Transaction charge amount.

number

Determine PCode for a location

Converts the given request data to a PCode. Only one of the fields should be used for the conversion: ZipAddress, FipsCode or NPANXX.

Api Endpoint
POST https://communications.avalara.net/api/v1/Location/PCode

Headers
Authorization: Basic aHR0cHdhdGNoOmY=Content-Type: text/json

Post Body Parameters

FipsCode

Fips code - leave null if other value is used.

string
NpaNxx

NPANXX - leave null if other value is used.

integer
ZipAddress
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

Response

Post Body Parameters

PCode for specified ZipAddress, FipsCode or NPANXX.

integer

Perform a tax-inclusive tax calculation

This method accepts transaction data and performs a reverse tax calculation in order to arrive at the base sale amount and taxes for the desired total charge.

Api Endpoint
POST https://communications.avalara.net/api/v1/CalculateReversal/Taxes

Headers
Authorization: Basic aHR0cHdhdGNoOmY=Content-Type: text/json

Post Body Parameters

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

Origination FIPS code.

string
OriginationPCode

Origination PCode.

integer
OriginationNpaNxx

Origination NPANXX.

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

Termination FIPS code.

string
TerminationPCode

Termination PCode.

integer
TerminationNpaNxx

Termination NPANXX.

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

Bill-to FIPS code.

string
BillToPCode

Bill-to PCode.

integer
BillToNpaNxx

Bill-to NPANXX

integer
IsPrivateLine

Indicates if the transaction is a private line transaction.

boolean
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
CustomerType
Required

Customer type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid customer types.

integer
BusinessClass

Business class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid business classes.

integer
Sale
Required

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

boolean
TransactionType
Required

Transaction type.

integer
ServiceType
Required

Service type.

integer
ServiceClass

Service class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid Service Classes.

integer
Date
Required

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

string
Charge
Required

Charge amount to customer for transaction

number
Incorporated
Required

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

boolean
FederalExempt

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

boolean
StateExempt

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

boolean
CountyExempt

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

boolean
LocalExempt

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

boolean
FederalPCode

Jurisdiction for Federal exemption.

integer
StatePCode

Jurisdiction for state exemption.

integer
CountyPCode

Jurisdiction for county exemption.

integer
LocalPCode

Jurisdiction for local exemption.

integer
Array[Exemptions]
PCode
Required

PCode for jurisdiction to exempt.

integer
TaxLevel
Required

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
TaxType
Required

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
ExemptionType

Exemtion type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid exemption types.

integer
InvoiceNumber

User-defined invoice number.

integer
Optional

Optional user-defined value.

integer
CustomerNumber

User-defined customer number.

string
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
OptionalAlpha1

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

string
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
Optional10

Optional user-defined value.

integer
AdjustmentMethod

Adjustment method. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid adjustment methods.

integer
Lines

Number of lines sold to customer when applicable.

integer
Locations

Number of customer locations.

integer
Minutes

Number of minutes for call when appropriate.

double float
Debit

Determines if this is a prepaid debit card transaction.

boolean
AdjustmentDiscount

Adjustment discount type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid discount types.

integer
FacilitiesBased

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

boolean
Franchise

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

boolean
Lifeline

Indicates if customer is a Lifeline participant.

boolean
Regulated

True if regulated, otherwise false.

boolean
ServiceLevelNumber

User-defined service level number.

integer
Array[Exclusions]
CountryISO

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

string
State

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

string
ExclusionOn
Required

True if entity exclusion applies in the state, otherwise false.

boolean
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

Tax Category. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for valid tax categories.

integer
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
TaxInclusive

Indicates if the charge of this transaction is tax-inclusive (reverse tax calculation).

boolean
Array[SafeHarborOverrides]
SafeHarborType

Safe harbor type (1 = Cellular, 2 = VoIP, 4 = Paging).

integer
OriginalFederalTam

Original Federal TAM value to override.

number
NewFederalTam

New TAM value that will replace the original TAM value.

number
DocumentCode

Document code.

string
Commit

Indicates if the transaction should be committed as soon at it is processed.

boolean

Response

BaseSaleAmount

Base sale amount necessary to arrive at desired total tax.

number
Array[Taxes]
AdjustmentType

Adjustmnet type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid adjustment types.

integer
Billable

Indicates if the tax is billable to the customer.

boolean
CalculationType

Calculation type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid calculation types.

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
ExemptionType

Exemption type from transaction input.

integer
ExemptSaleAmount

Amount of the charge exempt from taxes.

number
InvoiceNumber

User-defined invoice number.

integer
Optional

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value.

string
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
Optional10

Optional user-defined value.

integer
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
TaxableMeasure

Amount of sale subject to tax plus any taxed taxes.

number
TaxAmount

Calculated tax amount.

number
TaxLevel

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
TaxType

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
Lines

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

integer
Minutes

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

double float
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
TransCharge

Transaction charge amount.

number

Perform a tax-inclusive tax adjustment

This method accepts transaction data and performs a reverse tax adjustment in order to arrive at the base sale amount and taxes for the desired total charge.

Api Endpoint
POST https://communications.avalara.net/api/v1/CalculateReversal/Adjustments

Headers
Authorization: Basic aHR0cHdhdGNoOmY=Content-Type: text/json

Post Body Parameters

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

Origination FIPS code.

string
OriginationPCode

Origination PCode.

integer
OriginationNpaNxx

Origination NPANXX.

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

Termination FIPS code.

string
TerminationPCode

Termination PCode.

integer
TerminationNpaNxx

Termination NPANXX.

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

Bill-to FIPS code.

string
BillToPCode

Bill-to PCode.

integer
BillToNpaNxx

Bill-to NPANXX

integer
IsPrivateLine

Indicates if the transaction is a private line transaction.

boolean
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
CustomerType
Required

Customer type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid customer types.

integer
BusinessClass

Business class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid business classes.

integer
Sale
Required

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

boolean
TransactionType
Required

Transaction type.

integer
ServiceType
Required

Service type.

integer
ServiceClass

Service class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid Service Classes.

integer
Date
Required

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

string
Charge
Required

Charge amount to customer for transaction

number
Incorporated
Required

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

boolean
FederalExempt

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

boolean
StateExempt

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

boolean
CountyExempt

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

boolean
LocalExempt

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

boolean
FederalPCode

Jurisdiction for Federal exemption.

integer
StatePCode

Jurisdiction for state exemption.

integer
CountyPCode

Jurisdiction for county exemption.

integer
LocalPCode

Jurisdiction for local exemption.

integer
Array[Exemptions]
PCode
Required

PCode for jurisdiction to exempt.

integer
TaxLevel
Required

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
TaxType
Required

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
ExemptionType

Exemtion type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid exemption types.

integer
InvoiceNumber

User-defined invoice number.

integer
Optional

Optional user-defined value.

integer
CustomerNumber

User-defined customer number.

string
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
OptionalAlpha1

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

string
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
Optional10

Optional user-defined value.

integer
AdjustmentMethod

Adjustment method. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid adjustment methods.

integer
Lines

Number of lines sold to customer when applicable.

integer
Locations

Number of customer locations.

integer
Minutes

Number of minutes for call when appropriate.

double float
Debit

Determines if this is a prepaid debit card transaction.

boolean
AdjustmentDiscount

Adjustment discount type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid discount types.

integer
FacilitiesBased

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

boolean
Franchise

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

boolean
Lifeline

Indicates if customer is a Lifeline participant.

boolean
Regulated

True if regulated, otherwise false.

boolean
ServiceLevelNumber

User-defined service level number.

integer
Array[Exclusions]
CountryISO

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

string
State

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

string
ExclusionOn
Required

True if entity exclusion applies in the state, otherwise false.

boolean
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

Tax Category. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for valid tax categories.

integer
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
TaxInclusive

Indicates if the charge of this transaction is tax-inclusive (reverse tax calculation).

boolean
Array[SafeHarborOverrides]
SafeHarborType

Safe harbor type (1 = Cellular, 2 = VoIP, 4 = Paging).

integer
OriginalFederalTam

Original Federal TAM value to override.

number
NewFederalTam

New TAM value that will replace the original TAM value.

number
DocumentCode

Document code.

string
Commit

Indicates if the transaction should be committed as soon at it is processed.

boolean

Response

BaseSaleAmount

Base sale amount necessary to arrive at desired total tax.

number
Array[Taxes]
AdjustmentType

Adjustmnet type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid adjustment types.

integer
Billable

Indicates if the tax is billable to the customer.

boolean
CalculationType

Calculation type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid calculation types.

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
ExemptionType

Exemption type from transaction input.

integer
ExemptSaleAmount

Amount of the charge exempt from taxes.

number
InvoiceNumber

User-defined invoice number.

integer
Optional

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value.

string
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
Optional10

Optional user-defined value.

integer
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
TaxableMeasure

Amount of sale subject to tax plus any taxed taxes.

number
TaxAmount

Calculated tax amount.

number
TaxLevel

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
TaxType

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
Lines

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

integer
Minutes

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

double float
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
TransCharge

Transaction charge amount.

number

Convert a PCode to FIPS code

This method returns the FIPS code for the specified PCode.

Api Endpoint
GET https://communications.avalara.net/api/v1/Location/PCodeToFips/{pCode}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

pCode
Required

PCode for jurisdiction.

integer

Response

Post Body Parameters

FIPS code for jurisdiction.

string

Get address information for a jurisdiction

This method returns a list of addresses for the specified jurisdiction.

Api Endpoint
GET https://communications.avalara.net/api/v1/Location/Address/{pCode}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

pCode
Required

PCode for jurisdiction.

integer

Response[Array]

CountryISO

Three-character country ISO code.

string
County

County name.

string
Locality

Locality name.

string
State

Two-character state abbreviation.

string
TaxLevel

Tax level ID.

integer
ZipBegin

Begin of Zip code range.

string
ZipEnd

End of Zip code range.

string
ZipP4Begin

Begin of Zip+4 code range.

string
ZipP4End

End of Zip+4 code range.

string

Lookup jurisdictions by location name and/or postal code

Searches jurisdiction matches for the address provided. The results may be an exact match or potential matches as specified by the BestMatch attribute in the input parameter object.

Api Endpoint
POST https://communications.avalara.net/api/v1/Location/ZipAddressLookup

Headers
Authorization: Basic aHR0cHdhdGNoOmY=Content-Type: text/json

Post Body Parameters

CountryIso

3-character country ISO code.

string
State

2-character state abbreviation.

string
County

County name.

string
City

City name.

string
ZipCode

5-digit zip code (full zip code for Canadian addresses).

string
BestMatch
Required

Flag indicating whether to return the best matches (true) or exact matches only (false).

boolean
JurisdictionDetails
Required

Indicates if the full jurisdiction details (country ISO, state, county, and city) should be returned in the results. Otherwise, only the PCode will be included in the response.

boolean
LimitResults

Maximum number of results to return.

integer

Response

Array[LocationData]
CountryIso

3-character country ISO code.

string
State

2-character state abbreviation.

string
County

County name.

string
Locality

Locality name.

string
PCode

Jurisdiction PCode.

integer
MatchType

Indicates whether the matches returned are based on an "Exact" match or "Best" match.

string

Get tax category for a tax type

This method returns the tax category for the specified tax type.

Api Endpoint
GET https://communications.avalara.net/api/v1/TaxLookup/Category/{taxType}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

taxType
Required

Tax type ID to get the category description for.

integer

Response

Post Body Parameters

Tax category description for the specified tax type ID.

string

Get the tax description for a tax type

This method returns the description for the specified tax type ID.

Api Endpoint
GET https://communications.avalara.net/api/v1/TaxLookup/Description/{taxType}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

taxType
Required

Tax type ID to get the description for.

integer

Response

Post Body Parameters

Description for specified tax type ID.

string

Get tax rates for a jurisdiction

Returns the tax rate information for a jurisdiction identified by the specified PCode.

Api Endpoint
GET https://communications.avalara.net/api/v1/TaxLookup/TaxRates/{pCode}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

pCode
Required

PCode for jurisdiction.

integer

Response[Array]

TaxType
Required

Tax type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax types.

integer
TaxLevel
Required

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
Array[RateHistory]
EffectiveDate
Required

Effective date for rate.

string
LevelExemptible

Indicates if the tax can be exempted using level exemptions.

boolean
Array[BracketInfo]
Rate
Required

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

number
MaxBase
Required

Maximum base that this rate applies to.

number
CountyOverrideTax

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

number
StateOverrideTax

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

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
CountyOverrideOn

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

boolean

Get the version of the Rest APIs

Returns the version of the REST APIs.

Api Endpoint
GET https://communications.avalara.net/api/v1/Application/RESTVersion

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Response

Post Body Parameters

Version of the REST APIs.

string

Get the version of the AFC tax engine

Returns the version of the AFC tax engine.

Api Endpoint
GET https://communications.avalara.net/api/v1/Application/AFCEngineVersion

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Response

Post Body Parameters

Version of the AFC tax engine.

string

Get the AFC tax engine database version

Returns the AFC tax engine database version.

Api Endpoint
GET https://communications.avalara.net/api/v1/Application/AFCDatabaseEngineVersion

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Response

Post Body Parameters

AFC tax engine database version.

string

Get server time

Returns the server time in UTC.

Api Endpoint
GET https://communications.avalara.net/api/v1/Application/ServerTime

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Response

Post Body Parameters

Server time in UTC.

string

Calculate taxes for a pro-rated transaction

Accepts a pro-rated percentage that is used to calculate the taxable amount on the transaction and perform tax calculations.

Api Endpoint
POST https://communications.avalara.net/api/v1/CalculateProRated/Taxes

Headers
Authorization: Basic aHR0cHdhdGNoOmY=Content-Type: text/json

Post Body Parameters

ProRatedPercent
Required

Percentage to prorate specified as a decimal.

number
Transaction
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

Origination FIPS code.

string
OriginationPCode

Origination PCode.

integer
OriginationNpaNxx

Origination NPANXX.

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

Termination FIPS code.

string
TerminationPCode

Termination PCode.

integer
TerminationNpaNxx

Termination NPANXX.

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

Bill-to FIPS code.

string
BillToPCode

Bill-to PCode.

integer
BillToNpaNxx

Bill-to NPANXX

integer
IsPrivateLine

Indicates if the transaction is a private line transaction.

boolean
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
CustomerType
Required

Customer type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid customer types.

integer
BusinessClass

Business class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid business classes.

integer
Sale
Required

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

boolean
TransactionType
Required

Transaction type.

integer
ServiceType
Required

Service type.

integer
ServiceClass

Service class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid Service Classes.

integer
Date
Required

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

string
Charge
Required

Charge amount to customer for transaction

number
Incorporated
Required

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

boolean
FederalExempt

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

boolean
StateExempt

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

boolean
CountyExempt

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

boolean
LocalExempt

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

boolean
FederalPCode

Jurisdiction for Federal exemption.

integer
StatePCode

Jurisdiction for state exemption.

integer
CountyPCode

Jurisdiction for county exemption.

integer
LocalPCode

Jurisdiction for local exemption.

integer
Array[Exemptions]
PCode
Required

PCode for jurisdiction to exempt.

integer
TaxLevel
Required

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
TaxType
Required

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
ExemptionType

Exemtion type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid exemption types.

integer
InvoiceNumber

User-defined invoice number.

integer
Optional

Optional user-defined value.

integer
CustomerNumber

User-defined customer number.

string
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
OptionalAlpha1

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

string
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
Optional10

Optional user-defined value.

integer
AdjustmentMethod

Adjustment method. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid adjustment methods.

integer
Lines

Number of lines sold to customer when applicable.

integer
Locations

Number of customer locations.

integer
Minutes

Number of minutes for call when appropriate.

double float
Debit

Determines if this is a prepaid debit card transaction.

boolean
AdjustmentDiscount

Adjustment discount type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid discount types.

integer
FacilitiesBased

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

boolean
Franchise

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

boolean
Lifeline

Indicates if customer is a Lifeline participant.

boolean
Regulated

True if regulated, otherwise false.

boolean
ServiceLevelNumber

User-defined service level number.

integer
Array[Exclusions]
CountryISO

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

string
State

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

string
ExclusionOn
Required

True if entity exclusion applies in the state, otherwise false.

boolean
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

Tax Category. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for valid tax categories.

integer
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
TaxInclusive

Indicates if the charge of this transaction is tax-inclusive (reverse tax calculation).

boolean
Array[SafeHarborOverrides]
SafeHarborType

Safe harbor type (1 = Cellular, 2 = VoIP, 4 = Paging).

integer
OriginalFederalTam

Original Federal TAM value to override.

number
NewFederalTam

New TAM value that will replace the original TAM value.

number
DocumentCode

Document code.

string
Commit

Indicates if the transaction should be committed as soon at it is processed.

boolean

Response[Array]

AdjustmentType

Adjustmnet type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid adjustment types.

integer
Billable

Indicates if the tax is billable to the customer.

boolean
CalculationType

Calculation type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid calculation types.

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
ExemptionType

Exemption type from transaction input.

integer
ExemptSaleAmount

Amount of the charge exempt from taxes.

number
InvoiceNumber

User-defined invoice number.

integer
Optional

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value.

string
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
Optional10

Optional user-defined value.

integer
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
TaxableMeasure

Amount of sale subject to tax plus any taxed taxes.

number
TaxAmount

Calculated tax amount.

number
TaxLevel

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
TaxType

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
Lines

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

integer
Minutes

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

double float
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
TransCharge

Transaction charge amount.

number

Calculate tax adjustments for a pro-rated transaction

Accepts a pro-rated percentage that is used to calculate the taxable amount on the transaction and perform tax adjustments.

Api Endpoint
POST https://communications.avalara.net/api/v1/CalculateProRated/Adjustments

Headers
Authorization: Basic aHR0cHdhdGNoOmY=Content-Type: text/json

Post Body Parameters

ProRatedPercent
Required

Percentage to prorate specified as a decimal.

number
Transaction
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

Origination FIPS code.

string
OriginationPCode

Origination PCode.

integer
OriginationNpaNxx

Origination NPANXX.

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

Termination FIPS code.

string
TerminationPCode

Termination PCode.

integer
TerminationNpaNxx

Termination NPANXX.

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

Bill-to FIPS code.

string
BillToPCode

Bill-to PCode.

integer
BillToNpaNxx

Bill-to NPANXX

integer
IsPrivateLine

Indicates if the transaction is a private line transaction.

boolean
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
CustomerType
Required

Customer type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid customer types.

integer
BusinessClass

Business class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid business classes.

integer
Sale
Required

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

boolean
TransactionType
Required

Transaction type.

integer
ServiceType
Required

Service type.

integer
ServiceClass

Service class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid Service Classes.

integer
Date
Required

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

string
Charge
Required

Charge amount to customer for transaction

number
Incorporated
Required

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

boolean
FederalExempt

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

boolean
StateExempt

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

boolean
CountyExempt

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

boolean
LocalExempt

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

boolean
FederalPCode

Jurisdiction for Federal exemption.

integer
StatePCode

Jurisdiction for state exemption.

integer
CountyPCode

Jurisdiction for county exemption.

integer
LocalPCode

Jurisdiction for local exemption.

integer
Array[Exemptions]
PCode
Required

PCode for jurisdiction to exempt.

integer
TaxLevel
Required

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
TaxType
Required

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
ExemptionType

Exemtion type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid exemption types.

integer
InvoiceNumber

User-defined invoice number.

integer
Optional

Optional user-defined value.

integer
CustomerNumber

User-defined customer number.

string
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
OptionalAlpha1

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

string
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
Optional10

Optional user-defined value.

integer
AdjustmentMethod

Adjustment method. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid adjustment methods.

integer
Lines

Number of lines sold to customer when applicable.

integer
Locations

Number of customer locations.

integer
Minutes

Number of minutes for call when appropriate.

double float
Debit

Determines if this is a prepaid debit card transaction.

boolean
AdjustmentDiscount

Adjustment discount type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid discount types.

integer
FacilitiesBased

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

boolean
Franchise

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

boolean
Lifeline

Indicates if customer is a Lifeline participant.

boolean
Regulated

True if regulated, otherwise false.

boolean
ServiceLevelNumber

User-defined service level number.

integer
Array[Exclusions]
CountryISO

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

string
State

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

string
ExclusionOn
Required

True if entity exclusion applies in the state, otherwise false.

boolean
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

Tax Category. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for valid tax categories.

integer
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
TaxInclusive

Indicates if the charge of this transaction is tax-inclusive (reverse tax calculation).

boolean
Array[SafeHarborOverrides]
SafeHarborType

Safe harbor type (1 = Cellular, 2 = VoIP, 4 = Paging).

integer
OriginalFederalTam

Original Federal TAM value to override.

number
NewFederalTam

New TAM value that will replace the original TAM value.

number
DocumentCode

Document code.

string
Commit

Indicates if the transaction should be committed as soon at it is processed.

boolean

Response[Array]

AdjustmentType

Adjustmnet type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid adjustment types.

integer
Billable

Indicates if the tax is billable to the customer.

boolean
CalculationType

Calculation type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid calculation types.

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
ExemptionType

Exemption type from transaction input.

integer
ExemptSaleAmount

Amount of the charge exempt from taxes.

number
InvoiceNumber

User-defined invoice number.

integer
Optional

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value.

string
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
Optional10

Optional user-defined value.

integer
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
TaxableMeasure

Amount of sale subject to tax plus any taxed taxes.

number
TaxAmount

Calculated tax amount.

number
TaxLevel

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
TaxType

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
Lines

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

integer
Minutes

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

double float
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
TransCharge

Transaction charge amount.

number

Calculate taxes using overrides

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

Api Endpoint
POST https://communications.avalara.net/api/v1/CalculateWithOverrides/Taxes

Headers
Authorization: Basic aHR0cHdhdGNoOmY=Content-Type: text/json

Post Body Parameters

Transaction
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

Origination FIPS code.

string
OriginationPCode

Origination PCode.

integer
OriginationNpaNxx

Origination NPANXX.

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

Termination FIPS code.

string
TerminationPCode

Termination PCode.

integer
TerminationNpaNxx

Termination NPANXX.

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

Bill-to FIPS code.

string
BillToPCode

Bill-to PCode.

integer
BillToNpaNxx

Bill-to NPANXX

integer
IsPrivateLine

Indicates if the transaction is a private line transaction.

boolean
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
CustomerType
Required

Customer type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid customer types.

integer
BusinessClass

Business class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid business classes.

integer
Sale
Required

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

boolean
TransactionType
Required

Transaction type.

integer
ServiceType
Required

Service type.

integer
ServiceClass

Service class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid Service Classes.

integer
Date
Required

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

string
Charge
Required

Charge amount to customer for transaction

number
Incorporated
Required

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

boolean
FederalExempt

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

boolean
StateExempt

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

boolean
CountyExempt

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

boolean
LocalExempt

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

boolean
FederalPCode

Jurisdiction for Federal exemption.

integer
StatePCode

Jurisdiction for state exemption.

integer
CountyPCode

Jurisdiction for county exemption.

integer
LocalPCode

Jurisdiction for local exemption.

integer
Array[Exemptions]
PCode
Required

PCode for jurisdiction to exempt.

integer
TaxLevel
Required

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
TaxType
Required

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
ExemptionType

Exemtion type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid exemption types.

integer
InvoiceNumber

User-defined invoice number.

integer
Optional

Optional user-defined value.

integer
CustomerNumber

User-defined customer number.

string
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
OptionalAlpha1

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

string
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
Optional10

Optional user-defined value.

integer
AdjustmentMethod

Adjustment method. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid adjustment methods.

integer
Lines

Number of lines sold to customer when applicable.

integer
Locations

Number of customer locations.

integer
Minutes

Number of minutes for call when appropriate.

double float
Debit

Determines if this is a prepaid debit card transaction.

boolean
AdjustmentDiscount

Adjustment discount type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid discount types.

integer
FacilitiesBased

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

boolean
Franchise

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

boolean
Lifeline

Indicates if customer is a Lifeline participant.

boolean
Regulated

True if regulated, otherwise false.

boolean
ServiceLevelNumber

User-defined service level number.

integer
Array[Exclusions]
CountryISO

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

string
State

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

string
ExclusionOn
Required

True if entity exclusion applies in the state, otherwise false.

boolean
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

Tax Category. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for valid tax categories.

integer
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
TaxInclusive

Indicates if the charge of this transaction is tax-inclusive (reverse tax calculation).

boolean
Array[SafeHarborOverrides]
SafeHarborType

Safe harbor type (1 = Cellular, 2 = VoIP, 4 = Paging).

integer
OriginalFederalTam

Original Federal TAM value to override.

number
NewFederalTam

New TAM value that will replace the original TAM value.

number
DocumentCode

Document code.

string
Commit

Indicates if the transaction should be committed as soon at it is processed.

boolean
Array[Overrides]
Pcode
Required

Jurisdiction PCode for this tax rate override.

integer
Scope
Required

Scope for override. See the "TM_00101_AFC User Manual_Telecom.pdf" for valid values.

integer
TaxType
Required

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
TaxLevel
Required

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
LevelExemptible
Required

Indicates if the tax can be exempted using level exemptions.

boolean
Array[BracketInfo]
Rate
Required

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

number
MaxBase
Required

Maximum base that this rate applies to.

number
CountyOverrideTax

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

number
StateOverrideTax

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

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
CountyOverrideOn

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

boolean

Response[Array]

AdjustmentType

Adjustmnet type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid adjustment types.

integer
Billable

Indicates if the tax is billable to the customer.

boolean
CalculationType

Calculation type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid calculation types.

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
ExemptionType

Exemption type from transaction input.

integer
ExemptSaleAmount

Amount of the charge exempt from taxes.

number
InvoiceNumber

User-defined invoice number.

integer
Optional

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value.

string
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
Optional10

Optional user-defined value.

integer
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
TaxableMeasure

Amount of sale subject to tax plus any taxed taxes.

number
TaxAmount

Calculated tax amount.

number
TaxLevel

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
TaxType

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
Lines

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

integer
Minutes

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

double float
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
TransCharge

Transaction charge amount.

number

Calculate tax adjustments using overrides

Accepts transaction and tax rate override data to perform tax adjustments with the provided override information.

Api Endpoint
POST https://communications.avalara.net/api/v1/CalculateWithOverrides/Adjustments

Headers
Authorization: Basic aHR0cHdhdGNoOmY=Content-Type: text/json

Post Body Parameters

Transaction
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

Origination FIPS code.

string
OriginationPCode

Origination PCode.

integer
OriginationNpaNxx

Origination NPANXX.

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

Termination FIPS code.

string
TerminationPCode

Termination PCode.

integer
TerminationNpaNxx

Termination NPANXX.

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

Bill-to FIPS code.

string
BillToPCode

Bill-to PCode.

integer
BillToNpaNxx

Bill-to NPANXX

integer
IsPrivateLine

Indicates if the transaction is a private line transaction.

boolean
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
CustomerType
Required

Customer type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid customer types.

integer
BusinessClass

Business class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid business classes.

integer
Sale
Required

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

boolean
TransactionType
Required

Transaction type.

integer
ServiceType
Required

Service type.

integer
ServiceClass

Service class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid Service Classes.

integer
Date
Required

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

string
Charge
Required

Charge amount to customer for transaction

number
Incorporated
Required

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

boolean
FederalExempt

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

boolean
StateExempt

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

boolean
CountyExempt

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

boolean
LocalExempt

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

boolean
FederalPCode

Jurisdiction for Federal exemption.

integer
StatePCode

Jurisdiction for state exemption.

integer
CountyPCode

Jurisdiction for county exemption.

integer
LocalPCode

Jurisdiction for local exemption.

integer
Array[Exemptions]
PCode
Required

PCode for jurisdiction to exempt.

integer
TaxLevel
Required

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
TaxType
Required

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
ExemptionType

Exemtion type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid exemption types.

integer
InvoiceNumber

User-defined invoice number.

integer
Optional

Optional user-defined value.

integer
CustomerNumber

User-defined customer number.

string
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
OptionalAlpha1

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

string
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
Optional10

Optional user-defined value.

integer
AdjustmentMethod

Adjustment method. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid adjustment methods.

integer
Lines

Number of lines sold to customer when applicable.

integer
Locations

Number of customer locations.

integer
Minutes

Number of minutes for call when appropriate.

double float
Debit

Determines if this is a prepaid debit card transaction.

boolean
AdjustmentDiscount

Adjustment discount type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid discount types.

integer
FacilitiesBased

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

boolean
Franchise

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

boolean
Lifeline

Indicates if customer is a Lifeline participant.

boolean
Regulated

True if regulated, otherwise false.

boolean
ServiceLevelNumber

User-defined service level number.

integer
Array[Exclusions]
CountryISO

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

string
State

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

string
ExclusionOn
Required

True if entity exclusion applies in the state, otherwise false.

boolean
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

Tax Category. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for valid tax categories.

integer
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
TaxInclusive

Indicates if the charge of this transaction is tax-inclusive (reverse tax calculation).

boolean
Array[SafeHarborOverrides]
SafeHarborType

Safe harbor type (1 = Cellular, 2 = VoIP, 4 = Paging).

integer
OriginalFederalTam

Original Federal TAM value to override.

number
NewFederalTam

New TAM value that will replace the original TAM value.

number
DocumentCode

Document code.

string
Commit

Indicates if the transaction should be committed as soon at it is processed.

boolean
Array[Overrides]
Pcode
Required

Jurisdiction PCode for this tax rate override.

integer
Scope
Required

Scope for override. See the "TM_00101_AFC User Manual_Telecom.pdf" for valid values.

integer
TaxType
Required

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
TaxLevel
Required

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
LevelExemptible
Required

Indicates if the tax can be exempted using level exemptions.

boolean
Array[BracketInfo]
Rate
Required

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

number
MaxBase
Required

Maximum base that this rate applies to.

number
CountyOverrideTax

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

number
StateOverrideTax

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

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
CountyOverrideOn

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

boolean

Response[Array]

AdjustmentType

Adjustmnet type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid adjustment types.

integer
Billable

Indicates if the tax is billable to the customer.

boolean
CalculationType

Calculation type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid calculation types.

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
ExemptionType

Exemption type from transaction input.

integer
ExemptSaleAmount

Amount of the charge exempt from taxes.

number
InvoiceNumber

User-defined invoice number.

integer
Optional

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value.

string
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
Optional10

Optional user-defined value.

integer
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
TaxableMeasure

Amount of sale subject to tax plus any taxed taxes.

number
TaxAmount

Calculated tax amount.

number
TaxLevel

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
TaxType

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
Lines

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

integer
Minutes

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

double float
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
TransCharge

Transaction charge amount.

number

Calculate taxes on a transaction

This method accepts transaction data and performs appropriate tax calculations.

Api Endpoint
POST https://communications.avalara.net/api/v1/CommitTransactions

Headers
Authorization: Basic aHR0cHdhdGNoOmY=Content-Type: text/json

Post Body Parameters

DocumentCode

Document code.

string
Committed

Indicates if transactions for the specified document code should be committed.

boolean
CustomerNumber

Overrides value for CustomerNumber field in reports.

string
InvoiceNumber

Overrides value for InvoiceNumber field in reports.

integer
Optional

Overrides value for Optional field in reports.

integer
Optional4

Overrides value for Optional4 field in reports.

integer
Optional5

Overrides value for Optional5 field in reports.

integer
Optional6

Overrides value for Optional6 field in reports.

integer
Optional7

Overrides value for Optional7 field in reports.

integer
Optional8

Overrides value for Optional8 field in reports.

integer
Optional9

Overrides value for Optional9 field in reports.

integer
Optional10

Overrides value for Optional10 field in reports.

integer
OptionalAlpha1

Overrides value for OptionalAlpha1 field in reports.

string
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string

Response

Post Body Parameters
boolean

Initiate a new customer batch

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
GET https://communications.avalara.net/api/v1/CustMode/BeginBatch

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Response

Post Body Parameters

Unique identifier for the customer batch.

integer

Submit a transaction for a customer batch

Submits a single transaction to be processed for a customer batch. The transaction will be processed when the ProcessBatch API is invoked for the customer batch ID.

Api Endpoint
POST https://communications.avalara.net/api/v1/CustMode/CalcTaxes

Headers
Authorization: Basic aHR0cHdhdGNoOmY=Content-Type: text/json

Post Body Parameters

CustBatchID
Required

Customer batch identifier.

integer
Transaction
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

Origination FIPS code.

string
OriginationPCode

Origination PCode.

integer
OriginationNpaNxx

Origination NPANXX.

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

Termination FIPS code.

string
TerminationPCode

Termination PCode.

integer
TerminationNpaNxx

Termination NPANXX.

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

Bill-to FIPS code.

string
BillToPCode

Bill-to PCode.

integer
BillToNpaNxx

Bill-to NPANXX

integer
IsPrivateLine

Indicates if the transaction is a private line transaction.

boolean
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
CustomerType
Required

Customer type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid customer types.

integer
BusinessClass

Business class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid business classes.

integer
Sale
Required

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

boolean
TransactionType
Required

Transaction type.

integer
ServiceType
Required

Service type.

integer
ServiceClass

Service class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid Service Classes.

integer
Date
Required

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

string
Charge
Required

Charge amount to customer for transaction

number
Incorporated
Required

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

boolean
FederalExempt

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

boolean
StateExempt

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

boolean
CountyExempt

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

boolean
LocalExempt

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

boolean
FederalPCode

Jurisdiction for Federal exemption.

integer
StatePCode

Jurisdiction for state exemption.

integer
CountyPCode

Jurisdiction for county exemption.

integer
LocalPCode

Jurisdiction for local exemption.

integer
Array[Exemptions]
PCode
Required

PCode for jurisdiction to exempt.

integer
TaxLevel
Required

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
TaxType
Required

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
ExemptionType

Exemtion type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid exemption types.

integer
InvoiceNumber

User-defined invoice number.

integer
Optional

Optional user-defined value.

integer
CustomerNumber

User-defined customer number.

string
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
OptionalAlpha1

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

string
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
Optional10

Optional user-defined value.

integer
AdjustmentMethod

Adjustment method. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid adjustment methods.

integer
Lines

Number of lines sold to customer when applicable.

integer
Locations

Number of customer locations.

integer
Minutes

Number of minutes for call when appropriate.

double float
Debit

Determines if this is a prepaid debit card transaction.

boolean
AdjustmentDiscount

Adjustment discount type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid discount types.

integer
FacilitiesBased

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

boolean
Franchise

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

boolean
Lifeline

Indicates if customer is a Lifeline participant.

boolean
Regulated

True if regulated, otherwise false.

boolean
ServiceLevelNumber

User-defined service level number.

integer
Array[Exclusions]
CountryISO

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

string
State

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

string
ExclusionOn
Required

True if entity exclusion applies in the state, otherwise false.

boolean
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

Tax Category. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for valid tax categories.

integer
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
TaxInclusive

Indicates if the charge of this transaction is tax-inclusive (reverse tax calculation).

boolean
Array[SafeHarborOverrides]
SafeHarborType

Safe harbor type (1 = Cellular, 2 = VoIP, 4 = Paging).

integer
OriginalFederalTam

Original Federal TAM value to override.

number
NewFederalTam

New TAM value that will replace the original TAM value.

number
DocumentCode

Document code.

string
Commit

Indicates if the transaction should be committed as soon at it is processed.

boolean

Response

Post Body Parameters

Boolean indicating success or failure.

boolean

Submit an adjustment for a customer batch

Submits a single adjustment to be processed for a customer batch. The adjustment will be processed when the ProcessBatch API is invoked for the customer batch ID.

Api Endpoint
POST https://communications.avalara.net/api/v1/CustMode/CalcAdjustments

Headers
Authorization: Basic aHR0cHdhdGNoOmY=Content-Type: text/json

Post Body Parameters

CustBatchID
Required

Customer batch identifier.

integer
Transaction
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

Origination FIPS code.

string
OriginationPCode

Origination PCode.

integer
OriginationNpaNxx

Origination NPANXX.

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

Termination FIPS code.

string
TerminationPCode

Termination PCode.

integer
TerminationNpaNxx

Termination NPANXX.

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

Bill-to FIPS code.

string
BillToPCode

Bill-to PCode.

integer
BillToNpaNxx

Bill-to NPANXX

integer
IsPrivateLine

Indicates if the transaction is a private line transaction.

boolean
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
CustomerType
Required

Customer type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid customer types.

integer
BusinessClass

Business class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid business classes.

integer
Sale
Required

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

boolean
TransactionType
Required

Transaction type.

integer
ServiceType
Required

Service type.

integer
ServiceClass

Service class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid Service Classes.

integer
Date
Required

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

string
Charge
Required

Charge amount to customer for transaction

number
Incorporated
Required

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

boolean
FederalExempt

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

boolean
StateExempt

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

boolean
CountyExempt

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

boolean
LocalExempt

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

boolean
FederalPCode

Jurisdiction for Federal exemption.

integer
StatePCode

Jurisdiction for state exemption.

integer
CountyPCode

Jurisdiction for county exemption.

integer
LocalPCode

Jurisdiction for local exemption.

integer
Array[Exemptions]
PCode
Required

PCode for jurisdiction to exempt.

integer
TaxLevel
Required

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
TaxType
Required

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
ExemptionType

Exemtion type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid exemption types.

integer
InvoiceNumber

User-defined invoice number.

integer
Optional

Optional user-defined value.

integer
CustomerNumber

User-defined customer number.

string
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
OptionalAlpha1

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

string
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
Optional10

Optional user-defined value.

integer
AdjustmentMethod

Adjustment method. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid adjustment methods.

integer
Lines

Number of lines sold to customer when applicable.

integer
Locations

Number of customer locations.

integer
Minutes

Number of minutes for call when appropriate.

double float
Debit

Determines if this is a prepaid debit card transaction.

boolean
AdjustmentDiscount

Adjustment discount type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid discount types.

integer
FacilitiesBased

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

boolean
Franchise

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

boolean
Lifeline

Indicates if customer is a Lifeline participant.

boolean
Regulated

True if regulated, otherwise false.

boolean
ServiceLevelNumber

User-defined service level number.

integer
Array[Exclusions]
CountryISO

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

string
State

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

string
ExclusionOn
Required

True if entity exclusion applies in the state, otherwise false.

boolean
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

Tax Category. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for valid tax categories.

integer
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
TaxInclusive

Indicates if the charge of this transaction is tax-inclusive (reverse tax calculation).

boolean
Array[SafeHarborOverrides]
SafeHarborType

Safe harbor type (1 = Cellular, 2 = VoIP, 4 = Paging).

integer
OriginalFederalTam

Original Federal TAM value to override.

number
NewFederalTam

New TAM value that will replace the original TAM value.

number
DocumentCode

Document code.

string
Commit

Indicates if the transaction should be committed as soon at it is processed.

boolean

Response

Post Body Parameters

Boolean indicating success or failure.

boolean

Process a customer batch

Processes a customer batch and returns the tax calculation results.

Api Endpoint
POST https://communications.avalara.net/api/v1/CustMode/ProcessBatch

Headers
Authorization: Basic aHR0cHdhdGNoOmY=Content-Type: text/json

Post Body Parameters

CustBatchId
Required

Identifier for customer batch to process.

integer
Array[Exclusions]
CountryISO

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

string
State

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

string
ExclusionOn
Required

True if entity exclusion applies in the state, otherwise false.

boolean
ReturnDetail

Indicates if the individual transaction taxes should be returned in the response.

boolean
DocumentCode

Document code.

string
Commit

Indicates if the transaction should be committed as soon at it is processed.

boolean

Response

Array[Taxes]
AdjustmentType

Adjustmnet type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid adjustment types.

integer
Billable

Indicates if the tax is billable to the customer.

boolean
CalculationType

Calculation type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid calculation types.

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
ExemptionType

Exemption type from transaction input.

integer
ExemptSaleAmount

Amount of the charge exempt from taxes.

number
InvoiceNumber

User-defined invoice number.

integer
Optional

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value.

string
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
Optional10

Optional user-defined value.

integer
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
TaxableMeasure

Amount of sale subject to tax plus any taxed taxes.

number
TaxAmount

Calculated tax amount.

number
TaxLevel

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
TaxType

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
Lines

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

integer
Minutes

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

double float
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
TransCharge

Transaction charge amount.

number
Array[SummarizedTaxes]
PCode

PCode for the reporting jurisdiction.

integer
TaxType

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
TaxLevel

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
CalculationType

Calculation type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid calculation types.

integer
Rate

Tax rate.

number
TaxAmount

Tax amount.

number
ExemptSaleAmount

Amount of the charge exempt from taxes.

number
Description

Tax description.

string
Surcharge

Indicates if tax is considered a surcharge.

integer
MaxBase

Max amount to which tax is applied.

number
MinBase

Min amount to which tax is applied.

number
ExcessTax

Rate for amount above max base.

number
TotalCharge

Sum of charges for this customer.

number
CategoryID

Tax category ID.

integer
CategoryDescription

Tax category description.

string
Lines

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

integer
Minutes

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

double float

Process transactions and adjustments in customer mode

Processes a batch of transactions and adjustments in customer mode.

Api Endpoint
POST https://communications.avalara.net/api/v1/CustMode/CalcTaxesInCustMode

Headers
Authorization: Basic aHR0cHdhdGNoOmY=Content-Type: text/json

Post Body Parameters

Array[Transactions]
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

Origination FIPS code.

string
OriginationPCode

Origination PCode.

integer
OriginationNpaNxx

Origination NPANXX.

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

Termination FIPS code.

string
TerminationPCode

Termination PCode.

integer
TerminationNpaNxx

Termination NPANXX.

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

Bill-to FIPS code.

string
BillToPCode

Bill-to PCode.

integer
BillToNpaNxx

Bill-to NPANXX

integer
IsPrivateLine

Indicates if the transaction is a private line transaction.

boolean
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
CustomerType
Required

Customer type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid customer types.

integer
BusinessClass

Business class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid business classes.

integer
Sale
Required

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

boolean
TransactionType
Required

Transaction type.

integer
ServiceType
Required

Service type.

integer
ServiceClass

Service class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid Service Classes.

integer
Date
Required

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

string
Charge
Required

Charge amount to customer for transaction

number
Incorporated
Required

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

boolean
FederalExempt

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

boolean
StateExempt

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

boolean
CountyExempt

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

boolean
LocalExempt

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

boolean
FederalPCode

Jurisdiction for Federal exemption.

integer
StatePCode

Jurisdiction for state exemption.

integer
CountyPCode

Jurisdiction for county exemption.

integer
LocalPCode

Jurisdiction for local exemption.

integer
Array[Exemptions]
PCode
Required

PCode for jurisdiction to exempt.

integer
TaxLevel
Required

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
TaxType
Required

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
ExemptionType

Exemtion type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid exemption types.

integer
InvoiceNumber

User-defined invoice number.

integer
Optional

Optional user-defined value.

integer
CustomerNumber

User-defined customer number.

string
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
OptionalAlpha1

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

string
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
Optional10

Optional user-defined value.

integer
AdjustmentMethod

Adjustment method. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid adjustment methods.

integer
Lines

Number of lines sold to customer when applicable.

integer
Locations

Number of customer locations.

integer
Minutes

Number of minutes for call when appropriate.

double float
Debit

Determines if this is a prepaid debit card transaction.

boolean
AdjustmentDiscount

Adjustment discount type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid discount types.

integer
FacilitiesBased

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

boolean
Franchise

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

boolean
Lifeline

Indicates if customer is a Lifeline participant.

boolean
Regulated

True if regulated, otherwise false.

boolean
ServiceLevelNumber

User-defined service level number.

integer
Array[Exclusions]
CountryISO

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

string
State

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

string
ExclusionOn
Required

True if entity exclusion applies in the state, otherwise false.

boolean
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

Tax Category. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for valid tax categories.

integer
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
TaxInclusive

Indicates if the charge of this transaction is tax-inclusive (reverse tax calculation).

boolean
Array[SafeHarborOverrides]
SafeHarborType

Safe harbor type (1 = Cellular, 2 = VoIP, 4 = Paging).

integer
OriginalFederalTam

Original Federal TAM value to override.

number
NewFederalTam

New TAM value that will replace the original TAM value.

number
DocumentCode

Document code.

string
Commit

Indicates if the transaction should be committed as soon at it is processed.

boolean
Array[Adjustments]
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

Origination FIPS code.

string
OriginationPCode

Origination PCode.

integer
OriginationNpaNxx

Origination NPANXX.

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

Termination FIPS code.

string
TerminationPCode

Termination PCode.

integer
TerminationNpaNxx

Termination NPANXX.

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

Bill-to FIPS code.

string
BillToPCode

Bill-to PCode.

integer
BillToNpaNxx

Bill-to NPANXX

integer
IsPrivateLine

Indicates if the transaction is a private line transaction.

boolean
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
CustomerType
Required

Customer type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid customer types.

integer
BusinessClass

Business class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid business classes.

integer
Sale
Required

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

boolean
TransactionType
Required

Transaction type.

integer
ServiceType
Required

Service type.

integer
ServiceClass

Service class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid Service Classes.

integer
Date
Required

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

string
Charge
Required

Charge amount to customer for transaction

number
Incorporated
Required

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

boolean
FederalExempt

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

boolean
StateExempt

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

boolean
CountyExempt

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

boolean
LocalExempt

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

boolean
FederalPCode

Jurisdiction for Federal exemption.

integer
StatePCode

Jurisdiction for state exemption.

integer
CountyPCode

Jurisdiction for county exemption.

integer
LocalPCode

Jurisdiction for local exemption.

integer
Array[Exemptions]
PCode
Required

PCode for jurisdiction to exempt.

integer
TaxLevel
Required

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
TaxType
Required

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
ExemptionType

Exemtion type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid exemption types.

integer
InvoiceNumber

User-defined invoice number.

integer
Optional

Optional user-defined value.

integer
CustomerNumber

User-defined customer number.

string
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
OptionalAlpha1

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

string
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
Optional10

Optional user-defined value.

integer
AdjustmentMethod

Adjustment method. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid adjustment methods.

integer
Lines

Number of lines sold to customer when applicable.

integer
Locations

Number of customer locations.

integer
Minutes

Number of minutes for call when appropriate.

double float
Debit

Determines if this is a prepaid debit card transaction.

boolean
AdjustmentDiscount

Adjustment discount type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid discount types.

integer
FacilitiesBased

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

boolean
Franchise

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

boolean
Lifeline

Indicates if customer is a Lifeline participant.

boolean
Regulated

True if regulated, otherwise false.

boolean
ServiceLevelNumber

User-defined service level number.

integer
Array[Exclusions]
CountryISO

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

string
State

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

string
ExclusionOn
Required

True if entity exclusion applies in the state, otherwise false.

boolean
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

Tax Category. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for valid tax categories.

integer
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
TaxInclusive

Indicates if the charge of this transaction is tax-inclusive (reverse tax calculation).

boolean
Array[SafeHarborOverrides]
SafeHarborType

Safe harbor type (1 = Cellular, 2 = VoIP, 4 = Paging).

integer
OriginalFederalTam

Original Federal TAM value to override.

number
NewFederalTam

New TAM value that will replace the original TAM value.

number
DocumentCode

Document code.

string
Commit

Indicates if the transaction should be committed as soon at it is processed.

boolean
Array[Exclusions]
CountryISO

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

string
State

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

string
ExclusionOn
Required

True if entity exclusion applies in the state, otherwise false.

boolean
ReturnDetail

Indicates if the individual transaction taxes should be returned in the response.

boolean
DocumentCode

Document code.

string
Commit

Indicates if the transaction should be committed as soon at it is processed.

boolean

Response

Array[Taxes]
AdjustmentType

Adjustmnet type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid adjustment types.

integer
Billable

Indicates if the tax is billable to the customer.

boolean
CalculationType

Calculation type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid calculation types.

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
ExemptionType

Exemption type from transaction input.

integer
ExemptSaleAmount

Amount of the charge exempt from taxes.

number
InvoiceNumber

User-defined invoice number.

integer
Optional

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value.

string
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
Optional10

Optional user-defined value.

integer
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
TaxableMeasure

Amount of sale subject to tax plus any taxed taxes.

number
TaxAmount

Calculated tax amount.

number
TaxLevel

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
TaxType

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
Lines

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

integer
Minutes

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

double float
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
TransCharge

Transaction charge amount.

number
Array[SummarizedTaxes]
PCode

PCode for the reporting jurisdiction.

integer
TaxType

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
TaxLevel

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
CalculationType

Calculation type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid calculation types.

integer
Rate

Tax rate.

number
TaxAmount

Tax amount.

number
ExemptSaleAmount

Amount of the charge exempt from taxes.

number
Description

Tax description.

string
Surcharge

Indicates if tax is considered a surcharge.

integer
MaxBase

Max amount to which tax is applied.

number
MinBase

Min amount to which tax is applied.

number
ExcessTax

Rate for amount above max base.

number
TotalCharge

Sum of charges for this customer.

number
CategoryID

Tax category ID.

integer
CategoryDescription

Tax category description.

string
Lines

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

integer
Minutes

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

double float

Calculate taxes on a bridge conference transaction

This method will take a Billing address, Bridge Address, Host Address (optional) and list of participants. The system will determine which taxes apply for each participant and return the summarized taxes for the bridge conference transaction. The individual participant results are returned if ReturnParticipantResults is true.

Api Endpoint
POST https://communications.avalara.net/api/v1/BridgeConference/Taxes

Headers
Authorization: Basic aHR0cHdhdGNoOmY=Content-Type: text/json

Post Body Parameters

ProcessInvalidParticipant

Flag indicating whether invalid participant jurisdiction should cause the transaction to fail (false) or whether the participant should be processed with greatest tax liability (true).

boolean
ReturnParticipantTaxes

Indicates whether individual participant taxes should be returned in the response.

boolean
BillingPCode

PCode for billing.

integer
BridgePCode

PCode for bridge.

integer
HostPCode

PCode for host.

integer
BillingNpaNxx

NPANXX for billing.

integer
BridgeNpaNxx

NPANXX for bridge.

integer
HostNpaNxx

NPANXX for host.

integer
BillingAddress
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
BridgeAddress
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
HostAddress
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
Array[Participants]
ParticipantAddress
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
ParticipantPCode

PCode forpParticipant � all participants must use PCode values if any participant uses PCode. Not required if ParticipantAddress or ParticipantNpaNxx are specified.

integer
ParticipantNpaNxx

NpaNxx for participant � all participants must use NPANXX values if any participant uses NPANXX. Not required if ParticipantAddress or ParticipantPCode are specified.

integer
ParticipantRef

Alpha-numeric reference that will tie a participant in the request to participant taxes in response if ReturnParticipantTaxes is true. Max 127 bytes.

string
CustomerType
Required

Customer Type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for valid customer types.

integer
BusinessClass

Business Class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for valid business classes.

integer
Sale
Required

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

boolean
TransactionType

Transaction type.

integer
ServiceType

Service type.

integer
ServiceClass

Service class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid service classes.

integer
Date
Required

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

string
Charge
Required

Charge amount to customer for transaction.

number
Incorporated
Required

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

boolean
FederalExempt

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

boolean
StateExempt

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

boolean
CountyExempt

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

boolean
LocalExempt

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

boolean
FederalPCode

Jurisdiction for Federal exemption.

integer
StatePCode

Jurisdiction for state exemption.

integer
CountyPCode

Jurisdiction for county exemption.

integer
LocalPCode

Jurisdiction for local exemption.

integer
Array[Exemptions]
PCode
Required

PCode for jurisdiction to exempt.

integer
TaxLevel
Required

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
TaxType
Required

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
ExemptionType

Exemption type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid exemption types.

integer
InvoiceNumber

User-defined invoice number.

integer
Optional

Optional user-defined value.

integer
CustomerNumber

User-defined customer number.

string
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
OptionalAlpha1

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

string
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
Optional10

Optional user-defined value.

integer
AdjustmentMethod

Adjustment method. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid adjustment methods.

integer
Lines

Number of lines sold to customer when applicable.

integer
Locations

Number of customer locations.

integer
Minutes

Number of minutes for call when appropriate.

double float
Debit

Determines if this is a prepaid debit card transaction.

boolean
DiscountType

Discount Type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for valid discount types.

integer
FacilitiesBased

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

boolean
Franchise

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

boolean
Lifeline

Indicates if customer is a Lifeline participant.

boolean
Regulated

True if regulated, otherwise false.

boolean
ServiceLevelNumber

User-defined service level number.

integer
Array[Exclusions]
CountryISO

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

string
State

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

string
ExclusionOn
Required

True if entity exclusion applies in the state, otherwise false.

boolean
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

Tax Category. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for valid tax categories.

integer
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
DocumentCode

Document code.

string
Commit

Indicates if the transaction should be committed as soon at it is processed.

boolean

Response

Array[ParticipantResults]
ParticipantRef

Participant reference from request.

string
ErrorCode

Error code for participant tax calculation (as applicable).

integer
TransactionType

Transaction type used for participant.

integer
ServiceType

Service type used for participant.

integer
Array[ParticipantTaxes]
AdjustmentType

Adjustmnet type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid adjustment types.

integer
Billable

Indicates if the tax is billable to the customer.

boolean
CalculationType

Calculation type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid calculation types.

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
ExemptionType

Exemption type from transaction input.

integer
ExemptSaleAmount

Amount of the charge exempt from taxes.

number
InvoiceNumber

User-defined invoice number.

integer
Optional

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value.

string
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
Optional10

Optional user-defined value.

integer
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
TaxableMeasure

Amount of sale subject to tax plus any taxed taxes.

number
TaxAmount

Calculated tax amount.

number
TaxLevel

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
TaxType

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
Lines

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

integer
Minutes

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

double float
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
TransCharge

Transaction charge amount.

number
Array[Taxes]
AdjustmentType

Adjustmnet type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid adjustment types.

integer
Billable

Indicates if the tax is billable to the customer.

boolean
CalculationType

Calculation type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid calculation types.

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
ExemptionType

Exemption type from transaction input.

integer
ExemptSaleAmount

Amount of the charge exempt from taxes.

number
InvoiceNumber

User-defined invoice number.

integer
Optional

Optional user-defined value.

integer
OptionalAlpha1

Optional user-defined string value.

string
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
Optional10

Optional user-defined value.

integer
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
TaxableMeasure

Amount of sale subject to tax plus any taxed taxes.

number
TaxAmount

Calculated tax amount.

number
TaxLevel

Tax level. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid tax levels.

integer
TaxType

Tax type. See the Telecom Mapping guidelines ("TM_00505_AFC Telecom Mapping Guidelines.pdf") for a list of valid tax types.

integer
Lines

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

integer
Minutes

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

double float
Array[OptionalFields]
OptionalKeyNo
Required

Key number (1 to 10) for optional field.

integer
OptionalValue
Required

Optional field value.

string
TransCharge

Transaction charge amount.

number

Calculate tax adjustments on a bridge conference transaction

This method will take a Billing address, Bridge Address, Host Address (optional) and list of participants. The system will determine which taxes apply for each participant and return the summarized tax adjustments for the bridge conference transaction. The individual participant results are returned if ReturnParticipantResults is true.

Api Endpoint
POST https://communications.avalara.net/api/v1/BridgeConference/Adjustments

Headers
Authorization: Basic aHR0cHdhdGNoOmY=Content-Type: text/json

Post Body Parameters

ProcessInvalidParticipant

Flag indicating whether invalid participant jurisdiction should cause the transaction to fail (false) or whether the participant should be processed with greatest tax liability (true).

boolean
ReturnParticipantTaxes

Indicates whether individual participant taxes should be returned in the response.

boolean
BillingPCode

PCode for billing.

integer
BridgePCode

PCode for bridge.

integer
HostPCode

PCode for host.

integer
BillingNpaNxx

NPANXX for billing.

integer
BridgeNpaNxx

NPANXX for bridge.

integer
HostNpaNxx

NPANXX for host.

integer
BillingAddress
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
BridgeAddress
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
HostAddress
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
Array[Participants]
ParticipantAddress
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
ParticipantPCode

PCode forpParticipant � all participants must use PCode values if any participant uses PCode. Not required if ParticipantAddress or ParticipantNpaNxx are specified.

integer
ParticipantNpaNxx

NpaNxx for participant � all participants must use NPANXX values if any participant uses NPANXX. Not required if ParticipantAddress or ParticipantPCode are specified.

integer
ParticipantRef

Alpha-numeric reference that will tie a participant in the request to participant taxes in response if ReturnParticipantTaxes is true. Max 127 bytes.

string
CustomerType
Required

Customer Type. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for valid customer types.

integer
BusinessClass

Business Class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for valid business classes.

integer
Sale
Required

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

boolean
TransactionType

Transaction type.

integer
ServiceType

Service type.

integer
ServiceClass

Service class. See the "TM_00116_AFC SaaS pro Telecom Developer Manual.pdf" for a list of valid service classes.

integer
Date
Required

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

string
Charge
Required

Charge amount to customer for transaction.