Itsmind\Sevdesk\InvoiceApi

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

Method	HTTP request	Description
bookInvoice()	PUT /Invoice/{invoiceId}/bookAmount	Book an invoice
cancelInvoice()	POST /Invoice/{invoiceId}/cancelInvoice	Cancel an invoice / Create cancellation invoice
createInvoiceByFactory()	POST /Invoice/Factory/saveInvoice	Create a new invoice
createInvoiceFromOrder()	POST /Invoice/Factory/createInvoiceFromOrder	Create invoice from order
createInvoiceReminder()	POST /Invoice/Factory/createInvoiceReminder	Create invoice reminder
deleteInvoiceById()	DELETE /Invoice/{invoiceId}	Delete invoice by ID
getInvoiceById()	GET /Invoice/{invoiceId}	Find invoice by ID
getInvoicePositionsById()	GET /Invoice/{invoiceId}/getPositions	Find invoice positions
getInvoices()	GET /Invoice	Retrieve invoices
getIsInvoicePartiallyPaid()	GET /Invoice/{invoiceId}/getIsPartiallyPaid	Check if an invoice is already partially paid
getLastDunning()	GET /Invoice/{invoiceId}/getLastDunning	Get the last dunning of an invoice
getOpenInvoiceReminderDebit()	GET /Invoice/Factory/getOpenInvoiceReminderDebit	Get the oben reminder debit for an invoice
invoiceEnshrine()	PUT /Invoice/{invoiceId}/enshrine	Enshrine
invoiceGetPdf()	GET /Invoice/{invoiceId}/getPdf	Retrieve pdf document of an invoice
invoiceRender()	POST /Invoice/{invoiceId}/render	Render the pdf document of an invoice
invoiceResetToDraft()	PUT /Invoice/{invoiceId}/resetToDraft	Reset status to draft
invoiceResetToOpen()	PUT /Invoice/{invoiceId}/resetToOpen	Reset status to open
invoiceSendBy()	PUT /Invoice/{invoiceId}/sendBy	Mark invoice as sent
sendInvoiceViaEMail()	POST /Invoice/{invoiceId}/sendViaEmail	Send invoice via email
updateInvoiceById()	PUT /Invoice/{invoiceId}	Update invoice by ID

`bookInvoice()`

bookInvoice($invoice_id, $book_invoice_request): \Itsmind\Sevdesk\Model\BookInvoice200Response

Book an invoice

Booking the invoice with a transaction is probably the most important part in the bookkeeping process.
There are several ways on correctly booking an invoice, all by using the same endpoint.
for more information look here.

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\InvoiceApi(
    // 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
);
$invoice_id = 56; // int | ID of invoice to book
$book_invoice_request = new \Itsmind\Sevdesk\Model\BookInvoiceRequest(); // \Itsmind\Sevdesk\Model\BookInvoiceRequest | Booking data

try {
    $result = $apiInstance->bookInvoice($invoice_id, $book_invoice_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceApi->bookInvoice: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
invoice_id	int	ID of invoice to book
book_invoice_request	\Itsmind\Sevdesk\Model\BookInvoiceRequest	Booking data	[optional]

Return type

\Itsmind\Sevdesk\Model\BookInvoice200Response

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]

`cancelInvoice()`

cancelInvoice($invoice_id): \Itsmind\Sevdesk\Model\ModelInvoiceResponse

Cancel an invoice / Create cancellation invoice

This endpoint will cancel the specified invoice therefor creating a cancellation invoice.
The cancellation invoice will be automatically paid and the source invoices status will change to 'cancelled'.

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\InvoiceApi(
    // 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
);
$invoice_id = 56; // int | ID of invoice to be cancelled

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

Parameters

Name	Type	Description	Notes
invoice_id	int	ID of invoice to be cancelled

Return type

\Itsmind\Sevdesk\Model\ModelInvoiceResponse

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]

`createInvoiceByFactory()`

createInvoiceByFactory($save_invoice): \Itsmind\Sevdesk\Model\SaveInvoiceResponse

Create a new invoice

This endpoint offers you the following functionality.

Create invoices together with positions and discounts
Delete positions while adding new ones
Delete or add discounts, or both at the same time
Automatically fill the address of the supplied contact into the invoice address

