sevDesk

Deletes an accounting contact via DELETE /AccountingContact/{accountingContactId}. Attention, deleting an existing AccountingContact can lead to **booking errors**, especially in the **DATEV export**. Compatibility of sevdesk with DATEV is no longer guaranteed.

Deletes a check account via DELETE /CheckAccount/{checkAccountId}

Deletes a check account transaction via DELETE /CheckAccountTransaction/{checkAccountTransactionId}

Deletes a communication way via DELETE /CommunicationWay/{communicationWayId}

Deletes a contact via DELETE /Contact/{contactId}

Deletes a contact address via DELETE /ContactAddress/{contactAddressId}

delete a contact field via DELETE /ContactCustomField/{contactCustomFieldId}

Deletes a contact field setting via DELETE /ContactCustomFieldSetting/{contactCustomFieldSettingId}

Deletes an creditNote via DELETE /CreditNote/{creditNoteId}

Deletes an order via DELETE /Order/{orderId}

Deletes an order Position via DELETE /OrderPos/{orderPosId}

Delete the rule by id via DELETE /PrivateTransactionRule/{id}

Deletes a tag via DELETE /Tag/{tagId}

Retrieve accounting contact via GET /AccountingContact. Returns all accounting contact which have been added up until now. Filters can be added. This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Find accounting contact by ID via GET /AccountingContact/{accountingContactId}. Returns a single accounting contac

Retrieve check accounts via GET /CheckAccount. Retrieve all check accounts This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Find check account by ID via GET /CheckAccount/{checkAccountId}. Retrieve an existing check account

Get the balance at a given date via GET /CheckAccount/{checkAccountId}/getBalanceAtDate. Get the balance, calculated as the sum of all transactions sevdesk knows, up to and including the given date. Note that this balance does not have to be the actual bank account balance, e.g. if sevdesk did not import old transactions.

Retrieve transactions via GET /CheckAccountTransaction. Retrieve all transactions depending on the filters defined in the query. This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Find check account transaction by ID via GET /CheckAccountTransaction/{checkAccountTransactionId}. Retrieve an existing check account transaction

Retrieve communication ways via GET /CommunicationWay. Returns all communication ways which have been added up until now. Filters can be added. This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Find communication way by ID via GET /CommunicationWay/{communicationWayId}. Returns a single communication way

Retrieve communication way keys via GET /CommunicationWayKey. Returns all communication way keys. This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Retrieve contacts via GET /Contact. There are a multitude of parameter which can be used to filter.<br> A few of them are attached but for a complete list please check out <a href='#tag/Contact/How-to-filter-for-certain-contacts'>this</a> list This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Find contact by ID via GET /Contact/{contactId}. Returns a single contact

Get number of all items via GET /Contact/{contactId}/getTabsItemCount. Get number of all invoices, orders, etc. of a specified contact

Find contacts by custom field value via GET /Contact/Factory/findContactsByCustomFieldValue. Returns an array of contacts having a certain custom field value set. This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Get next free customer number via GET /Contact/Factory/getNextCustomerNumber. Retrieves the next available customer number. Avoids duplicates. This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Check if a customer number is available via GET /Contact/Mapper/checkCustomerNumberAvailability. Checks if a given customer number is available or already used. This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Retrieve contact addresses via GET /ContactAddress. Retrieve all contact addresses This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Find contact address by ID via GET /ContactAddress/{contactAddressId}. Returns a single contact address

Get Contact Fields via GET /ContactCustomField. Retrieve all contact fields This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Get Contact Fields By ID via GET /ContactCustomField/{contactCustomFieldId}. Retrieve all contact fields

Retrieve contact field settings via GET /ContactCustomFieldSetting. Retrieve all contact field settings This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Find contact field setting by ID via GET /ContactCustomFieldSetting/{contactCustomFieldSettingId}. Returns a single contact field setting

Receive count reference via GET /ContactCustomFieldSetting/{contactCustomFieldSettingId}/getReferenceCount

Retrieve CreditNote via GET /CreditNote. There are a multitude of parameter which can be used to filter. This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Find creditNote by ID via GET /CreditNote/{creditNoteId}. Returns a single creditNote

Retrieve pdf document of a credit note via GET /CreditNote/{creditNoteId}/getPdf. Retrieves the pdf document of a credit note with additional metadata.

