fattureincloud_python_sdk.ArchiveApi

All URIs are relative to https://api-v2.fattureincloud.it

Method	HTTP request	Description
create_archive_document	POST /c/{company_id}/archive	Create Archive Document
delete_archive_document	DELETE /c/{company_id}/archive/{document_id}	Delete Archive Document
get_archive_document	GET /c/{company_id}/archive/{document_id}	Get Archive Document
list_archive_documents	GET /c/{company_id}/archive	List Archive Documents
modify_archive_document	PUT /c/{company_id}/archive/{document_id}	Modify Archive Document
upload_archive_document_attachment	POST /c/{company_id}/archive/attachment	Upload Archive Document Attachment

create_archive_document

CreateArchiveDocumentResponse create_archive_document(company_id, create_archive_document_request=create_archive_document_request)

Create Archive Document

Creates a new archive document.

Example

OAuth Authentication (OAuth2AuthenticationCodeFlow):

from __future__ import print_function
import time
import os
import fattureincloud_python_sdk
from fattureincloud_python_sdk.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api-v2.fattureincloud.it
# See configuration.py for a list of all supported configuration parameters.
configuration = fattureincloud_python_sdk.Configuration(
    host = "https://api-v2.fattureincloud.it"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with fattureincloud_python_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fattureincloud_python_sdk.ArchiveApi(api_client)
    company_id = 12345 # int | The ID of the company.
    create_archive_document_request = {"data":{"date":"2021-08-20","category":"Altri documenti","description":"spesa 1","attachment_token":"ibfjdbf94ey9w94g3w894qbasrga"}} # CreateArchiveDocumentRequest | The Archive Document. (optional)

    try:
        # Create Archive Document
        api_response = api_instance.create_archive_document(company_id, create_archive_document_request=create_archive_document_request)
        print("The response of ArchiveApi->create_archive_document:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ArchiveApi->create_archive_document: %s\n" % e)

Parameters

Name	Type	Description	Notes
company_id	int	The ID of the company.
create_archive_document_request	CreateArchiveDocumentRequest	The Archive Document.	[optional]

Return type

CreateArchiveDocumentResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The Archive Document.	-
401	Unauthorized	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_archive_document

delete_archive_document(company_id, document_id)

Delete Archive Document

Deletes the specified archive document.

Example

OAuth Authentication (OAuth2AuthenticationCodeFlow):

from __future__ import print_function
import time
import os
import fattureincloud_python_sdk
from fattureincloud_python_sdk.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api-v2.fattureincloud.it
# See configuration.py for a list of all supported configuration parameters.
configuration = fattureincloud_python_sdk.Configuration(
    host = "https://api-v2.fattureincloud.it"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with fattureincloud_python_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fattureincloud_python_sdk.ArchiveApi(api_client)
    company_id = 12345 # int | The ID of the company.
    document_id = 56 # int | The ID of the document.

    try:
        # Delete Archive Document
        api_instance.delete_archive_document(company_id, document_id)
    except Exception as e:
        print("Exception when calling ArchiveApi->delete_archive_document: %s\n" % e)

Parameters

Name	Type	Description	Notes
company_id	int	The ID of the company.
document_id	int	The ID of the document.

Return type

void (empty response body)

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Document removed.	-
401	Unauthorized	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_archive_document

GetArchiveDocumentResponse get_archive_document(company_id, document_id, fields=fields, fieldset=fieldset)

Get Archive Document

Gets the specified archive document.

Example

OAuth Authentication (OAuth2AuthenticationCodeFlow):

from __future__ import print_function
import time
import os
import fattureincloud_python_sdk
from fattureincloud_python_sdk.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api-v2.fattureincloud.it
# See configuration.py for a list of all supported configuration parameters.
configuration = fattureincloud_python_sdk.Configuration(
    host = "https://api-v2.fattureincloud.it"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with fattureincloud_python_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fattureincloud_python_sdk.ArchiveApi(api_client)
    company_id = 12345 # int | The ID of the company.
    document_id = 56 # int | The ID of the document.
    fields = 'fields_example' # str | List of comma-separated fields. (optional)
    fieldset = 'fieldset_example' # str | Name of the fieldset. (optional)

    try:
        # Get Archive Document
        api_response = api_instance.get_archive_document(company_id, document_id, fields=fields, fieldset=fieldset)
        print("The response of ArchiveApi->get_archive_document:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ArchiveApi->get_archive_document: %s\n" % e)

Parameters

Name	Type	Description	Notes
company_id	int	The ID of the company.
document_id	int	The ID of the document.
fields	str	List of comma-separated fields.	[optional]
fieldset	str	Name of the fieldset.	[optional]

Return type

GetArchiveDocumentResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Archive Document Details	-
401	Unauthorized	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_archive_documents

ListArchiveDocumentsResponse list_archive_documents(company_id, fields=fields, fieldset=fieldset, sort=sort, page=page, per_page=per_page, q=q)

List Archive Documents

Lists the archive documents.

Example

OAuth Authentication (OAuth2AuthenticationCodeFlow):

from __future__ import print_function
import time
import os
import fattureincloud_python_sdk
from fattureincloud_python_sdk.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api-v2.fattureincloud.it
# See configuration.py for a list of all supported configuration parameters.
configuration = fattureincloud_python_sdk.Configuration(
    host = "https://api-v2.fattureincloud.it"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with fattureincloud_python_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fattureincloud_python_sdk.ArchiveApi(api_client)
    company_id = 12345 # int | The ID of the company.
    fields = 'fields_example' # str | List of comma-separated fields. (optional)
    fieldset = 'fieldset_example' # str | Name of the fieldset. (optional)
    sort = 'sort_example' # str | List of comma-separated fields for result sorting (minus for desc sorting). (optional)
    page = 1 # int | The page to retrieve. (optional) (default to 1)
    per_page = 5 # int | The size of the page. (optional) (default to 5)
    q = 'q_example' # str | Query for filtering the results. (optional)

    try:
        # List Archive Documents
        api_response = api_instance.list_archive_documents(company_id, fields=fields, fieldset=fieldset, sort=sort, page=page, per_page=per_page, q=q)
        print("The response of ArchiveApi->list_archive_documents:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ArchiveApi->list_archive_documents: %s\n" % e)

Parameters

Name	Type	Description	Notes
company_id	int	The ID of the company.
fields	str	List of comma-separated fields.	[optional]
fieldset	str	Name of the fieldset.	[optional]
sort	str	List of comma-separated fields for result sorting (minus for desc sorting).	[optional]
page	int	The page to retrieve.	[optional] [default to 1]
per_page	int	The size of the page.	[optional] [default to 5]
q	str	Query for filtering the results.	[optional]

Return type

ListArchiveDocumentsResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Results list.	-
401	Unauthorized	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

modify_archive_document

ModifyArchiveDocumentResponse modify_archive_document(company_id, document_id, modify_archive_document_request=modify_archive_document_request)

Modify Archive Document

Modifies the specified archive document.

Example

OAuth Authentication (OAuth2AuthenticationCodeFlow):

from __future__ import print_function
import time
import os
import fattureincloud_python_sdk
from fattureincloud_python_sdk.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api-v2.fattureincloud.it
# See configuration.py for a list of all supported configuration parameters.
configuration = fattureincloud_python_sdk.Configuration(
    host = "https://api-v2.fattureincloud.it"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with fattureincloud_python_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fattureincloud_python_sdk.ArchiveApi(api_client)
    company_id = 12345 # int | The ID of the company.
    document_id = 56 # int | The ID of the document.
    modify_archive_document_request = {"data":{"date":"2021-08-20","category":"Altri documenti","description":"spesa 2"}} # ModifyArchiveDocumentRequest | Modified Archive Document (optional)

    try:
        # Modify Archive Document
        api_response = api_instance.modify_archive_document(company_id, document_id, modify_archive_document_request=modify_archive_document_request)
        print("The response of ArchiveApi->modify_archive_document:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ArchiveApi->modify_archive_document: %s\n" % e)

Parameters

Name	Type	Description	Notes
company_id	int	The ID of the company.
document_id	int	The ID of the document.
modify_archive_document_request	ModifyArchiveDocumentRequest	Modified Archive Document	[optional]

Return type

ModifyArchiveDocumentResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The modified Archived Document	-
401	Unauthorized	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

upload_archive_document_attachment

UploadArchiveAttachmentResponse upload_archive_document_attachment(company_id, filename=filename, attachment=attachment)

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.

Example

OAuth Authentication (OAuth2AuthenticationCodeFlow):

from __future__ import print_function
import time
import os
import fattureincloud_python_sdk
from fattureincloud_python_sdk.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api-v2.fattureincloud.it
# See configuration.py for a list of all supported configuration parameters.
configuration = fattureincloud_python_sdk.Configuration(
    host = "https://api-v2.fattureincloud.it"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with fattureincloud_python_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fattureincloud_python_sdk.ArchiveApi(api_client)
    company_id = 12345 # int | The ID of the company.
    filename = 'filename_example' # str | Name of the file. (optional)
    attachment = fattureincloud_python_sdk.bytearray() # bytearray | Valid format: .png, .jpg, .gif, .pdf, .zip, .xls, .xlsx, .doc, .docx (optional)

    try:
        # Upload Archive Document Attachment
        api_response = api_instance.upload_archive_document_attachment(company_id, filename=filename, attachment=attachment)
        print("The response of ArchiveApi->upload_archive_document_attachment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ArchiveApi->upload_archive_document_attachment: %s\n" % e)

Parameters

Name	Type	Description	Notes
company_id	int	The ID of the company.
filename	str	Name of the file.	[optional]
attachment	bytearray	Valid format: .png, .jpg, .gif, .pdf, .zip, .xls, .xlsx, .doc, .docx	[optional]

Return type

UploadArchiveAttachmentResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Example response	-
401	Unauthorized	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ArchiveApi.md

Latest commit

History

ArchiveApi.md

File metadata and controls

fattureincloud_python_sdk.ArchiveApi

create_archive_document

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_archive_document

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_archive_document

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_archive_documents

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

modify_archive_document

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

upload_archive_document_attachment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details