Avalara Developer Network Developer avaTax

Avatax SOAP API - Models

Model Summary
Address

Input property of GetTaxRequest representing addresses needed for tax calculations.

AdjustTaxBody
AdjustTaxEnvelope
AdjustTaxRequest

Input for adjusting documents. An AdjustTaxRequest consists of the body of a regular GetTaxRequest plus the addition of the AdjustTaxRequest object and calling method. The GetTaxRequest specified will replace the original document. All original values that aren’t being modified need to be populated in this object in addition to any values that are being modified.

AdjustTaxResponse

Result data returned from AdjustTax. Within this result you will find the same elements as a GetTaxResult. It is likely you will want to consider retrieving the document Version in addition to other tax related information. This is an element of all GetTaxResult or AdjustTaxResult objects.

ApplyPaymentBody
ApplyPaymentEnvelope
ApplyPaymentRequest
ApplyPaymentResponse
BaseAddress

Input property of GetTaxRequest representing addresses needed for tax calculations.

CancelTaxBody
CancelTaxEnvelope
CancelTaxRequest
CancelTaxResponse
CommitTaxBody
CommitTaxEnvelope
CommitTaxRequest

Input for CommitTax indicating the document that should be committed. You may use just the DocId to locate and commit the document (5.8 adapter and earlier, or 14.2 and later), or you may use all three of CompanyCode, DocType and DocCode.

CommitTaxResponse

Output for CommitTax indicating the success of the operation, or any errors encountered.

Country

Two character ISO country code.

DocCode

While this is an optional field, serious consideration should be given to using it. If no value is sent, AvaTax assigns a GUID value to keep the document unique, which can make reconciliation a challenge.

GetTaxBody
GetTaxEnvelope
GetTaxHistoryBody
GetTaxHistoryEnvelope
GetTaxHistoryRequest

Input for GetTaxHistory indicating the document for which history should be retrieved. The request must specify all of CompanyCode, DocCode, and DocType in order to uniquely identify the document.

GetTaxHistoryResponse

Result data returned from GetTaxHistory. You can retrieve any part of the GetTaxRequest or GetTaxResult.

GetTaxRequest
GetTaxResponse
GetTaxResult
Header

The SOAP API uses standard WSS (Web Service Security) token to authenticate the account or user, and additional Profile information to describe the agent calling the service.

IsAuthorizedBody
IsAuthorizedEnvelope
IsAuthorizedRequest
IsAuthorizedResponse

Result data returned from IsAuthorized.

Line

Input property of the GetTaxRequest describing item lines.

Message
Ping
PingBody
PingEnvelope
PingResponse

Result data returned from Ping.

PostTaxBody
PostTaxEnvelope
PostTaxRequest
PostTaxResponse

Result data returned from PostTax.

Profile
ReconcileTaxHistoryBody
ReconcileTaxHistoryEnvelope
ReconcileTaxHistoryRequest
ReconcileTaxHistoryResponse
ResultCode

Classifies severity of message. One of: Success, Warning, Error, Exception

Security
TaxAddress

Represents canonical addresses used in tax calculation.

TaxDetail

Tax details by jurisdiction

TaxLine

Tax calculation details for each item line (returned for detail levels Line and Tax).

TaxOverride

Nested object describing any tax override applied to the document. TaxOverride only needs to be included when there is need to override our tax calculation, most commonly on product returns. For each document, this may be done at either the document or line level, but not both on the same document.

UnauthorizedError
UsernameToken

Either an Account/LicenseKey or a Username/Password is required to authenticate the request. AccountNumber/LicenseKey is preferred.

ValidAddress
ValidateBody
ValidateEnvelope
ValidateResponse

Output for address/validate showing the validated address match or address validation errors.