To make your own request sample slimmer, you can omit all parameters which are not required and nullable. However, for a valid and logical bookkeeping document, you will also need some of them to ensure that all the necessary data is in the invoice.

The list of parameters starts with the invoice array.
This array contains all required attributes for a complete invoice.
Most of the attributes are covered in the invoice attribute list, there are only two parameters standing out, namely mapAll and objectName.
These are just needed for our system and you always need to provide them.

The list of parameters then continues with the invoice position array.
With this array you have the possibility to add multiple positions at once.
In the example it only contains one position, again together with the parameters mapAll and objectName, however, you can add more invoice positions by extending the array.
So if you wanted to add another position, you would add the same list of parameters with an incremented array index of "1" instead of "0".

The list ends with the four parameters invoicePosDelete, discountSave, discountDelete and takeDefaultAddress.
They only play a minor role if you only want to create an invoice but we will shortly explain what they can do.
With invoicePosDelete you have to option to delete invoice positions as this request can also be used to update invoices.
With discountSave you can add discounts to your invoice.
With discountDelete you can delete discounts from your invoice.
With takeDefaultAddress you can specify that the first address of the contact you are using for the invoice is taken for the invoice address attribute automatically, so you don't need to provide the address yourself.
If you want to know more about these parameters, for example if you want to use this request to update invoices, feel free to contact our support.

Finally, after covering all parameters, they only important information left, is that the order of the last four attributes always needs to be kept.
You will also always need to provide all of them, as otherwise the request won't work properly.

Warning: You can not create a regular invoice with the deliveryDate being later than the invoiceDate.
To do that you will need to create a so called Abschlagsrechnung by setting the invoiceType parameter to AR.

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

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

Parameters

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

Return type

\Itsmind\Sevdesk\Model\SaveInvoiceResponse

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]

`createInvoiceFromOrder()`

createInvoiceFromOrder($invoice_id, $invoice_object_name, $model_create_invoice_from_order): \Itsmind\Sevdesk\Model\ModelInvoiceResponse

Create invoice from order

Create an invoice from an order

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\InvoiceApi(
    // 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
);
$invoice_id = 56; // int | the id of the invoice
$invoice_object_name = Invoice; // string | Model name, which is 'Invoice'
$model_create_invoice_from_order = new \Itsmind\Sevdesk\Model\ModelCreateInvoiceFromOrder(); // \Itsmind\Sevdesk\Model\ModelCreateInvoiceFromOrder | Create invoice

