Package Avalara.SDK.api.EInvoicing.V1

Class MandatesApi

java.lang.Object

Avalara.SDK.api.EInvoicing.V1.MandatesApi

public class MandatesApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	MandatesApi.GetMandateDataInputFieldsRequest	Represents the Request object for the GetMandateDataInputFields API
class	MandatesApi.GetMandatesRequest	Represents the Request object for the GetMandates API

Constructor Summary

Constructors

Constructor	Description
MandatesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
String	getCustomBaseUrl()
MandatesApi.GetMandateDataInputFieldsRequest	getGetMandateDataInputFieldsRequest()	Getter function to instantiate Request class
MandatesApi.GetMandatesRequest	getGetMandatesRequest()	Getter function to instantiate Request class
int	getHostIndex()
List<MandateDataInputField>	getMandateDataInputFields(MandatesApi.GetMandateDataInputFieldsRequest requestParameters)	Returns document field information for a country mandate, a selected document type, and its version This endpoint provides document field details and the optionality of fields (required, conditional, optional) of different documents supported by the country mandate.
okhttp3.Call	getMandateDataInputFieldsAsync(MandatesApi.GetMandateDataInputFieldsRequest requestParameters, ApiCallback<List<MandateDataInputField>> _callback)	Returns document field information for a country mandate, a selected document type, and its version (asynchronously) This endpoint provides document field details and the optionality of fields (required, conditional, optional) of different documents supported by the country mandate.
okhttp3.Call	getMandateDataInputFieldsCall(MandatesApi.GetMandateDataInputFieldsRequest requestParameters, ApiCallback _callback)	Build call for getMandateDataInputFields
ApiResponse<List<MandateDataInputField>>	getMandateDataInputFieldsWithHttpInfo(MandatesApi.GetMandateDataInputFieldsRequest requestParameters)	Returns document field information for a country mandate, a selected document type, and its version This endpoint provides document field details and the optionality of fields (required, conditional, optional) of different documents supported by the country mandate.
MandatesResponse	getMandates(MandatesApi.GetMandatesRequest requestParameters)	List country mandates that are supported by the Avalara E-Invoicing platform This endpoint offers a list of country mandates supported by the Avalara E-Invoicing API.
okhttp3.Call	getMandatesAsync(MandatesApi.GetMandatesRequest requestParameters, ApiCallback<MandatesResponse> _callback)	List country mandates that are supported by the Avalara E-Invoicing platform (asynchronously) This endpoint offers a list of country mandates supported by the Avalara E-Invoicing API.
okhttp3.Call	getMandatesCall(MandatesApi.GetMandatesRequest requestParameters, ApiCallback _callback)	Build call for getMandates
ApiResponse<MandatesResponse>	getMandatesWithHttpInfo(MandatesApi.GetMandatesRequest requestParameters)	List country mandates that are supported by the Avalara E-Invoicing platform This endpoint offers a list of country mandates supported by the Avalara E-Invoicing API.
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

MandatesApi

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

getMandateDataInputFieldsCall

public okhttp3.Call getMandateDataInputFieldsCall(MandatesApi.GetMandateDataInputFieldsRequest requestParameters,
                                                  ApiCallback _callback)
                                           throws ApiException

Build call for getMandateDataInputFields

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	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Resource not found	-
500	Internal Server Error	-

getMandateDataInputFields

public List<MandateDataInputField> getMandateDataInputFields(MandatesApi.GetMandateDataInputFieldsRequest requestParameters)
                                                      throws ApiException

Returns document field information for a country mandate, a selected document type, and its version This endpoint provides document field details and the optionality of fields (required, conditional, optional) of different documents supported by the country mandate. Use the GET <code>/mandates</code> endpoint to retrieve all available country mandates, their supported document types and supported versions. You can use the `documentType` and `documentVersion` query parameters to retrieve the input fields for a particular document type and document version.

Parameters:

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

Returns:

List<MandateDataInputField>

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	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Resource not found	-
500	Internal Server Error	-

getMandateDataInputFieldsWithHttpInfo

public ApiResponse<List<MandateDataInputField>> getMandateDataInputFieldsWithHttpInfo(MandatesApi.GetMandateDataInputFieldsRequest requestParameters)
                                                                               throws ApiException

Returns document field information for a country mandate, a selected document type, and its version This endpoint provides document field details and the optionality of fields (required, conditional, optional) of different documents supported by the country mandate. Use the GET <code>/mandates</code> endpoint to retrieve all available country mandates, their supported document types and supported versions. You can use the `documentType` and `documentVersion` query parameters to retrieve the input fields for a particular document type and document version.

Parameters:

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

Returns:

ApiResponse<List<MandateDataInputField>>

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	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Resource not found	-
500	Internal Server Error	-

getMandateDataInputFieldsAsync

public okhttp3.Call getMandateDataInputFieldsAsync(MandatesApi.GetMandateDataInputFieldsRequest requestParameters,
                                                   ApiCallback<List<MandateDataInputField>> _callback)
                                            throws ApiException

Returns document field information for a country mandate, a selected document type, and its version (asynchronously) This endpoint provides document field details and the optionality of fields (required, conditional, optional) of different documents supported by the country mandate. Use the GET <code>/mandates</code> endpoint to retrieve all available country mandates, their supported document types and supported versions. You can use the `documentType` and `documentVersion` query parameters to retrieve the input fields for a particular document type and document version.

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	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Resource not found	-
500	Internal Server Error	-

getGetMandateDataInputFieldsRequest

public MandatesApi.GetMandateDataInputFieldsRequest getGetMandateDataInputFieldsRequest()

Getter function to instantiate Request class

getMandatesCall

public okhttp3.Call getMandatesCall(MandatesApi.GetMandatesRequest requestParameters,
                                    ApiCallback _callback)
                             throws ApiException

Build call for getMandates

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	-
404	Resource not found	-
500	Internal Server Error	-

getMandates

public MandatesResponse getMandates(MandatesApi.GetMandatesRequest requestParameters)
                             throws ApiException

List country mandates that are supported by the Avalara E-Invoicing platform This endpoint offers a list of country mandates supported by the Avalara E-Invoicing API.

Parameters:

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

Returns:

MandatesResponse

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	-
404	Resource not found	-
500	Internal Server Error	-

getMandatesWithHttpInfo

public ApiResponse<MandatesResponse> getMandatesWithHttpInfo(MandatesApi.GetMandatesRequest requestParameters)
                                                      throws ApiException

List country mandates that are supported by the Avalara E-Invoicing platform This endpoint offers a list of country mandates supported by the Avalara E-Invoicing API.

Parameters:

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

Returns:

ApiResponse<MandatesResponse>

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	-
404	Resource not found	-
500	Internal Server Error	-

getMandatesAsync

public okhttp3.Call getMandatesAsync(MandatesApi.GetMandatesRequest requestParameters,
                                     ApiCallback<MandatesResponse> _callback)
                              throws ApiException

List country mandates that are supported by the Avalara E-Invoicing platform (asynchronously) This endpoint offers a list of country mandates supported by the Avalara E-Invoicing API.

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	-
404	Resource not found	-
500	Internal Server Error	-

getGetMandatesRequest

public MandatesApi.GetMandatesRequest getGetMandatesRequest()

Getter function to instantiate Request class