Itsmind\Sevdesk\ExportApi

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

Method	HTTP request	Description
exportContact()	GET /Export/contactListCsv	Export contact
exportCreditNote()	GET /Export/creditNoteCsv	Export creditNote
exportDatev()	GET /Export/datevCSV	Export datev
exportInvoice()	GET /Export/invoiceCsv	Export invoice
exportInvoiceZip()	GET /Export/invoiceZip	Export Invoice as zip
exportTransactions()	GET /Export/transactionsCsv	Export transaction
exportVoucher()	GET /Export/voucherListCsv	Export voucher as zip
exportVoucherZip()	GET /Export/voucherZip	Export voucher zip
updateExportConfig()	PUT /SevClient/{SevClientId}/updateExportConfig	Update export config

`exportContact()`

exportContact($sev_query, $download): \Itsmind\Sevdesk\Model\ExportContact200Response

Export contact

Contact export as csv

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\ExportApi(
    // 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
);
$sev_query = new \Itsmind\Sevdesk\Model\ExportContactSevQueryParameter(); // ExportContactSevQueryParameter
$download = True; // bool

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

Parameters

Name	Type	Description	Notes
sev_query	ExportContactSevQueryParameter
download	bool		[optional]

Return type

\Itsmind\Sevdesk\Model\ExportContact200Response

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]

`exportCreditNote()`

exportCreditNote($sev_query, $download): \Itsmind\Sevdesk\Model\ExportCreditNote200Response

Export creditNote

Export all credit notes as csv

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\ExportApi(
    // 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
);
$sev_query = new \Itsmind\Sevdesk\Model\ExportCreditNoteSevQueryParameter(); // ExportCreditNoteSevQueryParameter
$download = True; // bool

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

Parameters

Name	Type	Description	Notes
sev_query	ExportCreditNoteSevQueryParameter
download	bool		[optional]

Return type

\Itsmind\Sevdesk\Model\ExportCreditNote200Response

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]

`exportDatev()`

exportDatev($start_date, $end_date, $scope, $download, $with_unpaid_documents, $with_enshrined_documents, $enshrine): object

Export datev

Datev export as zip with csv´s. Before you can perform the datev export, you must first set the "accountingYearBegin". To do this, you must use the updateExportConfig endpoint.

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\ExportApi(
    // 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
);
$start_date = 1641032867; // int | the start date of the export as timestamp
$end_date = 1648805267; // int | the end date of the export as timestamp
$scope = EXTCD; // string | Define what you want to include in the datev export. This parameter takes a string of 5 letters. Each stands for a model that should be included. Possible letters are: ‘E’ (Earnings), ‘X’ (Expenditure), ‘T’ (Transactions), ‘C’ (Cashregister), ‘D’ (Assets). By providing one of those letter you specify that it should be included in the datev export. Some combinations are: ‘EXTCD’, ‘EXTD’ …
$download = true; // bool | Specifies if the document is downloaded
$with_unpaid_documents = true; // bool | include unpaid documents
$with_enshrined_documents = true; // bool | include enshrined documents
$enshrine = false; // bool | Specify if you want to enshrine all models which were included in the export

try {
    $result = $apiInstance->exportDatev($start_date, $end_date, $scope, $download, $with_unpaid_documents, $with_enshrined_documents, $enshrine);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportApi->exportDatev: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
start_date	int	the start date of the export as timestamp
end_date	int	the end date of the export as timestamp
scope	string	Define what you want to include in the datev export. This parameter takes a string of 5 letters. Each stands for a model that should be included. Possible letters are: ‘E’ (Earnings), ‘X’ (Expenditure), ‘T’ (Transactions), ‘C’ (Cashregister), ‘D’ (Assets). By providing one of those letter you specify that it should be included in the datev export. Some combinations are: ‘EXTCD’, ‘EXTD’ …
download	bool	Specifies if the document is downloaded	[optional]
with_unpaid_documents	bool	include unpaid documents	[optional]
with_enshrined_documents	bool	include enshrined documents	[optional]
enshrine	bool	Specify if you want to enshrine all models which were included in the export	[optional]

Return type

object

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]

`exportInvoice()`

exportInvoice($sev_query, $download): \Itsmind\Sevdesk\Model\ExportInvoice200Response

Export invoice

Export all invoices as csv

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\ExportApi(
    // 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
);
$sev_query = new \Itsmind\Sevdesk\Model\ExportInvoiceSevQueryParameter(); // ExportInvoiceSevQueryParameter
$download = True; // bool

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

Parameters

Name	Type	Description	Notes
sev_query	ExportInvoiceSevQueryParameter
download	bool		[optional]

