It.FattureInCloud.Sdk.Api.ReceiptsApi

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

Method	HTTP request	Description
CreateReceipt	POST /c/{company_id}/receipts	Create Receipt
DeleteReceipt	DELETE /c/{company_id}/receipts/{document_id}	Delete Receipt
GetReceipt	GET /c/{company_id}/receipts/{document_id}	Get Receipt
GetReceiptPreCreateInfo	GET /c/{company_id}/receipts/info	Get Receipt Pre-Create Info
GetReceiptsMonthlyTotals	GET /c/{company_id}/receipts/monthly_totals	Get Receipts Monthly Totals
ListReceipts	GET /c/{company_id}/receipts	List Receipts
ModifyReceipt	PUT /c/{company_id}/receipts/{document_id}	Modify Receipt

CreateReceipt

CreateReceiptResponse CreateReceipt (int companyId, CreateReceiptRequest createReceiptRequest = null)

Create Receipt

Creates a new receipt.

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 CreateReceiptExample
    {
        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 ReceiptsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var createReceiptRequest = new CreateReceiptRequest(); // CreateReceiptRequest | The Receipt to create. (optional) 

            try
            {
                // Create Receipt
                CreateReceiptResponse result = apiInstance.CreateReceipt(companyId, createReceiptRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ReceiptsApi.CreateReceipt: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CreateReceiptWithHttpInfo variant

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

try
{
    // Create Receipt
    ApiResponse<CreateReceiptResponse> response = apiInstance.CreateReceiptWithHttpInfo(companyId, createReceiptRequest);
    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 ReceiptsApi.CreateReceiptWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
companyId	int	The ID of the company.
createReceiptRequest	CreateReceiptRequest	The Receipt to create.	[optional]

Return type

CreateReceiptResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Created Receipt.	* RateLimit-HourlyRemaining - * RateLimit-HourlyLimit - * RateLimit-MonthlyRemaining - * RateLimit-MonthlyLimit -
400	ErrorResponse	* Retry-After -
401	ErrorResponse	* Retry-After -
403	ErrorResponse	* Retry-After -
404	ErrorResponse	* Retry-After -
405	ErrorResponse	* Retry-After -
409	ErrorResponse	* Retry-After -
422	ErrorResponse	* Retry-After -
429	ErrorResponse	* Retry-After -
500	ErrorResponse	* Retry-After -

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

DeleteReceipt

void DeleteReceipt (int companyId, int documentId)

Delete Receipt

Deletes the specified receipt.

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 DeleteReceiptExample
    {
        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 ReceiptsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var documentId = 56;  // int | The ID of the document.

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

Using the DeleteReceiptWithHttpInfo variant

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

try
{
    // Delete Receipt
    apiInstance.DeleteReceiptWithHttpInfo(companyId, documentId);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ReceiptsApi.DeleteReceiptWithHttpInfo: " + 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: application/json

HTTP response details

Status code	Description	Response headers
200	Document removed.	* RateLimit-HourlyRemaining - * RateLimit-HourlyLimit - * RateLimit-MonthlyRemaining - * RateLimit-MonthlyLimit -
400	ErrorResponse	* Retry-After -
401	ErrorResponse	* Retry-After -
403	ErrorResponse	* Retry-After -
404	ErrorResponse	* Retry-After -
405	ErrorResponse	* Retry-After -
409	ErrorResponse	* Retry-After -
422	ErrorResponse	* Retry-After -
429	ErrorResponse	* Retry-After -
500	ErrorResponse	* Retry-After -

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

GetReceipt

GetReceiptResponse GetReceipt (int companyId, int documentId, string fields = null, string fieldset = null)

Get Receipt

Gets the specified receipt.

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 GetReceiptExample
    {
        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 ReceiptsApi(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 Receipt
                GetReceiptResponse result = apiInstance.GetReceipt(companyId, documentId, fields, fieldset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ReceiptsApi.GetReceipt: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetReceiptWithHttpInfo variant

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

try
{
    // Get Receipt
    ApiResponse<GetReceiptResponse> response = apiInstance.GetReceiptWithHttpInfo(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 ReceiptsApi.GetReceiptWithHttpInfo: " + 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

GetReceiptResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Receipt Details.	* RateLimit-HourlyRemaining - * RateLimit-HourlyLimit - * RateLimit-MonthlyRemaining - * RateLimit-MonthlyLimit -
400	ErrorResponse	* Retry-After -
401	ErrorResponse	* Retry-After -
403	ErrorResponse	* Retry-After -
404	ErrorResponse	* Retry-After -
405	ErrorResponse	* Retry-After -
409	ErrorResponse	* Retry-After -
422	ErrorResponse	* Retry-After -
429	ErrorResponse	* Retry-After -
500	ErrorResponse	* Retry-After -

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

GetReceiptPreCreateInfo

GetReceiptPreCreateInfoResponse GetReceiptPreCreateInfo (int companyId)

Get Receipt Pre-Create Info

Retrieves the information useful while creating a new receipt.

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 GetReceiptPreCreateInfoExample
    {
        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 ReceiptsApi(config);
            var companyId = 12345;  // int | The ID of the company.

            try
            {
                // Get Receipt Pre-Create Info
                GetReceiptPreCreateInfoResponse result = apiInstance.GetReceiptPreCreateInfo(companyId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ReceiptsApi.GetReceiptPreCreateInfo: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetReceiptPreCreateInfoWithHttpInfo variant

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

try
{
    // Get Receipt Pre-Create Info
    ApiResponse<GetReceiptPreCreateInfoResponse> response = apiInstance.GetReceiptPreCreateInfoWithHttpInfo(companyId);
    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 ReceiptsApi.GetReceiptPreCreateInfoWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

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

Return type

GetReceiptPreCreateInfoResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Pre-create info.	* RateLimit-HourlyRemaining - * RateLimit-HourlyLimit - * RateLimit-MonthlyRemaining - * RateLimit-MonthlyLimit -
400	ErrorResponse	* Retry-After -
401	ErrorResponse	* Retry-After -
403	ErrorResponse	* Retry-After -
404	ErrorResponse	* Retry-After -
405	ErrorResponse	* Retry-After -
409	ErrorResponse	* Retry-After -
422	ErrorResponse	* Retry-After -
429	ErrorResponse	* Retry-After -
500	ErrorResponse	* Retry-After -

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

GetReceiptsMonthlyTotals

GetReceiptsMonthlyTotalsResponse GetReceiptsMonthlyTotals (int companyId, string type, string year)

Get Receipts Monthly Totals

Returns the monthly totals by year and receipt type.

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 GetReceiptsMonthlyTotalsExample
    {
        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 ReceiptsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var type = "sales_receipt";  // string | Receipt Type
            var year = "year_example";  // string | Year for which you want monthly totals

            try
            {
                // Get Receipts Monthly Totals
                GetReceiptsMonthlyTotalsResponse result = apiInstance.GetReceiptsMonthlyTotals(companyId, type, year);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ReceiptsApi.GetReceiptsMonthlyTotals: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetReceiptsMonthlyTotalsWithHttpInfo variant

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

try
{
    // Get Receipts Monthly Totals
    ApiResponse<GetReceiptsMonthlyTotalsResponse> response = apiInstance.GetReceiptsMonthlyTotalsWithHttpInfo(companyId, type, year);
    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 ReceiptsApi.GetReceiptsMonthlyTotalsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description
companyId	int	The ID of the company.
type	string	Receipt Type
year	string	Year for which you want monthly totals

Return type

GetReceiptsMonthlyTotalsResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Monthly Totals.	* RateLimit-HourlyRemaining - * RateLimit-HourlyLimit - * RateLimit-MonthlyRemaining - * RateLimit-MonthlyLimit -
400	ErrorResponse	* Retry-After -
401	ErrorResponse	* Retry-After -
403	ErrorResponse	* Retry-After -
404	ErrorResponse	* Retry-After -
405	ErrorResponse	* Retry-After -
409	ErrorResponse	* Retry-After -
422	ErrorResponse	* Retry-After -
429	ErrorResponse	* Retry-After -
500	ErrorResponse	* Retry-After -

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

ListReceipts

ListReceiptsResponse ListReceipts (int companyId, string fields = null, string fieldset = null, int? page = null, int? perPage = null, string sort = null, string q = null)

List Receipts

Lists the receipts.

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 ListReceiptsExample
    {
        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 ReceiptsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var fields = "fields_example";  // string | List of comma-separated fields. (optional) 
            var fieldset = "basic";  // string | Name of the fieldset. (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 sort = "sort_example";  // string | List of comma-separated fields for result sorting (minus for desc sorting). (optional) 
            var q = "q_example";  // string | Query for filtering the results. (optional) 

            try
            {
                // List Receipts
                ListReceiptsResponse result = apiInstance.ListReceipts(companyId, fields, fieldset, page, perPage, sort, q);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ReceiptsApi.ListReceipts: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ListReceiptsWithHttpInfo variant

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

try
{
    // List Receipts
    ApiResponse<ListReceiptsResponse> response = apiInstance.ListReceiptsWithHttpInfo(companyId, fields, fieldset, page, perPage, sort, q);
    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 ReceiptsApi.ListReceiptsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

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

Return type

ListReceiptsResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Receipts list.	* RateLimit-HourlyRemaining - * RateLimit-HourlyLimit - * RateLimit-MonthlyRemaining - * RateLimit-MonthlyLimit -
400	ErrorResponse	* Retry-After -
401	ErrorResponse	* Retry-After -
403	ErrorResponse	* Retry-After -
404	ErrorResponse	* Retry-After -
405	ErrorResponse	* Retry-After -
409	ErrorResponse	* Retry-After -
422	ErrorResponse	* Retry-After -
429	ErrorResponse	* Retry-After -
500	ErrorResponse	* Retry-After -

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

ModifyReceipt

ModifyReceiptResponse ModifyReceipt (int companyId, int documentId, ModifyReceiptRequest modifyReceiptRequest = null)

Modify Receipt

Modifies the specified receipt.

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 ModifyReceiptExample
    {
        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 ReceiptsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var documentId = 56;  // int | The ID of the document.
            var modifyReceiptRequest = new ModifyReceiptRequest(); // ModifyReceiptRequest | Modified receipt. (optional) 

            try
            {
                // Modify Receipt
                ModifyReceiptResponse result = apiInstance.ModifyReceipt(companyId, documentId, modifyReceiptRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ReceiptsApi.ModifyReceipt: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ModifyReceiptWithHttpInfo variant

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

try
{
    // Modify Receipt
    ApiResponse<ModifyReceiptResponse> response = apiInstance.ModifyReceiptWithHttpInfo(companyId, documentId, modifyReceiptRequest);
    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 ReceiptsApi.ModifyReceiptWithHttpInfo: " + 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.
modifyReceiptRequest	ModifyReceiptRequest	Modified receipt.	[optional]

Return type

ModifyReceiptResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Modified receipt.	* RateLimit-HourlyRemaining - * RateLimit-HourlyLimit - * RateLimit-MonthlyRemaining - * RateLimit-MonthlyLimit -
400	ErrorResponse	* Retry-After -
401	ErrorResponse	* Retry-After -
403	ErrorResponse	* Retry-After -
404	ErrorResponse	* Retry-After -
405	ErrorResponse	* Retry-After -
409	ErrorResponse	* Retry-After -
422	ErrorResponse	* Retry-After -
429	ErrorResponse	* Retry-After -
500	ErrorResponse	* Retry-After -

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

Uh oh!

FilesExpand file tree

ReceiptsApi.md

Latest commit

History

ReceiptsApi.md

File metadata and controls

It.FattureInCloud.Sdk.Api.ReceiptsApi

CreateReceipt

Example

Using the CreateReceiptWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeleteReceipt

Example

Using the DeleteReceiptWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetReceipt

Example

Using the GetReceiptWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetReceiptPreCreateInfo

Example

Using the GetReceiptPreCreateInfoWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetReceiptsMonthlyTotals

Example

Using the GetReceiptsMonthlyTotalsWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ListReceipts

Example

Using the ListReceiptsWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ModifyReceipt

Example

Using the ModifyReceiptWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details