try {
    $result = $apiInstance->createInvoiceFromOrder($invoice_id, $invoice_object_name, $model_create_invoice_from_order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceApi->createInvoiceFromOrder: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
invoice_id	int	the id of the invoice
invoice_object_name	string	Model name, which is 'Invoice'	[default to 'Invoice']
model_create_invoice_from_order	\Itsmind\Sevdesk\Model\ModelCreateInvoiceFromOrder	Create invoice	[optional]

Return type

\Itsmind\Sevdesk\Model\ModelInvoiceResponse

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]

`createInvoiceReminder()`

createInvoiceReminder($invoice_id, $invoice_object_name, $create_invoice_reminder_request): \Itsmind\Sevdesk\Model\UpdateInvoiceById200Response

Create invoice reminder

Create an reminder from an invoice

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\InvoiceApi(
    // 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
);
$invoice_id = 56; // int | the id of the invoice
$invoice_object_name = Invoice; // string | Model name, which is 'Invoice'
$create_invoice_reminder_request = new \Itsmind\Sevdesk\Model\CreateInvoiceReminderRequest(); // \Itsmind\Sevdesk\Model\CreateInvoiceReminderRequest | Create invoice

try {
    $result = $apiInstance->createInvoiceReminder($invoice_id, $invoice_object_name, $create_invoice_reminder_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceApi->createInvoiceReminder: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
invoice_id	int	the id of the invoice
invoice_object_name	string	Model name, which is 'Invoice'	[default to 'Invoice']
create_invoice_reminder_request	\Itsmind\Sevdesk\Model\CreateInvoiceReminderRequest	Create invoice	[optional]

Return type

\Itsmind\Sevdesk\Model\UpdateInvoiceById200Response

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]

`deleteInvoiceById()`

deleteInvoiceById($invoice_id)

Delete invoice by ID

Deletes a single invoice

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\InvoiceApi(
    // 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
);
$invoice_id = 56; // int | ID of invoice to return

try {
    $apiInstance->deleteInvoiceById($invoice_id);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceApi->deleteInvoiceById: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
invoice_id	int	ID of invoice to return

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`getInvoiceById()`

getInvoiceById($invoice_id, $embed): \Itsmind\Sevdesk\Model\GetInvoiceById200Response

Find invoice by ID

Returns a single invoice

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\InvoiceApi(
    // 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
);
$invoice_id = 56; // int | ID of invoice to return
$embed = array('embed_example'); // string[]

try {
    $result = $apiInstance->getInvoiceById($invoice_id, $embed);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceApi->getInvoiceById: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
invoice_id	int	ID of invoice to return
embed	string[]		[optional]

Return type

\Itsmind\Sevdesk\Model\GetInvoiceById200Response

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]

`getInvoicePositionsById()`

getInvoicePositionsById($invoice_id, $limit, $offset, $embed, $count_all): \Itsmind\Sevdesk\Model\GetInvoicePositionsById200Response

Find invoice positions

Returns all positions of an invoice

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\InvoiceApi(
    // 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
);
$invoice_id = 56; // int | ID of invoice to return the positions
$limit = 56; // int | limits the number of entries returned
$offset = 56; // int | set the index where the returned entries start
$embed = array('embed_example'); // string[] | Get some additional information. Embed can handle multiple values, they must be separated by comma.
$count_all = True; // bool | If all objects should be counted

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

Parameters

Name	Type	Description	Notes
invoice_id	int	ID of invoice to return the positions
limit	int	limits the number of entries returned	[optional]
offset	int	set the index where the returned entries start	[optional]
embed	string[]	Get some additional information. Embed can handle multiple values, they must be separated by comma.	[optional]
count_all	bool	If all objects should be counted	[optional]

Return type

\Itsmind\Sevdesk\Model\GetInvoicePositionsById200Response

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]

`getInvoices()`

getInvoices($status, $invoice_number, $start_date, $end_date, $count_all, $invoice_type, $offset, $limit, $partially_paid, $canceled, $contact, $payment_method, $embed): \Itsmind\Sevdesk\Model\GetInvoices200Response

Retrieve invoices

There are a multitude of parameter which can be used to filter. A few of them are attached but for a complete list please check out this list

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\InvoiceApi(
    // 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
);
$status = 3.4; // float | Status of the invoices
$invoice_number = 'invoice_number_example'; // string | Retrieve all invoices with this invoice number
$start_date = 56; // int | Retrieve all invoices with a date equal or higher
$end_date = 56; // int | Retrieve all invoices with a date equal or lower
$count_all = True; // bool | If all invoices should be counted
$invoice_type = array('key' => 'invoice_type_example'); // array<string,string> | The type of invoice
$offset = 56; // int | Which offset to start with
$limit = 56; // int | The max number of invoices
$partially_paid = True; // bool | Limit to partially paid invoices
$canceled = True; // bool | Limit to canceled invoices
$contact = new \Itsmind\Sevdesk\Model\GetInvoicesContactParameter(); // GetInvoicesContactParameter | Retrieve all invoices with this contact. The value of contact[objectName] must be 'Contact'.
$payment_method = new \Itsmind\Sevdesk\Model\GetInvoicesPaymentMethodParameter(); // GetInvoicesPaymentMethodParameter | Retrieve all invoices with this paymentMethod. The value of paymentMethod[objectName] must be 'PaymentMethod'.
$embed = array('embed_example'); // string[]

try {
    $result = $apiInstance->getInvoices($status, $invoice_number, $start_date, $end_date, $count_all, $invoice_type, $offset, $limit, $partially_paid, $canceled, $contact, $payment_method, $embed);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceApi->getInvoices: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
status	float	Status of the invoices	[optional]
invoice_number	string	Retrieve all invoices with this invoice number	[optional]
start_date	int	Retrieve all invoices with a date equal or higher	[optional]
end_date	int	Retrieve all invoices with a date equal or lower	[optional]
count_all	bool	If all invoices should be counted	[optional]
invoice_type	array<string,string>	The type of invoice	[optional]
offset	int	Which offset to start with	[optional]
limit	int	The max number of invoices	[optional]
partially_paid	bool	Limit to partially paid invoices	[optional]
canceled	bool	Limit to canceled invoices	[optional]
contact	GetInvoicesContactParameter	Retrieve all invoices with this contact. The value of contact[objectName] must be 'Contact'.	[optional]
payment_method	GetInvoicesPaymentMethodParameter	Retrieve all invoices with this paymentMethod. The value of paymentMethod[objectName] must be 'PaymentMethod'.	[optional]
embed	string[]		[optional]

Return type

\Itsmind\Sevdesk\Model\GetInvoices200Response

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]

`getIsInvoicePartiallyPaid()`

getIsInvoicePartiallyPaid($invoice_id): \Itsmind\Sevdesk\Model\ContactCustomerNumberAvailabilityCheck200Response

Check if an invoice is already partially paid

Returns 'true' if the given invoice is partially paid - 'false' if it is not. Invoices which are completely paid are regarded as not partially paid.

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\InvoiceApi(
    // 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
);
$invoice_id = 56; // int | ID of invoice to return

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

Parameters

Name	Type	Description	Notes
invoice_id	int	ID of invoice to return

Return type

\Itsmind\Sevdesk\Model\ContactCustomerNumberAvailabilityCheck200Response

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]

`getLastDunning()`

getLastDunning($invoice_id): \Itsmind\Sevdesk\Model\UpdateInvoiceById200Response

Get the last dunning of an invoice

Using this endpoint you can render the pdf document of an invoice.
Use cases for this are the retrieval of the pdf location or the forceful re-render of a already sent invoice.
Please be aware that changing an invoice after it has been sent to a customer is not an allowed bookkeeping process.

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\InvoiceApi(
    // 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
);
$invoice_id = 56; // int | ID of invoice to get last dunning for

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

Parameters

Name	Type	Description	Notes
invoice_id	int	ID of invoice to get last dunning for

Return type

\Itsmind\Sevdesk\Model\UpdateInvoiceById200Response

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]

