openapi: 3.2.0
info:
  title: Avalara AvaTax Funding Requests API
  description: Welcome to the AvaTax API Postman Collection!
  version: 1.0.0
servers:
- url: http://{{baseurl}}
security:
- basicAuth: []
tags:
- name: FundingRequests
paths:
  /api/v2/fundingrequests/{id}/widget:
    get:
      tags:
      - FundingRequests
      summary: Avalara ActivateFundingRequest
      description: 'This API is available by invitation only.

        Companies that use the Avalara Managed Returns or the SST Certified Service Provider services are

        required to setup their funding configuration before Avalara can begin filing tax returns on their

        behalf.

        Funding configuration for each company is set up by submitting a funding setup request, which can

        be sent either via email or via an embedded HTML widget.

        When the funding configuration is submitted to Avalara, it will be reviewed by treasury team members

        before approval.

        This API returns back the actual javascript code to insert into your application to render the

        JavaScript funding setup widget inline.

        Use the ''methodReturn.javaScript'' return value to insert this widget into your HTML page.

        This API requires a subscription to Avalara Managed Returns or SST Certified Service Provider.


        ### Security Policies


        * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.

        * 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: getApiV2FundingrequestsByIdWidget
      x-operation-id-source: derived
  /api/v2/fundingrequests/{id}:
    get:
      tags:
      - FundingRequests
      summary: Avalara FundingRequestStatus
      description: 'This API is available by invitation only.

        Companies that use the Avalara Managed Returns or the SST Certified Service Provider services are

        required to setup their funding configuration before Avalara can begin filing tax returns on their

        behalf.

        Funding configuration for each company is set up by submitting a funding setup request, which can

        be sent either via email or via an embedded HTML widget.

        When the funding configuration is submitted to Avalara, it will be reviewed by treasury team members

        before approval.

        This API checks the status on an existing funding request.

        This API requires a subscription to Avalara Managed Returns or SST Certified Service Provider.


        ### Security Policies


        * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.

        * 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: getApiV2FundingrequestsById
      x-operation-id-source: derived
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic