Avalara Developer Network Developer communications

Communications SOAP - Models

Model Summary
AddressDataArray
BadRequest

IIS rejection - Insure schemas match binding and that prefixes are matched.

BeginCustomerBatchBody

Container for the request payload.

BeginCustomerBatchEnvelope
BeginCustomerBatchObject

The object used for starting a batch calculation.

BeginCustomerBatchRespEnvelope

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.

CalcAdjWithFipsCodeBody

Container for the request payload.

CalcAdjWithFipsCodeEnvelope
CalcAdjWithFipsCodeObject

The object used for calculating adjustments using a FIPS code.

CalcAdjWithFipsCodeRespEnvelope

Returns an array of TaxData objects that contain the information about the taxes applied.

CalcAdjWithNpaNxxBody

Container for the request payload.

CalcAdjWithNpaNxxEnvelope
CalcAdjWithNpaNxxObject

The object used for calculating adjustments with NpaNxx.

CalcAdjWithNpaNxxRespEnvelope

Returns an array of TaxData objects that contain the information about the taxes applied.

CalcAdjWithOverridesBody

Container for the request payload.

CalcAdjWithOverridesEnvelope
CalcAdjWithOverridesObject

The object used for calculating taxes using a overrides.

CalcAdjWithOverridesRespEnvelope

Returns an array of TaxData objects that contain the information about the taxes applied.

CalcAdjWithPCodeBody

Container for the request payload.

CalcAdjWithPCodeEnvelope
CalcAdjWithPCodeObject

The object used for calculating adjustments using a FIPS code.

CalcAdjWithPCodeRespEnvelope

Returns an array of TaxData objects that contain the information about the taxes applied.

CalcAdjWithZipAddressBody

Container for the request payload.

CalcAdjWithZipAddressEnvelope
CalcAdjWithZipAddressObject

The object used for calculating taxes using a zip address.

CalcAdjWithZipAddressRespEnvelope

Returns an array of TaxData objects that contain the information about the taxes applied.

CalcCustAdjBody

Container for the request payload.

CalcCustAdjEnvelope
CalcCustAdjObject

The object used for calculating a single batch transaction.

CalcCustAdjRespEnvelope

Retruns a boolean value indicating success (true) or failure (false).

CalcCustTaxesBody

Container for the request payload.

CalcCustTaxesEnvelope
CalcCustTaxesObject

The object used for calculating a single batch transaction.

CalcCustTaxesRespEnvelope

Retruns a boolean value indicating success (true) or failure (false).

CalcJurisdictionBody

Container for the request payload.

CalcJurisdictionEnvelope
CalcJurisdictionObject

The object used for determining jurisdiction.

CalcJurisdictionRespEnvelope

Returns the PCode at the lowest taxing jurisdiction.

CalcProRatedAdjBody

Container for the request payload.

CalcProRatedAdjEnvelope
CalcProRatedAdjObject

The object used for calculating prorated adjustment.

CalcProRatedAdjRespEnvelope

Returns an array of TaxData objects that contain the information about the taxes applied.

CalcProRatedTaxesBody

Container for the request payload.

CalcProRatedTaxesEnvelope
CalcProRatedTaxesObject

The object used for calculating prorated taxes.

CalcProRatedTaxesRespEnvelope

Returns an array of TaxData objects that contain the information about the taxes applied.

CalcReverseAdjWithFipsCodeBody

Container for the request payload.

CalcReverseAdjWithFipsCodeEnvelope
CalcReverseAdjWithFipsCodeObject

The object used for calculating reverse taxes using a FIPS code.

CalcReverseAdjWithFipsCodeRespEnvelope

Returns the calculated base sale amount for the transaction and an array of TaxData objects that contain the information about the taxes applied.

CalcReverseAdjWithNpaNxxBody

Container for the request payload.

CalcReverseAdjWithNpaNxxEnvelope
CalcReverseAdjWithNpaNxxObject

The object used for calculating reverse taxes using an NpaNxx value.

CalcReverseAdjWithNpaNxxRespEnvelope

Returns the calculated base sale amount for the transaction and an array of TaxData objects that contain the information about the taxes applied.

CalcReverseAdjWithPCodeBody

Container for the request payload.

CalcReverseAdjWithPCodeEnvelope
CalcReverseAdjWithPCodeObject

The object used for calculating reverse taxes using a PCode.

CalcReverseAdjWithPCodeRespEnvelope

Returns the calculated base sale amount for the transaction and an array of TaxData objects that contain the information about the taxes applied.

CalcReverseAdjWithZipCodeBody

Container for the request payload.

CalcReverseAdjWithZipCodeEnvelope
CalcReverseAdjWithZipCodeObject

The object used for calculating reverse taxes using a zip code.

CalcReverseAdjWithZipCodeRespEnvelope

