it.fattureincloud.sdk.api

Class ReceivedDocumentsApi

java.lang.Object

it.fattureincloud.sdk.api.ReceivedDocumentsApi

public class ReceivedDocumentsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ReceivedDocumentsApi()
ReceivedDocumentsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
CreateReceivedDocumentResponse	createReceivedDocument(java.lang.Integer companyId, CreateReceivedDocumentRequest createReceivedDocumentRequest) Create Received Document Creates a new document.
okhttp3.Call	createReceivedDocumentAsync(java.lang.Integer companyId, CreateReceivedDocumentRequest createReceivedDocumentRequest, ApiCallback<CreateReceivedDocumentResponse> _callback) Create Received Document (asynchronously) Creates a new document.
okhttp3.Call	createReceivedDocumentCall(java.lang.Integer companyId, CreateReceivedDocumentRequest createReceivedDocumentRequest, ApiCallback _callback) Build call for createReceivedDocument
ApiResponse<CreateReceivedDocumentResponse>	createReceivedDocumentWithHttpInfo(java.lang.Integer companyId, CreateReceivedDocumentRequest createReceivedDocumentRequest) Create Received Document Creates a new document.
void	deleteReceivedDocument(java.lang.Integer companyId, java.lang.Integer documentId) Delete Received Document Deletes the specified document.
okhttp3.Call	deleteReceivedDocumentAsync(java.lang.Integer companyId, java.lang.Integer documentId, ApiCallback<java.lang.Void> _callback) Delete Received Document (asynchronously) Deletes the specified document.
void	deleteReceivedDocumentAttachment(java.lang.Integer companyId, java.lang.Integer documentId) Delete Received Document Attachment Removes the attachment of the specified document.
okhttp3.Call	deleteReceivedDocumentAttachmentAsync(java.lang.Integer companyId, java.lang.Integer documentId, ApiCallback<java.lang.Void> _callback) Delete Received Document Attachment (asynchronously) Removes the attachment of the specified document.
okhttp3.Call	deleteReceivedDocumentAttachmentCall(java.lang.Integer companyId, java.lang.Integer documentId, ApiCallback _callback) Build call for deleteReceivedDocumentAttachment
ApiResponse<java.lang.Void>	deleteReceivedDocumentAttachmentWithHttpInfo(java.lang.Integer companyId, java.lang.Integer documentId) Delete Received Document Attachment Removes the attachment of the specified document.
okhttp3.Call	deleteReceivedDocumentCall(java.lang.Integer companyId, java.lang.Integer documentId, ApiCallback _callback) Build call for deleteReceivedDocument
ApiResponse<java.lang.Void>	deleteReceivedDocumentWithHttpInfo(java.lang.Integer companyId, java.lang.Integer documentId) Delete Received Document Deletes the specified document.
ApiClient	getApiClient()
java.lang.String	getCustomBaseUrl()
GetExistingReceivedDocumentTotalsResponse	getExistingReceivedDocumentTotals(java.lang.Integer companyId, java.lang.Integer documentId, GetExistingReceivedDocumentTotalsRequest getExistingReceivedDocumentTotalsRequest) Get Existing Received Document Totals Returns the totals for the specified document.
okhttp3.Call	getExistingReceivedDocumentTotalsAsync(java.lang.Integer companyId, java.lang.Integer documentId, GetExistingReceivedDocumentTotalsRequest getExistingReceivedDocumentTotalsRequest, ApiCallback<GetExistingReceivedDocumentTotalsResponse> _callback) Get Existing Received Document Totals (asynchronously) Returns the totals for the specified document.
okhttp3.Call	getExistingReceivedDocumentTotalsCall(java.lang.Integer companyId, java.lang.Integer documentId, GetExistingReceivedDocumentTotalsRequest getExistingReceivedDocumentTotalsRequest, ApiCallback _callback) Build call for getExistingReceivedDocumentTotals
ApiResponse<GetExistingReceivedDocumentTotalsResponse>	getExistingReceivedDocumentTotalsWithHttpInfo(java.lang.Integer companyId, java.lang.Integer documentId, GetExistingReceivedDocumentTotalsRequest getExistingReceivedDocumentTotalsRequest) Get Existing Received Document Totals Returns the totals for the specified document.
int	getHostIndex()
GetNewReceivedDocumentTotalsResponse	getNewReceivedDocumentTotals(java.lang.Integer companyId, GetNewReceivedDocumentTotalsRequest getNewReceivedDocumentTotalsRequest) Get New Received Document Totals Returns the totals for a new document.
okhttp3.Call	getNewReceivedDocumentTotalsAsync(java.lang.Integer companyId, GetNewReceivedDocumentTotalsRequest getNewReceivedDocumentTotalsRequest, ApiCallback<GetNewReceivedDocumentTotalsResponse> _callback) Get New Received Document Totals (asynchronously) Returns the totals for a new document.
okhttp3.Call	getNewReceivedDocumentTotalsCall(java.lang.Integer companyId, GetNewReceivedDocumentTotalsRequest getNewReceivedDocumentTotalsRequest, ApiCallback _callback) Build call for getNewReceivedDocumentTotals
ApiResponse<GetNewReceivedDocumentTotalsResponse>	getNewReceivedDocumentTotalsWithHttpInfo(java.lang.Integer companyId, GetNewReceivedDocumentTotalsRequest getNewReceivedDocumentTotalsRequest) Get New Received Document Totals Returns the totals for a new document.
GetReceivedDocumentResponse	getReceivedDocument(java.lang.Integer companyId, java.lang.Integer documentId, java.lang.String fields, java.lang.String fieldset) Get Received Document Gets the specified document.
okhttp3.Call	getReceivedDocumentAsync(java.lang.Integer companyId, java.lang.Integer documentId, java.lang.String fields, java.lang.String fieldset, ApiCallback<GetReceivedDocumentResponse> _callback) Get Received Document (asynchronously) Gets the specified document.
okhttp3.Call	getReceivedDocumentCall(java.lang.Integer companyId, java.lang.Integer documentId, java.lang.String fields, java.lang.String fieldset, ApiCallback _callback) Build call for getReceivedDocument
GetReceivedDocumentPreCreateInfoResponse	getReceivedDocumentPreCreateInfo(java.lang.Integer companyId, java.lang.String type) Get Received Document Pre-Create Info Retrieves the information useful while creating a new document.
okhttp3.Call	getReceivedDocumentPreCreateInfoAsync(java.lang.Integer companyId, java.lang.String type, ApiCallback<GetReceivedDocumentPreCreateInfoResponse> _callback) Get Received Document Pre-Create Info (asynchronously) Retrieves the information useful while creating a new document.
okhttp3.Call	getReceivedDocumentPreCreateInfoCall(java.lang.Integer companyId, java.lang.String type, ApiCallback _callback) Build call for getReceivedDocumentPreCreateInfo
ApiResponse<GetReceivedDocumentPreCreateInfoResponse>	getReceivedDocumentPreCreateInfoWithHttpInfo(java.lang.Integer companyId, java.lang.String type) Get Received Document Pre-Create Info Retrieves the information useful while creating a new document.
ApiResponse<GetReceivedDocumentResponse>	getReceivedDocumentWithHttpInfo(java.lang.Integer companyId, java.lang.Integer documentId, java.lang.String fields, java.lang.String fieldset) Get Received Document Gets the specified document.
ListReceivedDocumentsResponse	listReceivedDocuments(java.lang.Integer companyId, java.lang.String type, java.lang.String fields, java.lang.String fieldset, java.lang.String sort, java.lang.Integer page, java.lang.Integer perPage, java.lang.String q) List Received Documents Lists the received documents.
okhttp3.Call	listReceivedDocumentsAsync(java.lang.Integer companyId, java.lang.String type, java.lang.String fields, java.lang.String fieldset, java.lang.String sort, java.lang.Integer page, java.lang.Integer perPage, java.lang.String q, ApiCallback<ListReceivedDocumentsResponse> _callback) List Received Documents (asynchronously) Lists the received documents.
okhttp3.Call	listReceivedDocumentsCall(java.lang.Integer companyId, java.lang.String type, java.lang.String fields, java.lang.String fieldset, java.lang.String sort, java.lang.Integer page, java.lang.Integer perPage, java.lang.String q, ApiCallback _callback) Build call for listReceivedDocuments
ApiResponse<ListReceivedDocumentsResponse>	listReceivedDocumentsWithHttpInfo(java.lang.Integer companyId, java.lang.String type, java.lang.String fields, java.lang.String fieldset, java.lang.String sort, java.lang.Integer page, java.lang.Integer perPage, java.lang.String q) List Received Documents Lists the received documents.
ModifyReceivedDocumentResponse	modifyReceivedDocument(java.lang.Integer companyId, java.lang.Integer documentId, ModifyReceivedDocumentRequest modifyReceivedDocumentRequest) Modify Received Document Modifies the specified document.
okhttp3.Call	modifyReceivedDocumentAsync(java.lang.Integer companyId, java.lang.Integer documentId, ModifyReceivedDocumentRequest modifyReceivedDocumentRequest, ApiCallback<ModifyReceivedDocumentResponse> _callback) Modify Received Document (asynchronously) Modifies the specified document.
okhttp3.Call	modifyReceivedDocumentCall(java.lang.Integer companyId, java.lang.Integer documentId, ModifyReceivedDocumentRequest modifyReceivedDocumentRequest, ApiCallback _callback) Build call for modifyReceivedDocument
ApiResponse<ModifyReceivedDocumentResponse>	modifyReceivedDocumentWithHttpInfo(java.lang.Integer companyId, java.lang.Integer documentId, ModifyReceivedDocumentRequest modifyReceivedDocumentRequest) Modify Received Document Modifies the specified document.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(java.lang.String customBaseUrl)
void	setHostIndex(int hostIndex)
UploadReceivedDocumentAttachmentResponse	uploadReceivedDocumentAttachment(java.lang.Integer companyId, java.lang.String filename, java.io.File attachment) Upload Received Document Attachment Uploads an attachment destined to a received document.
okhttp3.Call	uploadReceivedDocumentAttachmentAsync(java.lang.Integer companyId, java.lang.String filename, java.io.File attachment, ApiCallback<UploadReceivedDocumentAttachmentResponse> _callback) Upload Received Document Attachment (asynchronously) Uploads an attachment destined to a received document.
okhttp3.Call	uploadReceivedDocumentAttachmentCall(java.lang.Integer companyId, java.lang.String filename, java.io.File attachment, ApiCallback _callback) Build call for uploadReceivedDocumentAttachment
ApiResponse<UploadReceivedDocumentAttachmentResponse>	uploadReceivedDocumentAttachmentWithHttpInfo(java.lang.Integer companyId, java.lang.String filename, java.io.File attachment) Upload Received Document Attachment Uploads an attachment destined to a received document.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReceivedDocumentsApi

