Skip to content

Latest commit

 

History

History
985 lines (662 loc) · 28 KB

InfoApi.md

File metadata and controls

985 lines (662 loc) · 28 KB

FattureInCloud\InfoApi

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

Method HTTP request Description
listArchiveCategories() GET /c/{company_id}/info/archive_categories List Archive Categories
listCities() GET /info/cities List Cities
listCostCenters() GET /c/{company_id}/info/cost_centers List Cost Centers
listCountries() GET /info/countries List Countries
listCurrencies() GET /info/currencies List Currencies
listDeliveryNotesDefaultCausals() GET /info/dn_causals List Delivery Notes Default Causals
listDetailedCountries() GET /info/detailed_countries List Detailed Countries
listLanguages() GET /info/languages List Languages
listPaymentAccounts() GET /c/{company_id}/info/payment_accounts List Payment Accounts
listPaymentMethods() GET /c/{company_id}/info/payment_methods List Payment Methods
listProductCategories() GET /c/{company_id}/info/product_categories List Product Categories
listReceivedDocumentCategories() GET /c/{company_id}/info/received_document_categories List Received Document Categories
listRevenueCenters() GET /c/{company_id}/info/revenue_centers List Revenue Centers
listTemplates() GET /info/templates List Templates
listUnitsOfMeasure() GET /info/measures List Units of Measure
listVatTypes() GET /c/{company_id}/info/vat_types List Vat Types

listArchiveCategories()

listArchiveCategories($company_id): \FattureInCloud\Model\ListArchiveCategoriesResponse

List Archive Categories

Lists the archive categories.

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\InfoApi(
    // 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->listArchiveCategories($company_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InfoApi->listArchiveCategories: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

\FattureInCloud\Model\ListArchiveCategoriesResponse

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]

listCities()

listCities($postal_code, $city): \FattureInCloud\Model\ListCitiesResponse

List Cities

Lists the Italian cities.

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\InfoApi(
    // 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
);
$postal_code = 'postal_code_example'; // string | Postal code for filtering.
$city = 'city_example'; // string | City for filtering (ignored if postal_code is passed).

try {
    $result = $apiInstance->listCities($postal_code, $city);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InfoApi->listCities: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
postal_code string Postal code for filtering. [optional]
city string City for filtering (ignored if postal_code is passed). [optional]

Return type

\FattureInCloud\Model\ListCitiesResponse

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]

listCostCenters()

listCostCenters($company_id): \FattureInCloud\Model\ListCostCentersResponse

List Cost Centers

Lists the cost centers.

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\InfoApi(
    // 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->listCostCenters($company_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InfoApi->listCostCenters: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

\FattureInCloud\Model\ListCostCentersResponse

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]

listCountries()

listCountries(): \FattureInCloud\Model\ListCountriesResponse

List Countries

Lists the supported countries.

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\InfoApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\FattureInCloud\Model\ListCountriesResponse

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]

listCurrencies()

listCurrencies(): \FattureInCloud\Model\ListCurrenciesResponse

List Currencies

Lists the supported currencies.

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\InfoApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\FattureInCloud\Model\ListCurrenciesResponse

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]

listDeliveryNotesDefaultCausals()

listDeliveryNotesDefaultCausals(): \FattureInCloud\Model\ListDeliveryNotesDefaultCausalsResponse

List Delivery Notes Default Causals

Lists the delivery note default causals.

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\InfoApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\FattureInCloud\Model\ListDeliveryNotesDefaultCausalsResponse

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]

listDetailedCountries()

listDetailedCountries(): \FattureInCloud\Model\ListDetailedCountriesResponse

List Detailed Countries

Lists the supported countries.

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\InfoApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\FattureInCloud\Model\ListDetailedCountriesResponse

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]

listLanguages()

listLanguages(): \FattureInCloud\Model\ListLanguagesResponse

List Languages

Lists the supported languages.

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\InfoApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\FattureInCloud\Model\ListLanguagesResponse

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]

listPaymentAccounts()

listPaymentAccounts($company_id, $fields, $fieldset, $sort): \FattureInCloud\Model\ListPaymentAccountsResponse

