Deletes a batch from the visible logs. Note that this operation does not delete any records that were created as a concequence of the batch being originally processed. As such, it is recommended that you do not use this method.

SOAPAction must be "http://avatax.avalara.com/services/BatchDelete" for this operation: e.g. `--header "SOAPAction: \"http://avatax.avalara.com/services/BatchDelete\""`

SOAPAction

Envelope

The operation was completed. Refer to the response property `ResultCode` to determine operation success or error.

An Error Occurred. Check the error message text to find more information.

BatchFetch uses a generic FetchRequest object to return details about a specified batch or group of batches. Filters must be populated (as the service will otherwise return all accessible records of the specified type).

SOAPAction must be "http://avatax.avalara.com/services/BatchFetch" for this operation: e.g. `--header "SOAPAction: \"http://avatax.avalara.com/services/BatchFetch\""`

A granular operation that allows deletion of a batch file (or group of files) independently of a processing batch. If you're loading your batches with BatchSave (as recommended), you do not need to call this method.

SOAPAction must be "http://avatax.avalara.com/services/BatchFileDelete" for this operation: e.g. `--header "SOAPAction: \"http://avatax.avalara.com/services/BatchFileDelete\""`

BatchFileFetch uses a generic FetchRequest object to return details about a specified batch file or group of batch files. Filters must be populated (as the service will otherwise return all accessible records of the specified type). Up to three batchFiles may be associated with a given completed batch: an input file, an error file, and a results file. For batches with no errors, no error file is generated. Similarly, for batches with no successfully processed records, no results file is generated.

SOAPAction must be "http://avatax.avalara.com/services/BatchFileFetch" for this operation: e.g. `--header "SOAPAction: \"http://avatax.avalara.com/services/BatchFileFetch\""`

A granular operation that allows a single batch file to be saved independent of a processing batch. If you're loading your batches with BatchSave (as recommended), you do not need to call this method.

SOAPAction must be "http://avatax.avalara.com/services/BatchFileSave" for this operation: e.g. `--header "SOAPAction: \"http://avatax.avalara.com/services/BatchFileSave\""`

This method is intended for *internal use only* and may be changed or removed without warning. A granular operation that allows a batch or group of batches to be processed. If you're loading your batches with BatchSave (as recommended), you do not need to call this method.

SOAPAction must be "http://avatax.avalara.com/services/BatchProcess" for this operation: e.g. `--header "SOAPAction: \"http://avatax.avalara.com/services/BatchProcess\""`

