Avalara Tax Engine Settings

Last updated
Save as PDF

Describes how to create, retrieve, and update the Avalara Tax Engines through the Settings API. For more information on the Avalara Tax Engine, see Direct Avalara integration.

Create an Avalara Tax Engine

To create a new Avalara Tax Engine, see the following request and a sample of 200 response.

The Create API can be used only once, as each tenant is limited to a single AvalaraTaxEngine.

HTTP request:

POST https://rest.zuora.com/apps/settings/tax-engines/

Request body:

curl --location 'https://rest.zuora.com/apps/settings/tax-engines/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <oauth token>' \
--data '{
  "name": "AvalaraTestEngine12",
  "taxEngineType": "Avalara",
  "accountNumber": "0981236784",
  "licenseKey": "B6GG780FP12FIMIRIH",
  "isTest": true
 }'

Response body:

{
    "id": "4028818792d0c0550192d0e4c3af03ca",
    "name": "AvalaraTestEngine12",
    "taxEngineType": "Avalara",
    "accountNumber": "0981236784",
    "isTest": true,
    "username": null,
    "success": true
}

Get an Avalara Tax Engine

To get an Avalara Tax Engine, see the following request and a sample of 200 response.

GET https://rest.zuora.com/settings/tax-engines/avalara/{id}

Request body:

curl --location'https://rest.apisandbox.zuora.com/tax-engines/40288186929d8a6a01929dbcaab67314' \
--header 'Authorization: Bearer <oauth token>'

Response body:

{
    "id": "40288186929d8a6a01929dbcaab67314",
    "name": "AvalaraTestEngine",
    "taxEngineType": "Avalara",
    "accountNumber": "6547894321",
    "isTest": true,
    "username": null,
    "success": true
}

Update an Avalara Tax Engine

To update an Avalara Tax Engine, see the following request and a sample of 200 response.

HTTP request:

PUT https://rest.zuora.com/settings/tax-engines/avalara/{id}

Request body:

curl --location --request PUT 'https://rest.apisandbox.zuora.com/apps/tax-engines/4028818792d0c0550192d0e4c3af03ca' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <oauth token>' \
--data '{ 
"name": "AvalaraTestEngine12",
"accountNumber": "0981236784",
"licenseKey": "B6GG780FP12FIMIRIH",
"isTest": true
 }'

Response body:

{
    "id": "4028818792d0c0550192d0e4c3af03ca",
    "name": "AvalaraTestEngine12",
    "taxEngineType": "Avalara",
    "accountNumber": "0981236784",
    "isTest": true,
    "username": null,
    "success": true
}

Delete an Avalara Tax Engine

The Avalara Tax Engine does not support the Delete operation.