Package Avalara.SDK.api.A1099.V2

Class Forms1099Api

  • public class Forms1099Api
extends Object

    • Constructor Detail

      • Forms1099Api

        public Forms1099Api​(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)

      • bulkUpsert1099FormsCall

        public okhttp3.Call bulkUpsert1099FormsCall​(Forms1099Api.BulkUpsert1099FormsRequest requestParameters,
                                            ApiCallback _callback)
                                     throws ApiException
        Build call for bulkUpsert1099Forms
        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 Success -
        400 Bad Request -
        404 Not Found -
        500 Server Error -
        401 Unauthorized -

      • bulkUpsert1099Forms

        public JobResponse bulkUpsert1099Forms​(Forms1099Api.BulkUpsert1099FormsRequest requestParameters)
                                throws ApiException
        Create or update multiple 1099/1095/W2/1042S forms This endpoint allows you to create or update multiple 1099/1095/W2/1042S forms. Maximum of 5000 forms can be processed in a single bulk request.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        JobResponse
        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 Success -
        400 Bad Request -
        404 Not Found -
        500 Server Error -
        401 Unauthorized -

      • bulkUpsert1099FormsWithHttpInfo

        public ApiResponse<JobResponse> bulkUpsert1099FormsWithHttpInfo​(Forms1099Api.BulkUpsert1099FormsRequest requestParameters)
                                                         throws ApiException
        Create or update multiple 1099/1095/W2/1042S forms This endpoint allows you to create or update multiple 1099/1095/W2/1042S forms. Maximum of 5000 forms can be processed in a single bulk request.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        ApiResponse<JobResponse>
        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 Success -
        400 Bad Request -
        404 Not Found -
        500 Server Error -
        401 Unauthorized -

      • bulkUpsert1099FormsAsync

        public okhttp3.Call bulkUpsert1099FormsAsync​(Forms1099Api.BulkUpsert1099FormsRequest requestParameters,
                                             ApiCallback<JobResponse> _callback)
                                      throws ApiException
        Create or update multiple 1099/1095/W2/1042S forms (asynchronously) This endpoint allows you to create or update multiple 1099/1095/W2/1042S forms. Maximum of 5000 forms can be processed in a single bulk 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 Success -
        400 Bad Request -
        404 Not Found -
        500 Server Error -
        401 Unauthorized -

      • create1099FormCall

        public okhttp3.Call create1099FormCall​(Forms1099Api.Create1099FormRequest requestParameters,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for create1099Form
        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 Created -
        400 Bad Request -
        500 Server Error -
        401 Unauthorized -

      • create1099Form

        public Get1099Form200Response create1099Form​(Forms1099Api.Create1099FormRequest requestParameters)
                                      throws ApiException
        Create a 1099/1095/W2/1042S form Create a 1099/1095/W2/1042S form.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        Get1099Form200Response
        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 Created -
        400 Bad Request -
        500 Server Error -
        401 Unauthorized -

      • create1099FormWithHttpInfo

        public ApiResponse<Get1099Form200Response> create1099FormWithHttpInfo​(Forms1099Api.Create1099FormRequest requestParameters)
                                                               throws ApiException
        Create a 1099/1095/W2/1042S form Create a 1099/1095/W2/1042S form.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        ApiResponse<Get1099Form200Response>
        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 Created -
        400 Bad Request -
        500 Server Error -
        401 Unauthorized -

      • create1099FormAsync

        public okhttp3.Call create1099FormAsync​(Forms1099Api.Create1099FormRequest requestParameters,
                                        ApiCallback<Get1099Form200Response> _callback)
                                 throws ApiException
        Create a 1099/1095/W2/1042S form (asynchronously) Create a 1099/1095/W2/1042S 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 Created -
        400 Bad Request -
        500 Server Error -
        401 Unauthorized -

      • delete1099FormCall

        public okhttp3.Call delete1099FormCall​(Forms1099Api.Delete1099FormRequest requestParameters,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for delete1099Form
        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 No Content -
        400 Bad Request -
        404 Not Found -
        422 Client Error -
        500 Server Error -
        401 Unauthorized -

      • delete1099Form

        public void delete1099Form​(Forms1099Api.Delete1099FormRequest requestParameters)
                    throws ApiException
        Delete a 1099/1095/W2/1042S form Delete a 1099/1095/W2/1042S 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 No Content -
        400 Bad Request -
        404 Not Found -
        422 Client Error -
        500 Server Error -
        401 Unauthorized -

      • delete1099FormWithHttpInfo

        public ApiResponse<Void> delete1099FormWithHttpInfo​(Forms1099Api.Delete1099FormRequest requestParameters)
                                             throws ApiException
        Delete a 1099/1095/W2/1042S form Delete a 1099/1095/W2/1042S 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 No Content -
        400 Bad Request -
        404 Not Found -
        422 Client Error -
        500 Server Error -
        401 Unauthorized -

      • delete1099FormAsync

        public okhttp3.Call delete1099FormAsync​(Forms1099Api.Delete1099FormRequest requestParameters,
                                        ApiCallback<Void> _callback)
                                 throws ApiException
        Delete a 1099/1095/W2/1042S form (asynchronously) Delete a 1099/1095/W2/1042S 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 No Content -
        400 Bad Request -
        404 Not Found -
        422 Client Error -
        500 Server Error -
        401 Unauthorized -

      • get1099FormCall

        public okhttp3.Call get1099FormCall​(Forms1099Api.Get1099FormRequest requestParameters,
                                    ApiCallback _callback)
                             throws ApiException
        Build call for get1099Form
        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 Success -
        400 Bad Request -
        404 Not Found -
        500 Server Error -
        401 Unauthorized -

      • get1099Form

        public Get1099Form200Response get1099Form​(Forms1099Api.Get1099FormRequest requestParameters)
                                   throws ApiException
        Retrieve a 1099/1095/W2/1042S form Retrieve a 1099/1095/W2/1042S form.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        Get1099Form200Response
        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 Success -
        400 Bad Request -
        404 Not Found -
        500 Server Error -
        401 Unauthorized -

      • get1099FormWithHttpInfo

        public ApiResponse<Get1099Form200Response> get1099FormWithHttpInfo​(Forms1099Api.Get1099FormRequest requestParameters)
                                                            throws ApiException
        Retrieve a 1099/1095/W2/1042S form Retrieve a 1099/1095/W2/1042S form.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        ApiResponse<Get1099Form200Response>
        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 Success -
        400 Bad Request -
        404 Not Found -
        500 Server Error -
        401 Unauthorized -

      • get1099FormAsync

        public okhttp3.Call get1099FormAsync​(Forms1099Api.Get1099FormRequest requestParameters,
                                     ApiCallback<Get1099Form200Response> _callback)
                              throws ApiException
        Retrieve a 1099/1095/W2/1042S form (asynchronously) Retrieve a 1099/1095/W2/1042S 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 Success -
        400 Bad Request -
        404 Not Found -
        500 Server Error -
        401 Unauthorized -

      • get1099FormPdfCall

        public okhttp3.Call get1099FormPdfCall​(Forms1099Api.Get1099FormPdfRequest requestParameters,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for get1099FormPdf
        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 Success -
        400 Bad Request -
        404 Not Found -
        500 Server Error -
        401 Unauthorized -

      • get1099FormPdf

        public File get1099FormPdf​(Forms1099Api.Get1099FormPdfRequest requestParameters)
                    throws ApiException
        Retrieve the PDF file for a 1099/1095/W2/1042S form Retrieve the PDF file for a 1099/1095/W2/1042S form.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        File
        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 Success -
        400 Bad Request -
        404 Not Found -
        500 Server Error -
        401 Unauthorized -

      • get1099FormPdfWithHttpInfo

        public ApiResponse<File> get1099FormPdfWithHttpInfo​(Forms1099Api.Get1099FormPdfRequest requestParameters)
                                             throws ApiException
        Retrieve the PDF file for a 1099/1095/W2/1042S form Retrieve the PDF file for a 1099/1095/W2/1042S form.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        ApiResponse<File>
        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 Success -
        400 Bad Request -
        404 Not Found -
        500 Server Error -
        401 Unauthorized -

      • get1099FormPdfAsync

        public okhttp3.Call get1099FormPdfAsync​(Forms1099Api.Get1099FormPdfRequest requestParameters,
                                        ApiCallback<File> _callback)
                                 throws ApiException
        Retrieve the PDF file for a 1099/1095/W2/1042S form (asynchronously) Retrieve the PDF file for a 1099/1095/W2/1042S 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 Success -
        400 Bad Request -
        404 Not Found -
        500 Server Error -
        401 Unauthorized -

      • list1099FormsCall

        public okhttp3.Call list1099FormsCall​(Forms1099Api.List1099FormsRequest requestParameters,
                                      ApiCallback _callback)
                               throws ApiException
        Build call for list1099Forms
        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 Success -
        400 Bad Request -
        404 Not Found -
        500 Server Error -
        401 Unauthorized -

      • list1099Forms

        public PaginatedQueryResultModelForm1099Base list1099Forms​(Forms1099Api.List1099FormsRequest requestParameters)
                                                    throws ApiException
        List 1099/1095/W2/1042S forms List 1099/1095/W2/1042S forms. Collections support filtering only on certain fields. An attempt to filter on an unsupported field will receive a 400 Bad Request response. Supported filtering fields are as follows: - issuerId - issuerReferenceId - taxYear - addressVerificationStatus - possible values are: unknown, pending, failed, incomplete, unchanged, verified - createdAt - edeliveryStatus - possible values are: sent, unscheduled, bad_verify, bad_verify_limit, scheduled, bounced, accepted - email - federalEfileStatus - possible values are: unscheduled, scheduled, sent, corrected_scheduled, accepted, corrected, corrected_accepted, held - recipientName - mailStatus - possible values are: sent, unscheduled, pending, delivered - referenceId - tinMatchStatus - possible values are: none, pending, matched, failed - type - possible values are: 940, 941, 943, 944, 945, 1042, 1042-S, 1095-B, 1095-C, 1097-BTC, 1098, 1098-C, 1098-E, 1098-Q, 1098-T, 3921, 3922, 5498, 5498-ESA, 5498-SA, 1099-MISC, 1099-A, 1099-B, 1099-C, 1099-CAP, 1099-DIV, 1099-G, 1099-INT, 1099-K, 1099-LS, 1099-LTC, 1099-NEC, 1099-OID, 1099-PATR, 1099-Q, 1099-R, 1099-S, 1099-SA, T4A, W-2, W-2G, 1099-HC - updatedAt - validity - possible values are: true, false For more information on filtering, see <see href=\"https://developer.avalara.com/avatax/filtering-in-rest/\">Filtering in REST</see>.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        PaginatedQueryResultModelForm1099Base
        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 Success -
        400 Bad Request -
        404 Not Found -
        500 Server Error -
        401 Unauthorized -

      • list1099FormsWithHttpInfo

        public ApiResponse<PaginatedQueryResultModelForm1099Base> list1099FormsWithHttpInfo​(Forms1099Api.List1099FormsRequest requestParameters)
                                                                             throws ApiException
        List 1099/1095/W2/1042S forms List 1099/1095/W2/1042S forms. Collections support filtering only on certain fields. An attempt to filter on an unsupported field will receive a 400 Bad Request response. Supported filtering fields are as follows: - issuerId - issuerReferenceId - taxYear - addressVerificationStatus - possible values are: unknown, pending, failed, incomplete, unchanged, verified - createdAt - edeliveryStatus - possible values are: sent, unscheduled, bad_verify, bad_verify_limit, scheduled, bounced, accepted - email - federalEfileStatus - possible values are: unscheduled, scheduled, sent, corrected_scheduled, accepted, corrected, corrected_accepted, held - recipientName - mailStatus - possible values are: sent, unscheduled, pending, delivered - referenceId - tinMatchStatus - possible values are: none, pending, matched, failed - type - possible values are: 940, 941, 943, 944, 945, 1042, 1042-S, 1095-B, 1095-C, 1097-BTC, 1098, 1098-C, 1098-E, 1098-Q, 1098-T, 3921, 3922, 5498, 5498-ESA, 5498-SA, 1099-MISC, 1099-A, 1099-B, 1099-C, 1099-CAP, 1099-DIV, 1099-G, 1099-INT, 1099-K, 1099-LS, 1099-LTC, 1099-NEC, 1099-OID, 1099-PATR, 1099-Q, 1099-R, 1099-S, 1099-SA, T4A, W-2, W-2G, 1099-HC - updatedAt - validity - possible values are: true, false For more information on filtering, see <see href=\"https://developer.avalara.com/avatax/filtering-in-rest/\">Filtering in REST</see>.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        ApiResponse<PaginatedQueryResultModelForm1099Base>
        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 Success -
        400 Bad Request -
        404 Not Found -
        500 Server Error -
        401 Unauthorized -

      • list1099FormsAsync

        public okhttp3.Call list1099FormsAsync​(Forms1099Api.List1099FormsRequest requestParameters,
                                       ApiCallback<PaginatedQueryResultModelForm1099Base> _callback)
                                throws ApiException
        List 1099/1095/W2/1042S forms (asynchronously) List 1099/1095/W2/1042S forms. Collections support filtering only on certain fields. An attempt to filter on an unsupported field will receive a 400 Bad Request response. Supported filtering fields are as follows: - issuerId - issuerReferenceId - taxYear - addressVerificationStatus - possible values are: unknown, pending, failed, incomplete, unchanged, verified - createdAt - edeliveryStatus - possible values are: sent, unscheduled, bad_verify, bad_verify_limit, scheduled, bounced, accepted - email - federalEfileStatus - possible values are: unscheduled, scheduled, sent, corrected_scheduled, accepted, corrected, corrected_accepted, held - recipientName - mailStatus - possible values are: sent, unscheduled, pending, delivered - referenceId - tinMatchStatus - possible values are: none, pending, matched, failed - type - possible values are: 940, 941, 943, 944, 945, 1042, 1042-S, 1095-B, 1095-C, 1097-BTC, 1098, 1098-C, 1098-E, 1098-Q, 1098-T, 3921, 3922, 5498, 5498-ESA, 5498-SA, 1099-MISC, 1099-A, 1099-B, 1099-C, 1099-CAP, 1099-DIV, 1099-G, 1099-INT, 1099-K, 1099-LS, 1099-LTC, 1099-NEC, 1099-OID, 1099-PATR, 1099-Q, 1099-R, 1099-S, 1099-SA, T4A, W-2, W-2G, 1099-HC - updatedAt - validity - possible values are: true, false For more information on filtering, see <see href=\"https://developer.avalara.com/avatax/filtering-in-rest/\">Filtering in REST</see>.
        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 Success -
        400 Bad Request -
        404 Not Found -
        500 Server Error -
        401 Unauthorized -

      • update1099FormCall

        public okhttp3.Call update1099FormCall​(Forms1099Api.Update1099FormRequest requestParameters,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for update1099Form
        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 Success -
        400 Bad Request -
        404 Not Found -
        500 Server Error -
        401 Unauthorized -

      • update1099Form

        public Get1099Form200Response update1099Form​(Forms1099Api.Update1099FormRequest requestParameters)
                                      throws ApiException
        Update a 1099/1095/W2/1042S form Update a 1099/1095/W2/1042S form.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        Get1099Form200Response
        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 Success -
        400 Bad Request -
        404 Not Found -
        500 Server Error -
        401 Unauthorized -

      • update1099FormWithHttpInfo

        public ApiResponse<Get1099Form200Response> update1099FormWithHttpInfo​(Forms1099Api.Update1099FormRequest requestParameters)
                                                               throws ApiException
        Update a 1099/1095/W2/1042S form Update a 1099/1095/W2/1042S form.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        ApiResponse<Get1099Form200Response>
        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 Success -
        400 Bad Request -
        404 Not Found -
        500 Server Error -
        401 Unauthorized -

      • update1099FormAsync

        public okhttp3.Call update1099FormAsync​(Forms1099Api.Update1099FormRequest requestParameters,
                                        ApiCallback<Get1099Form200Response> _callback)
                                 throws ApiException
        Update a 1099/1095/W2/1042S form (asynchronously) Update a 1099/1095/W2/1042S 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 Success -
        400 Bad Request -
        404 Not Found -
        500 Server Error -
        401 Unauthorized -