Package Avalara.SDK.api.EInvoicing.V1

Class TaxIdentifiersApi

  • public class TaxIdentifiersApi
extends Object

    • Constructor Detail

      • TaxIdentifiersApi

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

      • taxIdentifierSchemaByCountryCall

        public okhttp3.Call taxIdentifierSchemaByCountryCall​(TaxIdentifiersApi.TaxIdentifierSchemaByCountryRequest requestParameters,
                                                     ApiCallback _callback)
                                              throws ApiException
        Build call for taxIdentifierSchemaByCountry
        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 OK * X-Correlation-Id -
        400 Invalid request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • taxIdentifierSchemaByCountry

        public TaxIdentifierSchemaByCountry200Response taxIdentifierSchemaByCountry​(TaxIdentifiersApi.TaxIdentifierSchemaByCountryRequest requestParameters)
                                                                     throws ApiException
        Returns the tax identifier request & response schema for a specific country. This endpoint retrieves the request and response schema required to validate tax identifiers based on a specific country's requirements. This can include both standard fields and any additional parameters required by the respective country's tax authority.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        TaxIdentifierSchemaByCountry200Response
        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 OK * X-Correlation-Id -
        400 Invalid request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • taxIdentifierSchemaByCountryWithHttpInfo

        public ApiResponse<TaxIdentifierSchemaByCountry200Response> taxIdentifierSchemaByCountryWithHttpInfo​(TaxIdentifiersApi.TaxIdentifierSchemaByCountryRequest requestParameters)
                                                                                              throws ApiException
        Returns the tax identifier request & response schema for a specific country. This endpoint retrieves the request and response schema required to validate tax identifiers based on a specific country's requirements. This can include both standard fields and any additional parameters required by the respective country's tax authority.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        ApiResponse<TaxIdentifierSchemaByCountry200Response>
        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 OK * X-Correlation-Id -
        400 Invalid request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • taxIdentifierSchemaByCountryAsync

        public okhttp3.Call taxIdentifierSchemaByCountryAsync​(TaxIdentifiersApi.TaxIdentifierSchemaByCountryRequest requestParameters,
                                                      ApiCallback<TaxIdentifierSchemaByCountry200Response> _callback)
                                               throws ApiException
        Returns the tax identifier request & response schema for a specific country. (asynchronously) This endpoint retrieves the request and response schema required to validate tax identifiers based on a specific country's requirements. This can include both standard fields and any additional parameters required by the respective country's tax authority.
        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 OK * X-Correlation-Id -
        400 Invalid request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • validateTaxIdentifierCall

        public okhttp3.Call validateTaxIdentifierCall​(TaxIdentifiersApi.ValidateTaxIdentifierRequest requestParameters,
                                              ApiCallback _callback)
                                       throws ApiException
        Build call for validateTaxIdentifier
        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 response. * X-Correlation-Id -
        400 Invalid request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        429 Rate limit exceeded * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • validateTaxIdentifier

        public TaxIdentifierResponse validateTaxIdentifier​(TaxIdentifiersApi.ValidateTaxIdentifierRequest requestParameters)
                                            throws ApiException
        Validates a tax identifier. This endpoint verifies whether a given tax identifier is valid and properly formatted according to the rules of the applicable country or tax system.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        TaxIdentifierResponse
        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 response. * X-Correlation-Id -
        400 Invalid request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        429 Rate limit exceeded * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • validateTaxIdentifierWithHttpInfo

        public ApiResponse<TaxIdentifierResponse> validateTaxIdentifierWithHttpInfo​(TaxIdentifiersApi.ValidateTaxIdentifierRequest requestParameters)
                                                                     throws ApiException
        Validates a tax identifier. This endpoint verifies whether a given tax identifier is valid and properly formatted according to the rules of the applicable country or tax system.
        Parameters:
        requestOptions - Object which represents the options available for a given API/request
        Returns:
        ApiResponse<TaxIdentifierResponse>
        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 response. * X-Correlation-Id -
        400 Invalid request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        429 Rate limit exceeded * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -

      • validateTaxIdentifierAsync

        public okhttp3.Call validateTaxIdentifierAsync​(TaxIdentifiersApi.ValidateTaxIdentifierRequest requestParameters,
                                               ApiCallback<TaxIdentifierResponse> _callback)
                                        throws ApiException
        Validates a tax identifier. (asynchronously) This endpoint verifies whether a given tax identifier is valid and properly formatted according to the rules of the applicable country or tax system.
        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 response. * X-Correlation-Id -
        400 Invalid request * X-Correlation-Id -
        401 Unauthorized * X-Correlation-Id -
        403 Forbidden * X-Correlation-Id -
        429 Rate limit exceeded * X-Correlation-Id -
        500 Internal server error * X-Correlation-Id -