`getOpenInvoiceReminderDebit()`

getOpenInvoiceReminderDebit($invoice): \Itsmind\Sevdesk\Model\GetOpenInvoiceReminderDebit200Response

Get the oben reminder debit for an invoice

Using this endpoint you can render the pdf document of an invoice.
Use cases for this are the retrieval of the pdf location or the forceful re-render of a already sent invoice.
Please be aware that changing an invoice after it has been sent to a customer is not an allowed bookkeeping process.

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\InvoiceApi(
    // 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
);
$invoice = new \Itsmind\Sevdesk\Model\GetOpenInvoiceReminderDebitInvoiceParameter(); // GetOpenInvoiceReminderDebitInvoiceParameter | Retrieve the open reminder debit for this invoice. The value of invoice[objectName] must be 'Invoice'.

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

Parameters

Name	Type	Description	Notes
invoice	GetOpenInvoiceReminderDebitInvoiceParameter	Retrieve the open reminder debit for this invoice. The value of invoice[objectName] must be 'Invoice'.

Return type

\Itsmind\Sevdesk\Model\GetOpenInvoiceReminderDebit200Response

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]

`invoiceEnshrine()`

invoiceEnshrine($invoice_id): \Itsmind\Sevdesk\Model\CheckAccountTransactionEnshrine200Response

Enshrine

Sets the current date and time as a value for the property enshrined.
This operation is only possible if the status is "Open" (\"status\": \"200\") or higher. Enshrined invoices cannot be changed. This operation cannot be undone.

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\InvoiceApi(
    // 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
);
$invoice_id = 56; // int | ID of the invoice to enshrine

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

Parameters

Name	Type	Description	Notes
invoice_id	int	ID of the invoice to enshrine

Return type

\Itsmind\Sevdesk\Model\CheckAccountTransactionEnshrine200Response

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]

`invoiceGetPdf()`

invoiceGetPdf($invoice_id, $download, $prevent_send_by): \Itsmind\Sevdesk\Model\InvoiceGetPdf200Response

Retrieve pdf document of an invoice

Retrieves the pdf document of an invoice with additional metadata.

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\InvoiceApi(
    // 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
);
$invoice_id = 56; // int | ID of invoice from which you want the pdf
$download = true; // bool | If u want to download the pdf of the invoice.
$prevent_send_by = true; // bool | Defines if u want to send the invoice.

