Skip to content

Latest commit

 

History

History
335 lines (232 loc) · 10.8 KB

CashbookApi.md

File metadata and controls

335 lines (232 loc) · 10.8 KB

FattureInCloud\CashbookApi

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

Method HTTP request Description
createCashbookEntry() POST /c/{company_id}/cashbook Create Cashbook Entry
deleteCashbookEntry() DELETE /c/{company_id}/cashbook/{document_id} Delete Cashbook Entry
getCashbookEntry() GET /c/{company_id}/cashbook/{document_id} Get Cashbook Entry
listCashbookEntries() GET /c/{company_id}/cashbook List Cashbook Entries
modifyCashbookEntry() PUT /c/{company_id}/cashbook/{document_id} Modify Cashbook Entry

createCashbookEntry()

createCashbookEntry($company_id, $create_cashbook_entry_request): \FattureInCloud\Model\CreateCashbookEntryResponse

Create Cashbook Entry

Creates a new cashbook entry.

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\CashbookApi(
    // 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_cashbook_entry_request = new \FattureInCloud\Model\CreateCashbookEntryRequest; // \FattureInCloud\Model\CreateCashbookEntryRequest | Cashbook entry.

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

Parameters

Name Type Description Notes
company_id int The ID of the company.
create_cashbook_entry_request \FattureInCloud\Model\CreateCashbookEntryRequest Cashbook entry. [optional]

Return type

\FattureInCloud\Model\CreateCashbookEntryResponse

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]

deleteCashbookEntry()

deleteCashbookEntry($company_id, $document_id)

Delete Cashbook Entry

Deletes the specified cashbook entry.

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\CashbookApi(
    // 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.
$document_id = 'document_id_example'; // string | The ID of the document.

try {
    $apiInstance->deleteCashbookEntry($company_id, $document_id);
} catch (Exception $e) {
    echo 'Exception when calling CashbookApi->deleteCashbookEntry: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

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]

getCashbookEntry()

getCashbookEntry($company_id, $document_id, $fields, $fieldset): \FattureInCloud\Model\GetCashbookEntryResponse

Get Cashbook Entry

Gets the specified cashbook entry.

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\CashbookApi(
    // 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.
$document_id = 'document_id_example'; // string | The ID of the document.
$fields = 'fields_example'; // string | List of comma-separated fields.
$fieldset = 'fieldset_example'; // string | Name of the fieldset.

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

Parameters

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

Return type

\FattureInCloud\Model\GetCashbookEntryResponse

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]

listCashbookEntries()

listCashbookEntries($company_id, $date_from, $date_to, $year, $type, $payment_account_id): \FattureInCloud\Model\ListCashbookEntriesResponse

List Cashbook Entries

Lists the cashbook entries.

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\CashbookApi(
    // 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.
$date_from = 'date_from_example'; // string | Start date.
$date_to = 'date_to_example'; // string | End date.
$year = 56; // int | Filter cashbook by year.
$type = 'type_example'; // string | Filter cashbook by type.
$payment_account_id = 56; // int | Filter by payment account.

try {
    $result = $apiInstance->listCashbookEntries($company_id, $date_from, $date_to, $year, $type, $payment_account_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CashbookApi->listCashbookEntries: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
company_id int The ID of the company.
date_from string Start date.
date_to string End date.
year int Filter cashbook by year. [optional]
type string Filter cashbook by type. [optional]
payment_account_id int Filter by payment account. [optional]

Return type

\FattureInCloud\Model\ListCashbookEntriesResponse

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]

modifyCashbookEntry()

modifyCashbookEntry($company_id, $document_id, $modify_cashbook_entry_request): \FattureInCloud\Model\ModifyCashbookEntryResponse

Modify Cashbook Entry

Modifies the specified cashbook entry.

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\CashbookApi(
    // 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.
$document_id = 'document_id_example'; // string | The ID of the document.
$modify_cashbook_entry_request = new \FattureInCloud\Model\ModifyCashbookEntryRequest; // \FattureInCloud\Model\ModifyCashbookEntryRequest | Cashbook Entry

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

Parameters

Name Type Description Notes
company_id int The ID of the company.
document_id string The ID of the document.
modify_cashbook_entry_request \FattureInCloud\Model\ModifyCashbookEntryRequest Cashbook Entry [optional]

Return type

\FattureInCloud\Model\ModifyCashbookEntryResponse

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]