Return type

\Itsmind\Sevdesk\Model\ExportInvoice200Response

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]

`exportInvoiceZip()`

exportInvoiceZip($sev_query, $download): \Itsmind\Sevdesk\Model\ExportInvoiceZip200Response

Export Invoice as zip

Export all invoices as zip

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\ExportApi(
    // 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
);
$sev_query = new \Itsmind\Sevdesk\Model\ExportInvoiceSevQueryParameter(); // ExportInvoiceSevQueryParameter
$download = True; // bool

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

Parameters

Name	Type	Description	Notes
sev_query	ExportInvoiceSevQueryParameter
download	bool		[optional]

Return type

\Itsmind\Sevdesk\Model\ExportInvoiceZip200Response

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]

`exportTransactions()`

exportTransactions($sev_query, $download): \Itsmind\Sevdesk\Model\ExportTransactions200Response

Export transaction

Export all transactions as csv

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\ExportApi(
    // 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
);
$sev_query = new \Itsmind\Sevdesk\Model\ExportTransactionsSevQueryParameter(); // ExportTransactionsSevQueryParameter
$download = True; // bool

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

Parameters

Name	Type	Description	Notes
sev_query	ExportTransactionsSevQueryParameter
download	bool		[optional]

Return type

\Itsmind\Sevdesk\Model\ExportTransactions200Response

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]

`exportVoucher()`

exportVoucher($sev_query, $download): \Itsmind\Sevdesk\Model\ExportVoucher200Response

Export voucher as zip

Export all vouchers as zip

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\ExportApi(
    // 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
);
$sev_query = new \Itsmind\Sevdesk\Model\ExportVoucherSevQueryParameter(); // ExportVoucherSevQueryParameter
$download = True; // bool

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

Parameters

Name	Type	Description	Notes
sev_query	ExportVoucherSevQueryParameter
download	bool		[optional]

Return type

\Itsmind\Sevdesk\Model\ExportVoucher200Response

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]

`exportVoucherZip()`

exportVoucherZip($sev_query, $download): \Itsmind\Sevdesk\Model\ExportVoucherZip200Response

Export voucher zip

export all vouchers as zip

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\ExportApi(
    // 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
);
$sev_query = new \Itsmind\Sevdesk\Model\ExportVoucherZipSevQueryParameter(); // ExportVoucherZipSevQueryParameter
$download = True; // bool

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

Parameters

Name	Type	Description	Notes
sev_query	ExportVoucherZipSevQueryParameter
download	bool		[optional]

Return type

\Itsmind\Sevdesk\Model\ExportVoucherZip200Response

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]

`updateExportConfig()`

updateExportConfig($sev_client_id, $update_export_config_request): \Itsmind\Sevdesk\Model\CheckAccountTransactionEnshrine200Response

Update export config

Update export config to export datev CSV

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\ExportApi(
    // 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
);
$sev_client_id = 3.4; // float | id of sevClient
$update_export_config_request = new \Itsmind\Sevdesk\Model\UpdateExportConfigRequest(); // \Itsmind\Sevdesk\Model\UpdateExportConfigRequest | Specify the update

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

Parameters

Name	Type	Description	Notes
sev_client_id	float	id of sevClient
update_export_config_request	\Itsmind\Sevdesk\Model\UpdateExportConfigRequest	Specify the update	[optional]

Return type

\Itsmind\Sevdesk\Model\CheckAccountTransactionEnshrine200Response

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

ExportApi.md

Latest commit

History

ExportApi.md

File metadata and controls

Itsmind\Sevdesk\ExportApi

exportContact()

Example

Parameters

Return type

Authorization

HTTP request headers

exportCreditNote()

Example

Parameters

Return type

Authorization

HTTP request headers

exportDatev()

Example

Parameters

Return type

Authorization

HTTP request headers

exportInvoice()

Example

Parameters

Return type

Authorization

HTTP request headers

exportInvoiceZip()

Example

Parameters

Return type

Authorization

HTTP request headers

exportTransactions()

Example

Parameters

Return type

Authorization

HTTP request headers

exportVoucher()

Example

Parameters

Return type

Authorization

HTTP request headers

exportVoucherZip()

Example

Parameters

Return type

Authorization

HTTP request headers

updateExportConfig()

Example

Parameters

Return type

Authorization

HTTP request headers

`exportContact()`

`exportCreditNote()`

`exportDatev()`

`exportInvoice()`

`exportInvoiceZip()`

`exportTransactions()`

`exportVoucher()`

`exportVoucherZip()`

`updateExportConfig()`