Send credit note by printing via GET /CreditNote/{creditNoteId}/sendByWithRender. Sending a credit note to end-customers is an important part of the bookkeeping process.<br> Depending on the way you want to send the credit note, you need to use different endpoints.<br> Let's start with just printing out the credit note, meaning we only need to render the pdf.

Retrieve creditNote positions via GET /CreditNotePos. Retrieve all creditNote positions depending on the filters defined in the query. This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Retrieve letterpapers via GET /DocServer/getLetterpapersWithThumb. Retrieve all letterpapers with Thumb This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Retrieve templates via GET /DocServer/getTemplatesWithThumb. Retrieve all templates This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Export contact via GET /Export/contactListCsv. Contact export as csv This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Start DATEV CSV ZIP export via GET /Export/createDatevCsvZipExportJob. Start an export that generates booking data in the DATEV format (CSV) Before you can perform the DATEV export, you first have to set the "accountingYearBegin". To do this, use the endpoint <a href='#tag/Export/operation/updateExportConfig'>updateExportConfig</a>. After that you can use the createDatevCsvZipExportJob endpoint to start the DATEV export which returns the export ID. You have to use the <a href='#tag/Export/operation/jobDownloadInfo'>jobDownloadInfo</a> endpoint to receive the download url when the export is ready. <h3>Export workflow</h2> To get the DATEV CSV zip file, please implement the following workflow. <ol> <li>Set the accountingYearBegin (if not already set) via <a href='#tag/Export/operation/updateExportConfig'>updateExportConfig</a></li> <li>Start the export by using the createDatevCsvZipExportJob endpoint</li> <li>Request a progressHash with endpoint <a href='#tag/Export/operation/generateDownloadHash'>generateDownloadHash</a> (optional)</li> <li>Use the progressHash to receive export progress information with endpoint <a href='#tag/Export/operation/getProgress'>getProgress</a> (optional)</li> <li>Use the <a href='#tag/Export/operation/jobDownloadInfo'>jobDownloadInfo</a> endpoint to get the download url to the zip file.</li> </ol> This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Start DATEV XML ZIP export via GET /Export/createDatevXmlZipExportJob. Start an export that generates invoice data in the DATEV format (XML) Before you can perform the DATEV export, you first have to set the "accountingYearBegin". To do this, use the endpoint <a href='#tag/Export/operation/updateExportConfig'>updateExportConfig</a>. After that you can use the createDatevXmlZipExportJob endpoint to start the DATEV export which returns the export ID. You have to use the <a href='#tag/Export/operation/jobDownloadInfo'>jobDownloadInfo</a> endpoint to receive the download url when the export is ready. <h3>Export workflow</h2> To get the DATEV XML zip file, please implement the following workflow. <ol> <li>Set the accountingYearBegin (if not already set) via <a href='#tag/Export/operation/updateExportConfig'>updateExportConfig</a></li> <li>Start the export by using the createDatevXmlZipExportJob endpoint</li> <li>Request a progressHash with endpoint <a href='#tag/Export/operation/generateDownloadHash'>generateDownloadHash</a> (optional)</li> <li>Use the progressHash to receive export progress information with endpoint <a href='#tag/Export/operation/getProgress'>getProgress</a> (optional)</li> <li>Use the <a href='#tag/Export/operation/jobDownloadInfo'>jobDownloadInfo</a> endpoint to get the download url to the zip file.</li> </ol> This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Export creditNote via GET /Export/creditNoteCsv. Export all credit notes as csv This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Export datev via GET /Export/datevCSV. DATEV export as zip with CSVs. Before you can perform the DATEV export, you must first set the "accountingYearBegin". To do this, you must use the <a href='#tag/Export/operation/updateExportConfig'>updateExportConfig</a> endpoint. Please note, that this endpoint is deprecated. You should use the endpoint <a href='#tag/Export/operation/exportDatevCSV'>/Export/createDatevCsvZipExportJob</a>. sevDesk marks this operation DEPRECATED in its own specification. It still answers, and sevDesk announces removals in advance, but prefer the replacement its reference names before building on this one. This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Export invoice via GET /Export/invoiceCsv. Export all invoices as csv This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Export Invoice as zip via GET /Export/invoiceZip. Export all invoices as zip This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Export transaction via GET /Export/transactionsCsv. Export all transactions as csv This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Export voucher as zip via GET /Export/voucherListCsv. Export all vouchers as zip This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Export voucher zip via GET /Export/voucherZip. export all vouchers as zip This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Get job download info via GET /ExportJob/jobDownloadInfo. When the export job has finished you can call this endpoint to get the download url. This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Retrieve invoices via GET /Invoice. 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 <a href='#tag/Invoice/How-to-filter-for-certain-invoices'>this</a> list This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Find invoice by ID via GET /Invoice/{invoiceId}. Returns a single invoice