try {
    $result = $apiInstance->invoiceGetPdf($invoice_id, $download, $prevent_send_by);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceApi->invoiceGetPdf: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
invoice_id	int	ID of invoice from which you want the pdf
download	bool	If u want to download the pdf of the invoice.	[optional]
prevent_send_by	bool	Defines if u want to send the invoice.	[optional]

Return type

\Itsmind\Sevdesk\Model\InvoiceGetPdf200Response

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]

`invoiceRender()`

invoiceRender($invoice_id, $invoice_render_request): \Itsmind\Sevdesk\Model\InvoiceRender201Response

Render the pdf document of an invoice

Using this endpoint you can render the pdf document of an invoice.
Use cases for this are the retrieval of the pdf location or the forceful re-render of a already sent invoice.
Please be aware that changing an invoice after it has been sent to a customer is not an allowed bookkeeping process.

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\InvoiceApi(
    // 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
);
$invoice_id = 56; // int | ID of invoice to render
$invoice_render_request = new \Itsmind\Sevdesk\Model\InvoiceRenderRequest(); // \Itsmind\Sevdesk\Model\InvoiceRenderRequest | Define if the document should be forcefully re-rendered.

try {
    $result = $apiInstance->invoiceRender($invoice_id, $invoice_render_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceApi->invoiceRender: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
invoice_id	int	ID of invoice to render
invoice_render_request	\Itsmind\Sevdesk\Model\InvoiceRenderRequest	Define if the document should be forcefully re-rendered.	[optional]

Return type

\Itsmind\Sevdesk\Model\InvoiceRender201Response

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]

`invoiceResetToDraft()`

invoiceResetToDraft($invoice_id): \Itsmind\Sevdesk\Model\InvoiceResetToDraft200Response

Reset status to draft

Resets the status to "Draft" (\"status\": \"100\").
This is only possible if the invoice has the status "Open" (\"status\": \"200\").
If it has a higher status use Invoice/{invoiceId}/resetToOpen first. This endpoint cannot be used for recurring invoices (\"invoiceType\": \"WKR\").
Use Invoice/Factory/saveInvoice instead.

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\InvoiceApi(
    // 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
);
$invoice_id = 56; // int | ID of the invoice to reset

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

Parameters

Name	Type	Description	Notes
invoice_id	int	ID of the invoice to reset

Return type

\Itsmind\Sevdesk\Model\InvoiceResetToDraft200Response

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]

`invoiceResetToOpen()`

invoiceResetToOpen($invoice_id): \Itsmind\Sevdesk\Model\InvoiceResetToOpen200Response

Reset status to open

Resets the status "Open" (\"status\": \"200\"). Linked transactions will be unlinked.
This is not possible if the invoice itself or one of its transactions (CheckAccountTransaction) is already enshrined. This endpoint cannot be used to increase the status to "Open" (\"status\": \"200\").
Use Invoice/{invoiceId}/sendBy / Invoice/{invoiceId}/sendViaEmail instead. This endpoint cannot be used for recurring invoices (\"invoiceType\": \"WKR\"). Use Invoice/Factory/saveInvoice instead.

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\InvoiceApi(
    // 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
);
$invoice_id = 56; // int | ID of the invoice to reset

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

Parameters

Name	Type	Description	Notes
invoice_id	int	ID of the invoice to reset

Return type

\Itsmind\Sevdesk\Model\InvoiceResetToOpen200Response

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]

`invoiceSendBy()`

invoiceSendBy($invoice_id, $invoice_send_by_request): \Itsmind\Sevdesk\Model\ModelInvoiceResponse

Mark invoice as sent

Marks an invoice as sent by a chosen send type.

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\InvoiceApi(
    // 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
);
$invoice_id = 56; // int | ID of invoice to mark as sent
$invoice_send_by_request = new \Itsmind\Sevdesk\Model\InvoiceSendByRequest(); // \Itsmind\Sevdesk\Model\InvoiceSendByRequest | Specify the send type

try {
    $result = $apiInstance->invoiceSendBy($invoice_id, $invoice_send_by_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceApi->invoiceSendBy: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
invoice_id	int	ID of invoice to mark as sent
invoice_send_by_request	\Itsmind\Sevdesk\Model\InvoiceSendByRequest	Specify the send type	[optional]

Return type

\Itsmind\Sevdesk\Model\ModelInvoiceResponse

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]

`sendInvoiceViaEMail()`

sendInvoiceViaEMail($invoice_id, $send_invoice_via_e_mail_request): \Itsmind\Sevdesk\Model\ModelEmail

Send invoice via email

This endpoint sends the specified invoice to a customer via email.
This will automatically mark the invoice as sent.
Please note, that in production an invoice is not allowed to be changed after this happened!

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\InvoiceApi(
    // 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
);
$invoice_id = 56; // int | ID of invoice to be sent via email
$send_invoice_via_e_mail_request = new \Itsmind\Sevdesk\Model\SendInvoiceViaEMailRequest(); // \Itsmind\Sevdesk\Model\SendInvoiceViaEMailRequest | Mail data

try {
    $result = $apiInstance->sendInvoiceViaEMail($invoice_id, $send_invoice_via_e_mail_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceApi->sendInvoiceViaEMail: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
invoice_id	int	ID of invoice to be sent via email
send_invoice_via_e_mail_request	\Itsmind\Sevdesk\Model\SendInvoiceViaEMailRequest	Mail data	[optional]

Return type

\Itsmind\Sevdesk\Model\ModelEmail

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]

`updateInvoiceById()`

updateInvoiceById($invoice_id, $embed, $model_invoice_update): \Itsmind\Sevdesk\Model\UpdateInvoiceById200Response

Update invoice by ID

Updates a single invoice

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\InvoiceApi(
    // 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
);
$invoice_id = 56; // int | ID of invoice to return
$embed = array('embed_example'); // string[]
$model_invoice_update = new \Itsmind\Sevdesk\Model\ModelInvoiceUpdate(); // \Itsmind\Sevdesk\Model\ModelInvoiceUpdate | Update data

try {
    $result = $apiInstance->updateInvoiceById($invoice_id, $embed, $model_invoice_update);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceApi->updateInvoiceById: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
invoice_id	int	ID of invoice to return
embed	string[]		[optional]
model_invoice_update	\Itsmind\Sevdesk\Model\ModelInvoiceUpdate	Update data	[optional]

Return type

\Itsmind\Sevdesk\Model\UpdateInvoiceById200Response

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

InvoiceApi.md

Latest commit

History

InvoiceApi.md

File metadata and controls

Itsmind\Sevdesk\InvoiceApi

bookInvoice()

Example

Parameters

Return type

Authorization

HTTP request headers

cancelInvoice()

Example

Parameters

Return type

Authorization

HTTP request headers

createInvoiceByFactory()

Example

Parameters

Return type

Authorization

HTTP request headers

createInvoiceFromOrder()

Example

Parameters

Return type

Authorization

HTTP request headers

createInvoiceReminder()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteInvoiceById()

Example

Parameters

Return type

Authorization

HTTP request headers

getInvoiceById()

Example

Parameters

Return type

Authorization

HTTP request headers

getInvoicePositionsById()

Example

Parameters

Return type

Authorization

HTTP request headers

getInvoices()

Example

Parameters

Return type

Authorization

HTTP request headers

getIsInvoicePartiallyPaid()

Example

Parameters

Return type

Authorization

HTTP request headers

getLastDunning()

Example

Parameters

Return type

Authorization

HTTP request headers

getOpenInvoiceReminderDebit()

Example

Parameters

Return type

Authorization

HTTP request headers

invoiceEnshrine()

`bookInvoice()`

`cancelInvoice()`

`createInvoiceByFactory()`

`createInvoiceFromOrder()`

`createInvoiceReminder()`

`deleteInvoiceById()`

`getInvoiceById()`

`getInvoicePositionsById()`

`getInvoices()`

`getIsInvoicePartiallyPaid()`

`getLastDunning()`

`getOpenInvoiceReminderDebit()`

`invoiceEnshrine()`

`invoiceGetPdf()`

`invoiceRender()`

`invoiceResetToDraft()`

`invoiceResetToOpen()`

`invoiceSendBy()`

`sendInvoiceViaEMail()`

`updateInvoiceById()`