Skip to content

Latest commit

 

History

History
334 lines (231 loc) · 12.1 KB

AccountingContactApi.md

File metadata and controls

334 lines (231 loc) · 12.1 KB
Raw

Itsmind\Sevdesk\AccountingContactApi

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

Method HTTP request Description
createAccountingContact() POST /AccountingContact Create a new accounting contact
deleteAccountingContact() DELETE /AccountingContact/{accountingContactId} Deletes an accounting contact
getAccountingContact() GET /AccountingContact Retrieve accounting contact
getAccountingContactById() GET /AccountingContact/{accountingContactId} Find accounting contact by ID
updateAccountingContact() PUT /AccountingContact/{accountingContactId} Update an existing accounting contact

createAccountingContact()

createAccountingContact($model_accounting_contact): \Itsmind\Sevdesk\Model\ModelAccountingContactResponse

Create a new accounting contact

Creates a new accounting contact.

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\AccountingContactApi(
    // 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_accounting_contact = new \Itsmind\Sevdesk\Model\ModelAccountingContact(); // \Itsmind\Sevdesk\Model\ModelAccountingContact | Creation data

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

Parameters

Name Type Description Notes
model_accounting_contact \Itsmind\Sevdesk\Model\ModelAccountingContact Creation data [optional]

Return type

\Itsmind\Sevdesk\Model\ModelAccountingContactResponse

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]

deleteAccountingContact()

deleteAccountingContact($accounting_contact_id): \Itsmind\Sevdesk\Model\DeleteCheckAccount200Response

Deletes an accounting contact

Attention, deleting an existing AccountingContact can lead to booking errors, especially in the DATEV export. Compatibility of sevDesk with DATEV is no longer guaranteed.

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\AccountingContactApi(
    // 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
);
$accounting_contact_id = 56; // int | Id of accounting contact resource to delete

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

Parameters

Name Type Description Notes
accounting_contact_id int Id of accounting contact resource 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]

getAccountingContact()

getAccountingContact($contact_id, $contact_object_name, $count_all, $offset, $limit, $embed): \Itsmind\Sevdesk\Model\GetAccountingContact200Response

Retrieve accounting contact

Returns all accounting contact which have been added up until now. Filters can be added.

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\AccountingContactApi(
    // 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
);
$contact_id = 'contact_id_example'; // string | ID of contact for which you want the accounting contact.
$contact_object_name = Contact; // string | Object name. Only needed if you also defined the ID of a contact.
$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->getAccountingContact($contact_id, $contact_object_name, $count_all, $offset, $limit, $embed);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountingContactApi->getAccountingContact: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
contact_id string ID of contact for which you want the accounting contact. [optional]
contact_object_name string Object name. Only needed if you also defined the ID of a contact. [optional] [default to 'Contact']
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\GetAccountingContact200Response

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]

getAccountingContactById()

getAccountingContactById($accounting_contact_id): \Itsmind\Sevdesk\Model\GetAccountingContactById200Response

Find accounting contact by ID

Returns a single accounting contac

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\AccountingContactApi(
    // 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
);
$accounting_contact_id = 56; // int | ID of accounting contact to return

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

Parameters

Name Type Description Notes
accounting_contact_id int ID of accounting contact to return

Return type

\Itsmind\Sevdesk\Model\GetAccountingContactById200Response

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]

updateAccountingContact()

updateAccountingContact($accounting_contact_id, $model_accounting_contact_update): \Itsmind\Sevdesk\Model\ModelAccountingContactResponse

Update an existing accounting contact

Attention, updating an existing AccountingContact can lead to booking errors, especially in the DATEV export. Compatibility of sevDesk with DATEV is no longer guaranteed.

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\AccountingContactApi(
    // 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
);
$accounting_contact_id = 56; // int | ID of accounting contact to update
$model_accounting_contact_update = new \Itsmind\Sevdesk\Model\ModelAccountingContactUpdate(); // \Itsmind\Sevdesk\Model\ModelAccountingContactUpdate | Update data

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

Parameters

Name Type Description Notes
accounting_contact_id int ID of accounting contact to update
model_accounting_contact_update \Itsmind\Sevdesk\Model\ModelAccountingContactUpdate Update data [optional]

Return type

\Itsmind\Sevdesk\Model\ModelAccountingContactResponse

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]