Check if an invoice is already partially paid via GET /Invoice/{invoiceId}/getIsPartiallyPaid. 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.

Retrieve pdf document of an invoice via GET /Invoice/{invoiceId}/getPdf. Retrieves the pdf document of an invoice with additional metadata.

Find invoice positions via GET /Invoice/{invoiceId}/getPositions. Returns all positions of an invoice sevDesk returns {"total": "157", "objects": [...]}, and `limit` with `offset` is the only way through a large collection. Send both explicitly.

Retrieve XML of an e-invoice via GET /Invoice/{invoiceId}/getXml. Retrieves the XML of an e-invoice

Retrieve InvoicePos via GET /InvoicePos. There are a multitude of parameter which can be used to filter. This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Retrieve orders via GET /Order. 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 <a href='#tag/Order/How-to-filter-for-certain-orders'>this</a> list This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Find order by ID via GET /Order/{orderId}. Returns a single order

Find order discounts via GET /Order/{orderId}/getDiscounts. Returns all discounts of an order sevDesk returns {"total": "157", "objects": [...]}, and `limit` with `offset` is the only way through a large collection. Send both explicitly.

Retrieve pdf document of an order via GET /Order/{orderId}/getPdf. Retrieves the pdf document of an order with additional metadata and commit the order.

Find order positions via GET /Order/{orderId}/getPositions. Returns all positions of an order sevDesk returns {"total": "157", "objects": [...]}, and `limit` with `offset` is the only way through a large collection. Send both explicitly.

Find related objects via GET /Order/{orderId}/getRelatedObjects. Get related objects of a specified order

Retrieve order positions via GET /OrderPos. Retrieve all order positions depending on the filters defined in the query. This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Find order position by ID via GET /OrderPos/{orderPosId}. Returns a single order position

Retrieve parts via GET /Part. Retrieve all parts in your sevdesk inventory according to the applied filters. This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Find part by ID via GET /Part/{partId}. Returns a single part

Get stock of a part via GET /Part/{partId}/getStock. Returns the current stock amount of the given part.

List existing rules via GET /PrivateTransactionRule. List all existing rules you defined for automated marking private transactions. This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Generate download hash via GET /Progress/generateDownloadHash. Generates an identifier to request the current export progress. This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Get progress via GET /Progress/getProgress. Get the progress state of the export. You can use polling (request every few seconds) to get the current state. This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Get guidance by account number via GET /ReceiptGuidance/forAccountNumber. You can use this endpoint to get additional information about the account that you may want to use. This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Get all account guides via GET /ReceiptGuidance/forAllAccounts. You can use this endpoint to help you decide which accounts you can use when creating a voucher This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Get guidance for expense accounts via GET /ReceiptGuidance/forExpense. Provides all possible combinations for expense accounts to be used with expense receipts/vouchers. This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Get guidance for revenue accounts via GET /ReceiptGuidance/forRevenue. Provides all possible combinations for revenue accounts to be used with revenue receipts/vouchers. This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Get guidance by Tax Rule via GET /ReceiptGuidance/forTaxRule. You can use this endpoint to get additional information about the tax rule (for example, USTPFL_UMS_EINN) that you may want to use. This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Export contact list via GET /Report/contactlist. This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Export invoice list via GET /Report/invoicelist. This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Export order list via GET /Report/orderlist. This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Export voucher list via GET /Report/voucherlist. This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Retrieve tags via GET /Tag. Retrieve all tags This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Find tag by ID via GET /Tag/{tagId}. Returns a single tag

