Skip to content

Latest commit

 

History

History
300 lines (223 loc) · 12.7 KB

CheckAccountTransactionApi.md

File metadata and controls

300 lines (223 loc) · 12.7 KB

Swagger\Client\CheckAccountTransactionApi

All URIs are relative to https://my.sevdesk.de/api/v1

Method HTTP request Description
createTransaction POST /CheckAccountTransaction Create a new transaction
deleteCheckAccountTransaction DELETE /CheckAccountTransaction/{checkAccountTransactionId} Deletes a check account transaction
getCheckAccountTransactionById GET /CheckAccountTransaction/{checkAccountTransactionId} Find check account transaction by ID
getTransactions GET /CheckAccountTransaction Retrieve transactions
updateCheckAccountTransaction PUT /CheckAccountTransaction/{checkAccountTransactionId} Update an existing check account transaction

createTransaction

\Swagger\Client\Model\InlineResponse2004 createTransaction($body)

Create a new transaction

Creates a new transaction on a check account.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\CheckAccountTransactionApi(
    // 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
);
$body = new \Swagger\Client\Model\ModelCheckAccountTransaction(); // \Swagger\Client\Model\ModelCheckAccountTransaction | Creation data. Please be aware, that you need to provide at least all required parameter
    of the CheckAccountTransaction model!

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

Parameters

Name Type Description Notes
body \Swagger\Client\Model\ModelCheckAccountTransaction Creation data. Please be aware, that you need to provide at least all required parameter 
of the CheckAccountTransaction model! | [optional]

Return type

\Swagger\Client\Model\InlineResponse2004

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]

deleteCheckAccountTransaction

\Swagger\Client\Model\InlineResponse2003 deleteCheckAccountTransaction($check_account_transaction_id)

Deletes a check account transaction

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\CheckAccountTransactionApi(
    // 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_transaction_id = 56; // int | Id of check account transaction to delete

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

Parameters

Name Type Description Notes
check_account_transaction_id int Id of check account transaction to delete

Return type

\Swagger\Client\Model\InlineResponse2003

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]

getCheckAccountTransactionById

\Swagger\Client\Model\InlineResponse2004 getCheckAccountTransactionById($check_account_transaction_id)

Find check account transaction by ID

Retrieve an existing check account transaction

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\CheckAccountTransactionApi(
    // 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_transaction_id = 56; // int | ID of check account transaction

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

Parameters

Name Type Description Notes
check_account_transaction_id int ID of check account transaction

Return type

\Swagger\Client\Model\InlineResponse2004

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]

getTransactions

\Swagger\Client\Model\InlineResponse2004 getTransactions($check_account_id, $check_account_object_name, $is_booked, $paymt_purpose, $start_date, $end_date, $payee_payer_name, $only_credit, $only_debit)

Retrieve transactions

Retrieve all transactions depending on the filters defined in the query.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\CheckAccountTransactionApi(
    // 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 | Retrieve all transactions on this check account. Must be provided with checkAccount[objectName]
$check_account_object_name = "check_account_object_name_example"; // string | Only required if checkAccount[id] was provided. 'CheckAccount' should be used as value.
$is_booked = true; // bool | Only retrieve booked transactions
$paymt_purpose = "paymt_purpose_example"; // string | Only retrieve transactions with this payment purpose
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Only retrieve transactions from this date on
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Only retrieve transactions up to this date
$payee_payer_name = "payee_payer_name_example"; // string | Only retrieve transactions with this payee / payer
$only_credit = true; // bool | Only retrieve credit transactions
$only_debit = true; // bool | Only retrieve debit transactions

try {
    $result = $apiInstance->getTransactions($check_account_id, $check_account_object_name, $is_booked, $paymt_purpose, $start_date, $end_date, $payee_payer_name, $only_credit, $only_debit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckAccountTransactionApi->getTransactions: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
check_account_id int Retrieve all transactions on this check account. Must be provided with checkAccount[objectName] [optional]
check_account_object_name string Only required if checkAccount[id] was provided. 'CheckAccount' should be used as value. [optional]
is_booked bool Only retrieve booked transactions [optional]
paymt_purpose string Only retrieve transactions with this payment purpose [optional]
start_date \DateTime Only retrieve transactions from this date on [optional]
end_date \DateTime Only retrieve transactions up to this date [optional]
payee_payer_name string Only retrieve transactions with this payee / payer [optional]
only_credit bool Only retrieve credit transactions [optional]
only_debit bool Only retrieve debit transactions [optional]

Return type

\Swagger\Client\Model\InlineResponse2004

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]

updateCheckAccountTransaction

\Swagger\Client\Model\InlineResponse2004 updateCheckAccountTransaction($check_account_transaction_id, $body)

Update an existing check account transaction

Update a check account transaction

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\CheckAccountTransactionApi(
    // 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_transaction_id = 56; // int | ID of check account to update transaction
$body = new \Swagger\Client\Model\ModelCheckAccountTransactionUpdate(); // \Swagger\Client\Model\ModelCheckAccountTransactionUpdate | Update data

try {
    $result = $apiInstance->updateCheckAccountTransaction($check_account_transaction_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckAccountTransactionApi->updateCheckAccountTransaction: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
check_account_transaction_id int ID of check account to update transaction
body \Swagger\Client\Model\ModelCheckAccountTransactionUpdate Update data [optional]

Return type

\Swagger\Client\Model\InlineResponse2004

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]