Skip to content

Latest commit

 

History

History
1603 lines (1300 loc) · 56.7 KB

File metadata and controls

1603 lines (1300 loc) · 56.7 KB

It.FattureInCloud.Sdk.Api.SettingsApi

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

Method HTTP request Description
CreatePaymentAccount POST /c/{company_id}/settings/payment_accounts Create Payment Account
CreatePaymentMethod POST /c/{company_id}/settings/payment_methods Create Payment Method
CreateVatType POST /c/{company_id}/settings/vat_types Create Vat Type
DeletePaymentAccount DELETE /c/{company_id}/settings/payment_accounts/{payment_account_id} Delete Payment Account
DeletePaymentMethod DELETE /c/{company_id}/settings/payment_methods/{payment_method_id} Delete Payment Method
DeleteVatType DELETE /c/{company_id}/settings/vat_types/{vat_type_id} Delete Vat Type
GetPaymentAccount GET /c/{company_id}/settings/payment_accounts/{payment_account_id} Get Payment Account
GetPaymentMethod GET /c/{company_id}/settings/payment_methods/{payment_method_id} Get Payment Method
GetTaxProfile GET /c/{company_id}/settings/tax_profile Get Tax Profile
GetTemplate GET /c/{company_id}/settings/templates/{template_id} Get Template
GetVatType GET /c/{company_id}/settings/vat_types/{vat_type_id} Get Vat Type
ListTemplates GET /c/{company_id}/settings/templates List Templates
ModifyPaymentAccount PUT /c/{company_id}/settings/payment_accounts/{payment_account_id} Modify Payment Account
ModifyPaymentMethod PUT /c/{company_id}/settings/payment_methods/{payment_method_id} Modify Payment Method
ModifyVatType PUT /c/{company_id}/settings/vat_types/{vat_type_id} Modify Vat Type

CreatePaymentAccount

CreatePaymentAccountResponse CreatePaymentAccount (int companyId, CreatePaymentAccountRequest createPaymentAccountRequest = null)

Create Payment Account