Retrieve tag relations via GET /TagRelation. Retrieve all tag relations This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Retrieve Placeholders via GET /Textparser/fetchDictionaryEntriesByType. Retrieve all Placeholders This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Retrieve bookkeeping system version via GET /Tools/bookkeepingSystemVersion. To check if you already received the update to version 2.0 you can use this endpoint. This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Retrieve vouchers via GET /Voucher. 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 <a href='#tag/Voucher/How-to-filter-for-certain-vouchers'>this</a> list This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Find voucher by ID via GET /Voucher/{voucherId}. Returns a single voucher

Retrieve voucher positions via GET /VoucherPos. Retrieve all voucher positions depending on the filters defined in the query. This read takes no limit or offset: sevDesk's specification declares pagination on three operations only, so the whole collection comes back in one response envelope ({"total": ..., "objects": [...]}) and there is nothing to page with.

Create a new accounting contact via POST /AccountingContact. Creates a new accounting contact.

Create a new clearing account via POST /CheckAccount/Factory/clearingAccount. Creates a new clearing account.

Create a new file import account via POST /CheckAccount/Factory/fileImportAccount. Creates a new banking account for file imports (CSV, MT940).

Create a new transaction via POST /CheckAccountTransaction. Creates a new transaction on a check account. This should only be used with check account type online, preferably for csv import accounts.

Create a new contact communication way via POST /CommunicationWay. Creates a new contact communication way.

Create a new contact via POST /Contact. Creates a new contact.<br> For adding addresses and communication ways, you will need to use the ContactAddress and CommunicationWay endpoints.

Create a new contact address via POST /ContactAddress. Creates a new contact address.

Create contact field via POST /ContactCustomField

Create contact field setting via POST /ContactCustomFieldSetting

Send credit note via email via POST /CreditNote/{creditNoteId}/sendViaEmail. This endpoint sends the specified credit note to a customer via email.<br> This will automatically mark the credit note as sent.<br> Please note, that in production an credit note is not allowed to be changed after this happened!

Creates a new creditNote from an invoice via POST /CreditNote/Factory/createFromInvoice. Use this endpoint to create a new creditNote from an invoice.

Creates a new creditNote from a voucher via POST /CreditNote/Factory/createFromVoucher. **Not supported with sevdesk-Update 2.0** Use this endpoint to create a new creditNote from a voucher.

Create a new creditNote via POST /CreditNote/Factory/saveCreditNote. The list of parameters starts with the credit note array.<br> This array contains all required attributes for a complete credit note.<br> Most of the attributes are covered in the credit note attribute list, there are only two parameters standing out, namely <b>mapAll</b> and <b>objectName</b>.<br> These are just needed for our system and you always need to provide them.<br> The list of parameters then continues with the credit note position array.<br> With this array you have the possibility to add multiple positions at once.<br> In the example it only contains one position, again together with the parameters <b>mapAll</b> and <b>objectName</b>, however, you can add more credit note positions by extending the array.<br> 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".<br><br> The list ends with the five parameters creditNotePosDelete, discountSave, discountDelete, takeDefaultAddress and forCashRegister.<br> They only play a minor role if you only want to create a credit note but we will shortly explain what they can do.<br> With creditNotePosDelete you have to option to delete credit note positions as this request can also be used to update credit notes.<br> 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.<br> 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.<br> Finally, the forCashRegister parameter needs to be set to <b>true</b> if your credit note is to be booked on the cash register.<br> 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.<br> Finally, after covering all parameters, they only important information left, is that the order of the last five attributes always needs to be kept.<br> You will also always need to provide all of them, as otherwise the request won't work properly. sevDesk marks this operation DEPRECATED in its own specification. It still answers, and sevDesk announces removals in advance, but prefer the replacement its reference names before building on this one.

Cancel an invoice / Create cancellation invoice via POST /Invoice/{invoiceId}/cancelInvoice. This endpoint will cancel the specified invoice therefor creating a cancellation invoice.<br> The cancellation invoice will be automatically paid and the source invoices status will change to 'cancelled'.

Render the pdf document of an invoice via POST /Invoice/{invoiceId}/render. Using this endpoint you can render the pdf document of an invoice.<br> Use cases for this are the retrieval of the pdf location or the forceful re-render of a already sent invoice.<br> Please be aware that changing an invoice after it has been sent to a customer is not an allowed bookkeeping process.

