openapi: 3.0.0
info:
title: Avalara AvaTax AvaFileForms 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: AvaFileForms
paths:
/api/v2/avafileforms:
post:
tags:
- AvaFileForms
summary: Avalara CreateAvaFileForms
description: 'Create one or more AvaFileForms
A ''AvaFileForm'' represents a form supported by our returns team
### Security Policies
* This API requires the user role Compliance Root User.
* This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
'
requestBody:
content:
application/json:
schema:
type: object
example:
id: 2415
returnName: CABOE401A2
formName: CA BOE 401 A2
description: State, Local, and District Sales and Use Tax Return
effDate: '2005-04-01T00:00:00'
endDate: '9999-12-31T00:00:00'
region: CA
country: US
formTypeId: SalesAndUse
filingOptionTypeId: Paper
dueDateTypeId: ByDay
dueDay: 20
efileDueDateTypeId: ByDay
efileDueDay: 20
efileDueTime: '1900-01-01T00:00:00'
hasVendorDiscount: false
roundingTypeId: None
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
responses:
'200':
description: Successful response
content:
application/json: {}
get:
tags:
- AvaFileForms
summary: Avalara QueryAvaFileForms
description: 'Search 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/) .
Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
### Security Policies
* This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin.
* This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
'
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: {}
/api/v2/avafileforms/{id}:
delete:
tags:
- AvaFileForms
summary: Avalara DeleteAvaFileForm
description: 'Marks the existing AvaFileForm object at this URL as deleted.
### Security Policies
* This API requires one of the following user roles: Compliance Root User, ComplianceUser, FirmAdmin.
* This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
'
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: id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
get:
tags:
- AvaFileForms
summary: Avalara GetAvaFileForm
description: 'Get the AvaFileForm object identified by this URL.
### Security Policies
* This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin.
* This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
'
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: id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
put:
tags:
- AvaFileForms
summary: Avalara UpdateAvaFileForm
description: 'All data from the existing object will be replaced with data in the object you PUT.
To set a field''s value to null, you may either set its value to null or omit that field from the object you post.
### Security Policies
* This API requires the user role Compliance Root User.
* This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
'
requestBody:
content:
application/json:
schema:
type: object
example:
id: 2415
returnName: CABOE401A2
formName: CA BOE 401 A2
description: State, Local, and District Sales and Use Tax Return
effDate: '2005-04-01T00:00:00'
endDate: '9999-12-31T00:00:00'
region: CA
country: US
formTypeId: SalesAndUse
filingOptionTypeId: Paper
dueDateTypeId: ByDay
dueDay: 20
efileDueDateTypeId: ByDay
efileDueDay: 20
efileDueTime: '1900-01-01T00:00:00'
hasVendorDiscount: false
roundingTypeId: None
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: id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
components:
securitySchemes:
basicAuth:
type: http
scheme: basic