This function uses a Batch object to load and save a batch into the AvaTax system. It will automatically process the loaded batch. The file loaded needs to be in a .csv, .xls, or .xlsx format, with a header row, and data consistent with the appropriate import format. This import format is the same as the format required for imports through the Admin Console. Templates and information about these formats is available through our [Admin Console documentation](https://help.avalara.com/000_AvaTax_Calc/000AvaTaxCalc_User_Guide/055_Add_or_Import_Transactions?_ga=1.247157572.1375781175.1454001053).

SOAPAction must be "http://avatax.avalara.com/services/BatchSave" for this operation: e.g. `--header "SOAPAction: \"http://avatax.avalara.com/services/BatchSave\""`

A simple service to test authorized operations.

SOAPAction must be "http://avatax.avalara.com/services/IsAuthorized" for this operation: e.g. `--header "SOAPAction: \"http://avatax.avalara.com/services/IsAuthorized\""`

SOAPAction must be "http://avatax.avalara.com/services/Ping" for this operation: e.g. `--header "SOAPAction: \"http://avatax.avalara.com/services/Ping\""`

soap

Account number of the target account (e.g. 1100012345).

A unique Id assigned by the Avalara system to the given batch.

This value is used to display the batch status on when viewed on the Admin Console. Possible values are Waiting, Processing, Completed, Errors. Result/Error files are only available for batches with a status of Completed or Errors.

An indicator of the type of batch. Permitted values are: TransactionImport, TaxRuleImport, ExemptCertImport, CompanyLocationImport, ItemImport.

The unique identifier of the target company. Note that this is different from the CompanyCode. For information on finding your CompanyId, look here.

Date the batch process was completed.  Formatted as a DateTime.

Date the batch was created in the AvaTax system.  Formatted as a DateTime.

UserId of the user who created the Batch in the system.

An array of files associated with the batch. There may be up to three files: an input file, a results file (of those records that were successfully processed), and an error file (of those records which were not successfully processed).

Date the batch was last modified in the database. Formatted as a DateTime.

UserId of the user who last modified the batch.

Name of the batch – this will be the same as the Name of the input file.

BatchDelete

Body

BatchFetch

A system-assigned unique identifier of the file.

Unique identifier for the uploaded batch, matches the BatchId specified in the containing Batch object.

File content, as a byte array. Note that this is not returned in BatchFetch, and must be retrieved with BatchFileFetch. encoded as base64Binary

Number of records contained in the file (for error files only).

Applicable only for input, is not returned.

BatchFileDelete

BatchFileFetch

BatchFileSave

Upon saving a batch file, the system assigns that file a unique BatchFileId.

The unique transaction ID assigned by AvaTax to this request/response set. This value need only be retained for troubleshooting.

BatchProcess

BatchSave

The BatchId uniquely identifies the batch in the Avalara system. A unique BatchId will be assigned upon saving the batch.

Estimated time to complete the processing of the batch. Formatted as a DateTime.

BatchSaveResult

Allows the user to specify which properties of the specified object are desired. If not populated, all fields at the root level will be returned. Default and optional fields are documented at the operation level.

Allows the user to specify filter criteria for the result set. e.g. to return all batches with BatchId=12345, the filter would be 'BatchId=12345'. Not required, but highly recommended

PageIndex and PageSize (along with Sort) allow for pagination of records. PageIndex will determine the page number returned, as determined by Sort and PageSize from the result set.

Specifies the maximum number of records to be returned. Note that there is a service-level RecordCount limit of 100,000.

Returns the records sorted by the specified field. Especially useful when used with RecordCount.

The number of records found that fit the filter criteria specified in the request.

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.

IsAuthorized

The list of operations that you would like to test.

The date and time at which your AvaTax account will expire. DateTime in the format YYYY-MM-DD

The operations that the current user is authorized to use. Determined from the list provided in the IsAuthorized call. Possible operations are: Ping, IsAuthorized, GetTax, PostTax, CommitTax, CancelTax, AdjustTax, GetTaxHistory, Validate.

IsAuthorizedResult

Company not found.  Verify the CompanyCode.

The data used during the request that caused the message to be generated.

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

The internal location that generated the message.

Message

A message recorded in server-side audit logs. Can be empty.

The service version of the AvaTax service.

PingResult

Name and version of the adapter. This is set automatically by the .NET, PHP, and Java adapters.

Client application name and version. This should unique identify the software client that is calling the AvaTax service, and should be consistent across all deployments of that client version. e.g. “Drupal Commerce 5.7”

The NetBIOS name of the local computer. This is set automatically by the .NET, PHP, and Java adapters.

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

The WS-Security standard requires the wsse:Security element contains a SOAP-ENV:actor attribute.

Fault

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

The unique account number provided by Avalara for verification against the service. If you are on a free trial and don’t have a license key, use Username.

The unique alpha-numeric key provided by Avalara for verification against the service. If you are on a free trial and don’t have a license key, use Password.

Your AvaTax Admin Console username. Usually an email address.

For support, visit the Avalara Community

Avalara offers an alternate API for process batches of transactions with a single web service call. This API uses the same TaxSvc logic on the back end for tax calculation, but provides functions similar to the Upload feature available through the Admin Console. This means that you can process transaction batches, but also use it to import batches of tax rules, exemption certificate records, and locations.
There are three primary resources in the BatchSvc: BatchSave, BatchFetch, and BatchFileFetch. Other functions are referenced in the WSDL, but we do not recommend using them in a standard use case.
Proxy DLLs are also maintained by AvaTax for this functionality, and can be downloaded from our [sample code page](http://developer.avalara.com/avatax/sample-code/).
Note that BatchSvc has some quirks to it: you will need to authenticate with an Account Admin level username/password combination, an account number/license key combination will not be sufficient. Also, you will need to know your CompanyId (which is not the same as the CompanyCode used in the standard TaxSvc functionality). To find your CompanyId, take a look at [this article](http://developer.avalara.com/api-docs/soap/finding-your-companyid).