Send invoice via email via POST /Invoice/{invoiceId}/sendViaEmail. This endpoint sends the specified invoice to a customer via email.<br> This will automatically mark the invoice as sent.<br> Please note, that in production an invoice is not allowed to be changed after this happened!

Create invoice from order via POST /Invoice/Factory/createInvoiceFromOrder. Create an invoice from an order

Create invoice reminder via POST /Invoice/Factory/createInvoiceReminder. Create an reminder from an invoice

Create a new invoice via POST /Invoice/Factory/saveInvoice. This endpoint offers you the following functionality. <ul> <li>Create invoices together with positions and discounts</li> <li>Delete positions while adding new ones</li> <li>Delete or add discounts, or both at the same time</li> <li>Automatically fill the address of the supplied contact into the invoice address</li> </ul> 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.<br><br> The list of parameters starts with the invoice array.<br> This array contains all required attributes for a complete invoice.<br> Most of the attributes are covered in the invoice attribute list, there are only two parameters standing out, namely <b>mapAll</b> and <b>objectName</b>.<br> These are just needed for our system and you always need to provide them.<br><br> The list of parameters then continues with the invoice position array.<br> With this array you have the possibility to add multiple positions at once.<br> In the example it only contains one position, again together with the parameters <b>mapAll</b> and <b>objectName</b>, however, you can add more invoice positions by extending the array.<br> 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".<br><br> The list ends with the four parameters invoicePosDelete, discountSave, discountDelete and takeDefaultAddress.<br> They only play a minor role if you only want to create an invoice but we will shortly explain what they can do.<br> With invoicePosDelete you have to option to delete invoice positions as this request can also be used to update invoices.<br> With discountSave you can add discounts to your invoice.<br> With discountDelete you can delete discounts from your invoice.<br> 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.<br> 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.<br><br> Finally, after covering all parameters, they only important information left, is that the order of the last four attributes always needs to be kept.<br> You will also always need to provide all of them, as otherwise the request won't work properly.<br><br> <b>Warning:</b> You can not create a regular invoice with the <b>deliveryDate</b> being later than the <b>invoiceDate</b>.<br> To do that you will need to create a so called <b>Abschlagsrechnung</b> by setting the <b>invoiceType</b> parameter to <b>AR</b>.

Send order via email via POST /Order/{orderId}/sendViaEmail. This endpoint sends the specified order to a customer via email.<br> This will automatically mark the order as sent.<br> Please note, that in production an order is not allowed to be changed after this happened!

Create contract note from order via POST /Order/Factory/createContractNoteFromOrder

Create packing list from order via POST /Order/Factory/createPackingListFromOrder

Create a new order via POST /Order/Factory/saveOrder. Creates an order to which positions can be added later.

Create a new part via POST /Part. Creates a part in your sevdesk inventory.

Create a new rule via POST /PrivateTransactionRule. Creates a new rule for marking private transactions automatically.

Create a new tag via POST /Tag/Factory/create

Create a new voucher via POST /Voucher/Factory/saveVoucher. Bundles the creation or updating of voucher and voucher position.<br> The list of parameters starts with the voucher model.<br> This contains all required attributes for a complete voucher.<br> Most of the attributes are covered in the voucher attribute list, there are only two parameters standing out, namely <b>mapAll</b> and <b>objectName</b>.<br> These are just needed for our system and you always need to provide them.<br><br> The list of parameters then continues with the voucher position array.<br> With this array you have the possibility to add multiple positions at once.<br> In the example it only contains one position, again together with the parameters <b>mapAll</b> and <b>objectName</b>, however, you can add more voucher positions by extending the array.<br> 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\".<br><br> The list ends with the two parameters voucherPosDelete and filename.<br> We will shortly explain what they can do.<br> With voucherPosDelete you can delete voucher positions as this request can also be used to update draft vouchers.<br> With filename you can attach a file to the voucher.<br> For most of our customers this is a really important step, as they need to digitize their receipts.<br> Finally, after covering all parameters, the only important information left, is that the order of the last two attributes always needs to be kept. <br><br> The only valid status values for this endpoint are 50 (draft) and 100 (open). You can only update draft vouchers. If you have to, you can downgrade the status by calling resetToOpen (from paid) and resetToDraft (from open).