Returns the calculated base sale amount for the transaction and an array of TaxData objects that contain the information about the taxes applied.

CalcReverseTaxesWithFipsCodeBody

Container for the request payload.

CalcReverseTaxesWithFipsCodeEnvelope
CalcReverseTaxesWithFipsCodeObject

The object used for calculating reverse taxes using a FIPS code.

CalcReverseTaxesWithFipsCodeRespEnvelope

Returns the calculated base sale amount for the transaction and an array of TaxData objects that contain the information about the taxes applied.

CalcReverseTaxesWithNpaNxxBody

Container for the request payload.

CalcReverseTaxesWithNpaNxxEnvelope
CalcReverseTaxesWithNpaNxxObject

The object used for calculating reverse taxes using an NpaNxx.

CalcReverseTaxesWithNpaNxxRespEnvelope

Returns the calculated base sale amount for the transaction and an array of TaxData objects that contain the information about the taxes applied.

CalcReverseTaxesWithPCodeBody

Container for the request payload.

CalcReverseTaxesWithPCodeEnvelope
CalcReverseTaxesWithPCodeObject

The object used for calculating reverse taxes using a PCode.

CalcReverseTaxesWithPCodeRespEnvelope

Returns the calculated base sale amount for the transaction and an array of TaxData objects that contain the information about the taxes applied.

CalcReverseTaxesWithZipAddressBody

Container for the request payload.

CalcReverseTaxesWithZipAddressEnvelope
CalcReverseTaxesWithZipAddressObject

The object used for calculating reverse taxes using a Zip Address.

CalcReverseTaxesWithZipAddressRespEnvelope

Returns the calculated base sale amount for the transaction and an array of TaxData objects that contain the information about the taxes applied.

CalcTaxesInCustModeBody

Container for the request payload.

CalcTaxesInCustModeEnvelope
CalcTaxesInCustModeObject

The object used for calculating taxes in customer mode.

CalcTaxesInCustModeRespEnvelope

Data structure containing an array of TaxData objects for each individual transaction processed and CustomerTaxData array containing the summarized taxes for the customer batch.

CalcTaxesWithFipsCodeBody

Container for the request payload.

CalcTaxesWithFipsCodeEnvelope
CalcTaxesWithFipsCodeObject

The object used for calculating taxes with FIPS Codes.

CalcTaxesWithFipsCodeRespEnvelope

Transaction data for performing tax calculations.

CalcTaxesWithNpaNxxBody

Container for the request payload.

CalcTaxesWithNpaNxxEnvelope
CalcTaxesWithNpaNxxObject

The object used for calculating taxes with NpaNxx.

CalcTaxesWithNpaNxxRespEnvelope

Transaction data for performing tax calculations.

CalcTaxesWithOverridesBody

Container for the request payload.

CalcTaxesWithOverridesEnvelope
CalcTaxesWithOverridesObject

The object used for calculating taxes with overrides.

CalcTaxesWithOverridesRespEnvelope

Returns an array of TaxData objects that contain the information about the taxes applied.

CalcTaxesWithPCodeBody

Container for the request payload.

CalcTaxesWithPCodeEnvelope
CalcTaxesWithPCodeObject

The object used for calculating taxes with PCode.

CalcTaxesWithPCodeRespEnvelope

Transaction data for performing tax calculations.

CalcTaxesWithZipAddressBody

Container for the request payload.

CalcTaxesWithZipAddressEnvelope
CalcTaxesWithZipAddressObject

The object used for calculating taxes with Zip Address.

CalcTaxesWithZipAddressRespEnvelope

Transaction data for performing tax calculations.

CategoryExemption

Category Exemption Class

CreateReport
CreateReportBody

Container for the request payload.

CreateReportEnvelope
CreateReportObject

The object used to request creation of a report.

CreateReportRespEnvelope

Returns a boolean as a string. ‘true’ indicates success and ‘false’ indicates failure.

CustomLogField
CustomLogFieldList

List of columns to include in the report when using the �customlog� report type.

CustomLogFields

Container for zero or more CustomLogField sepcifications.

CustomerTaxData

Customer taxes when using Customer Mode.

Exclusion

Exclusions Class

FaultDetail
FipsToPCodeBody

Container for the request payload.

FipsToPCodeEnvelope
FipsToPCodeObject

The object used for converting a FIPS code to a PCode.

FipsToPCodeRespEnvelope

Returns the PCode corresponding to the submitted FIPS value.

GetAddressBody

Container for the request payload.

GetAddressEnvelope
GetAddressObject

The object used for getting an address.

GetAddressRespEnvelope

This method returns the addresses for the specified jurisdiction.

GetEZTaxDbVersion

The request to fetch the database version.

GetEZTaxDbVersionBody

Container for the request payload.

GetEZTaxDbVersionEnvelope
GetEZTaxDbVersionRespEnvelope

