openapi: 3.0.0
info:
title: Avalara AvaTax JurisdictionOverrides API
description: "Welcome to the AvaTax API Postman Collection! \n \nThis collection provides a REST interface to Avalara's enterprise tax service, AvaTax. You can use this collection to interact with the AvaTax APIs while building your integration. \n\nWhile using this collection, we recommend following along with our Developer Implementation Guide: https://developer.avalara.com/avatax/dev-guide/ \n\nAPI requests are grouped into folders to help you navigate through the collection easily. Each request includes a description of the operation and its associated URL, method, headers, and example request body (if applicable). \n\nThe collection uses Postman environment variables for the API base URL and credentials, making it easy to switch between the sandbox and production environments.\n\nTo get started, ensure you have the necessary credentials. Then, update the 'username' and 'password' variables in the 'Authorization' or 'Variables' section with your credentials if you prefer username and password authentication. Alternatively, you can use the 'account_id' and 'license_key' variables for authentication using an account ID and license key.\n\nWe recommend starting with the Ping API, located within the Utilities folder, to test your connectivity and ensure your authentication credentials are valid. The Ping API is a simple way to check if you can successfully communicate with AvaTax.\n\nCollection Variables:\n- Base URL: The base URL for the API. By default, it is set to the sandbox URL - https://sandbox-rest.avatax.com. \n - Change this variable to switch between sandbox and production environments:\n - Sandbox URL: https://sandbox-rest.avatax.com\n\t\t- Production URL: https://rest.avatax.com\n- Username: If you are using username and password authentication, enter your username for AvaTax.\n- Password: If you are using username and password authentication, enter your password for AvaTax.\n- Account ID: If you are using account ID and license key authentication, enter your AvaTax account ID. \n - Be sure to also replace the username variable in the authorization tab with account_id.\n- License Key: If you are using account ID and license key authentication, enter your AvaTax license key.\n - Be sure to also replace the password variable in the authorization tab with license_key.\n\nHappy testing with AvaTax APIs!"
version: 1.0.0
servers:
- url: http://{{baseurl}}
security:
- basicAuth: []
tags:
- name: JurisdictionOverrides
paths:
/api/v2/accounts/{accountId}/jurisdictionoverrides:
post:
tags:
- JurisdictionOverrides
summary: Avalara CreateJurisdictionOverrides
description: "Creates one or more jurisdiction override objects for this account.\n \nA Jurisdiction Override is a configuration setting that allows you to select the taxing\njurisdiction for a specific address. If you encounter an address that is on the boundary\nbetween two different jurisdictions, you can choose to set up a jurisdiction override\nto switch this address to use different taxing jurisdictions.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n"
requestBody:
content:
application/json:
schema:
type: object
example:
id: 0
accountId: 0
description: a test JO
line1: 5500 Irvine Center Dr
city: Irvine
region: CA
country: US
postalCode: '92618'
effectiveDate: '2006-08-01'
endDate: '2099-01-12'
jurisdictions:
- code: '53'
name: WASHINGTON
type: State
rate: 0.06
salesRate: 0.06
signatureCode: ''
region: WA
useRate: 0.06
taxRegionId: 0
boundaryLevel: Address
isDefault: false
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: X-Avalara-Client
in: header
schema:
type: string
description: Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/).
example: AvaTax Postman Collection
- name: accountId
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
get:
tags:
- JurisdictionOverrides
summary: Avalara ListJurisdictionOverridesByAccount
description: "List all jurisdiction override objects defined for this account.\n \nA Jurisdiction Override is a configuration setting that allows you to select the taxing\njurisdiction for a specific address. If you encounter an address that is on the boundary\nbetween two different jurisdictions, you can choose to set up a jurisdiction override\nto switch this address to use different taxing jurisdictions.\n \nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n"
parameters:
- name: X-Avalara-Client
in: header
schema:
type: string
description: Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/).
example: AvaTax Postman Collection
- name: accountId
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
/api/v2/accounts/{accountId}/jurisdictionoverrides/{id}:
delete:
tags:
- JurisdictionOverrides
summary: Avalara DeleteJurisdictionOverride
description: 'Marks the item object at this URL as deleted.
### Security Policies
* This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
'
parameters:
- name: X-Avalara-Client
in: header
schema:
type: string
description: Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/).
example: AvaTax Postman Collection
- name: accountId
in: path
schema:
type: string
required: true
- name: id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
get:
tags:
- JurisdictionOverrides
summary: Avalara GetJurisdictionOverride
description: "Get the item object identified by this URL.\n \nA Jurisdiction Override is a configuration setting that allows you to select the taxing\njurisdiction for a specific address. If you encounter an address that is on the boundary\nbetween two different jurisdictions, you can choose to set up a jurisdiction override\nto switch this address to use different taxing jurisdictions.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n"
parameters:
- name: X-Avalara-Client
in: header
schema:
type: string
description: Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/).
example: AvaTax Postman Collection
- name: accountId
in: path
schema:
type: string
required: true
- name: id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
put:
tags:
- JurisdictionOverrides
summary: Avalara UpdateJurisdictionOverride
description: 'Replace the existing jurisdictionoverride object at this URL with an updated object.
### Security Policies
* This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
'
requestBody:
content:
application/json:
schema:
type: object
example:
id: 0
accountId: 0
description: a test JO
line1: 5500 Irvine Center Dr
city: Irvine
region: CA
country: US
postalCode: '92618'
effectiveDate: '2006-08-01'
endDate: '2099-01-12'
jurisdictions:
- code: '53'
name: WASHINGTON
type: State
rate: 0.06
salesRate: 0.06
signatureCode: ''
region: WA
useRate: 0.06
taxRegionId: 0
boundaryLevel: Address
isDefault: false
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: X-Avalara-Client
in: header
schema:
type: string
description: Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/).
example: AvaTax Postman Collection
- name: accountId
in: path
schema:
type: string
required: true
- name: id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
/api/v2/jurisdictionoverrides:
get:
tags:
- JurisdictionOverrides
summary: Avalara QueryJurisdictionOverrides
description: "Get multiple jurisdiction override objects across all companies.\n \nA Jurisdiction Override is a configuration setting that allows you to select the taxing\njurisdiction for a specific address. If you encounter an address that is on the boundary\nbetween two different jurisdictions, you can choose to set up a jurisdiction override\nto switch this address to use different taxing jurisdictions.\n \nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n"
parameters:
- name: X-Avalara-Client
in: header
schema:
type: string
description: Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/).
example: AvaTax Postman Collection
responses:
'200':
description: Successful response
content:
application/json: {}
components:
securitySchemes:
basicAuth:
type: http
scheme: basic