Package Avalara.SDK.api.EInvoicing.V1

Class InteropApi

java.lang.Object

Avalara.SDK.api.EInvoicing.V1.InteropApi

public class InteropApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	InteropApi.SubmitInteropDocumentRequest	Represents the Request object for the SubmitInteropDocument API

Constructor Summary

Constructors

Constructor	Description
InteropApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
InteropApi.SubmitInteropDocumentRequest	getSubmitInteropDocumentRequest()	Getter function to instantiate Request class
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
SubmitInteropDocument202Response	submitInteropDocument(InteropApi.SubmitInteropDocumentRequest requestParameters)	Submit a document This API used by the interoperability partners to submit a document to their trading partners in Avalara on behalf of their customers.
okhttp3.Call	submitInteropDocumentAsync(InteropApi.SubmitInteropDocumentRequest requestParameters, ApiCallback<SubmitInteropDocument202Response> _callback)	Submit a document (asynchronously) This API used by the interoperability partners to submit a document to their trading partners in Avalara on behalf of their customers.
okhttp3.Call	submitInteropDocumentCall(InteropApi.SubmitInteropDocumentRequest requestParameters, ApiCallback _callback)	Build call for submitInteropDocument
ApiResponse<SubmitInteropDocument202Response>	submitInteropDocumentWithHttpInfo(InteropApi.SubmitInteropDocumentRequest requestParameters)	Submit a document This API used by the interoperability partners to submit a document to their trading partners in Avalara on behalf of their customers.

Methods inherited from class java.lang.Object

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

Constructor Detail

InteropApi

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

submitInteropDocumentCall

public okhttp3.Call submitInteropDocumentCall(InteropApi.SubmitInteropDocumentRequest requestParameters,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for submitInteropDocument

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
202	Document Accepted. This doesn't mean it is processed. This is just a transport ack.	* X-Correlation-ID -
400	Bad/Invalid Request.	* X-Correlation-Id -
401	Unauthorized	* X-Correlation-Id -
403	Forbidden	* X-Correlation-Id -
500	Internal server error	* X-Correlation-Id -

submitInteropDocument

public SubmitInteropDocument202Response submitInteropDocument(InteropApi.SubmitInteropDocumentRequest requestParameters)
                                                       throws ApiException

Submit a document This API used by the interoperability partners to submit a document to their trading partners in Avalara on behalf of their customers.

Parameters:

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

Returns:

SubmitInteropDocument202Response

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
202	Document Accepted. This doesn't mean it is processed. This is just a transport ack.	* X-Correlation-ID -
400	Bad/Invalid Request.	* X-Correlation-Id -
401	Unauthorized	* X-Correlation-Id -
403	Forbidden	* X-Correlation-Id -
500	Internal server error	* X-Correlation-Id -

submitInteropDocumentWithHttpInfo

public ApiResponse<SubmitInteropDocument202Response> submitInteropDocumentWithHttpInfo(InteropApi.SubmitInteropDocumentRequest requestParameters)
                                                                                throws ApiException

Submit a document This API used by the interoperability partners to submit a document to their trading partners in Avalara on behalf of their customers.

Parameters:

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

Returns:

ApiResponse<SubmitInteropDocument202Response>

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
202	Document Accepted. This doesn't mean it is processed. This is just a transport ack.	* X-Correlation-ID -
400	Bad/Invalid Request.	* X-Correlation-Id -
401	Unauthorized	* X-Correlation-Id -
403	Forbidden	* X-Correlation-Id -
500	Internal server error	* X-Correlation-Id -

submitInteropDocumentAsync

public okhttp3.Call submitInteropDocumentAsync(InteropApi.SubmitInteropDocumentRequest requestParameters,
                                               ApiCallback<SubmitInteropDocument202Response> _callback)
                                        throws ApiException

Submit a document (asynchronously) This API used by the interoperability partners to submit a document to their trading partners in Avalara on behalf of their customers.

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
202	Document Accepted. This doesn't mean it is processed. This is just a transport ack.	* X-Correlation-ID -
400	Bad/Invalid Request.	* X-Correlation-Id -
401	Unauthorized	* X-Correlation-Id -
403	Forbidden	* X-Correlation-Id -
500	Internal server error	* X-Correlation-Id -

getSubmitInteropDocumentRequest

public InteropApi.SubmitInteropDocumentRequest getSubmitInteropDocumentRequest()

Getter function to instantiate Request class