Package Avalara.SDK.api.EInvoicing.V1

Class DataInputFieldsApi

java.lang.Object

Avalara.SDK.api.EInvoicing.V1.DataInputFieldsApi

public class DataInputFieldsApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	DataInputFieldsApi.GetDataInputFieldsRequest	Represents the Request object for the GetDataInputFields API

Constructor Summary

Constructors

Constructor	Description
DataInputFieldsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
String	getCustomBaseUrl()
DataInputFieldsResponse	getDataInputFields(DataInputFieldsApi.GetDataInputFieldsRequest requestParameters)	Returns the optionality of document fields for different country mandates This endpoint provides a list of required, conditional, and optional fields for each country mandate.
okhttp3.Call	getDataInputFieldsAsync(DataInputFieldsApi.GetDataInputFieldsRequest requestParameters, ApiCallback<DataInputFieldsResponse> _callback)	Returns the optionality of document fields for different country mandates (asynchronously) This endpoint provides a list of required, conditional, and optional fields for each country mandate.
okhttp3.Call	getDataInputFieldsCall(DataInputFieldsApi.GetDataInputFieldsRequest requestParameters, ApiCallback _callback)	Build call for getDataInputFields
ApiResponse<DataInputFieldsResponse>	getDataInputFieldsWithHttpInfo(DataInputFieldsApi.GetDataInputFieldsRequest requestParameters)	Returns the optionality of document fields for different country mandates This endpoint provides a list of required, conditional, and optional fields for each country mandate.
DataInputFieldsApi.GetDataInputFieldsRequest	getGetDataInputFieldsRequest()	Getter function to instantiate Request class
int	getHostIndex()
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataInputFieldsApi

public DataInputFieldsApi(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)

getDataInputFieldsCall

public okhttp3.Call getDataInputFieldsCall(DataInputFieldsApi.GetDataInputFieldsRequest requestParameters,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for getDataInputFields

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	-
401	Unauthorized	-
403	Forbidden	-
500	Internal Server Error	-

getDataInputFields

public DataInputFieldsResponse getDataInputFields(DataInputFieldsApi.GetDataInputFieldsRequest requestParameters)
                                           throws ApiException

Returns the optionality of document fields for different country mandates This endpoint provides a list of required, conditional, and optional fields for each country mandate. You can use the <code>mandates</code> endpoint to retrieve all available country mandates. You can use the $filter query parameter to retrieve fields for a particular mandate

Parameters:

requestOptions - Object which represents the options available for a given API/request

Returns:

DataInputFieldsResponse

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	-
401	Unauthorized	-
403	Forbidden	-
500	Internal Server Error	-

getDataInputFieldsWithHttpInfo

public ApiResponse<DataInputFieldsResponse> getDataInputFieldsWithHttpInfo(DataInputFieldsApi.GetDataInputFieldsRequest requestParameters)
                                                                    throws ApiException

Returns the optionality of document fields for different country mandates This endpoint provides a list of required, conditional, and optional fields for each country mandate. You can use the <code>mandates</code> endpoint to retrieve all available country mandates. You can use the $filter query parameter to retrieve fields for a particular mandate

Parameters:

requestOptions - Object which represents the options available for a given API/request

Returns:

ApiResponse<DataInputFieldsResponse>

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	-
401	Unauthorized	-
403	Forbidden	-
500	Internal Server Error	-

getDataInputFieldsAsync

public okhttp3.Call getDataInputFieldsAsync(DataInputFieldsApi.GetDataInputFieldsRequest requestParameters,
                                            ApiCallback<DataInputFieldsResponse> _callback)
                                     throws ApiException

Returns the optionality of document fields for different country mandates (asynchronously) This endpoint provides a list of required, conditional, and optional fields for each country mandate. You can use the <code>mandates</code> endpoint to retrieve all available country mandates. You can use the $filter query parameter to retrieve fields for a particular mandate

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	-
401	Unauthorized	-
403	Forbidden	-
500	Internal Server Error	-

getGetDataInputFieldsRequest

public DataInputFieldsApi.GetDataInputFieldsRequest getGetDataInputFieldsRequest()

Getter function to instantiate Request class