Update an existing accounting contact via PUT /AccountingContact/{accountingContactId}. Attention, updating an existing AccountingContact can lead to **booking errors**, especially in the **DATEV export**. Compatibility of sevdesk with DATEV is no longer guaranteed.

Update an existing check account via PUT /CheckAccount/{checkAccountId}. Update a check account

Update an existing check account transaction via PUT /CheckAccountTransaction/{checkAccountTransactionId}. Update a check account transaction

Check Account Transaction Enshrine via PUT /CheckAccountTransaction/{checkAccountTransactionId}/enshrine. Sets the current date and time as a value for the property `enshrined`.<br> This operation is only possible if the status is "Linked" (`"status": "200"`) or higher. Linked invoices, credit notes or vouchers cannot be changed when the transaction is enshrined. Enshrining is IRREVERSIBLE: it seals the record for bookkeeping and sevDesk offers no un-enshrine. The document can no longer be edited or deleted afterwards.

Update a existing communication way via PUT /CommunicationWay/{communicationWayId}. Update a communication way

Update a existing contact via PUT /Contact/{contactId}. Update a contact

update a existing contact address via PUT /ContactAddress/{contactAddressId}. update a existing contact address.

Update a contact field via PUT /ContactCustomField/{contactCustomFieldId}

Update contact field setting via PUT /ContactCustomFieldSetting/{contactCustomFieldSettingId}. Update an existing contact field setting

Update an existing creditNote via PUT /CreditNote/{creditNoteId}. Update a creditNote

Book a credit note via PUT /CreditNote/{creditNoteId}/bookAmount. Booking the credit note with a transaction is probably the most important part in the bookkeeping process.<br> There are several ways on correctly booking a credit note, all by using the same endpoint.<br> Conveniently, the booking process is exactly the same as the process for invoices and vouchers.<br> For this reason, you can have a look at it in the <a href='#tag/Invoice/How-to-book-an-invoice'>invoice chapter</a> and all you need to do is to change "Invoice" into "CreditNote" in the URL.

Update an of credit note template via PUT /CreditNote/{creditNoteId}/changeParameter. Update an existing of credit note template

Credit Note Enshrine via PUT /CreditNote/{creditNoteId}/enshrine. Sets the current date and time as a value for the property `enshrined`.<br> 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. Enshrining is IRREVERSIBLE: it seals the record for bookkeeping and sevDesk offers no un-enshrine. The document can no longer be edited or deleted afterwards.