Returns the version of the AFC database as a string.

GetEZTaxVersion

The request to fetch the EZTax Net version.

GetEZTaxVersionBody

Container for the request payload.

GetEZTaxVersionEnvelope
GetEZTaxVersionRespEnvelope

Returns the tax engine version information as a string.

GetOptionalFieldKeyDesc

The request to retrieve the Field Key Descriptions.

GetOptionalFieldKeyDescBody

Container for the request payload.

GetOptionalFieldKeyDescEnvelope
GetOptionalFieldKeyDescRespEnvelope

Returns the Field Key Descriptions.

GetServerTimeBody

Container for the request payload.

GetServerTimeEnvelope
GetServerTimeObject

The object used to get the current server time. Syntax: a: GetServerTime /

GetServerTimeRespEnvelope

Returns the server date and time as a formatted string.

GetTaxCategoryBody

Container for the request payload.

GetTaxCategoryEnvelope
GetTaxCategoryObject

The object used for fetching a Tax Type Category string.

GetTaxCategoryRespEnvelope

This method returns a string describing the tax category for the specified tax type.

GetTaxDescriptionBody

Container for the request payload.

GetTaxDescriptionEnvelope
GetTaxDescriptionObject

The object used for fetching a Tax Type Description string.

GetTaxDescriptionRespEnvelope

This method returns a string describing the tax description for the specified tax type.

GetTaxRatesBody

Container for the request payload.

GetTaxRatesEnvelope
GetTaxRatesObject

The object used for getting tax rates.

GetTaxRatesRespEnvelope

Determines the tax rate information for a jurisdiction identified by the input PCode.

GetVersion

The request to fetch the Web Service version.

GetVersionBody

Container for the request payload.

GetVersionEnvelope
GetVersionRespEnvelope

Returns the version of the AFC SaaS Pro Web Service as a string.

Header

The SOAP API uses standard security to authenticate the account or user.

HeaderResp

The SOAP API uses standard security to authenticate the account or user.

InternalServerError
Nexus

Please see ‘TM_00116_AFC SaaS Pro Telecom Developer Manual.pdf’ or ‘TM_00117_AFC SaaS Pro Sales and Use Developer Manual.pdf’ for details.

NpaNxxToPCodeBody

Container for the request payload.

NpaNxxToPCodeEnvelope
NpaNxxToPCodeObject

The object used for converting an NpaNxx to PCode.

NpaNxxToPCodeRespEnvelope

Returns the PCode corresponding to the submitted NpaNxx value.

OptionalField

Data structure used to provide optional alphanumeric data for transactions.

OptionalKeyData

Data structure used to provide optional alphanumeric data for transactions.

OverrideList
PCodeToFipsBody

Container for the request payload.

PCodeToFipsEnvelope
PCodeToFipsObject

The object used for converting a PCode to a FIPS code.

PCodeToFipsRespEnvelope

Returns the FIPS code corresponding to the submitted PCode value.

ProcessCustomerBatchBody

Container for the request payload.

ProcessCustomerBatchEnvelope
ProcessCustomerBatchObject

The object used to submit a Process Customer Batch request.

ProcessCustomerBatchRespEnvelope

Returns a CustomerTaxData array containing the summarized taxes for the customer batch. And, if requested, an array of TaxData objects for each individual transaction processed.

Security

SOAP element containing authentication strategy.

SecurityResp

SOAP element containing response certification information.

TaxBracket

Array of Tax Bracket Information structures.

TaxBracketInfo

Tax Bracket Info

TaxData

Zero or more array elements containing tax data.

TaxExemption

Tax Exemption class

TaxRateHistory

Tax Rate History Class

TaxRateInfo

Tax Rate Info Class

TaxRateOverrideInfo
TimestampResp

SOAP element containing time and date stamp.

Transaction

Note: Only select one from each of the BillTo, Origination and Termination options.

UpdateOptionalFieldKeyDesc

The object used to update a single Optional Field Key Description.

UpdateOptionalFieldKeyDescBody

Container for the request payload.

UpdateOptionalFieldKeyDescEnvelope
UpdateOptionalFieldKeyDescRespEnvelope

Retruns a boolean value indicating success (true) or failure (false).

UsernameToken

SOAP element containing username and password.

ZipAddress

Zip Address Class. Select only one BillToxxx option.

ZipToPCodeBody

Container for the request payload.

ZipToPCodeEnvelope
ZipToPCodeObject

The object used for converting a zip address to PCode.

ZipToPCodeRespEnvelope

Returns the PCode corresponding to the submitted zip address.

custBatchId
optionalFieldDesc
reportInfo

Fields that specify the reports to provide, the type of sorted report to generate, the sepcifications for the sorted report and the email delivery address. Note: If TimeSpan is provided, EndDate is not required.