openapi: 3.2.0 info: title: Avalara AvaTax Ava File Forms API description: Welcome to the AvaTax API Postman Collection! 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: {} operationId: postApiV2Avafileforms x-operation-id-source: derived 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 . 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: {} operationId: getApiV2Avafileforms x-operation-id-source: derived /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: {} operationId: deleteApiV2AvafileformsById x-operation-id-source: derived 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: {} operationId: getApiV2AvafileformsById x-operation-id-source: derived 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: {} operationId: putApiV2AvafileformsById x-operation-id-source: derived components: securitySchemes: basicAuth: type: http scheme: basic