Credit Note Reset To Draft via PUT /CreditNote/{creditNoteId}/resetToDraft. Resets the status to "Draft" (`"status": "100"`).<br> This is only possible if the credit note has the status "Open" (`"status": "200"`).<br> If it has a higher status use [CreditNote/{creditNoteId}/resetToOpen](#tag/CreditNote/operation/creditNoteResetToOpen) first.

Credit Note Reset To Open via PUT /CreditNote/{creditNoteId}/resetToOpen. Resets the status "Open" (`"status": "200"`). Linked transactions will be unlinked.<br> 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"`).<br> Use [CreditNote/{creditNoteId}/sendBy](#tag/CreditNote/operation/creditNoteSendBy) / [CreditNote/{creditNoteId}/sendViaEmail](#tag/CreditNote/operation/sendCreditNoteViaEMail) instead.

Mark credit note as sent via PUT /CreditNote/{creditNoteId}/sendBy. Marks an credit note as sent by a chosen send type.

Book an invoice via PUT /Invoice/{invoiceId}/bookAmount. Booking the invoice with a transaction is probably the most important part in the bookkeeping process.<br> There are several ways on correctly booking an invoice, all by using the same endpoint.<br> for more information look <a href='#tag/Invoice/How-to-book-an-invoice'>here</a>.

Update an invoice template via PUT /Invoice/{invoiceId}/changeParameter. Update an existing invoice template

Invoice Enshrine via PUT /Invoice/{invoiceId}/enshrine. Sets the current date and time as a value for the property `enshrined`.<br> This operation is only possible if the status is "Open" (`"status": "200"`) or higher. Enshrined invoices cannot be changed. This operation cannot be undone. Enshrining is IRREVERSIBLE: it seals the record for bookkeeping and sevDesk offers no un-enshrine. The document can no longer be edited or deleted afterwards.

Invoice Reset To Draft via PUT /Invoice/{invoiceId}/resetToDraft. Resets the status to "Draft" (`"status": "100"`).<br> This is only possible if the invoice has the status "Open" (`"status": "200"`).<br> If it has a higher status use [Invoice/{invoiceId}/resetToOpen](#tag/Invoice/operation/invoiceResetToOpen) first. This endpoint cannot be used for recurring invoices (`"invoiceType": "WKR"`).<br> Use [Invoice/Factory/saveInvoice](#tag/Invoice/operation/createInvoiceByFactory) instead.

Invoice Reset To Open via PUT /Invoice/{invoiceId}/resetToOpen. Resets the status "Open" (`"status": "200"`). Linked transactions will be unlinked.<br> 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"`).<br> Use [Invoice/{invoiceId}/sendBy](#tag/Invoice/operation/invoiceSendBy) / [Invoice/{invoiceId}/sendViaEmail](#tag/Invoice/operation/sendInvoiceViaEMail) instead. This endpoint cannot be used for recurring invoices (`"invoiceType": "WKR"`). Use [Invoice/Factory/saveInvoice](#tag/Invoice/operation/createInvoiceByFactory) instead.

Mark invoice as sent via PUT /Invoice/{invoiceId}/sendBy. Marks an invoice as sent by a chosen send type.

Update an existing order via PUT /Order/{orderId}. Update an order

Update an order template via PUT /Order/{orderId}/changeParameter. Update an existing order template

Mark order as sent via PUT /Order/{orderId}/sendBy. Marks an order as sent by a chosen send type.

Update an existing order position via PUT /OrderPos/{orderPosId}. Update an order position

Update an existing part via PUT /Part/{partId}. Update a part

Update export config via PUT /SevClient/{SevClientId}/updateExportConfig. Update export config to export DATEV

Update tag via PUT /Tag/{tagId}. Update an existing tag

Update an existing voucher via PUT /Voucher/{voucherId}. Update a draft voucher using this method if you want to change simple values like the description. Complex changes like adding a position should use /Voucher/Factory/saveVoucher.<br> You can not change the status using this endpoint.

Book a voucher via PUT /Voucher/{voucherId}/bookAmount. Booking the voucher with a transaction is probably the most important part in the bookkeeping process.<br> There are several ways on correctly booking a voucher, all by using the same endpoint.<br> Conveniently, the booking process is exactly the same as the process for invoices.<br> For this reason, you can have a look at it <a href='#tag/Invoice/How-to-book-an-invoice'>here</a> and all you need to do is to change "Invoice" into "Voucher" in the URL.

Voucher Enshrine via PUT /Voucher/{voucherId}/enshrine. Sets the current date and time as a value for the property `enshrined`.<br> This operation is only possible if the status is "Open" (`"status": "100"`) or higher. Enshrined vouchers cannot be changed. This operation cannot be undone. Enshrining is IRREVERSIBLE: it seals the record for bookkeeping and sevDesk offers no un-enshrine. The document can no longer be edited or deleted afterwards.

Voucher Reset To Draft via PUT /Voucher/{voucherId}/resetToDraft. Resets the status "Draft" (`"status": "50"`). Linked payments will be unlinked. Created asset depreciation will be reset.<br> This is not possible if the voucher is already enshrined! You can only change the status from higher to lower ("Open" to "Draft").<br> To change to higher status use [/Voucher/Factory/saveVoucher](#tag/Voucher/operation/voucherFactorySaveVoucher).

Voucher Reset To Open via PUT /Voucher/{voucherId}/resetToOpen. Resets the status to "Open" (`"status": "100"`). Linked payments will be unlinked. Created asset depreciation will be reset.<br> This is not possible if the voucher is already enshrined! This endpoint can not be used to increase the status from "Draft" to "Open".<br> You can only change the status from higher to lower ("Open" to "Draft").<br> To change to higher status use [Voucher/{voucherId}/bookAmount](#tag/Voucher/operation/bookVoucher). To change to lower status use [Voucher/{voucherId}/resetToDraft](#tag/Voucher/operation/voucherResetToDraft).