Itsmind\Sevdesk\CheckAccountApi

All URIs are relative to https://my.sevdesk.de/api/v1, except if the operation defines another base path.

Method	HTTP request	Description
createCheckAccount()	POST /CheckAccount	Create a new check account
deleteCheckAccount()	DELETE /CheckAccount/{checkAccountId}	Deletes a check account
getBalanceAtDate()	GET /CheckAccount/{checkAccountId}/getBalanceAtDate	Get the balance at a given date
getCheckAccountById()	GET /CheckAccount/{checkAccountId}	Find check account by ID
getCheckAccounts()	GET /CheckAccount	Retrieve check accounts
updateCheckAccount()	PUT /CheckAccount/{checkAccountId}	Update an existing check account

`createCheckAccount()`

createCheckAccount($model_check_account): \Itsmind\Sevdesk\Model\CreateCheckAccount201Response

Create a new check account

Creates a new banking account on which transactions can be created.

Example

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


// Configure API key authorization: api_key
$config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Itsmind\Sevdesk\Api\CheckAccountApi(
    // 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
);
$model_check_account = new \Itsmind\Sevdesk\Model\ModelCheckAccount(); // \Itsmind\Sevdesk\Model\ModelCheckAccount | Creation data. Please be aware, that you need to provide at least all required parameter      of the CheckAccount model!

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

Parameters

Name	Type	Description	Notes
model_check_account	\Itsmind\Sevdesk\Model\ModelCheckAccount	Creation data. Please be aware, that you need to provide at least all required parameter of the CheckAccount model!	[optional]

Return type

\Itsmind\Sevdesk\Model\CreateCheckAccount201Response

Authorization

api_key

HTTP request headers

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

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

`deleteCheckAccount()`

deleteCheckAccount($check_account_id): \Itsmind\Sevdesk\Model\DeleteCheckAccount200Response

Deletes a check account

Example

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


// Configure API key authorization: api_key
$config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Itsmind\Sevdesk\Api\CheckAccountApi(
    // 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
);
$check_account_id = 56; // int | Id of check account to delete

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

Parameters

Name	Type	Description	Notes
check_account_id	int	Id of check account to delete

Return type

\Itsmind\Sevdesk\Model\DeleteCheckAccount200Response

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getBalanceAtDate()`

getBalanceAtDate($check_account_id, $date): \Itsmind\Sevdesk\Model\GetBalanceAtDate200Response

Get the balance at a given date

Get the balance, calculated as the sum of all transactions sevDesk knows, up to and including the given date. Note that this balance does not have to be the actual bank account balance, e.g. if sevDesk did not import old transactions.

Example

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


// Configure API key authorization: api_key
$config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Itsmind\Sevdesk\Api\CheckAccountApi(
    // 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
);
$check_account_id = 56; // int | ID of check account
$date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Only consider transactions up to this date at 23:59:59

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

Parameters

Name	Type	Description	Notes
check_account_id	int	ID of check account
date	\DateTime	Only consider transactions up to this date at 23:59:59

Return type

\Itsmind\Sevdesk\Model\GetBalanceAtDate200Response

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getCheckAccountById()`

getCheckAccountById($check_account_id): \Itsmind\Sevdesk\Model\CreateCheckAccount201Response

Find check account by ID

Retrieve an existing check account

Example

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


// Configure API key authorization: api_key
$config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Itsmind\Sevdesk\Api\CheckAccountApi(
    // 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
);
$check_account_id = 56; // int | ID of check account

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

Parameters

Name	Type	Description	Notes
check_account_id	int	ID of check account

Return type

\Itsmind\Sevdesk\Model\CreateCheckAccount201Response

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getCheckAccounts()`

getCheckAccounts($count_all, $offset, $limit, $embed): \Itsmind\Sevdesk\Model\GetCheckAccounts200Response

Retrieve check accounts

Retrieve all check accounts

Example

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


// Configure API key authorization: api_key
$config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Itsmind\Sevdesk\Api\CheckAccountApi(
    // 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
);
$count_all = True; // bool | If all objects should be counted
$offset = 56; // int | Which offset to start with
$limit = 56; // int | The max number of objects to return
$embed = array('embed_example'); // string[] | Get some additional information. Embed can handle multiple values, they must be separated by comma.

try {
    $result = $apiInstance->getCheckAccounts($count_all, $offset, $limit, $embed);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckAccountApi->getCheckAccounts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
count_all	bool	If all objects should be counted	[optional]
offset	int	Which offset to start with	[optional]
limit	int	The max number of objects to return	[optional]
embed	string[]	Get some additional information. Embed can handle multiple values, they must be separated by comma.	[optional]

Return type

\Itsmind\Sevdesk\Model\GetCheckAccounts200Response

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`updateCheckAccount()`

updateCheckAccount($check_account_id, $model_check_account_update): \Itsmind\Sevdesk\Model\ModelCheckAccountResponse

Update an existing check account

Update a check account

Example

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


// Configure API key authorization: api_key
$config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Itsmind\Sevdesk\Api\CheckAccountApi(
    // 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
);
$check_account_id = 56; // int | ID of check account to update
$model_check_account_update = new \Itsmind\Sevdesk\Model\ModelCheckAccountUpdate(); // \Itsmind\Sevdesk\Model\ModelCheckAccountUpdate | Update data

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

Parameters

Name	Type	Description	Notes
check_account_id	int	ID of check account to update
model_check_account_update	\Itsmind\Sevdesk\Model\ModelCheckAccountUpdate	Update data	[optional]

Return type

\Itsmind\Sevdesk\Model\ModelCheckAccountResponse

Authorization

api_key

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

CheckAccountApi.md

Latest commit

History

CheckAccountApi.md

File metadata and controls

Itsmind\Sevdesk\CheckAccountApi

createCheckAccount()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteCheckAccount()

Example

Parameters

Return type

Authorization

HTTP request headers

getBalanceAtDate()

Example

Parameters

Return type

Authorization

HTTP request headers

getCheckAccountById()

Example

Parameters

Return type

Authorization

HTTP request headers

getCheckAccounts()

Example

Parameters

Return type

Authorization

HTTP request headers

updateCheckAccount()

Example

Parameters

Return type

Authorization

HTTP request headers

`createCheckAccount()`

`deleteCheckAccount()`

`getBalanceAtDate()`

`getCheckAccountById()`

`getCheckAccounts()`

`updateCheckAccount()`