It.FattureInCloud.Sdk.Api.IssuedDocumentsApi

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

Method	HTTP request	Description
CreateIssuedDocument	POST /c/{company_id}/issued_documents	Create Issued Document
DeleteIssuedDocument	DELETE /c/{company_id}/issued_documents/{document_id}	Delete Issued Document
DeleteIssuedDocumentAttachment	DELETE /c/{company_id}/issued_documents/{document_id}/attachment	Delete Issued Document Attachment
GetEmailData	GET /c/{company_id}/issued_documents/{document_id}/email	Get Email Data
GetExistingIssuedDocumentTotals	POST /c/{company_id}/issued_documents/{document_id}/totals	Get Existing Issued Document Totals
GetIssuedDocument	GET /c/{company_id}/issued_documents/{document_id}	Get Issued Document
GetIssuedDocumentPreCreateInfo	GET /c/{company_id}/issued_documents/info	Get Issued Document Pre-Create Info
GetNewIssuedDocumentTotals	POST /c/{company_id}/issued_documents/totals	Get New Issued Document Totals
JoinIssuedDocuments	GET /c/{company_id}/issued_documents/join	Join Issued Documents
ListIssuedDocuments	GET /c/{company_id}/issued_documents	List Issued Documents
ModifyIssuedDocument	PUT /c/{company_id}/issued_documents/{document_id}	Modify Issued Document
ScheduleEmail	POST /c/{company_id}/issued_documents/{document_id}/email	Schedule Email
TransformIssuedDocument	GET /c/{company_id}/issued_documents/transform	Transform Issued Document
UploadIssuedDocumentAttachment	POST /c/{company_id}/issued_documents/attachment	Upload Issued Document Attachment

CreateIssuedDocument

CreateIssuedDocumentResponse CreateIssuedDocument (int companyId, CreateIssuedDocumentRequest createIssuedDocumentRequest = null)

Create Issued Document

Creates a new document.

Example

using System.Collections.Generic;
using System.Diagnostics;
using It.FattureInCloud.Sdk.Api;
using It.FattureInCloud.Sdk.Client;
using It.FattureInCloud.Sdk.Model;

namespace Example
{
    public class CreateIssuedDocumentExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api-v2.fattureincloud.it";
            // Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new IssuedDocumentsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var createIssuedDocumentRequest = new CreateIssuedDocumentRequest(); // CreateIssuedDocumentRequest | The Issued Document (optional) 

