Skip to content

Latest commit

 

History

History
982 lines (680 loc) · 37.4 KB

CreditNoteApi.md

File metadata and controls

982 lines (680 loc) · 37.4 KB
Raw

Itsmind\Sevdesk\CreditNoteApi

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

Method HTTP request Description
bookCreditNote() PUT /CreditNote/{creditNoteId}/bookAmount Book a credit note
createCreditNoteFromInvoice() POST /CreditNote/Factory/createFromInvoice Creates a new creditNote from an invoice
createCreditNoteFromVoucher() POST /CreditNote/Factory/createFromVoucher Creates a new creditNote from a voucher
createcreditNote() POST /CreditNote/Factory/saveCreditNote Create a new creditNote
creditNoteEnshrine() PUT /CreditNote/{creditNoteId}/enshrine Enshrine
creditNoteGetPdf() GET /CreditNote/{creditNoteId}/getPdf Retrieve pdf document of a credit note
creditNoteResetToDraft() PUT /CreditNote/{creditNoteId}/resetToDraft Reset status to draft
creditNoteResetToOpen() PUT /CreditNote/{creditNoteId}/resetToOpen Reset status to open
creditNoteSendBy() PUT /CreditNote/{creditNoteId}/sendBy Mark credit note as sent
deletecreditNote() DELETE /CreditNote/{creditNoteId} Deletes an creditNote
getCreditNotes() GET /CreditNote Retrieve CreditNote
getcreditNoteById() GET /CreditNote/{creditNoteId} Find creditNote by ID
sendCreditNoteByPrinting() GET /CreditNote/{creditNoteId}/sendByWithRender Send credit note by printing
sendCreditNoteViaEMail() POST /CreditNote/{creditNoteId}/sendViaEmail Send credit note via email
updatecreditNote() PUT /CreditNote/{creditNoteId} Update an existing creditNote

bookCreditNote()

bookCreditNote($credit_note_id, $book_credit_note_request): \Itsmind\Sevdesk\Model\BookCreditNote200Response

Book a credit note

Booking the credit note with a transaction is probably the most important part in the bookkeeping process.
There are several ways on correctly booking a credit note, all by using the same endpoint.
Conveniently, the booking process is exactly the same as the process for invoices and vouchers.
For this reason, you can have a look at it in the invoice chapter and all you need to do is to change "Invoice" into "CreditNote" in the URL.

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\CreditNoteApi(
    // 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
);
$credit_note_id = 56; // int | ID of credit note to book
$book_credit_note_request = new \Itsmind\Sevdesk\Model\BookCreditNoteRequest(); // \Itsmind\Sevdesk\Model\BookCreditNoteRequest | Booking data

try {
    $result = $apiInstance->bookCreditNote($credit_note_id, $book_credit_note_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreditNoteApi->bookCreditNote: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
credit_note_id int ID of credit note to book
book_credit_note_request \Itsmind\Sevdesk\Model\BookCreditNoteRequest Booking data [optional]

Return type

\Itsmind\Sevdesk\Model\BookCreditNote200Response

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]

createCreditNoteFromInvoice()

createCreditNoteFromInvoice($create_credit_note_from_invoice_request): \Itsmind\Sevdesk\Model\CreateCreditNoteFromInvoice201Response

Creates a new creditNote from an invoice

Use this endpoint to create a new creditNote 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\CreditNoteApi(
    // 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
);
$create_credit_note_from_invoice_request = new \Itsmind\Sevdesk\Model\CreateCreditNoteFromInvoiceRequest(); // \Itsmind\Sevdesk\Model\CreateCreditNoteFromInvoiceRequest

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

Parameters

Name Type Description Notes
create_credit_note_from_invoice_request \Itsmind\Sevdesk\Model\CreateCreditNoteFromInvoiceRequest [optional]

Return type

\Itsmind\Sevdesk\Model\CreateCreditNoteFromInvoice201Response

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]

