APConfigSetting

Accounts

Addresses

AvaFileForms

Batches

CertExpressInvites

Certificates

Clerk

CommunicationCertificates

Compliance

Contacts

CostCenter

Customers

DataSources

Definitions

DistanceThresholds

DomainControlVerification

ECommerceToken

EcmEventNotifications

FirmClientLinkages

FundingRequests

GLAccount

Items

JurisdictionOverrides

Locations

MultiDocument

Nexus

Notices

Notifications

Provisioning

Registrar

Reports

Settings

Subscriptions

TaxCodes

TaxContent

TaxRules

Upcs

UserDefinedFields

Users

Utilities

Models

Top 10 EndPoints

AvaTax API

REST interface to Avalara's enterprise tax service, AvaTax.

Check top 10 endpoints

Batches

ListBatchesByCompany

Retrieve all batches for this company

List all batch objects attached to the specified company.

A batch object is a large collection of API calls stored in a compact file.

Search for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST . Paginate results using the $top, $skip, and $orderby parameters.

Use GetBatch to retrieve the results, or check the status, of an individual batch.

When a batch is created, it is added to the AvaTax Batch Queue and will be processed as quickly as possible in the order it was received. To check the status of a batch, fetch the batch and retrieve the results of the batch operation.

Because the batch system processes with a degree of concurrency, and because of batch sizes in the queue vary, AvaTax API is unable to accurately predict when a batch will complete. If high performance processing is required, please use the CreateTransaction API.

Security Policies

This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.

ListBatchesByCompany

ListBatchesByCompany

GEThttps://sandbox-rest.avatax.com/api/v2/companies/{companyId}/batches

SAMPLE

PARAMETERS

Request

Curl

cURL

1curl -g 'https://sandbox-rest.avatax.com/api/v2/companies/{companyId}/batches' \
2-H 'X-Avalara-Client: {X-Avalara-Client}' \
3-H 'Authorization: Basic <Base64-encoded credentials>' \
4-H 'Content-Type: application/json'

Response

HEADER

Content-type: application/json

BODY

1{
2 	"@recordsetCount": "",
3 	"value": [
4 	 	{
5 	 	 	"type": "TransactionImport",
6 	 	 	"batchAgent": "manual",
7 	 	 	"name": "TestBatch",
8 	 	 	"files": [
9 	 	 	 	{
10 	 	 	 	 	"name": "samplebatch.csv",
11 	 	 	 	 	"content": "UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==",
12 	 	 	 	 	"contentLength": 0,
13 	 	 	 	 	"contentType": "text/csv",
14 	 	 	 	 	"fileExtension": ".csv",
15 	 	 	 	 	"filePath": "samplebatch.csv"
16 	 	 	 	}
17 	 	 	]
18 	 	}
19 	],
20 	"@nextLink": "",
21 	"pageKey": ""
22}

SAMPLE

PARAMETERS