public ReceivedDocumentsApi()

ReceivedDocumentsApi

public ReceivedDocumentsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public java.lang.String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(java.lang.String customBaseUrl)

createReceivedDocumentCall

public okhttp3.Call createReceivedDocumentCall(java.lang.Integer companyId,
                                               CreateReceivedDocumentRequest createReceivedDocumentRequest,
                                               ApiCallback _callback)
                                        throws ApiException

Build call for createReceivedDocument

Parameters:

companyId - The ID of the company. (required)

createReceivedDocumentRequest - Document to create (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Document created.	-

createReceivedDocument

public CreateReceivedDocumentResponse createReceivedDocument(java.lang.Integer companyId,
                                                             CreateReceivedDocumentRequest createReceivedDocumentRequest)
                                                      throws ApiException

Create Received Document Creates a new document.

Parameters:

companyId - The ID of the company. (required)

createReceivedDocumentRequest - Document to create (optional)

Returns:

CreateReceivedDocumentResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Document created.	-

createReceivedDocumentWithHttpInfo

public ApiResponse<CreateReceivedDocumentResponse> createReceivedDocumentWithHttpInfo(java.lang.Integer companyId,
                                                                                      CreateReceivedDocumentRequest createReceivedDocumentRequest)
                                                                               throws ApiException

Create Received Document Creates a new document.

Parameters:

companyId - The ID of the company. (required)

createReceivedDocumentRequest - Document to create (optional)

Returns:

ApiResponse<CreateReceivedDocumentResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Document created.	-

createReceivedDocumentAsync

public okhttp3.Call createReceivedDocumentAsync(java.lang.Integer companyId,
                                                CreateReceivedDocumentRequest createReceivedDocumentRequest,
                                                ApiCallback<CreateReceivedDocumentResponse> _callback)
                                         throws ApiException

Create Received Document (asynchronously) Creates a new document.

Parameters:

companyId - The ID of the company. (required)

createReceivedDocumentRequest - Document to create (optional)

_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

Response Details

Status Code	Description	Response Headers
200	Document created.	-

deleteReceivedDocumentCall

public okhttp3.Call deleteReceivedDocumentCall(java.lang.Integer companyId,
                                               java.lang.Integer documentId,
                                               ApiCallback _callback)
                                        throws ApiException

Build call for deleteReceivedDocument

Parameters:

companyId - The ID of the company. (required)

documentId - The ID of the document. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Document removed.	-
401	Unauthorized	-
404	Not Found	-

deleteReceivedDocument

public void deleteReceivedDocument(java.lang.Integer companyId,
                                   java.lang.Integer documentId)
                            throws ApiException

Delete Received Document Deletes the specified document.

Parameters:

companyId - The ID of the company. (required)

documentId - The ID of the document. (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Document removed.	-
401	Unauthorized	-
404	Not Found	-

deleteReceivedDocumentWithHttpInfo

public ApiResponse<java.lang.Void> deleteReceivedDocumentWithHttpInfo(java.lang.Integer companyId,
                                                                      java.lang.Integer documentId)
                                                               throws ApiException

Delete Received Document Deletes the specified document.

Parameters:

companyId - The ID of the company. (required)

documentId - The ID of the document. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Document removed.	-
401	Unauthorized	-
404	Not Found	-

deleteReceivedDocumentAsync

public okhttp3.Call deleteReceivedDocumentAsync(java.lang.Integer companyId,
                                                java.lang.Integer documentId,
                                                ApiCallback<java.lang.Void> _callback)
                                         throws ApiException

Delete Received Document (asynchronously) Deletes the specified document.

Parameters:

companyId - The ID of the company. (required)

documentId - The ID of the document. (required)

_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

Response Details

Status Code	Description	Response Headers
200	Document removed.	-
401	Unauthorized	-
404	Not Found	-

deleteReceivedDocumentAttachmentCall

public okhttp3.Call deleteReceivedDocumentAttachmentCall(java.lang.Integer companyId,
                                                         java.lang.Integer documentId,
                                                         ApiCallback _callback)
                                                  throws ApiException

Build call for deleteReceivedDocumentAttachment

Parameters:

companyId - The ID of the company. (required)

documentId - The ID of the document. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	File removed	-
401	Unauthorized	-
404	Not Found	-

deleteReceivedDocumentAttachment

public void deleteReceivedDocumentAttachment(java.lang.Integer companyId,
                                             java.lang.Integer documentId)
                                      throws ApiException

Delete Received Document Attachment Removes the attachment of the specified document.

Parameters:

companyId - The ID of the company. (required)

documentId - The ID of the document. (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	File removed	-
401	Unauthorized	-
404	Not Found	-

deleteReceivedDocumentAttachmentWithHttpInfo

public ApiResponse<java.lang.Void> deleteReceivedDocumentAttachmentWithHttpInfo(java.lang.Integer companyId,
                                                                                java.lang.Integer documentId)
                                                                         throws ApiException

Delete Received Document Attachment Removes the attachment of the specified document.

Parameters:

companyId - The ID of the company. (required)

documentId - The ID of the document. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	File removed	-
401	Unauthorized	-
404	Not Found	-

deleteReceivedDocumentAttachmentAsync

public okhttp3.Call deleteReceivedDocumentAttachmentAsync(java.lang.Integer companyId,
                                                          java.lang.Integer documentId,
                                                          ApiCallback<java.lang.Void> _callback)
                                                   throws ApiException

Delete Received Document Attachment (asynchronously) Removes the attachment of the specified document.

Parameters:

companyId - The ID of the company. (required)

documentId - The ID of the document. (required)

_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

Response Details

Status Code	Description	Response Headers
200	File removed	-
401	Unauthorized	-
404	Not Found	-

getExistingReceivedDocumentTotalsCall

public okhttp3.Call getExistingReceivedDocumentTotalsCall(java.lang.Integer companyId,
                                                          java.lang.Integer documentId,
                                                          GetExistingReceivedDocumentTotalsRequest getExistingReceivedDocumentTotalsRequest,
                                                          ApiCallback _callback)
                                                   throws ApiException

Build call for getExistingReceivedDocumentTotals

Parameters:

companyId - The ID of the company. (required)

documentId - The ID of the document. (required)

getExistingReceivedDocumentTotalsRequest - Received document. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Document Totals.	-

getExistingReceivedDocumentTotals

public GetExistingReceivedDocumentTotalsResponse getExistingReceivedDocumentTotals(java.lang.Integer companyId,
                                                                                   java.lang.Integer documentId,
                                                                                   GetExistingReceivedDocumentTotalsRequest getExistingReceivedDocumentTotalsRequest)
                                                                            throws ApiException

Get Existing Received Document Totals Returns the totals for the specified document.

Parameters:

companyId - The ID of the company. (required)

documentId - The ID of the document. (required)

getExistingReceivedDocumentTotalsRequest - Received document. (optional)

Returns:

GetExistingReceivedDocumentTotalsResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Document Totals.	-

getExistingReceivedDocumentTotalsWithHttpInfo

public ApiResponse<GetExistingReceivedDocumentTotalsResponse> getExistingReceivedDocumentTotalsWithHttpInfo(java.lang.Integer companyId,
                                                                                                            java.lang.Integer documentId,
                                                                                                            GetExistingReceivedDocumentTotalsRequest getExistingReceivedDocumentTotalsRequest)
                                                                                                     throws ApiException

Get Existing Received Document Totals Returns the totals for the specified document.

Parameters:

companyId - The ID of the company. (required)

documentId - The ID of the document. (required)

getExistingReceivedDocumentTotalsRequest - Received document. (optional)

Returns:

ApiResponse<GetExistingReceivedDocumentTotalsResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Document Totals.	-

getExistingReceivedDocumentTotalsAsync

public okhttp3.Call getExistingReceivedDocumentTotalsAsync(java.lang.Integer companyId,
                                                           java.lang.Integer documentId,
                                                           GetExistingReceivedDocumentTotalsRequest getExistingReceivedDocumentTotalsRequest,
                                                           ApiCallback<GetExistingReceivedDocumentTotalsResponse> _callback)
                                                    throws ApiException

Get Existing Received Document Totals (asynchronously) Returns the totals for the specified document.

Parameters:

companyId - The ID of the company. (required)

documentId - The ID of the document. (required)

getExistingReceivedDocumentTotalsRequest - Received document. (optional)

_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

Response Details

Status Code	Description	Response Headers
200	Document Totals.	-

getNewReceivedDocumentTotalsCall

public okhttp3.Call getNewReceivedDocumentTotalsCall(java.lang.Integer companyId,
                                                     GetNewReceivedDocumentTotalsRequest getNewReceivedDocumentTotalsRequest,
                                                     ApiCallback _callback)
                                              throws ApiException

Build call for getNewReceivedDocumentTotals

Parameters:

companyId - The ID of the company. (required)

getNewReceivedDocumentTotalsRequest - Received document. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Document Totals.	-
401	Unauthorized	-
404	Not Found	-

getNewReceivedDocumentTotals

public GetNewReceivedDocumentTotalsResponse getNewReceivedDocumentTotals(java.lang.Integer companyId,
                                                                         GetNewReceivedDocumentTotalsRequest getNewReceivedDocumentTotalsRequest)
                                                                  throws ApiException

Get New Received Document Totals Returns the totals for a new document.

Parameters:

companyId - The ID of the company. (required)

getNewReceivedDocumentTotalsRequest - Received document. (optional)

Returns:

GetNewReceivedDocumentTotalsResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Document Totals.	-
401	Unauthorized	-
404	Not Found	-

getNewReceivedDocumentTotalsWithHttpInfo

public ApiResponse<GetNewReceivedDocumentTotalsResponse> getNewReceivedDocumentTotalsWithHttpInfo(java.lang.Integer companyId,
                                                                                                  GetNewReceivedDocumentTotalsRequest getNewReceivedDocumentTotalsRequest)
                                                                                           throws ApiException

Get New Received Document Totals Returns the totals for a new document.

Parameters:

companyId - The ID of the company. (required)

getNewReceivedDocumentTotalsRequest - Received document. (optional)

Returns:

ApiResponse<GetNewReceivedDocumentTotalsResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Document Totals.	-
401	Unauthorized	-
404	Not Found	-

getNewReceivedDocumentTotalsAsync

public okhttp3.Call getNewReceivedDocumentTotalsAsync(java.lang.Integer companyId,
                                                      GetNewReceivedDocumentTotalsRequest getNewReceivedDocumentTotalsRequest,
                                                      ApiCallback<GetNewReceivedDocumentTotalsResponse> _callback)
                                               throws ApiException

Get New Received Document Totals (asynchronously) Returns the totals for a new document.

Parameters:

companyId - The ID of the company. (required)

getNewReceivedDocumentTotalsRequest - Received document. (optional)

_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

Response Details

Status Code	Description	Response Headers
200	Document Totals.	-
401	Unauthorized	-
404	Not Found	-

getReceivedDocumentCall

public okhttp3.Call getReceivedDocumentCall(java.lang.Integer companyId,
                                            java.lang.Integer documentId,
                                            java.lang.String fields,
                                            java.lang.String fieldset,
                                            ApiCallback _callback)
                                     throws ApiException

Build call for getReceivedDocument

Parameters:

companyId - The ID of the company. (required)

documentId - The ID of the document. (required)

fields - List of comma-separated fields. (optional)

fieldset - Name of the fieldset. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Document details.	-
401	Unauthorized	-
404	Not Found	-

getReceivedDocument

public GetReceivedDocumentResponse getReceivedDocument(java.lang.Integer companyId,
                                                       java.lang.Integer documentId,
                                                       java.lang.String fields,
                                                       java.lang.String fieldset)
                                                throws ApiException

Get Received Document Gets the specified document.

Parameters:

companyId - The ID of the company. (required)

documentId - The ID of the document. (required)

fields - List of comma-separated fields. (optional)

fieldset - Name of the fieldset. (optional)

Returns:

GetReceivedDocumentResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Document details.	-
401	Unauthorized	-
404	Not Found	-

getReceivedDocumentWithHttpInfo

public ApiResponse<GetReceivedDocumentResponse> getReceivedDocumentWithHttpInfo(java.lang.Integer companyId,
                                                                                java.lang.Integer documentId,
                                                                                java.lang.String fields,
                                                                                java.lang.String fieldset)
                                                                         throws ApiException

Get Received Document Gets the specified document.

Parameters:

companyId - The ID of the company. (required)

documentId - The ID of the document. (required)

fields - List of comma-separated fields. (optional)

fieldset - Name of the fieldset. (optional)

Returns:

ApiResponse<GetReceivedDocumentResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Document details.	-
401	Unauthorized	-
404	Not Found	-

getReceivedDocumentAsync

public okhttp3.Call getReceivedDocumentAsync(java.lang.Integer companyId,
                                             java.lang.Integer documentId,
                                             java.lang.String fields,
                                             java.lang.String fieldset,
                                             ApiCallback<GetReceivedDocumentResponse> _callback)
                                      throws ApiException

Get Received Document (asynchronously) Gets the specified document.

Parameters:

companyId - The ID of the company. (required)

documentId - The ID of the document. (required)

fields - List of comma-separated fields. (optional)

fieldset - Name of the fieldset. (optional)

_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

Response Details

Status Code	Description	Response Headers
200	Document details.	-
401	Unauthorized	-
404	Not Found	-

getReceivedDocumentPreCreateInfoCall

public okhttp3.Call getReceivedDocumentPreCreateInfoCall(java.lang.Integer companyId,
                                                         java.lang.String type,
                                                         ApiCallback _callback)
                                                  throws ApiException

Build call for getReceivedDocumentPreCreateInfo

Parameters:

companyId - The ID of the company. (required)

type - The type of the received document. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Pre-create info	-

getReceivedDocumentPreCreateInfo

public GetReceivedDocumentPreCreateInfoResponse getReceivedDocumentPreCreateInfo(java.lang.Integer companyId,
                                                                                 java.lang.String type)
                                                                          throws ApiException

Get Received Document Pre-Create Info Retrieves the information useful while creating a new document.

Parameters:

companyId - The ID of the company. (required)

type - The type of the received document. (required)

Returns:

GetReceivedDocumentPreCreateInfoResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Pre-create info	-

getReceivedDocumentPreCreateInfoWithHttpInfo

public ApiResponse<GetReceivedDocumentPreCreateInfoResponse> getReceivedDocumentPreCreateInfoWithHttpInfo(java.lang.Integer companyId,
                                                                                                          java.lang.String type)
                                                                                                   throws ApiException

Get Received Document Pre-Create Info Retrieves the information useful while creating a new document.

Parameters:

companyId - The ID of the company. (required)

type - The type of the received document. (required)

Returns:

ApiResponse<GetReceivedDocumentPreCreateInfoResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Pre-create info	-

getReceivedDocumentPreCreateInfoAsync

public okhttp3.Call getReceivedDocumentPreCreateInfoAsync(java.lang.Integer companyId,
                                                          java.lang.String type,
                                                          ApiCallback<GetReceivedDocumentPreCreateInfoResponse> _callback)
                                                   throws ApiException

Get Received Document Pre-Create Info (asynchronously) Retrieves the information useful while creating a new document.

Parameters:

companyId - The ID of the company. (required)

type - The type of the received document. (required)

_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

Response Details

Status Code	Description	Response Headers
200	Pre-create info	-

listReceivedDocumentsCall

public okhttp3.Call listReceivedDocumentsCall(java.lang.Integer companyId,
                                              java.lang.String type,
                                              java.lang.String fields,
                                              java.lang.String fieldset,
                                              java.lang.String sort,
                                              java.lang.Integer page,
                                              java.lang.Integer perPage,
                                              java.lang.String q,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for listReceivedDocuments

Parameters:

companyId - The ID of the company. (required)

type - The type of the received document. (required)

fields - List of comma-separated fields. (optional)

fieldset - Name of the fieldset. (optional)

sort - List of comma-separated fields for result sorting (minus for desc sorting). (optional)

page - The page to retrieve. (optional, default to 1)

perPage - The size of the page. (optional, default to 5)

q - Query for filtering the results. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Results list.	-
401	Unauthorized	-

listReceivedDocuments

public ListReceivedDocumentsResponse listReceivedDocuments(java.lang.Integer companyId,
                                                           java.lang.String type,
                                                           java.lang.String fields,
                                                           java.lang.String fieldset,
                                                           java.lang.String sort,
                                                           java.lang.Integer page,
                                                           java.lang.Integer perPage,
                                                           java.lang.String q)
                                                    throws ApiException

List Received Documents Lists the received documents.

Parameters:

companyId - The ID of the company. (required)

type - The type of the received document. (required)

fields - List of comma-separated fields. (optional)

fieldset - Name of the fieldset. (optional)

sort - List of comma-separated fields for result sorting (minus for desc sorting). (optional)

page - The page to retrieve. (optional, default to 1)

perPage - The size of the page. (optional, default to 5)

q - Query for filtering the results. (optional)

Returns:

ListReceivedDocumentsResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Results list.	-
401	Unauthorized	-

listReceivedDocumentsWithHttpInfo

public ApiResponse<ListReceivedDocumentsResponse> listReceivedDocumentsWithHttpInfo(java.lang.Integer companyId,
                                                                                    java.lang.String type,
                                                                                    java.lang.String fields,
                                                                                    java.lang.String fieldset,
                                                                                    java.lang.String sort,
                                                                                    java.lang.Integer page,
                                                                                    java.lang.Integer perPage,
                                                                                    java.lang.String q)
                                                                             throws ApiException

List Received Documents Lists the received documents.

Parameters:

companyId - The ID of the company. (required)

type - The type of the received document. (required)

fields - List of comma-separated fields. (optional)

fieldset - Name of the fieldset. (optional)

sort - List of comma-separated fields for result sorting (minus for desc sorting). (optional)

page - The page to retrieve. (optional, default to 1)

perPage - The size of the page. (optional, default to 5)

q - Query for filtering the results. (optional)

Returns:

ApiResponse<ListReceivedDocumentsResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Results list.	-
401	Unauthorized	-

listReceivedDocumentsAsync

public okhttp3.Call listReceivedDocumentsAsync(java.lang.Integer companyId,
                                               java.lang.String type,
                                               java.lang.String fields,
                                               java.lang.String fieldset,
                                               java.lang.String sort,
                                               java.lang.Integer page,
                                               java.lang.Integer perPage,
                                               java.lang.String q,
                                               ApiCallback<ListReceivedDocumentsResponse> _callback)
                                        throws ApiException

List Received Documents (asynchronously) Lists the received documents.

Parameters:

companyId - The ID of the company. (required)

type - The type of the received document. (required)

fields - List of comma-separated fields. (optional)

fieldset - Name of the fieldset. (optional)

sort - List of comma-separated fields for result sorting (minus for desc sorting). (optional)

page - The page to retrieve. (optional, default to 1)

perPage - The size of the page. (optional, default to 5)

q - Query for filtering the results. (optional)

_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

Response Details

Status Code	Description	Response Headers
200	Results list.	-
401	Unauthorized	-

modifyReceivedDocumentCall

public okhttp3.Call modifyReceivedDocumentCall(java.lang.Integer companyId,
                                               java.lang.Integer documentId,
                                               ModifyReceivedDocumentRequest modifyReceivedDocumentRequest,
                                               ApiCallback _callback)
                                        throws ApiException

Build call for modifyReceivedDocument

Parameters:

companyId - The ID of the company. (required)

documentId - The ID of the document. (required)

modifyReceivedDocumentRequest - Modified document. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Modified document.	-
401	Unauthorized	-
404	Not Found	-

modifyReceivedDocument

public ModifyReceivedDocumentResponse modifyReceivedDocument(java.lang.Integer companyId,
                                                             java.lang.Integer documentId,
                                                             ModifyReceivedDocumentRequest modifyReceivedDocumentRequest)
                                                      throws ApiException

Modify Received Document Modifies the specified document.

Parameters:

companyId - The ID of the company. (required)

documentId - The ID of the document. (required)

modifyReceivedDocumentRequest - Modified document. (optional)

Returns:

ModifyReceivedDocumentResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Modified document.	-
401	Unauthorized	-
404	Not Found	-

modifyReceivedDocumentWithHttpInfo

public ApiResponse<ModifyReceivedDocumentResponse> modifyReceivedDocumentWithHttpInfo(java.lang.Integer companyId,
                                                                                      java.lang.Integer documentId,
                                                                                      ModifyReceivedDocumentRequest modifyReceivedDocumentRequest)
                                                                               throws ApiException

Modify Received Document Modifies the specified document.

Parameters:

companyId - The ID of the company. (required)

documentId - The ID of the document. (required)

modifyReceivedDocumentRequest - Modified document. (optional)

Returns:

ApiResponse<ModifyReceivedDocumentResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Modified document.	-
401	Unauthorized	-
404	Not Found	-

modifyReceivedDocumentAsync

public okhttp3.Call modifyReceivedDocumentAsync(java.lang.Integer companyId,
                                                java.lang.Integer documentId,
                                                ModifyReceivedDocumentRequest modifyReceivedDocumentRequest,
                                                ApiCallback<ModifyReceivedDocumentResponse> _callback)
                                         throws ApiException

Modify Received Document (asynchronously) Modifies the specified document.

Parameters:

companyId - The ID of the company. (required)

documentId - The ID of the document. (required)

modifyReceivedDocumentRequest - Modified document. (optional)

_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

Response Details

Status Code	Description	Response Headers
200	Modified document.	-
401	Unauthorized	-
404	Not Found	-

uploadReceivedDocumentAttachmentCall

public okhttp3.Call uploadReceivedDocumentAttachmentCall(java.lang.Integer companyId,
                                                         java.lang.String filename,
                                                         java.io.File attachment,
                                                         ApiCallback _callback)
                                                  throws ApiException

Build call for uploadReceivedDocumentAttachment

Parameters:

companyId - The ID of the company. (required)

filename - Attachment file name (optional)

attachment - Attachment file [.png, .jpg, .gif, .pdf, .zip, .xls, .xlsx, .doc, .docx] (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Attachment Token.	-
401	Unauthorized	-

uploadReceivedDocumentAttachment

public UploadReceivedDocumentAttachmentResponse uploadReceivedDocumentAttachment(java.lang.Integer companyId,
                                                                                 java.lang.String filename,
                                                                                 java.io.File attachment)
                                                                          throws ApiException

Upload Received Document Attachment Uploads an attachment destined to a received document. The actual association between the document and the attachment must be implemented separately, using the returned token.

Parameters:

companyId - The ID of the company. (required)

filename - Attachment file name (optional)

attachment - Attachment file [.png, .jpg, .gif, .pdf, .zip, .xls, .xlsx, .doc, .docx] (optional)

Returns:

UploadReceivedDocumentAttachmentResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Attachment Token.	-
401	Unauthorized	-

uploadReceivedDocumentAttachmentWithHttpInfo

public ApiResponse<UploadReceivedDocumentAttachmentResponse> uploadReceivedDocumentAttachmentWithHttpInfo(java.lang.Integer companyId,
                                                                                                          java.lang.String filename,
                                                                                                          java.io.File attachment)
                                                                                                   throws ApiException

Upload Received Document Attachment Uploads an attachment destined to a received document. The actual association between the document and the attachment must be implemented separately, using the returned token.

Parameters:

companyId - The ID of the company. (required)

filename - Attachment file name (optional)

attachment - Attachment file [.png, .jpg, .gif, .pdf, .zip, .xls, .xlsx, .doc, .docx] (optional)

Returns:

ApiResponse<UploadReceivedDocumentAttachmentResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Attachment Token.	-
401	Unauthorized	-

uploadReceivedDocumentAttachmentAsync

public okhttp3.Call uploadReceivedDocumentAttachmentAsync(java.lang.Integer companyId,
                                                          java.lang.String filename,
                                                          java.io.File attachment,
                                                          ApiCallback<UploadReceivedDocumentAttachmentResponse> _callback)
                                                   throws ApiException

Upload Received Document Attachment (asynchronously) Uploads an attachment destined to a received document. The actual association between the document and the attachment must be implemented separately, using the returned token.

Parameters:

companyId - The ID of the company. (required)

filename - Attachment file name (optional)

attachment - Attachment file [.png, .jpg, .gif, .pdf, .zip, .xls, .xlsx, .doc, .docx] (optional)

_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

Response Details

Status Code	Description	Response Headers
200	Attachment Token.	-
401	Unauthorized	-