createCreditNoteFromVoucher()

createCreditNoteFromVoucher($create_credit_note_from_voucher_request): \Itsmind\Sevdesk\Model\CreateCreditNoteFromInvoice201Response

Creates a new creditNote from a voucher

Not supported with sevDesk-Update 2.0 Use this endpoint to create a new creditNote from a voucher.

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\CreditNoteApi(
    // 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
);
$create_credit_note_from_voucher_request = new \Itsmind\Sevdesk\Model\CreateCreditNoteFromVoucherRequest(); // \Itsmind\Sevdesk\Model\CreateCreditNoteFromVoucherRequest

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

Parameters

Name Type Description Notes
create_credit_note_from_voucher_request \Itsmind\Sevdesk\Model\CreateCreditNoteFromVoucherRequest [optional]

Return type

\Itsmind\Sevdesk\Model\CreateCreditNoteFromInvoice201Response

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]

createcreditNote()

createcreditNote($save_credit_note): \Itsmind\Sevdesk\Model\SaveCreditNoteResponse

Create a new creditNote

The list of parameters starts with the credit note array.
This array contains all required attributes for a complete credit note.
Most of the attributes are covered in the credit note 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 credit note 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 credit note 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 five parameters creditNotePosDelete, discountSave, discountDelete, takeDefaultAddress and forCashRegister.
They only play a minor role if you only want to create a credit note but we will shortly explain what they can do.
With creditNotePosDelete you have to option to delete credit note positions as this request can also be used to update credit notes.
Both discount parameters are deprecated and have no use for credit notes, however they need to be provided in case you want to use the following two parameters.
With takeDefaultAddress you can specify that the first address of the contact you are using for the credit note is taken for the credit note address attribute automatically, so you don't need to provide the address yourself.
Finally, the forCashRegister parameter needs to be set to true if your credit note is to be booked on the cash register.
If you want to know more about these parameters, for example if you want to use this request to update credit notes, feel free to contact our support.
Finally, after covering all parameters, they only important information left, is that the order of the last five attributes always needs to be kept.
You will also always need to provide all of them, as otherwise the request won't work properly.

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\CreditNoteApi(
    // 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_credit_note = new \Itsmind\Sevdesk\Model\SaveCreditNote(); // \Itsmind\Sevdesk\Model\SaveCreditNote | Creation data. Please be aware, that you need to provide at least all required parameter      of the credit note model!

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

Parameters

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

Return type

\Itsmind\Sevdesk\Model\SaveCreditNoteResponse

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]

creditNoteEnshrine()

creditNoteEnshrine($credit_note_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 credit notes 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\CreditNoteApi(
    // 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
);
$credit_note_id = 56; // int | ID of the credit note to enshrine

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

Parameters

Name Type Description Notes
credit_note_id int ID of the credit note 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]

creditNoteGetPdf()

creditNoteGetPdf($credit_note_id, $download, $prevent_send_by): \Itsmind\Sevdesk\Model\CreditNoteGetPdf200Response

Retrieve pdf document of a credit note

Retrieves the pdf document of a credit note 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\CreditNoteApi(
    // 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
);
$credit_note_id = 56; // int | ID of credit note from which you want the pdf
$download = true; // bool | If u want to download the pdf of the credit note.
$prevent_send_by = true; // bool | Defines if u want to send the credit note.

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

Parameters

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

Return type

\Itsmind\Sevdesk\Model\CreditNoteGetPdf200Response

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]

creditNoteResetToDraft()

creditNoteResetToDraft($credit_note_id): \Itsmind\Sevdesk\Model\CreditNoteResetToDraft200Response

Reset status to draft

