FattureInCloud\SettingsApi

All URIs are relative to https://api-v2.fattureincloud.it, except if the operation defines another base path.

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
getVatType()	GET /c/{company_id}/settings/vat_types/{vat_type_id}	Get Vat Type
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()`

createPaymentAccount($company_id, $create_payment_account_request): \FattureInCloud\Model\CreatePaymentAccountResponse

Create Payment Account

Creates a new payment account.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
$config = FattureInCloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new FattureInCloud\Api\SettingsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$company_id = 12345; // int | The ID of the company.
$create_payment_account_request = new \FattureInCloud\Model\CreatePaymentAccountRequest; // \FattureInCloud\Model\CreatePaymentAccountRequest

try {
    $result = $apiInstance->createPaymentAccount($company_id, $create_payment_account_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SettingsApi->createPaymentAccount: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
company_id	int	The ID of the company.
create_payment_account_request	\FattureInCloud\Model\CreatePaymentAccountRequest		[optional]

Return type

\FattureInCloud\Model\CreatePaymentAccountResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

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

`createPaymentMethod()`

createPaymentMethod($company_id, $create_payment_method_request): \FattureInCloud\Model\CreatePaymentMethodResponse

Create Payment Method

Creates a new payment method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
$config = FattureInCloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new FattureInCloud\Api\SettingsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$company_id = 12345; // int | The ID of the company.
$create_payment_method_request = new \FattureInCloud\Model\CreatePaymentMethodRequest; // \FattureInCloud\Model\CreatePaymentMethodRequest

try {
    $result = $apiInstance->createPaymentMethod($company_id, $create_payment_method_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SettingsApi->createPaymentMethod: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
company_id	int	The ID of the company.
create_payment_method_request	\FattureInCloud\Model\CreatePaymentMethodRequest		[optional]

Return type

\FattureInCloud\Model\CreatePaymentMethodResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

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

`createVatType()`

createVatType($company_id, $create_vat_type_request): \FattureInCloud\Model\CreateVatTypeResponse

Create Vat Type

Creates a vat type.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
$config = FattureInCloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new FattureInCloud\Api\SettingsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$company_id = 12345; // int | The ID of the company.
$create_vat_type_request = new \FattureInCloud\Model\CreateVatTypeRequest; // \FattureInCloud\Model\CreateVatTypeRequest | 

try {
    $result = $apiInstance->createVatType($company_id, $create_vat_type_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SettingsApi->createVatType: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
company_id	int	The ID of the company.
create_vat_type_request	\FattureInCloud\Model\CreateVatTypeRequest		[optional]

Return type

\FattureInCloud\Model\CreateVatTypeResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

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

`deletePaymentAccount()`

deletePaymentAccount($company_id, $payment_account_id)

Delete Payment Account

Deletes the specified payment account.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
$config = FattureInCloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new FattureInCloud\Api\SettingsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$company_id = 12345; // int | The ID of the company.
$payment_account_id = 56; // int | The Referred Payment Account Id.

try {
    $apiInstance->deletePaymentAccount($company_id, $payment_account_id);
} catch (Exception $e) {
    echo 'Exception when calling SettingsApi->deletePaymentAccount: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
company_id	int	The ID of the company.
payment_account_id	int	The Referred Payment Account Id.

Return type

void (empty response body)

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`deletePaymentMethod()`

deletePaymentMethod($company_id, $payment_method_id)

Delete Payment Method

Deletes the specified payment method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
$config = FattureInCloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new FattureInCloud\Api\SettingsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$company_id = 12345; // int | The ID of the company.
$payment_method_id = 56; // int | The Referred Payment Method Id.

try {
    $apiInstance->deletePaymentMethod($company_id, $payment_method_id);
} catch (Exception $e) {
    echo 'Exception when calling SettingsApi->deletePaymentMethod: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
company_id	int	The ID of the company.
payment_method_id	int	The Referred Payment Method Id.

Return type

void (empty response body)

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`deleteVatType()`

deleteVatType($company_id, $vat_type_id)

Delete Vat Type

Deletes the specified vat type.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
$config = FattureInCloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new FattureInCloud\Api\SettingsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$company_id = 12345; // int | The ID of the company.
$vat_type_id = 56; // int | The Referred Vat Type Id.

try {
    $apiInstance->deleteVatType($company_id, $vat_type_id);
} catch (Exception $e) {
    echo 'Exception when calling SettingsApi->deleteVatType: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
company_id	int	The ID of the company.
vat_type_id	int	The Referred Vat Type Id.

Return type

void (empty response body)

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`getPaymentAccount()`

getPaymentAccount($company_id, $payment_account_id, $fields, $fieldset): \FattureInCloud\Model\GetPaymentAccountResponse

Get Payment Account

Gets the specified payment account.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
$config = FattureInCloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new FattureInCloud\Api\SettingsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$company_id = 12345; // int | The ID of the company.
$payment_account_id = 56; // int | The Referred Payment Account Id.
$fields = 'fields_example'; // string | List of comma-separated fields.
$fieldset = 'fieldset_example'; // string | Name of the fieldset.

try {
    $result = $apiInstance->getPaymentAccount($company_id, $payment_account_id, $fields, $fieldset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SettingsApi->getPaymentAccount: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

\FattureInCloud\Model\GetPaymentAccountResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getPaymentMethod()`