            try
            {
                // Create Issued Document
                CreateIssuedDocumentResponse result = apiInstance.CreateIssuedDocument(companyId, createIssuedDocumentRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IssuedDocumentsApi.CreateIssuedDocument: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CreateIssuedDocumentWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Create Issued Document
    ApiResponse<CreateIssuedDocumentResponse> response = apiInstance.CreateIssuedDocumentWithHttpInfo(companyId, createIssuedDocumentRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling IssuedDocumentsApi.CreateIssuedDocumentWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
companyId	int	The ID of the company.
createIssuedDocumentRequest	CreateIssuedDocumentRequest	The Issued Document	[optional]

Return type

CreateIssuedDocumentResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Document created.	-
401	Unauthorized	-

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

DeleteIssuedDocument

void DeleteIssuedDocument (int companyId, int documentId)

Delete Issued Document

Deletes the specified document.

Example

using System.Collections.Generic;
using System.Diagnostics;
using It.FattureInCloud.Sdk.Api;
using It.FattureInCloud.Sdk.Client;
using It.FattureInCloud.Sdk.Model;

namespace Example
{
    public class DeleteIssuedDocumentExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api-v2.fattureincloud.it";
            // Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new IssuedDocumentsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var documentId = 56;  // int | The ID of the document.

            try
            {
                // Delete Issued Document
                apiInstance.DeleteIssuedDocument(companyId, documentId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IssuedDocumentsApi.DeleteIssuedDocument: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the DeleteIssuedDocumentWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Delete Issued Document
    apiInstance.DeleteIssuedDocumentWithHttpInfo(companyId, documentId);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling IssuedDocumentsApi.DeleteIssuedDocumentWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
companyId	int	The ID of the company.
documentId	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]

DeleteIssuedDocumentAttachment

void DeleteIssuedDocumentAttachment (int companyId, int documentId)

Delete Issued Document Attachment

Removes the attachment of the specified document.

Example

using System.Collections.Generic;
using System.Diagnostics;
using It.FattureInCloud.Sdk.Api;
using It.FattureInCloud.Sdk.Client;
using It.FattureInCloud.Sdk.Model;

namespace Example
{
    public class DeleteIssuedDocumentAttachmentExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api-v2.fattureincloud.it";
            // Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new IssuedDocumentsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var documentId = 56;  // int | The ID of the document.

            try
            {
                // Delete Issued Document Attachment
                apiInstance.DeleteIssuedDocumentAttachment(companyId, documentId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IssuedDocumentsApi.DeleteIssuedDocumentAttachment: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the DeleteIssuedDocumentAttachmentWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Delete Issued Document Attachment
    apiInstance.DeleteIssuedDocumentAttachmentWithHttpInfo(companyId, documentId);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling IssuedDocumentsApi.DeleteIssuedDocumentAttachmentWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
companyId	int	The ID of the company.
documentId	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	File removed.	-
401	Unauthorized	-
404	Not Found	-

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

GetEmailData

GetEmailDataResponse GetEmailData (int companyId, int documentId)

Get Email Data

Gets the pre-compiled email details.

Example

using System.Collections.Generic;
using System.Diagnostics;
using It.FattureInCloud.Sdk.Api;
using It.FattureInCloud.Sdk.Client;
using It.FattureInCloud.Sdk.Model;

namespace Example
{
    public class GetEmailDataExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api-v2.fattureincloud.it";
            // Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new IssuedDocumentsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var documentId = 56;  // int | The ID of the document.

            try
            {
                // Get Email Data
                GetEmailDataResponse result = apiInstance.GetEmailData(companyId, documentId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IssuedDocumentsApi.GetEmailData: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetEmailDataWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get Email Data
    ApiResponse<GetEmailDataResponse> response = apiInstance.GetEmailDataWithHttpInfo(companyId, documentId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling IssuedDocumentsApi.GetEmailDataWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
companyId	int	The ID of the company.
documentId	int	The ID of the document.

Return type

GetEmailDataResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	EmailData	-

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

GetExistingIssuedDocumentTotals

GetExistingIssuedDocumentTotalsResponse GetExistingIssuedDocumentTotals (int companyId, int documentId, GetExistingIssuedDocumentTotalsRequest getExistingIssuedDocumentTotalsRequest = null)

Get Existing Issued Document Totals

Returns the totals for a specified document.

Example

using System.Collections.Generic;
using System.Diagnostics;
using It.FattureInCloud.Sdk.Api;
using It.FattureInCloud.Sdk.Client;
using It.FattureInCloud.Sdk.Model;

namespace Example
{
    public class GetExistingIssuedDocumentTotalsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api-v2.fattureincloud.it";
            // Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new IssuedDocumentsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var documentId = 56;  // int | The ID of the document.
            var getExistingIssuedDocumentTotalsRequest = new GetExistingIssuedDocumentTotalsRequest(); // GetExistingIssuedDocumentTotalsRequest |  (optional) 

            try
            {
                // Get Existing Issued Document Totals
                GetExistingIssuedDocumentTotalsResponse result = apiInstance.GetExistingIssuedDocumentTotals(companyId, documentId, getExistingIssuedDocumentTotalsRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IssuedDocumentsApi.GetExistingIssuedDocumentTotals: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetExistingIssuedDocumentTotalsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get Existing Issued Document Totals
    ApiResponse<GetExistingIssuedDocumentTotalsResponse> response = apiInstance.GetExistingIssuedDocumentTotalsWithHttpInfo(companyId, documentId, getExistingIssuedDocumentTotalsRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling IssuedDocumentsApi.GetExistingIssuedDocumentTotalsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
companyId	int	The ID of the company.
documentId	int	The ID of the document.
getExistingIssuedDocumentTotalsRequest	GetExistingIssuedDocumentTotalsRequest		[optional]

Return type

GetExistingIssuedDocumentTotalsResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

HTTP response details

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

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

GetIssuedDocument

GetIssuedDocumentResponse GetIssuedDocument (int companyId, int documentId, string fields = null, string fieldset = null)

Get Issued Document

Gets the specified document.

Example

using System.Collections.Generic;
using System.Diagnostics;
using It.FattureInCloud.Sdk.Api;
using It.FattureInCloud.Sdk.Client;
using It.FattureInCloud.Sdk.Model;

namespace Example
{
    public class GetIssuedDocumentExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api-v2.fattureincloud.it";
            // Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new IssuedDocumentsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var documentId = 56;  // int | The ID of the document.
            var fields = "fields_example";  // string | List of comma-separated fields. (optional) 
            var fieldset = "basic";  // string | Name of the fieldset. (optional) 

            try
            {
                // Get Issued Document
                GetIssuedDocumentResponse result = apiInstance.GetIssuedDocument(companyId, documentId, fields, fieldset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IssuedDocumentsApi.GetIssuedDocument: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetIssuedDocumentWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get Issued Document
    ApiResponse<GetIssuedDocumentResponse> response = apiInstance.GetIssuedDocumentWithHttpInfo(companyId, documentId, fields, fieldset);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling IssuedDocumentsApi.GetIssuedDocumentWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
companyId	int	The ID of the company.
documentId	int	The ID of the document.
fields	string	List of comma-separated fields.	[optional]
fieldset	string	Name of the fieldset.	[optional]

Return type

GetIssuedDocumentResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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

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

GetIssuedDocumentPreCreateInfo

GetIssuedDocumentPreCreateInfoResponse GetIssuedDocumentPreCreateInfo (int companyId, string type)

Get Issued Document Pre-Create Info

Retrieves the information useful while creating a new document.

Example

using System.Collections.Generic;
using System.Diagnostics;
using It.FattureInCloud.Sdk.Api;
using It.FattureInCloud.Sdk.Client;
using It.FattureInCloud.Sdk.Model;

namespace Example
{
    public class GetIssuedDocumentPreCreateInfoExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api-v2.fattureincloud.it";
            // Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new IssuedDocumentsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var type = "invoice";  // string | The type of the issued document.

            try
            {
                // Get Issued Document Pre-Create Info
                GetIssuedDocumentPreCreateInfoResponse result = apiInstance.GetIssuedDocumentPreCreateInfo(companyId, type);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IssuedDocumentsApi.GetIssuedDocumentPreCreateInfo: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetIssuedDocumentPreCreateInfoWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get Issued Document Pre-Create Info
    ApiResponse<GetIssuedDocumentPreCreateInfoResponse> response = apiInstance.GetIssuedDocumentPreCreateInfoWithHttpInfo(companyId, type);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling IssuedDocumentsApi.GetIssuedDocumentPreCreateInfoWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
companyId	int	The ID of the company.
type	string	The type of the issued document.

Return type

GetIssuedDocumentPreCreateInfoResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Pre-create info.	-

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

GetNewIssuedDocumentTotals

GetNewIssuedDocumentTotalsResponse GetNewIssuedDocumentTotals (int companyId, GetNewIssuedDocumentTotalsRequest getNewIssuedDocumentTotalsRequest = null)

Get New Issued Document Totals

Returns the totals for a new document.

Example

using System.Collections.Generic;
using System.Diagnostics;
using It.FattureInCloud.Sdk.Api;
using It.FattureInCloud.Sdk.Client;
using It.FattureInCloud.Sdk.Model;

namespace Example
{
    public class GetNewIssuedDocumentTotalsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api-v2.fattureincloud.it";
            // Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new IssuedDocumentsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var getNewIssuedDocumentTotalsRequest = new GetNewIssuedDocumentTotalsRequest(); // GetNewIssuedDocumentTotalsRequest |  (optional) 

            try
            {
                // Get New Issued Document Totals
                GetNewIssuedDocumentTotalsResponse result = apiInstance.GetNewIssuedDocumentTotals(companyId, getNewIssuedDocumentTotalsRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IssuedDocumentsApi.GetNewIssuedDocumentTotals: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetNewIssuedDocumentTotalsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get New Issued Document Totals
    ApiResponse<GetNewIssuedDocumentTotalsResponse> response = apiInstance.GetNewIssuedDocumentTotalsWithHttpInfo(companyId, getNewIssuedDocumentTotalsRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling IssuedDocumentsApi.GetNewIssuedDocumentTotalsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
companyId	int	The ID of the company.
getNewIssuedDocumentTotalsRequest	GetNewIssuedDocumentTotalsRequest		[optional]

Return type

GetNewIssuedDocumentTotalsResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Totals.	-
401	Unauthorized	-

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

JoinIssuedDocuments

JoinIssuedDocumentsResponse JoinIssuedDocuments (int companyId, string ids, int? group = null, string type = null)

Join Issued Documents

Joins issued documents.

Example

using System.Collections.Generic;
using System.Diagnostics;
using It.FattureInCloud.Sdk.Api;
using It.FattureInCloud.Sdk.Client;
using It.FattureInCloud.Sdk.Model;

namespace Example
{
    public class JoinIssuedDocumentsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api-v2.fattureincloud.it";
            // Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new IssuedDocumentsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var ids = 1,2,3,4;  // string | Ids of the documents.
            var group = 0;  // int? | Group items. (optional) 
            var type = delivery_notes, orders, quotes, work_reports;  // string | Type of the documents to be joined (optional) 

            try
            {
                // Join Issued Documents
                JoinIssuedDocumentsResponse result = apiInstance.JoinIssuedDocuments(companyId, ids, group, type);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IssuedDocumentsApi.JoinIssuedDocuments: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the JoinIssuedDocumentsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Join Issued Documents
    ApiResponse<JoinIssuedDocumentsResponse> response = apiInstance.JoinIssuedDocumentsWithHttpInfo(companyId, ids, group, type);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling IssuedDocumentsApi.JoinIssuedDocumentsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
companyId	int	The ID of the company.
ids	string	Ids of the documents.
group	int?	Group items.	[optional]
type	string	Type of the documents to be joined	[optional]

Return type

JoinIssuedDocumentsResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Example response	-

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

ListIssuedDocuments

ListIssuedDocumentsResponse ListIssuedDocuments (int companyId, string type, string fields = null, string fieldset = null, string sort = null, int? page = null, int? perPage = null, string q = null, int? inclusive = null)

List Issued Documents

Lists the issued documents.

Example

using System.Collections.Generic;
using System.Diagnostics;
using It.FattureInCloud.Sdk.Api;
using It.FattureInCloud.Sdk.Client;
using It.FattureInCloud.Sdk.Model;

namespace Example
{
    public class ListIssuedDocumentsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api-v2.fattureincloud.it";
            // Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new IssuedDocumentsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var type = "invoice";  // string | The type of the issued document.
            var fields = "fields_example";  // string | List of comma-separated fields. (optional) 
            var fieldset = "basic";  // string | Name of the fieldset. (optional) 
            var sort = "sort_example";  // string | List of comma-separated fields for result sorting (minus for desc sorting). (optional) 
            var page = 1;  // int? | The page to retrieve. (optional)  (default to 1)
            var perPage = 5;  // int? | The size of the page. (optional)  (default to 5)
            var q = "q_example";  // string | Query for filtering the results. (optional) 
            var inclusive = 0;  // int? | (Only for type = delivery_notes) Include invoices delivery notes. (optional) 

            try
            {
                // List Issued Documents
                ListIssuedDocumentsResponse result = apiInstance.ListIssuedDocuments(companyId, type, fields, fieldset, sort, page, perPage, q, inclusive);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IssuedDocumentsApi.ListIssuedDocuments: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ListIssuedDocumentsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // List Issued Documents
    ApiResponse<ListIssuedDocumentsResponse> response = apiInstance.ListIssuedDocumentsWithHttpInfo(companyId, type, fields, fieldset, sort, page, perPage, q, inclusive);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling IssuedDocumentsApi.ListIssuedDocumentsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
companyId	int	The ID of the company.
type	string	The type of the issued document.
fields	string	List of comma-separated fields.	[optional]
fieldset	string	Name of the fieldset.	[optional]
sort	string	List of comma-separated fields for result sorting (minus for desc sorting).	[optional]
page	int?	The page to retrieve.	[optional] [default to 1]
perPage	int?	The size of the page.	[optional] [default to 5]
q	string	Query for filtering the results.	[optional]
inclusive	int?	(Only for type = delivery_notes) Include invoices delivery notes.	[optional]

Return type

ListIssuedDocumentsResponse

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]

ModifyIssuedDocument

ModifyIssuedDocumentResponse ModifyIssuedDocument (int companyId, int documentId, ModifyIssuedDocumentRequest modifyIssuedDocumentRequest = null)

Modify Issued Document

Modifies the specified document.

Example

using System.Collections.Generic;
using System.Diagnostics;
using It.FattureInCloud.Sdk.Api;
using It.FattureInCloud.Sdk.Client;
using It.FattureInCloud.Sdk.Model;

namespace Example
{
    public class ModifyIssuedDocumentExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api-v2.fattureincloud.it";
            // Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new IssuedDocumentsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var documentId = 56;  // int | The ID of the document.
            var modifyIssuedDocumentRequest = new ModifyIssuedDocumentRequest(); // ModifyIssuedDocumentRequest | The modified document (optional) 

            try
            {
                // Modify Issued Document
                ModifyIssuedDocumentResponse result = apiInstance.ModifyIssuedDocument(companyId, documentId, modifyIssuedDocumentRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IssuedDocumentsApi.ModifyIssuedDocument: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ModifyIssuedDocumentWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Modify Issued Document
    ApiResponse<ModifyIssuedDocumentResponse> response = apiInstance.ModifyIssuedDocumentWithHttpInfo(companyId, documentId, modifyIssuedDocumentRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling IssuedDocumentsApi.ModifyIssuedDocumentWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
companyId	int	The ID of the company.
documentId	int	The ID of the document.
modifyIssuedDocumentRequest	ModifyIssuedDocumentRequest	The modified document	[optional]

Return type

ModifyIssuedDocumentResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

HTTP response details

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

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

ScheduleEmail

void ScheduleEmail (int companyId, int documentId, ScheduleEmailRequest scheduleEmailRequest = null)

Schedule Email

Schedules the sending of a document by email.

Example

using System.Collections.Generic;
using System.Diagnostics;
using It.FattureInCloud.Sdk.Api;
using It.FattureInCloud.Sdk.Client;
using It.FattureInCloud.Sdk.Model;

namespace Example
{
    public class ScheduleEmailExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api-v2.fattureincloud.it";
            // Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new IssuedDocumentsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var documentId = 56;  // int | The ID of the document.
            var scheduleEmailRequest = new ScheduleEmailRequest(); // ScheduleEmailRequest | Email Schedule (optional) 

            try
            {
                // Schedule Email
                apiInstance.ScheduleEmail(companyId, documentId, scheduleEmailRequest);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IssuedDocumentsApi.ScheduleEmail: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ScheduleEmailWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Schedule Email
    apiInstance.ScheduleEmailWithHttpInfo(companyId, documentId, scheduleEmailRequest);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling IssuedDocumentsApi.ScheduleEmailWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
companyId	int	The ID of the company.
documentId	int	The ID of the document.
scheduleEmailRequest	ScheduleEmailRequest	Email Schedule	[optional]

Return type

void (empty response body)

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

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

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

TransformIssuedDocument

TransformIssuedDocumentResponse TransformIssuedDocument (int companyId, int originalDocumentId, string newType, string type = null, int? eInvoice = null, int? transformKeepCopy = null)

Transform Issued Document

Transforms the document.

Example

using System.Collections.Generic;
using System.Diagnostics;
using It.FattureInCloud.Sdk.Api;
using It.FattureInCloud.Sdk.Client;
using It.FattureInCloud.Sdk.Model;

namespace Example
{
    public class TransformIssuedDocumentExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api-v2.fattureincloud.it";
            // Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new IssuedDocumentsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var originalDocumentId = 56;  // int | Original document id.
            var newType = "newType_example";  // string | New document type.
            var type = "type_example";  // string | Current document type. (optional) 
            var eInvoice = 0;  // int? | New document e_invoice. (optional) 
            var transformKeepCopy = 0;  // int? | Keep the old document. (optional) 

            try
            {
                // Transform Issued Document
                TransformIssuedDocumentResponse result = apiInstance.TransformIssuedDocument(companyId, originalDocumentId, newType, type, eInvoice, transformKeepCopy);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IssuedDocumentsApi.TransformIssuedDocument: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the TransformIssuedDocumentWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Transform Issued Document
    ApiResponse<TransformIssuedDocumentResponse> response = apiInstance.TransformIssuedDocumentWithHttpInfo(companyId, originalDocumentId, newType, type, eInvoice, transformKeepCopy);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling IssuedDocumentsApi.TransformIssuedDocumentWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
companyId	int	The ID of the company.
originalDocumentId	int	Original document id.
newType	string	New document type.
type	string	Current document type.	[optional]
eInvoice	int?	New document e_invoice.	[optional]
transformKeepCopy	int?	Keep the old document.	[optional]

Return type

TransformIssuedDocumentResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Example response	-

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

UploadIssuedDocumentAttachment

UploadIssuedDocumentAttachmentResponse UploadIssuedDocumentAttachment (int companyId, string filename = null, System.IO.Stream attachment = null)

Upload Issued Document Attachment

Uploads an attachment destined to an issued document. The actual association between the document and the attachment must be implemented separately, using the returned token.

Example

using System.Collections.Generic;
using System.Diagnostics;
using It.FattureInCloud.Sdk.Api;
using It.FattureInCloud.Sdk.Client;
using It.FattureInCloud.Sdk.Model;

namespace Example
{
    public class UploadIssuedDocumentAttachmentExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api-v2.fattureincloud.it";
            // Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new IssuedDocumentsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var filename = "filename_example";  // string | Attachment file name (optional) 
            var attachment = new System.IO.MemoryStream(System.IO.File.ReadAllBytes("/path/to/file.txt"));  // System.IO.Stream | Attachment file [.png, .jpg, .gif, .pdf, .zip, .xls, .xlsx, .doc, .docx] (optional) 

            try
            {
                // Upload Issued Document Attachment
                UploadIssuedDocumentAttachmentResponse result = apiInstance.UploadIssuedDocumentAttachment(companyId, filename, attachment);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling IssuedDocumentsApi.UploadIssuedDocumentAttachment: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the UploadIssuedDocumentAttachmentWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Upload Issued Document Attachment
    ApiResponse<UploadIssuedDocumentAttachmentResponse> response = apiInstance.UploadIssuedDocumentAttachmentWithHttpInfo(companyId, filename, attachment);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling IssuedDocumentsApi.UploadIssuedDocumentAttachmentWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
companyId	int	The ID of the company.
filename	string	Attachment file name	[optional]
attachment	System.IO.StreamSystem.IO.Stream	Attachment file [.png, .jpg, .gif, .pdf, .zip, .xls, .xlsx, .doc, .docx]	[optional]

Return type

UploadIssuedDocumentAttachmentResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Attachment Token.	-
401	Unauthorized	-

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

Files

IssuedDocumentsApi.md

Latest commit

History

IssuedDocumentsApi.md

File metadata and controls

It.FattureInCloud.Sdk.Api.IssuedDocumentsApi

CreateIssuedDocument

Example

Using the CreateIssuedDocumentWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeleteIssuedDocument

Example

Using the DeleteIssuedDocumentWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeleteIssuedDocumentAttachment

Example

Using the DeleteIssuedDocumentAttachmentWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetEmailData

Example

Using the GetEmailDataWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetExistingIssuedDocumentTotals

Example

Using the GetExistingIssuedDocumentTotalsWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetIssuedDocument

Example

Using the GetIssuedDocumentWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetIssuedDocumentPreCreateInfo

Example

Using the GetIssuedDocumentPreCreateInfoWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetNewIssuedDocumentTotals

Example

Using the GetNewIssuedDocumentTotalsWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

JoinIssuedDocuments

Example

Using the JoinIssuedDocumentsWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ListIssuedDocuments