Resets the status to "Draft" (\"status\": \"100\").
This is only possible if the credit note has the status "Open" (\"status\": \"200\").
If it has a higher status use CreditNote/{creditNoteId}/resetToOpen first.

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\CreditNoteApi(
    // 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
);
$credit_note_id = 56; // int | ID of the credit note to reset

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

Parameters

Name Type Description Notes
credit_note_id int ID of the credit note to reset

Return type

\Itsmind\Sevdesk\Model\CreditNoteResetToDraft200Response

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]

creditNoteResetToOpen()

creditNoteResetToOpen($credit_note_id): \Itsmind\Sevdesk\Model\CreditNoteResetToOpen200Response

Reset status to open

Resets the status "Open" (\"status\": \"200\"). Linked transactions will be unlinked.
This is not possible if the credit note itself or one of its transactions (CheckAccountTransaction) is already enshrined. This endpoint cannot be used to increase the status to "Open" (\"status\": \"200\").
Use CreditNote/{creditNoteId}/sendBy / CreditNote/{creditNoteId}/sendViaEmail 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\CreditNoteApi(
    // 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
);
$credit_note_id = 56; // int | ID of the credit note to reset

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

Parameters

Name Type Description Notes
credit_note_id int ID of the credit note to reset

Return type

\Itsmind\Sevdesk\Model\CreditNoteResetToOpen200Response

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]

creditNoteSendBy()

creditNoteSendBy($credit_note_id, $credit_note_send_by_request): \Itsmind\Sevdesk\Model\ModelCreditNoteResponse

Mark credit note as sent

Marks an credit note 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\CreditNoteApi(
    // 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
);
$credit_note_id = 56; // int | ID of credit note to mark as sent
$credit_note_send_by_request = new \Itsmind\Sevdesk\Model\CreditNoteSendByRequest(); // \Itsmind\Sevdesk\Model\CreditNoteSendByRequest | Specify the send type

try {
    $result = $apiInstance->creditNoteSendBy($credit_note_id, $credit_note_send_by_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreditNoteApi->creditNoteSendBy: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
credit_note_id int ID of credit note to mark as sent
credit_note_send_by_request \Itsmind\Sevdesk\Model\CreditNoteSendByRequest Specify the send type [optional]

Return type

\Itsmind\Sevdesk\Model\ModelCreditNoteResponse

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]

deletecreditNote()

deletecreditNote($credit_note_id): \Itsmind\Sevdesk\Model\GetcreditNoteById200Response

Deletes an creditNote

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\CreditNoteApi(
    // 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
);
$credit_note_id = 56; // int | Id of creditNote resource to delete

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

Parameters

Name Type Description Notes
credit_note_id int Id of creditNote resource to delete

Return type

\Itsmind\Sevdesk\Model\GetcreditNoteById200Response

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]

getCreditNotes()

getCreditNotes($status, $credit_note_number, $start_date, $end_date, $contact_id, $contact_object_name, $count_all, $offset, $limit, $embed): \Itsmind\Sevdesk\Model\GetCreditNotes200Response

Retrieve CreditNote

There are a multitude of parameter which can be used to filter.

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\CreditNoteApi(
    // 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 = 'status_example'; // string | Status of the CreditNote
$credit_note_number = 'credit_note_number_example'; // string | Retrieve all CreditNotes with this creditNote number
$start_date = 01.01.2020; // int | Retrieve all CreditNotes with a date equal or higher
$end_date = 01.01.2021; // int | Retrieve all CreditNotes with a date equal or lower
$contact_id = 56; // int | Retrieve all CreditNotes with this contact. Must be provided with contact[objectName]
$contact_object_name = 'contact_object_name_example'; // string | Only required if contact[id] was provided. 'Contact' should be used as value.
$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->getCreditNotes($status, $credit_note_number, $start_date, $end_date, $contact_id, $contact_object_name, $count_all, $offset, $limit, $embed);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreditNoteApi->getCreditNotes: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
status string Status of the CreditNote [optional]
credit_note_number string Retrieve all CreditNotes with this creditNote number [optional]
start_date int Retrieve all CreditNotes with a date equal or higher [optional]
end_date int Retrieve all CreditNotes with a date equal or lower [optional]
contact_id int Retrieve all CreditNotes with this contact. Must be provided with contact[objectName] [optional]
contact_object_name string Only required if contact[id] was provided. 'Contact' should be used as value. [optional]
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\GetCreditNotes200Response

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]

getcreditNoteById()

getcreditNoteById($credit_note_id): \Itsmind\Sevdesk\Model\GetcreditNoteById200Response

Find creditNote by ID

Returns a single creditNote

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\CreditNoteApi(
    // 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
);
$credit_note_id = 56; // int | ID of creditNote to return

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

Parameters

Name Type Description Notes
credit_note_id int ID of creditNote to return

Return type

\Itsmind\Sevdesk\Model\GetcreditNoteById200Response

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]

sendCreditNoteByPrinting()

sendCreditNoteByPrinting($credit_note_id, $send_type): \Itsmind\Sevdesk\Model\ModelCreditNoteSendByWithRender

Send credit note by printing

Sending a credit note to end-customers is an important part of the bookkeeping process.
Depending on the way you want to send the credit note, you need to use different endpoints.
Let's start with just printing out the credit note, meaning we only need to render the pdf.

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\CreditNoteApi(
    // 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
);
$credit_note_id = 56; // int | ID of creditNote to return
$send_type = PRN; // string | the type you want to print.

try {
    $result = $apiInstance->sendCreditNoteByPrinting($credit_note_id, $send_type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreditNoteApi->sendCreditNoteByPrinting: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
credit_note_id int ID of creditNote to return
send_type string the type you want to print.

Return type

\Itsmind\Sevdesk\Model\ModelCreditNoteSendByWithRender

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]

sendCreditNoteViaEMail()

sendCreditNoteViaEMail($credit_note_id, $send_credit_note_via_e_mail_request): \Itsmind\Sevdesk\Model\SendCreditNoteViaEMail201Response

Send credit note via email

This endpoint sends the specified credit note to a customer via email.
This will automatically mark the credit note as sent.
Please note, that in production an credit note 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\CreditNoteApi(
    // 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
);
$credit_note_id = 56; // int | ID of credit note to be sent via email
$send_credit_note_via_e_mail_request = new \Itsmind\Sevdesk\Model\SendCreditNoteViaEMailRequest(); // \Itsmind\Sevdesk\Model\SendCreditNoteViaEMailRequest | Mail data

try {
    $result = $apiInstance->sendCreditNoteViaEMail($credit_note_id, $send_credit_note_via_e_mail_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreditNoteApi->sendCreditNoteViaEMail: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
credit_note_id int ID of credit note to be sent via email
send_credit_note_via_e_mail_request \Itsmind\Sevdesk\Model\SendCreditNoteViaEMailRequest Mail data [optional]

Return type

\Itsmind\Sevdesk\Model\SendCreditNoteViaEMail201Response

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]

updatecreditNote()

updatecreditNote($credit_note_id, $model_credit_note_update): \Itsmind\Sevdesk\Model\GetcreditNoteById200Response

Update an existing creditNote

Update a creditNote

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\CreditNoteApi(
    // 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
);
$credit_note_id = 56; // int | ID of creditNote to update
$model_credit_note_update = new \Itsmind\Sevdesk\Model\ModelCreditNoteUpdate(); // \Itsmind\Sevdesk\Model\ModelCreditNoteUpdate | Update data

try {
    $result = $apiInstance->updatecreditNote($credit_note_id, $model_credit_note_update);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreditNoteApi->updatecreditNote: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
credit_note_id int ID of creditNote to update
model_credit_note_update \Itsmind\Sevdesk\Model\ModelCreditNoteUpdate Update data [optional]

Return type

\Itsmind\Sevdesk\Model\GetcreditNoteById200Response

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]