getPaymentMethod($company_id, $payment_method_id, $fields, $fieldset): \FattureInCloud\Model\GetPaymentMethodResponse

Get Payment Method

Gets the specified payment method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
$config = FattureInCloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new FattureInCloud\Api\SettingsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$company_id = 12345; // int | The ID of the company.
$payment_method_id = 56; // int | The Referred Payment Method Id.
$fields = 'fields_example'; // string | List of comma-separated fields.
$fieldset = 'fieldset_example'; // string | Name of the fieldset.

try {
    $result = $apiInstance->getPaymentMethod($company_id, $payment_method_id, $fields, $fieldset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SettingsApi->getPaymentMethod: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

\FattureInCloud\Model\GetPaymentMethodResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getTaxProfile()`

getTaxProfile($company_id): \FattureInCloud\Model\GetTaxProfileResponse

Get Tax Profile

Gets the Tax Profile

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
$config = FattureInCloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new FattureInCloud\Api\SettingsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$company_id = 12345; // int | The ID of the company.

try {
    $result = $apiInstance->getTaxProfile($company_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SettingsApi->getTaxProfile: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

\FattureInCloud\Model\GetTaxProfileResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getVatType()`

getVatType($company_id, $vat_type_id): \FattureInCloud\Model\GetVatTypeResponse

Get Vat Type

Gets the specified vat type.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
$config = FattureInCloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new FattureInCloud\Api\SettingsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$company_id = 12345; // int | The ID of the company.
$vat_type_id = 56; // int | The Referred Vat Type Id.

try {
    $result = $apiInstance->getVatType($company_id, $vat_type_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SettingsApi->getVatType: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
company_id	int	The ID of the company.
vat_type_id	int	The Referred Vat Type Id.

Return type

\FattureInCloud\Model\GetVatTypeResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`modifyPaymentAccount()`

modifyPaymentAccount($company_id, $payment_account_id, $modify_payment_account_request): \FattureInCloud\Model\ModifyPaymentAccountResponse

Modify Payment Account

Modifies the specified payment account.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
$config = FattureInCloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new FattureInCloud\Api\SettingsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$company_id = 12345; // int | The ID of the company.
$payment_account_id = 56; // int | The Referred Payment Account Id.
$modify_payment_account_request = new \FattureInCloud\Model\ModifyPaymentAccountRequest; // \FattureInCloud\Model\ModifyPaymentAccountRequest

try {
    $result = $apiInstance->modifyPaymentAccount($company_id, $payment_account_id, $modify_payment_account_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SettingsApi->modifyPaymentAccount: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
company_id	int	The ID of the company.
payment_account_id	int	The Referred Payment Account Id.
modify_payment_account_request	\FattureInCloud\Model\ModifyPaymentAccountRequest		[optional]

Return type

\FattureInCloud\Model\ModifyPaymentAccountResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

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

`modifyPaymentMethod()`

modifyPaymentMethod($company_id, $payment_method_id, $modify_payment_method_request): \FattureInCloud\Model\ModifyPaymentMethodResponse

Modify Payment Method

Modifies the specified payment method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
$config = FattureInCloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new FattureInCloud\Api\SettingsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$company_id = 12345; // int | The ID of the company.
$payment_method_id = 56; // int | The Referred Payment Method Id.
$modify_payment_method_request = new \FattureInCloud\Model\ModifyPaymentMethodRequest; // \FattureInCloud\Model\ModifyPaymentMethodRequest | 

try {
    $result = $apiInstance->modifyPaymentMethod($company_id, $payment_method_id, $modify_payment_method_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SettingsApi->modifyPaymentMethod: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
company_id	int	The ID of the company.
payment_method_id	int	The Referred Payment Method Id.
modify_payment_method_request	\FattureInCloud\Model\ModifyPaymentMethodRequest		[optional]

Return type

\FattureInCloud\Model\ModifyPaymentMethodResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

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

`modifyVatType()`

modifyVatType($company_id, $vat_type_id, $modify_vat_type_request): \FattureInCloud\Model\ModifyVatTypeResponse

Modify Vat Type

Modifies the specified vat type.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
$config = FattureInCloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new FattureInCloud\Api\SettingsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$company_id = 12345; // int | The ID of the company.
$vat_type_id = 56; // int | The Referred Vat Type Id.
$modify_vat_type_request = new \FattureInCloud\Model\ModifyVatTypeRequest; // \FattureInCloud\Model\ModifyVatTypeRequest

try {
    $result = $apiInstance->modifyVatType($company_id, $vat_type_id, $modify_vat_type_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SettingsApi->modifyVatType: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
company_id	int	The ID of the company.
vat_type_id	int	The Referred Vat Type Id.
modify_vat_type_request	\FattureInCloud\Model\ModifyVatTypeRequest		[optional]

Return type

\FattureInCloud\Model\ModifyVatTypeResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

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

Files

SettingsApi.md

Latest commit

History

SettingsApi.md

File metadata and controls

FattureInCloud\SettingsApi

createPaymentAccount()

Example

Parameters

Return type

Authorization

HTTP request headers

createPaymentMethod()

Example

Parameters

Return type

Authorization

HTTP request headers

createVatType()

Example

Parameters

Return type

Authorization

HTTP request headers

deletePaymentAccount()

Example

Parameters

Return type

Authorization

HTTP request headers

deletePaymentMethod()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteVatType()

Example

Parameters

Return type

Authorization

HTTP request headers

getPaymentAccount()

Example

Parameters

Return type

Authorization

HTTP request headers

getPaymentMethod()

Example

Parameters

Return type

Authorization

HTTP request headers

getTaxProfile()

Example

Parameters

Return type

Authorization

HTTP request headers

getVatType()

Example

Parameters

Return type

Authorization

HTTP request headers

modifyPaymentAccount()

Example

Parameters

Return type

Authorization

HTTP request headers

modifyPaymentMethod()

Example

Parameters

Return type

Authorization

HTTP request headers

modifyVatType()

`createPaymentAccount()`

`createPaymentMethod()`

`createVatType()`

`deletePaymentAccount()`

`deletePaymentMethod()`

`deleteVatType()`

`getPaymentAccount()`

`getPaymentMethod()`

`getTaxProfile()`

`getVatType()`

`modifyPaymentAccount()`

`modifyPaymentMethod()`

`modifyVatType()`