List Payment Accounts

Lists the available payment accounts.

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\InfoApi(
    // 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.
$fields = 'fields_example'; // string | List of comma-separated fields.
$fieldset = 'fieldset_example'; // string | Name of the fieldset.
$sort = 'sort_example'; // string | List of comma-separated fields for result sorting (minus for desc sorting).

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

Parameters

Name Type Description Notes
company_id int The ID of the company.
fields string List of comma-separated fields. [optional]
fieldset string Name of the fieldset. [optional]
sort string List of comma-separated fields for result sorting (minus for desc sorting). [optional]

Return type

\FattureInCloud\Model\ListPaymentAccountsResponse

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]

listPaymentMethods()

listPaymentMethods($company_id, $fields, $fieldset, $sort): \FattureInCloud\Model\ListPaymentMethodsResponse

List Payment Methods

Lists the available payment methods.

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\InfoApi(
    // 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.
$fields = 'fields_example'; // string | List of comma-separated fields.
$fieldset = 'fieldset_example'; // string | Name of the fieldset.
$sort = 'sort_example'; // string | List of comma-separated fields for result sorting (minus for desc sorting).

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

Parameters

Name Type Description Notes
company_id int The ID of the company.
fields string List of comma-separated fields. [optional]
fieldset string Name of the fieldset. [optional]
sort string List of comma-separated fields for result sorting (minus for desc sorting). [optional]

Return type

\FattureInCloud\Model\ListPaymentMethodsResponse

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]

listProductCategories()

listProductCategories($company_id, $context): \FattureInCloud\Model\ListProductCategoriesResponse

List Product Categories

Lists the product categories.

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\InfoApi(
    // 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.
$context = 'context_example'; // string | Categories resource type.

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

Parameters

Name Type Description Notes
company_id int The ID of the company.
context string Categories resource type.

Return type

\FattureInCloud\Model\ListProductCategoriesResponse

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]

listReceivedDocumentCategories()

listReceivedDocumentCategories($company_id): \FattureInCloud\Model\ListReceivedDocumentCategoriesResponse

List Received Document Categories

Lists the received document categories.

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\InfoApi(
    // 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->listReceivedDocumentCategories($company_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InfoApi->listReceivedDocumentCategories: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

\FattureInCloud\Model\ListReceivedDocumentCategoriesResponse

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]

listRevenueCenters()

listRevenueCenters($company_id): \FattureInCloud\Model\ListRevenueCentersResponse

List Revenue Centers

Lists the revenue centers.

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\InfoApi(
    // 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->listRevenueCenters($company_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InfoApi->listRevenueCenters: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

\FattureInCloud\Model\ListRevenueCentersResponse

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]

listTemplates()

listTemplates($type, $by_type): \FattureInCloud\Model\ListTemplatesResponse

List Templates

Lists the available templates.

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\InfoApi(
    // 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
);
$type = 'all'; // string | Type of the templates.
$by_type = false; // bool | [Only if type=all] If true, splits the list in objects, grouping templates by type.

try {
    $result = $apiInstance->listTemplates($type, $by_type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InfoApi->listTemplates: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
type string Type of the templates. [optional] [default to 'all']
by_type bool [Only if type=all] If true, splits the list in objects, grouping templates by type. [optional] [default to false]

Return type

\FattureInCloud\Model\ListTemplatesResponse

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]

listUnitsOfMeasure()

listUnitsOfMeasure(): \FattureInCloud\Model\ListUnitsOfMeasureResponse

List Units of Measure

Lists the units of measure.

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\InfoApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\FattureInCloud\Model\ListUnitsOfMeasureResponse

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]

listVatTypes()

listVatTypes($company_id, $fieldset): \FattureInCloud\Model\ListVatTypesResponse

List Vat Types

Lists the available vat types.

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\InfoApi(
    // 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.
$fieldset = 'fieldset_example'; // string | Name of the fieldset.

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

Parameters

Name Type Description Notes
company_id int The ID of the company.
fieldset string Name of the fieldset. [optional]

Return type

\FattureInCloud\Model\ListVatTypesResponse

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]