it.fattureincloud.sdk.api

Class ArchiveApi

java.lang.Object

it.fattureincloud.sdk.api.ArchiveApi

public class ArchiveApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ArchiveApi()
ArchiveApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
CreateArchiveDocumentResponse	createArchiveDocument(java.lang.Integer companyId, CreateArchiveDocumentRequest createArchiveDocumentRequest) Create Archive Document Creates a new archive document.
okhttp3.Call	createArchiveDocumentAsync(java.lang.Integer companyId, CreateArchiveDocumentRequest createArchiveDocumentRequest, ApiCallback<CreateArchiveDocumentResponse> _callback) Create Archive Document (asynchronously) Creates a new archive document.
okhttp3.Call	createArchiveDocumentCall(java.lang.Integer companyId, CreateArchiveDocumentRequest createArchiveDocumentRequest, ApiCallback _callback) Build call for createArchiveDocument
ApiResponse<CreateArchiveDocumentResponse>	createArchiveDocumentWithHttpInfo(java.lang.Integer companyId, CreateArchiveDocumentRequest createArchiveDocumentRequest) Create Archive Document Creates a new archive document.
void	deleteArchiveDocument(java.lang.Integer companyId, java.lang.Integer documentId) Delete Archive Document Deletes the specified archive document.
okhttp3.Call	deleteArchiveDocumentAsync(java.lang.Integer companyId, java.lang.Integer documentId, ApiCallback<java.lang.Void> _callback) Delete Archive Document (asynchronously) Deletes the specified archive document.
okhttp3.Call	deleteArchiveDocumentCall(java.lang.Integer companyId, java.lang.Integer documentId, ApiCallback _callback) Build call for deleteArchiveDocument
ApiResponse<java.lang.Void>	deleteArchiveDocumentWithHttpInfo(java.lang.Integer companyId, java.lang.Integer documentId) Delete Archive Document Deletes the specified archive document.
ApiClient	getApiClient()
GetArchiveDocumentResponse	getArchiveDocument(java.lang.Integer companyId, java.lang.Integer documentId, java.lang.String fields, java.lang.String fieldset) Get Archive Document Gets the specified archive document.
okhttp3.Call	getArchiveDocumentAsync(java.lang.Integer companyId, java.lang.Integer documentId, java.lang.String fields, java.lang.String fieldset, ApiCallback<GetArchiveDocumentResponse> _callback) Get Archive Document (asynchronously) Gets the specified archive document.
okhttp3.Call	getArchiveDocumentCall(java.lang.Integer companyId, java.lang.Integer documentId, java.lang.String fields, java.lang.String fieldset, ApiCallback _callback) Build call for getArchiveDocument
ApiResponse<GetArchiveDocumentResponse>	getArchiveDocumentWithHttpInfo(java.lang.Integer companyId, java.lang.Integer documentId, java.lang.String fields, java.lang.String fieldset) Get Archive Document Gets the specified archive document.
java.lang.String	getCustomBaseUrl()
int	getHostIndex()
ListArchiveDocumentsResponse	listArchiveDocuments(java.lang.Integer companyId, 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 Archive Documents Lists the archive documents.
okhttp3.Call	listArchiveDocumentsAsync(java.lang.Integer companyId, 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<ListArchiveDocumentsResponse> _callback) List Archive Documents (asynchronously) Lists the archive documents.
okhttp3.Call	listArchiveDocumentsCall(java.lang.Integer companyId, 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 listArchiveDocuments
ApiResponse<ListArchiveDocumentsResponse>	listArchiveDocumentsWithHttpInfo(java.lang.Integer companyId, 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 Archive Documents Lists the archive documents.
ModifyArchiveDocumentResponse	modifyArchiveDocument(java.lang.Integer companyId, java.lang.Integer documentId, ModifyArchiveDocumentRequest modifyArchiveDocumentRequest) Modify Archive Document Modifies the specified archive document.
okhttp3.Call	modifyArchiveDocumentAsync(java.lang.Integer companyId, java.lang.Integer documentId, ModifyArchiveDocumentRequest modifyArchiveDocumentRequest, ApiCallback<ModifyArchiveDocumentResponse> _callback) Modify Archive Document (asynchronously) Modifies the specified archive document.
okhttp3.Call	modifyArchiveDocumentCall(java.lang.Integer companyId, java.lang.Integer documentId, ModifyArchiveDocumentRequest modifyArchiveDocumentRequest, ApiCallback _callback) Build call for modifyArchiveDocument
ApiResponse<ModifyArchiveDocumentResponse>	modifyArchiveDocumentWithHttpInfo(java.lang.Integer companyId, java.lang.Integer documentId, ModifyArchiveDocumentRequest modifyArchiveDocumentRequest) Modify Archive Document Modifies the specified archive document.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(java.lang.String customBaseUrl)
void	setHostIndex(int hostIndex)
UploadArchiveAttachmentResponse	uploadArchiveDocumentAttachment(java.lang.Integer companyId, java.lang.String filename, java.io.File attachment) Upload Archive Document Attachment Uploads an attachment destined to an archive document.
okhttp3.Call	uploadArchiveDocumentAttachmentAsync(java.lang.Integer companyId, java.lang.String filename, java.io.File attachment, ApiCallback<UploadArchiveAttachmentResponse> _callback) Upload Archive Document Attachment (asynchronously) Uploads an attachment destined to an archive document.
okhttp3.Call	uploadArchiveDocumentAttachmentCall(java.lang.Integer companyId, java.lang.String filename, java.io.File attachment, ApiCallback _callback) Build call for uploadArchiveDocumentAttachment
ApiResponse<UploadArchiveAttachmentResponse>	uploadArchiveDocumentAttachmentWithHttpInfo(java.lang.Integer companyId, java.lang.String filename, java.io.File attachment) Upload Archive Document Attachment Uploads an attachment destined to an archive document.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchiveApi

public ArchiveApi()

ArchiveApi

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

createArchiveDocumentCall

public okhttp3.Call createArchiveDocumentCall(java.lang.Integer companyId,
                                              CreateArchiveDocumentRequest createArchiveDocumentRequest,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for createArchiveDocument

Parameters:

companyId - The ID of the company. (required)

createArchiveDocumentRequest - The Archive 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	The Archive Document.	-
401	Unauthorized	-
404	Not Found	-

createArchiveDocument

public CreateArchiveDocumentResponse createArchiveDocument(java.lang.Integer companyId,
                                                           CreateArchiveDocumentRequest createArchiveDocumentRequest)
                                                    throws ApiException

Create Archive Document Creates a new archive document.

Parameters:

companyId - The ID of the company. (required)

createArchiveDocumentRequest - The Archive Document. (optional)

Returns:

CreateArchiveDocumentResponse

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	The Archive Document.	-
401	Unauthorized	-
404	Not Found	-

createArchiveDocumentWithHttpInfo

public ApiResponse<CreateArchiveDocumentResponse> createArchiveDocumentWithHttpInfo(java.lang.Integer companyId,
                                                                                    CreateArchiveDocumentRequest createArchiveDocumentRequest)
                                                                             throws ApiException

Create Archive Document Creates a new archive document.

Parameters:

companyId - The ID of the company. (required)

createArchiveDocumentRequest - The Archive Document. (optional)

Returns:

ApiResponse<CreateArchiveDocumentResponse>

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	The Archive Document.	-
401	Unauthorized	-
404	Not Found	-

createArchiveDocumentAsync

public okhttp3.Call createArchiveDocumentAsync(java.lang.Integer companyId,
                                               CreateArchiveDocumentRequest createArchiveDocumentRequest,
                                               ApiCallback<CreateArchiveDocumentResponse> _callback)
                                        throws ApiException

Create Archive Document (asynchronously) Creates a new archive document.

Parameters:

companyId - The ID of the company. (required)

createArchiveDocumentRequest - The Archive 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	The Archive Document.	-
401	Unauthorized	-
404	Not Found	-

deleteArchiveDocumentCall

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

Build call for deleteArchiveDocument

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	-

deleteArchiveDocument

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

Delete Archive Document Deletes the specified archive 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	-

deleteArchiveDocumentWithHttpInfo

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

Delete Archive Document Deletes the specified archive 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	-

deleteArchiveDocumentAsync

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

Delete Archive Document (asynchronously) Deletes the specified archive 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	-

getArchiveDocumentCall

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

Build call for getArchiveDocument

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	Archive Document Details	-
401	Unauthorized	-
404	Not Found	-

getArchiveDocument

public GetArchiveDocumentResponse getArchiveDocument(java.lang.Integer companyId,
                                                     java.lang.Integer documentId,
                                                     java.lang.String fields,
                                                     java.lang.String fieldset)
                                              throws ApiException

Get Archive Document Gets the specified archive 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:

GetArchiveDocumentResponse

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	Archive Document Details	-
401	Unauthorized	-
404	Not Found	-

getArchiveDocumentWithHttpInfo

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

Get Archive Document Gets the specified archive 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<GetArchiveDocumentResponse>

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	Archive Document Details	-
401	Unauthorized	-
404	Not Found	-

getArchiveDocumentAsync

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

Get Archive Document (asynchronously) Gets the specified archive 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	Archive Document Details	-
401	Unauthorized	-
404	Not Found	-

listArchiveDocumentsCall

public okhttp3.Call listArchiveDocumentsCall(java.lang.Integer companyId,
                                             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 listArchiveDocuments

Parameters:

companyId - The ID of the company. (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	-
404	Not Found	-

listArchiveDocuments

public ListArchiveDocumentsResponse listArchiveDocuments(java.lang.Integer companyId,
                                                         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 Archive Documents Lists the archive documents.

Parameters:

companyId - The ID of the company. (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:

ListArchiveDocumentsResponse

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	-
404	Not Found	-

listArchiveDocumentsWithHttpInfo

public ApiResponse<ListArchiveDocumentsResponse> listArchiveDocumentsWithHttpInfo(java.lang.Integer companyId,
                                                                                  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 Archive Documents Lists the archive documents.

Parameters:

companyId - The ID of the company. (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<ListArchiveDocumentsResponse>

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	-
404	Not Found	-

listArchiveDocumentsAsync

public okhttp3.Call listArchiveDocumentsAsync(java.lang.Integer companyId,
                                              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<ListArchiveDocumentsResponse> _callback)
                                       throws ApiException

List Archive Documents (asynchronously) Lists the archive documents.

Parameters:

companyId - The ID of the company. (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	-
404	Not Found	-

modifyArchiveDocumentCall

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

Build call for modifyArchiveDocument

Parameters:

companyId - The ID of the company. (required)

documentId - The ID of the document. (required)

modifyArchiveDocumentRequest - Modified Archive 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	The modified Archived Document	-
401	Unauthorized	-
404	Not Found	-

modifyArchiveDocument

public ModifyArchiveDocumentResponse modifyArchiveDocument(java.lang.Integer companyId,
                                                           java.lang.Integer documentId,
                                                           ModifyArchiveDocumentRequest modifyArchiveDocumentRequest)
                                                    throws ApiException

Modify Archive Document Modifies the specified archive document.

Parameters:

companyId - The ID of the company. (required)

documentId - The ID of the document. (required)

modifyArchiveDocumentRequest - Modified Archive Document (optional)

Returns:

ModifyArchiveDocumentResponse

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	The modified Archived Document	-
401	Unauthorized	-
404	Not Found	-

modifyArchiveDocumentWithHttpInfo

public ApiResponse<ModifyArchiveDocumentResponse> modifyArchiveDocumentWithHttpInfo(java.lang.Integer companyId,
                                                                                    java.lang.Integer documentId,
                                                                                    ModifyArchiveDocumentRequest modifyArchiveDocumentRequest)
                                                                             throws ApiException

Modify Archive Document Modifies the specified archive document.

Parameters:

companyId - The ID of the company. (required)

documentId - The ID of the document. (required)

modifyArchiveDocumentRequest - Modified Archive Document (optional)

Returns:

ApiResponse<ModifyArchiveDocumentResponse>

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	The modified Archived Document	-
401	Unauthorized	-
404	Not Found	-

modifyArchiveDocumentAsync

public okhttp3.Call modifyArchiveDocumentAsync(java.lang.Integer companyId,
                                               java.lang.Integer documentId,
                                               ModifyArchiveDocumentRequest modifyArchiveDocumentRequest,
                                               ApiCallback<ModifyArchiveDocumentResponse> _callback)
                                        throws ApiException

Modify Archive Document (asynchronously) Modifies the specified archive document.

Parameters:

companyId - The ID of the company. (required)

documentId - The ID of the document. (required)

modifyArchiveDocumentRequest - Modified Archive 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	The modified Archived Document	-
401	Unauthorized	-
404	Not Found	-

uploadArchiveDocumentAttachmentCall

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

Build call for uploadArchiveDocumentAttachment

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	Example response	-
401	Unauthorized	-
404	Not Found	-

uploadArchiveDocumentAttachment

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

Upload Archive Document Attachment Uploads an attachment destined to an archive 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:

UploadArchiveAttachmentResponse

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	Example response	-
401	Unauthorized	-
404	Not Found	-

uploadArchiveDocumentAttachmentWithHttpInfo

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

Upload Archive Document Attachment Uploads an attachment destined to an archive 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<UploadArchiveAttachmentResponse>

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	Example response	-
401	Unauthorized	-
404	Not Found	-

uploadArchiveDocumentAttachmentAsync

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

Upload Archive Document Attachment (asynchronously) Uploads an attachment destined to an archive 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	Example response	-
401	Unauthorized	-
404	Not Found	-