Creates a new payment account.

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 CreatePaymentAccountExample
    {
        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 SettingsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var createPaymentAccountRequest = new CreatePaymentAccountRequest(); // CreatePaymentAccountRequest |  (optional) 

            try
            {
                // Create Payment Account
                CreatePaymentAccountResponse result = apiInstance.CreatePaymentAccount(companyId, createPaymentAccountRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SettingsApi.CreatePaymentAccount: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CreatePaymentAccountWithHttpInfo variant

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

try
{
    // Create Payment Account
    ApiResponse<CreatePaymentAccountResponse> response = apiInstance.CreatePaymentAccountWithHttpInfo(companyId, createPaymentAccountRequest);
    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 SettingsApi.CreatePaymentAccountWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
companyId int The ID of the company.
createPaymentAccountRequest CreatePaymentAccountRequest [optional]

Return type

CreatePaymentAccountResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Example response * 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]

CreatePaymentMethod

CreatePaymentMethodResponse CreatePaymentMethod (int companyId, CreatePaymentMethodRequest createPaymentMethodRequest = null)

Create Payment Method

Creates a new payment method.

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 CreatePaymentMethodExample
    {
        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 SettingsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var createPaymentMethodRequest = new CreatePaymentMethodRequest(); // CreatePaymentMethodRequest |  (optional) 

            try
            {
                // Create Payment Method
                CreatePaymentMethodResponse result = apiInstance.CreatePaymentMethod(companyId, createPaymentMethodRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SettingsApi.CreatePaymentMethod: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CreatePaymentMethodWithHttpInfo variant

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

try
{
    // Create Payment Method
    ApiResponse<CreatePaymentMethodResponse> response = apiInstance.CreatePaymentMethodWithHttpInfo(companyId, createPaymentMethodRequest);
    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 SettingsApi.CreatePaymentMethodWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
companyId int The ID of the company.
createPaymentMethodRequest CreatePaymentMethodRequest [optional]

Return type

CreatePaymentMethodResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Example response * 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]

CreateVatType

CreateVatTypeResponse CreateVatType (int companyId, CreateVatTypeRequest createVatTypeRequest = null)

Create Vat Type

Creates a vat 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 CreateVatTypeExample
    {
        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 SettingsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var createVatTypeRequest = new CreateVatTypeRequest(); // CreateVatTypeRequest |  (optional) 

            try
            {
                // Create Vat Type
                CreateVatTypeResponse result = apiInstance.CreateVatType(companyId, createVatTypeRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SettingsApi.CreateVatType: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CreateVatTypeWithHttpInfo variant

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

try
{
    // Create Vat Type
    ApiResponse<CreateVatTypeResponse> response = apiInstance.CreateVatTypeWithHttpInfo(companyId, createVatTypeRequest);
    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 SettingsApi.CreateVatTypeWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
companyId int The ID of the company.
createVatTypeRequest CreateVatTypeRequest [optional]

Return type

CreateVatTypeResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Example response * 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]

DeletePaymentAccount

void DeletePaymentAccount (int companyId, int paymentAccountId)

Delete Payment Account

Deletes the specified payment account.

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 DeletePaymentAccountExample
    {
        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 SettingsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var paymentAccountId = 56;  // int | The Referred Payment Account Id.

            try
            {
                // Delete Payment Account
                apiInstance.DeletePaymentAccount(companyId, paymentAccountId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SettingsApi.DeletePaymentAccount: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the DeletePaymentAccountWithHttpInfo variant

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

try
{
    // Delete Payment Account
    apiInstance.DeletePaymentAccountWithHttpInfo(companyId, paymentAccountId);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling SettingsApi.DeletePaymentAccountWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
companyId int The ID of the company.
paymentAccountId int The Referred Payment Account Id.

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 OK * 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]

DeletePaymentMethod

void DeletePaymentMethod (int companyId, int paymentMethodId)

Delete Payment Method

Deletes the specified payment method.

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 DeletePaymentMethodExample
    {
        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 SettingsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var paymentMethodId = 56;  // int | The Referred Payment Method Id.

            try
            {
                // Delete Payment Method
                apiInstance.DeletePaymentMethod(companyId, paymentMethodId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SettingsApi.DeletePaymentMethod: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the DeletePaymentMethodWithHttpInfo variant

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

try
{
    // Delete Payment Method
    apiInstance.DeletePaymentMethodWithHttpInfo(companyId, paymentMethodId);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling SettingsApi.DeletePaymentMethodWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
companyId int The ID of the company.
paymentMethodId int The Referred Payment Method Id.

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 OK * 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]

DeleteVatType

void DeleteVatType (int companyId, int vatTypeId)

Delete Vat Type

Deletes the specified vat 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 DeleteVatTypeExample
    {
        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 SettingsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var vatTypeId = 56;  // int | The Referred Vat Type Id.

            try
            {
                // Delete Vat Type
                apiInstance.DeleteVatType(companyId, vatTypeId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SettingsApi.DeleteVatType: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the DeleteVatTypeWithHttpInfo variant

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

try
{
    // Delete Vat Type
    apiInstance.DeleteVatTypeWithHttpInfo(companyId, vatTypeId);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling SettingsApi.DeleteVatTypeWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
companyId int The ID of the company.
vatTypeId int The Referred Vat Type Id.

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 OK * 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]

GetPaymentAccount

GetPaymentAccountResponse GetPaymentAccount (int companyId, int paymentAccountId, string fields = null, string fieldset = null)

Get Payment Account

Gets the specified payment account.

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 GetPaymentAccountExample
    {
        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 SettingsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var paymentAccountId = 56;  // int | The Referred Payment Account Id.
            var fields = "fields_example";  // string | List of comma-separated fields. (optional) 
            var fieldset = "basic";  // string | Name of the fieldset. (optional) 

            try
            {
                // Get Payment Account
                GetPaymentAccountResponse result = apiInstance.GetPaymentAccount(companyId, paymentAccountId, fields, fieldset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SettingsApi.GetPaymentAccount: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetPaymentAccountWithHttpInfo variant

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

try
{
    // Get Payment Account
    ApiResponse<GetPaymentAccountResponse> response = apiInstance.GetPaymentAccountWithHttpInfo(companyId, paymentAccountId, 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 SettingsApi.GetPaymentAccountWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
companyId int The ID of the company.
paymentAccountId int The Referred Payment Account Id.
fields string List of comma-separated fields. [optional]
fieldset string Name of the fieldset. [optional]

Return type

GetPaymentAccountResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Example response * 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]

GetPaymentMethod

GetPaymentMethodResponse GetPaymentMethod (int companyId, int paymentMethodId, string fields = null, string fieldset = null)

Get Payment Method

Gets the specified payment method.

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 GetPaymentMethodExample
    {
        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 SettingsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var paymentMethodId = 56;  // int | The Referred Payment Method Id.
            var fields = "fields_example";  // string | List of comma-separated fields. (optional) 
            var fieldset = "basic";  // string | Name of the fieldset. (optional) 

            try
            {
                // Get Payment Method
                GetPaymentMethodResponse result = apiInstance.GetPaymentMethod(companyId, paymentMethodId, fields, fieldset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SettingsApi.GetPaymentMethod: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetPaymentMethodWithHttpInfo variant

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

try
{
    // Get Payment Method
    ApiResponse<GetPaymentMethodResponse> response = apiInstance.GetPaymentMethodWithHttpInfo(companyId, paymentMethodId, 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 SettingsApi.GetPaymentMethodWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
companyId int The ID of the company.
paymentMethodId int The Referred Payment Method Id.
fields string List of comma-separated fields. [optional]
fieldset string Name of the fieldset. [optional]

Return type

GetPaymentMethodResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Example response * 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]

GetTaxProfile

GetTaxProfileResponse GetTaxProfile (int companyId)

Get Tax Profile

Gets the Tax Profile

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

            try
            {
                // Get Tax Profile
                GetTaxProfileResponse result = apiInstance.GetTaxProfile(companyId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SettingsApi.GetTaxProfile: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetTaxProfileWithHttpInfo variant

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

try
{
    // Get Tax Profile
    ApiResponse<GetTaxProfileResponse> response = apiInstance.GetTaxProfileWithHttpInfo(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 SettingsApi.GetTaxProfileWithHttpInfo: " + 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

GetTaxProfileResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Example response * 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]

GetTemplate

GetTemplatesResponse GetTemplate (int companyId, int templateId, string fields = null, string fieldset = null)

Get Template

Gets a specified template.

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 GetTemplateExample
    {
        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 SettingsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var templateId = 56;  // int | The Referred Template Id.
            var fields = "fields_example";  // string | List of comma-separated fields. (optional) 
            var fieldset = "basic";  // string | Name of the fieldset. (optional) 

            try
            {
                // Get Template
                GetTemplatesResponse result = apiInstance.GetTemplate(companyId, templateId, fields, fieldset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SettingsApi.GetTemplate: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetTemplateWithHttpInfo variant

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

try
{
    // Get Template
    ApiResponse<GetTemplatesResponse> response = apiInstance.GetTemplateWithHttpInfo(companyId, templateId, 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 SettingsApi.GetTemplateWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
companyId int The ID of the company.
templateId int The Referred Template Id.
fields string List of comma-separated fields. [optional]
fieldset string Name of the fieldset. [optional]

Return type

GetTemplatesResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Example response * 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]

GetVatType

GetVatTypeResponse GetVatType (int companyId, int vatTypeId)

Get Vat Type

Gets the specified vat 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 GetVatTypeExample
    {
        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 SettingsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var vatTypeId = 56;  // int | The Referred Vat Type Id.

            try
            {
                // Get Vat Type
                GetVatTypeResponse result = apiInstance.GetVatType(companyId, vatTypeId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SettingsApi.GetVatType: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetVatTypeWithHttpInfo variant

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

try
{
    // Get Vat Type
    ApiResponse<GetVatTypeResponse> response = apiInstance.GetVatTypeWithHttpInfo(companyId, vatTypeId);
    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 SettingsApi.GetVatTypeWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
companyId int The ID of the company.
vatTypeId int The Referred Vat Type Id.

Return type

GetVatTypeResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Example response * 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]

ListTemplates

ListTemplatesResponse ListTemplates (int companyId, string fields = null, string fieldset = null)

List Templates

Gets all the standard and private templates.

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 ListTemplatesExample
    {
        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 SettingsApi(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) 

            try
            {
                // List Templates
                ListTemplatesResponse result = apiInstance.ListTemplates(companyId, fields, fieldset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SettingsApi.ListTemplates: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ListTemplatesWithHttpInfo variant

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

try
{
    // List Templates
    ApiResponse<ListTemplatesResponse> response = apiInstance.ListTemplatesWithHttpInfo(companyId, 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 SettingsApi.ListTemplatesWithHttpInfo: " + 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]

Return type

ListTemplatesResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Templates 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]

ModifyPaymentAccount

ModifyPaymentAccountResponse ModifyPaymentAccount (int companyId, int paymentAccountId, ModifyPaymentAccountRequest modifyPaymentAccountRequest = null)

Modify Payment Account

Modifies the specified payment account.

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 ModifyPaymentAccountExample
    {
        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 SettingsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var paymentAccountId = 56;  // int | The Referred Payment Account Id.
            var modifyPaymentAccountRequest = new ModifyPaymentAccountRequest(); // ModifyPaymentAccountRequest |  (optional) 

            try
            {
                // Modify Payment Account
                ModifyPaymentAccountResponse result = apiInstance.ModifyPaymentAccount(companyId, paymentAccountId, modifyPaymentAccountRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SettingsApi.ModifyPaymentAccount: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ModifyPaymentAccountWithHttpInfo variant

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

try
{
    // Modify Payment Account
    ApiResponse<ModifyPaymentAccountResponse> response = apiInstance.ModifyPaymentAccountWithHttpInfo(companyId, paymentAccountId, modifyPaymentAccountRequest);
    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 SettingsApi.ModifyPaymentAccountWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
companyId int The ID of the company.
paymentAccountId int The Referred Payment Account Id.
modifyPaymentAccountRequest ModifyPaymentAccountRequest [optional]

Return type

ModifyPaymentAccountResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Example response * 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]

ModifyPaymentMethod

ModifyPaymentMethodResponse ModifyPaymentMethod (int companyId, int paymentMethodId, ModifyPaymentMethodRequest modifyPaymentMethodRequest = null)

Modify Payment Method

Modifies the specified payment method.

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 ModifyPaymentMethodExample
    {
        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 SettingsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var paymentMethodId = 56;  // int | The Referred Payment Method Id.
            var modifyPaymentMethodRequest = new ModifyPaymentMethodRequest(); // ModifyPaymentMethodRequest |  (optional) 

            try
            {
                // Modify Payment Method
                ModifyPaymentMethodResponse result = apiInstance.ModifyPaymentMethod(companyId, paymentMethodId, modifyPaymentMethodRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SettingsApi.ModifyPaymentMethod: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ModifyPaymentMethodWithHttpInfo variant

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

try
{
    // Modify Payment Method
    ApiResponse<ModifyPaymentMethodResponse> response = apiInstance.ModifyPaymentMethodWithHttpInfo(companyId, paymentMethodId, modifyPaymentMethodRequest);
    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 SettingsApi.ModifyPaymentMethodWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
companyId int The ID of the company.
paymentMethodId int The Referred Payment Method Id.
modifyPaymentMethodRequest ModifyPaymentMethodRequest [optional]

Return type

ModifyPaymentMethodResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Example response * 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]

ModifyVatType

ModifyVatTypeResponse ModifyVatType (int companyId, int vatTypeId, ModifyVatTypeRequest modifyVatTypeRequest = null)

Modify Vat Type

Modifies the specified vat 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 ModifyVatTypeExample
    {
        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 SettingsApi(config);
            var companyId = 12345;  // int | The ID of the company.
            var vatTypeId = 56;  // int | The Referred Vat Type Id.
            var modifyVatTypeRequest = new ModifyVatTypeRequest(); // ModifyVatTypeRequest |  (optional) 

            try
            {
                // Modify Vat Type
                ModifyVatTypeResponse result = apiInstance.ModifyVatType(companyId, vatTypeId, modifyVatTypeRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SettingsApi.ModifyVatType: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ModifyVatTypeWithHttpInfo variant

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

try
{
    // Modify Vat Type
    ApiResponse<ModifyVatTypeResponse> response = apiInstance.ModifyVatTypeWithHttpInfo(companyId, vatTypeId, modifyVatTypeRequest);
    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 SettingsApi.ModifyVatTypeWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
companyId int The ID of the company.
vatTypeId int The Referred Vat Type Id.
modifyVatTypeRequest ModifyVatTypeRequest [optional]

Return type

ModifyVatTypeResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Example response * 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]