Package Avalara.SDK.api.A1099.V2

Class FormsW9Api

  • public class FormsW9Api
extends Object

    • Constructor Detail

      • FormsW9Api

        public FormsW9Api​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • getHostIndex

        public int getHostIndex()

      • setHostIndex

        public void setHostIndex​(int hostIndex)

      • getCustomBaseUrl

        public String getCustomBaseUrl()

      • setCustomBaseUrl

        public void setCustomBaseUrl​(String customBaseUrl)

      • createAndSendW9FormEmailCall

        public okhttp3.Call createAndSendW9FormEmailCall​(FormsW9Api.CreateAndSendW9FormEmailRequest requestParameters,
                                                 ApiCallback _callback)
                                          throws ApiException
        Build call for createAndSendW9FormEmail
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        201 The created W9/W4/W8 form -
        400 Bad request (e.g. Unknown form type: W10\") -
        401 Authentication failed -

      • createAndSendW9FormEmail

        public CreateW9Form201Response createAndSendW9FormEmail​(FormsW9Api.CreateAndSendW9FormEmailRequest requestParameters)
                                                 throws ApiException
        Create a minimal W9/W4/W8 form and sends the e-mail request Create a minimal W9/W4/W8 form and sends the e-mail request.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        CreateW9Form201Response
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        201 The created W9/W4/W8 form -
        400 Bad request (e.g. Unknown form type: W10\") -
        401 Authentication failed -

      • createAndSendW9FormEmailWithHttpInfo

        public ApiResponse<CreateW9Form201Response> createAndSendW9FormEmailWithHttpInfo​(FormsW9Api.CreateAndSendW9FormEmailRequest requestParameters)
                                                                          throws ApiException
        Create a minimal W9/W4/W8 form and sends the e-mail request Create a minimal W9/W4/W8 form and sends the e-mail request.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        ApiResponse<CreateW9Form201Response>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        201 The created W9/W4/W8 form -
        400 Bad request (e.g. Unknown form type: W10\") -
        401 Authentication failed -

      • createAndSendW9FormEmailAsync

        public okhttp3.Call createAndSendW9FormEmailAsync​(FormsW9Api.CreateAndSendW9FormEmailRequest requestParameters,
                                                  ApiCallback<CreateW9Form201Response> _callback)
                                           throws ApiException
        Create a minimal W9/W4/W8 form and sends the e-mail request (asynchronously) Create a minimal W9/W4/W8 form and sends the e-mail request.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        201 The created W9/W4/W8 form -
        400 Bad request (e.g. Unknown form type: W10\") -
        401 Authentication failed -

      • createW9FormCall

        public okhttp3.Call createW9FormCall​(FormsW9Api.CreateW9FormRequest requestParameters,
                                     ApiCallback _callback)
                              throws ApiException
        Build call for createW9Form
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        201 The created W9/W4/W8 form -
        400 Bad request (e.g., invalid sort key) -
        401 Authentication failed -

      • createW9Form

        public CreateW9Form201Response createW9Form​(FormsW9Api.CreateW9FormRequest requestParameters)
                                     throws ApiException
        Create a W9/W4/W8 form Create a W9/W4/W8 form.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        CreateW9Form201Response
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        201 The created W9/W4/W8 form -
        400 Bad request (e.g., invalid sort key) -
        401 Authentication failed -

      • createW9FormWithHttpInfo

        public ApiResponse<CreateW9Form201Response> createW9FormWithHttpInfo​(FormsW9Api.CreateW9FormRequest requestParameters)
                                                              throws ApiException
        Create a W9/W4/W8 form Create a W9/W4/W8 form.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        ApiResponse<CreateW9Form201Response>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        201 The created W9/W4/W8 form -
        400 Bad request (e.g., invalid sort key) -
        401 Authentication failed -

      • createW9FormAsync

        public okhttp3.Call createW9FormAsync​(FormsW9Api.CreateW9FormRequest requestParameters,
                                      ApiCallback<CreateW9Form201Response> _callback)
                               throws ApiException
        Create a W9/W4/W8 form (asynchronously) Create a W9/W4/W8 form.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        201 The created W9/W4/W8 form -
        400 Bad request (e.g., invalid sort key) -
        401 Authentication failed -

      • deleteW9FormCall

        public okhttp3.Call deleteW9FormCall​(FormsW9Api.DeleteW9FormRequest requestParameters,
                                     ApiCallback _callback)
                              throws ApiException
        Build call for deleteW9Form
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 Empty response -
        400 Bad request (e.g., invalid sort key) -
        401 Authentication failed -

      • deleteW9Form

        public void deleteW9Form​(FormsW9Api.DeleteW9FormRequest requestParameters)
                  throws ApiException
        Delete a W9/W4/W8 form Delete a W9/W4/W8 form.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 Empty response -
        400 Bad request (e.g., invalid sort key) -
        401 Authentication failed -

      • deleteW9FormWithHttpInfo

        public ApiResponse<Void> deleteW9FormWithHttpInfo​(FormsW9Api.DeleteW9FormRequest requestParameters)
                                           throws ApiException
        Delete a W9/W4/W8 form Delete a W9/W4/W8 form.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 Empty response -
        400 Bad request (e.g., invalid sort key) -
        401 Authentication failed -

      • deleteW9FormAsync

        public okhttp3.Call deleteW9FormAsync​(FormsW9Api.DeleteW9FormRequest requestParameters,
                                      ApiCallback<Void> _callback)
                               throws ApiException
        Delete a W9/W4/W8 form (asynchronously) Delete a W9/W4/W8 form.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 Empty response -
        400 Bad request (e.g., invalid sort key) -
        401 Authentication failed -

      • getW9FormCall

        public okhttp3.Call getW9FormCall​(FormsW9Api.GetW9FormRequest requestParameters,
                                  ApiCallback _callback)
                           throws ApiException
        Build call for getW9Form
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 W9/W4/W8 form with id -
        401 Authentication failed -
        404 W9/W4/W8 form not found -

      • getW9Form

        public CreateW9Form201Response getW9Form​(FormsW9Api.GetW9FormRequest requestParameters)
                                  throws ApiException
        Retrieve a W9/W4/W8 form Retrieve a W9/W4/W8 form.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        CreateW9Form201Response
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 W9/W4/W8 form with id -
        401 Authentication failed -
        404 W9/W4/W8 form not found -

      • getW9FormWithHttpInfo

        public ApiResponse<CreateW9Form201Response> getW9FormWithHttpInfo​(FormsW9Api.GetW9FormRequest requestParameters)
                                                           throws ApiException
        Retrieve a W9/W4/W8 form Retrieve a W9/W4/W8 form.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        ApiResponse<CreateW9Form201Response>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 W9/W4/W8 form with id -
        401 Authentication failed -
        404 W9/W4/W8 form not found -

      • getW9FormAsync

        public okhttp3.Call getW9FormAsync​(FormsW9Api.GetW9FormRequest requestParameters,
                                   ApiCallback<CreateW9Form201Response> _callback)
                            throws ApiException
        Retrieve a W9/W4/W8 form (asynchronously) Retrieve a W9/W4/W8 form.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 W9/W4/W8 form with id -
        401 Authentication failed -
        404 W9/W4/W8 form not found -

      • listW9FormsCall

        public okhttp3.Call listW9FormsCall​(FormsW9Api.ListW9FormsRequest requestParameters,
                                    ApiCallback _callback)
                             throws ApiException
        Build call for listW9Forms
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        400 Bad request (e.g., invalid sort key) -
        401 Authentication failed -
        200 list -

      • listW9Forms

        public PaginatedQueryResultModelW9FormBaseResponse listW9Forms​(FormsW9Api.ListW9FormsRequest requestParameters)
                                                        throws ApiException
        List W9/W4/W8 forms List W9/W4/W8 forms. Filterable/Sortable fields are: \"companyId\", \"type\", \"displayName\", \"entryStatus\", \"email\", \"archived\" and \"referenceId\".
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        PaginatedQueryResultModelW9FormBaseResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        400 Bad request (e.g., invalid sort key) -
        401 Authentication failed -
        200 list -

      • listW9FormsWithHttpInfo

        public ApiResponse<PaginatedQueryResultModelW9FormBaseResponse> listW9FormsWithHttpInfo​(FormsW9Api.ListW9FormsRequest requestParameters)
                                                                                 throws ApiException
        List W9/W4/W8 forms List W9/W4/W8 forms. Filterable/Sortable fields are: \"companyId\", \"type\", \"displayName\", \"entryStatus\", \"email\", \"archived\" and \"referenceId\".
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        ApiResponse<PaginatedQueryResultModelW9FormBaseResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        400 Bad request (e.g., invalid sort key) -
        401 Authentication failed -
        200 list -

      • listW9FormsAsync

        public okhttp3.Call listW9FormsAsync​(FormsW9Api.ListW9FormsRequest requestParameters,
                                     ApiCallback<PaginatedQueryResultModelW9FormBaseResponse> _callback)
                              throws ApiException
        List W9/W4/W8 forms (asynchronously) List W9/W4/W8 forms. Filterable/Sortable fields are: \"companyId\", \"type\", \"displayName\", \"entryStatus\", \"email\", \"archived\" and \"referenceId\".
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        400 Bad request (e.g., invalid sort key) -
        401 Authentication failed -
        200 list -

      • sendW9FormEmailCall

        public okhttp3.Call sendW9FormEmailCall​(FormsW9Api.SendW9FormEmailRequest requestParameters,
                                        ApiCallback _callback)
                                 throws ApiException
        Build call for sendW9FormEmail
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 Email sent using existing form (form was already in 'Requested' status or descendant found) -
        201 Email sent using newly created minimal form -
        400 Bad request (e.g., invalid sort key) -
        401 Authentication failed -

      • sendW9FormEmail

        public CreateW9Form201Response sendW9FormEmail​(FormsW9Api.SendW9FormEmailRequest requestParameters)
                                        throws ApiException
        Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form. If the form is not in 'Requested' status, it will either use an existing descendant form in 'Requested' status or create a new minimal form and send the email request.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        CreateW9Form201Response
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Email sent using existing form (form was already in 'Requested' status or descendant found) -
        201 Email sent using newly created minimal form -
        400 Bad request (e.g., invalid sort key) -
        401 Authentication failed -

      • sendW9FormEmailWithHttpInfo

        public ApiResponse<CreateW9Form201Response> sendW9FormEmailWithHttpInfo​(FormsW9Api.SendW9FormEmailRequest requestParameters)
                                                                 throws ApiException
        Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form. If the form is not in 'Requested' status, it will either use an existing descendant form in 'Requested' status or create a new minimal form and send the email request.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        ApiResponse<CreateW9Form201Response>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Email sent using existing form (form was already in 'Requested' status or descendant found) -
        201 Email sent using newly created minimal form -
        400 Bad request (e.g., invalid sort key) -
        401 Authentication failed -

      • sendW9FormEmailAsync

        public okhttp3.Call sendW9FormEmailAsync​(FormsW9Api.SendW9FormEmailRequest requestParameters,
                                         ApiCallback<CreateW9Form201Response> _callback)
                                  throws ApiException
        Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form (asynchronously) Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form. If the form is not in 'Requested' status, it will either use an existing descendant form in 'Requested' status or create a new minimal form and send the email request.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 Email sent using existing form (form was already in 'Requested' status or descendant found) -
        201 Email sent using newly created minimal form -
        400 Bad request (e.g., invalid sort key) -
        401 Authentication failed -

      • updateW9FormCall

        public okhttp3.Call updateW9FormCall​(FormsW9Api.UpdateW9FormRequest requestParameters,
                                     ApiCallback _callback)
                              throws ApiException
        Build call for updateW9Form
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 The updated W9/W4/W8 form -
        400 Bad request (e.g., invalid sort key) -
        401 Authentication failed -
        404 W9/W4/W8 form not found -

      • updateW9Form

        public IW9FormDataModelsOneOf updateW9Form​(FormsW9Api.UpdateW9FormRequest requestParameters)
                                    throws ApiException
        Update a W9/W4/W8 form Update a W9/W4/W8 form.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        IW9FormDataModelsOneOf
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 The updated W9/W4/W8 form -
        400 Bad request (e.g., invalid sort key) -
        401 Authentication failed -
        404 W9/W4/W8 form not found -

      • updateW9FormWithHttpInfo

        public ApiResponse<IW9FormDataModelsOneOf> updateW9FormWithHttpInfo​(FormsW9Api.UpdateW9FormRequest requestParameters)
                                                             throws ApiException
        Update a W9/W4/W8 form Update a W9/W4/W8 form.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        ApiResponse<IW9FormDataModelsOneOf>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 The updated W9/W4/W8 form -
        400 Bad request (e.g., invalid sort key) -
        401 Authentication failed -
        404 W9/W4/W8 form not found -

      • updateW9FormAsync

        public okhttp3.Call updateW9FormAsync​(FormsW9Api.UpdateW9FormRequest requestParameters,
                                      ApiCallback<IW9FormDataModelsOneOf> _callback)
                               throws ApiException
        Update a W9/W4/W8 form (asynchronously) Update a W9/W4/W8 form.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 The updated W9/W4/W8 form -
        400 Bad request (e.g., invalid sort key) -
        401 Authentication failed -
        404 W9/W4/W8 form not found -

      • uploadW9FilesCall

        public okhttp3.Call uploadW9FilesCall​(FormsW9Api.UploadW9FilesRequest requestParameters,
                                      ApiCallback _callback)
                               throws ApiException
        Build call for uploadW9Files
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 -
        400 Bad request (e.g., Only .pdf files are allowed.) -
        401 Authentication failed -
        404 Not Found -

      • uploadW9Files

        public void uploadW9Files​(FormsW9Api.UploadW9FilesRequest requestParameters)
                   throws ApiException
        Replace the PDF file for a W9/W4/W8 form Replaces the PDF file for a W9/W4/W8 form.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 -
        400 Bad request (e.g., Only .pdf files are allowed.) -
        401 Authentication failed -
        404 Not Found -

      • uploadW9FilesWithHttpInfo

        public ApiResponse<Void> uploadW9FilesWithHttpInfo​(FormsW9Api.UploadW9FilesRequest requestParameters)
                                            throws ApiException
        Replace the PDF file for a W9/W4/W8 form Replaces the PDF file for a W9/W4/W8 form.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 -
        400 Bad request (e.g., Only .pdf files are allowed.) -
        401 Authentication failed -
        404 Not Found -

      • uploadW9FilesAsync

        public okhttp3.Call uploadW9FilesAsync​(FormsW9Api.UploadW9FilesRequest requestParameters,
                                       ApiCallback<Void> _callback)
                                throws ApiException
        Replace the PDF file for a W9/W4/W8 form (asynchronously) Replaces the PDF file for a W9/W4/W8 form.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 -
        400 Bad request (e.g., Only .pdf files are allowed.) -
        401 Authentication failed -
        404 Not Found -