# Sevdesk sevDesk is an online accounting software designed for small businesses and freelancers, offering features like invoicing, expense management, and financial reporting. - **Category:** accounting - **Auth:** API_KEY - **Composio Managed App Available?** N/A - **Tools:** 115 - **Triggers:** 0 - **Slug:** `SEVDESK` - **Version:** 20260313_00 ## Tools ### Book Invoice Amount **Slug:** `SEVDESK_BOOK_INVOICE_AMOUNT` Tool to book an invoice amount in SevDesk. Use when you need to record a payment for an invoice, either full or partial. This creates an invoice log entry and updates the invoice status accordingly. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | integer | Yes | The booking date as Unix timestamp. Most likely the current date | | `type` | string ("FULL_PAYMENT" | "N" | "CB" | "CF" | "O" | "OF" | "MTC") | Yes | Define a type for the booking. FULL_PAYMENT = Normal booking, N = Partial booking (historically used for normal booking), CB = Reduced amount due to discount (skonto), CF = Reduced/Higher amount due to currency fluctuations (deprecated), O = Reduced/Higher amount due to other reasons, OF = Higher amount due to reminder charges, MTC = Reduced amount due to the monetary traffic costs | | `amount` | number | Yes | Amount which should be booked. Can also be a partial amount | | `invoiceId` | integer | Yes | ID of invoice to book | | `createFeed` | boolean | No | Determines if a feed is created for the booking process | | `checkAccount` | object | Yes | The check account on which should be booked | | `checkAccountTransaction` | object | No | Reference to a check account transaction. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Check Customer Number Availability **Slug:** `SEVDESK_CHECK_CUSTOMER_NUMBER_AVAILABILITY` Tool to check if a customer number is available in sevDesk. Use when you need to verify that a customer number can be assigned without conflicts. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `customerNumber` | string | No | The customer number to be checked. If not provided, checks general availability. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Accounting Contact **Slug:** `SEVDESK_CREATE_ACCOUNTING_CONTACT` Tool to create a new accounting contact in sevDesk. Use when you need to assign debitor or creditor numbers to existing contacts for accounting purposes. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `contact` | object | Yes | The contact to which this accounting contact belongs | | `debitorNumber` | integer | No | Debitor number of the accounting contact. Used for customer/receivable accounting. | | `creditorNumber` | integer | No | Creditor number of the accounting contact. Used for supplier/payable accounting. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Check Account Transaction **Slug:** `SEVDESK_CREATE_CHECK_ACCOUNT_TRANSACTION` Tool to create a new check account transaction in SevDesk. Use when you need to manually record a transaction for a payment account, such as bank transfers, cash movements, or other financial transactions that need to be tracked in the accounting system. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `amount` | number | Yes | Amount of the transaction (use positive for income, negative for expense) | | `status` | string ("created" | "linked" | "private" | "booked") | Yes | Status of the check account transaction: created (100), linked (200), private (300), or booked (400) | | `entryDate` | string | No | Date the check account transaction was imported, in ISO 8601 format (e.g., '2024-05-10T00:00:00+02:00') | | `valueDate` | string | Yes | Date the check account transaction was booked, in ISO 8601 format (e.g., '2024-05-10T00:00:00+02:00') | | `checkAccount` | object | Yes | The check account to which the transaction belongs | | `paymtPurpose` | string | No | The purpose of the transaction | | `payeePayerName` | string | Yes | Name of the other party involved in the transaction | | `payeePayerAcctNo` | string | No | IBAN or account number of the other party | | `sourceTransaction` | object | No | Reference to the source transaction for rebooking. | | `targetTransaction` | object | No | Reference to the target transaction for rebooking. | | `payeePayerBankCode` | string | No | BIC or bank code of the other party | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Clearing Account **Slug:** `SEVDESK_CREATE_CLEARING_ACCOUNT` Tool to create a new clearing account in sevDesk. Use when you need to set up accounts for tracking intermediate transactions like coupons, gift cards, or prepayments. Clearing accounts are offline accounts used for booking purposes. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name of the clearing account | | `accountingNumber` | integer | No | The booking account used for this clearing account, e.g. 3320 in SKR04 and 1723 in SKR03. Must be unique among all your CheckAccounts. Ask your tax consultant what to choose. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Communication Way **Slug:** `SEVDESK_CREATE_COMMUNICATION_WAY` Tool to create a new contact communication way (email, phone, website, etc.) in SevDesk. Use when you need to add contact information like email addresses, phone numbers, or website URLs to an existing contact. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `key` | object | Yes | The key/category of the communication way. For all available keys, use GET /CommunicationWayKey endpoint | | `main` | boolean | No | Defines whether this is the main communication way for the contact. Only one communication way of each type can be marked as main | | `type` | string ("EMAIL" | "PHONE" | "WEB" | "MOBILE") | Yes | Type of the communication way | | `value` | string | Yes | The value of the communication way (e.g., phone number, email address, or website URL) | | `contact` | object | No | Reference to a contact in SevDesk | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Contact **Slug:** `SEVDESK_CREATE_CONTACT` Creates a new contact (person or company) in SevDesk accounting system. Required fields: - type: Must be 'PERSON' or 'COMPANY' - familyname: Required for PERSON type (last name) - name: Required for COMPANY type (company name) - category: Contact category reference (e.g., id=3 for Customer, id=2 for Supplier) Automatically generates customerNumber if not provided. Supports optional fields like email, phone, address, bank details, tax information, and more. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `fax` | string | No | Fax number | | `name` | string | No | Company name, required if type=COMPANY | | `type` | string ("PERSON" | "COMPANY") | Yes | Contact type: PERSON or COMPANY | | `email` | string | No | Email address | | `phone` | string | No | Telephone number | | `gender` | string ("m" | "w" | "d") | No | Gender: m=male, w=female, d=diverse | | `mobile` | string | No | Mobile phone number | | `address` | object | No | Postal address for the contact | | `revenue` | number | No | Annual revenue as numeric value | | `birthday` | string | No | Birth date in YYYY-MM-DD format | | `category` | object | Yes | Category reference for grouping contacts. Common values: id=3 for 'Customer', id=2 for 'Supplier' | | `surename` | string | No | Deprecated: Use 'familyname' instead. This field is kept for backward compatibility. | | `firstname` | string | No | First name of the person | | `taxNumber` | string | No | Tax number | | `taxOffice` | string | No | Tax office | | `vatNumber` | string | No | VAT number | | `familyname` | string | No | Last name/family name, required if type=PERSON | | `bankDetails` | object | No | Bank account details for the contact | | `description` | string | No | Free-text notes | | `academicTitle` | string | No | Academic title (e.g., Dr.) | | `customerNumber` | string | No | Customer reference code | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Contact (REST API) **Slug:** `SEVDESK_CREATE_CONTACT2` Tool to create a new contact in sevDesk using the standard REST API endpoint. Use when you need to create a person or organization contact with category assignment. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | The organization name. Be aware that the type of contact will depend on this attribute. If it holds a value, the contact will be regarded as an organization. | | `name2` | string | No | Second name of the contact. Not to be used for organizations. | | `titel` | string | No | A non-academic title for the contact. Not to be used for organizations. | | `gender` | string | No | Gender of the contact. Not to be used for organizations. | | `parent` | object | No | Parent contact reference - must be an organization | | `status` | integer | No | Defines the status of the contact. 100 = Lead, 500 = Pending, 1000 = Active. Defaults to 100. | | `birthday` | string | No | Birthday of the contact in YYYY-MM-DD format. Not to be used for organizations. | | `category` | object | Yes | Category of the contact. Required field. For more information, see https://my.sevdesk.de/apiOverview/index.html#/doc-contacts#types | | `surename` | string | No | The first name of the contact. Not to be used for organizations. | | `exemptVat` | boolean | No | Defines if the contact is freed from paying VAT. | | `taxNumber` | string | No | The tax number of the contact. | | `taxOffice` | string | No | The tax office of the contact (only for greek customers). | | `vatNumber` | string | No | VAT number of the contact. | | `bankNumber` | string | No | Bank number of the bank used by the contact. | | `familyname` | string | No | The last name of the contact. Not to be used for organizations. | | `bankAccount` | string | No | Bank account number (IBAN) of the contact. | | `description` | string | No | A description for the contact. | | `academicTitle` | string | No | An academic title for the contact. Not to be used for organizations. | | `buyerReference` | string | No | Buyer reference of the contact. | | `customerNumber` | string | No | The customer number | | `defaultTimeToPay` | integer | No | The payment goal in days which is set for every invoice of the contact. | | `governmentAgency` | boolean | No | Defines whether the contact is a government agency (true) or not (false). | | `defaultCashbackTime` | integer | No | Absolute time in days which the contact has to pay his invoices and subsequently get a cashback. | | `defaultDiscountAmount` | number | No | The default discount the contact gets for every invoice. Depending on defaultDiscountPercentage attribute, in percent or absolute value. | | `defaultCashbackPercent` | number | No | Percentage of the invoice sum the contact gets back if he paid invoices in time. | | `defaultDiscountPercentage` | boolean | No | Defines if the discount is a percentage (true) or an absolute value (false). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Contact Address **Slug:** `SEVDESK_CREATE_CONTACT_ADDRESS` Tool to create a new contact address in SevDesk. Use when you need to add a new address for an existing contact with street, city, postal code, and country information. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `zip` | string | No | Zip code | | `city` | string | No | City name | | `name` | string | No | Name in address | | `name2` | string | No | Second name in address | | `name3` | string | No | Third name in address | | `name4` | string | No | Fourth name in address | | `street` | string | No | Street name | | `contact` | object | Yes | The contact to which this contact address belongs | | `country` | object | Yes | Country of the contact address. For all countries, send a GET to /StaticCountry | | `category` | object | Yes | Category of the contact address. For all categories, send a GET to /Category?objectType=ContactAddress | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Contact Custom Field **Slug:** `SEVDESK_CREATE_CONTACT_CUSTOM_FIELD` Tool to create a custom field for a contact in sevDesk. Use when you need to add custom field values to a contact. Requires references to both the contact and the custom field setting that defines the field type. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `value` | string | Yes | The value to set for this custom field | | `contact` | object | Yes | Reference to the contact for which to create the custom field | | `contactCustomFieldSetting` | object | Yes | Reference to the custom field setting that defines the field type and metadata | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Contact Custom Field Setting **Slug:** `SEVDESK_CREATE_CONTACT_CUSTOM_FIELD_SETTING` Creates a new contact custom field setting in sevDesk for tracking additional contact information. Use this tool when you need to add custom fields to contacts to store information beyond the standard fields provided by sevDesk (e.g., customer type, lead source, industry classification, or other custom attributes). Once created, these custom fields can be used when managing contacts. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name of the contact custom field (e.g., 'Customer ID', 'Referral Source', 'Industry') | | `objectName` | string | No | Internal object name which should be 'ContactCustomFieldSetting'. This is typically set automatically by the API. | | `description` | string | No | Description of the contact custom field to explain its purpose or usage | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Credit Note from Invoice **Slug:** `SEVDESK_CREATE_CREDIT_NOTE_FROM_INVOICE` Tool to create a new credit note from an existing invoice in SevDesk. Use when you need to issue a credit note based on an already created invoice. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `invoice` | object | Yes | Reference to the existing invoice to create a credit note from | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create File Import Account **Slug:** `SEVDESK_CREATE_FILE_IMPORT_ACCOUNT` Tool to create a new file import account (check account) in sevDesk. Use when you need to set up a new bank account that will receive transaction imports via CSV or MT940 files. The account will be created with type 'online' to support file imports. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `iban` | string | No | IBAN of the bank account, without spaces | | `name` | string | Yes | Name of the check account | | `importType` | string ("CSV" | "MT940") | Yes | Import type for transactions. CSV for comma-separated values or MT940 for the MT940 format | | `accountingNumber` | integer | No | The booking account used for this bank account, e.g. 1800 in SKR04 and 1200 in SKR03. Must be unique among all your CheckAccounts. If not provided, a sensible default will be used | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Part **Slug:** `SEVDESK_CREATE_PART` Tool to create a new part (product or service) in SevDesk. Use when you need to add inventory items, products, or services to the system for use in invoices and orders. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name of the part | | `text` | string | No | A text describing the part - longer description or notes | | `price` | number | No | Net price for which the part is sold. Deprecated - use priceNet instead. This parameter will be changed so that the gross price is calculated automatically | | `stock` | number | Yes | The stock quantity of the part | | `unity` | object | Yes | The unit in which the part is measured (e.g., pieces, hours, meters) | | `status` | string ("inactive" | "active") | No | Status of the part in sevDesk | | `taxRate` | number | Yes | Tax rate of the part as a percentage (e.g., 19 for 19% VAT) | | `category` | object | No | Category reference for a part | | `priceNet` | number | No | Net price for which the part is sold (excluding tax) | | `partNumber` | string | Yes | The part number - unique identifier for the part | | `priceGross` | number | No | Gross price for which the part is sold (including tax) | | `stockEnabled` | boolean | Yes | Whether stock tracking is enabled for this part. Set to true to track inventory, false to disable | | `pricePurchase` | number | No | Purchase price of the part (cost) | | `internalComment` | string | No | An internal comment for the part. Does not appear on invoices and orders | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Payment Method **Slug:** `SEVDESK_CREATE_PAYMENT_METHOD` Creates a new payment method in sevDesk for tracking different payment types. Use this tool when you need to add custom payment options (e.g., specific credit cards, digital wallets, or regional payment methods) that aren't already available in the system. The created payment method can then be used when creating invoices or recording payments. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name of the payment method (e.g., 'Credit Card', 'PayPal', 'Cash') | | `type` | string | Yes | Type identifier for the payment method. Common values include: 'cash', 'banktransfer', 'creditcard', 'debitcard', 'paypal', 'directdebit', 'check', or custom types | | `isActive` | boolean | No | Whether the payment method is active and available for use. Defaults to true if omitted. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Private Transaction Rule **Slug:** `SEVDESK_CREATE_PRIVATE_TRANSACTION_RULE` Tool to create a new private transaction rule in SevDesk. Use when you need to define rules that automatically mark transactions as private based on counterpart name or payment purpose. This is useful for separating personal transactions from business ones. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `objectName` | string | No | The object name, must be 'PrivateTransactionRule' | | `paymentPurpose` | string | No | The purpose of transactions that you want to match. Transactions matching this payment purpose will be automatically marked as private. | | `counterpartName` | string | No | The counterpart name of transactions that you want to match. Transactions matching this name will be automatically marked as private. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Tag **Slug:** `SEVDESK_CREATE_TAG` Tool to create a new tag and attach it to an object (Invoice, Order, Voucher, or CreditNote) in sevDesk. Use when you need to categorize or label objects for organization and filtering. If a tag with the same name already exists, it will be linked to the object instead of creating a duplicate. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name of the tag to create. If the tag already exists, it will be linked to the object instead of creating a duplicate. | | `object` | object | Yes | Reference to the object (Invoice, Order, Voucher, or CreditNote) that should be tagged | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Accounting Contact By ID **Slug:** `SEVDESK_DELETE_ACCOUNTING_CONTACT_BY_ID` Permanently deletes an accounting contact from sevDesk by its unique identifier. This action removes the accounting contact and cannot be undone. Use this when you need to: - Remove outdated or duplicate accounting contacts - Clean up test data - Delete accounting contacts that are no longer needed The accounting contact ID must be valid and the contact must exist, otherwise a 404 error will be raised. Example: "Delete accounting contact with ID 90804710" #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `accountingContactId` | integer | Yes | The unique identifier of the accounting contact to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Check Account By ID **Slug:** `SEVDESK_DELETE_CHECK_ACCOUNT_BY_ID` Permanently deletes a check account from sevDesk by its unique identifier. This action removes the check account (bank account) and cannot be undone. Use this when you need to: - Remove outdated or unused bank accounts - Clean up test data - Delete check accounts that are no longer needed The check account ID must be valid and the account must exist, otherwise a 404 error will be raised. Example: "Delete check account with ID 6158594" #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `checkAccountId` | integer | Yes | The unique identifier of the check account to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Check Account Transaction **Slug:** `SEVDESK_DELETE_CHECK_ACCOUNT_TRANSACTION_BY_ID` Permanently deletes a check account transaction from sevDesk by its unique identifier. Use when you need to remove a transaction that was created in error or is no longer needed. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `checkAccountTransactionId` | integer | Yes | Id of check account transaction to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Communication Way By ID **Slug:** `SEVDESK_DELETE_COMMUNICATION_WAY_BY_ID` Permanently deletes a communication way from sevDesk by its unique identifier. Use when you need to remove phone numbers, email addresses, or other contact methods from contacts. The communication way ID must be valid and exist, otherwise a 404 error will be raised. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `communicationWayId` | integer | Yes | Id of communication way resource to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Contact **Slug:** `SEVDESK_DELETE_CONTACT` Permanently deletes a contact from sevDesk by its unique identifier. This action removes the contact and cannot be undone. Use this when you need to: - Remove outdated or duplicate contacts - Clean up test data - Delete contacts that are no longer needed The contact ID must be valid and the contact must exist, otherwise a 404 error will be raised. Example: "Delete contact with ID 12345" #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The unique identifier of the contact to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Contact Address By ID **Slug:** `SEVDESK_DELETE_CONTACT_ADDRESS_BY_ID` Tool to delete a contact address from sevDesk by its unique identifier. Use when you need to permanently remove a contact address that is no longer needed or is outdated. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `contactAddressId` | integer | Yes | Id of contact address resource to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Contact Custom Field By ID **Slug:** `SEVDESK_DELETE_CONTACT_CUSTOM_FIELD_BY_ID` Tool to permanently delete a contact custom field by its ID. Use when you need to remove a custom field value from a contact. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `contactCustomFieldId` | integer | Yes | The unique identifier of the contact custom field to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Contact Custom Field Setting By ID **Slug:** `SEVDESK_DELETE_CONTACT_CUSTOM_FIELD_SETTING_BY_ID` Tool to permanently delete a contact custom field setting by its ID. Use when you need to remove a custom field configuration from contacts. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `contactCustomFieldSettingId` | integer | Yes | The unique identifier of the contact custom field setting to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Credit Note By ID **Slug:** `SEVDESK_DELETE_CREDIT_NOTE_BY_ID` Permanently deletes a credit note from sevDesk by its unique identifier. This action removes the credit note and cannot be undone. Use this when you need to: - Remove outdated or incorrect credit notes - Clean up draft credit notes that are no longer needed - Delete test data Note: The credit note must be in draft status to be deleted. Attempting to delete a non-draft credit note will result in a 409 Conflict error. The credit note ID must be valid and exist, otherwise a 404 error will be raised. Example: "Delete credit note with ID 2569269" #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `creditNoteId` | integer | Yes | The unique identifier of the credit note to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Order By ID **Slug:** `SEVDESK_DELETE_ORDER_BY_ID` Permanently deletes an order from sevDesk by its unique identifier. Use this when you need to remove orders from the system. Note that only draft orders can be deleted - attempting to delete orders in other states will result in a 409 conflict error. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `orderId` | integer | Yes | The unique identifier of the order to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Order Position By ID **Slug:** `SEVDESK_DELETE_ORDER_POS_BY_ID` Permanently deletes an order position from sevDesk by its unique identifier. Use this when you need to remove line items or positions from orders. Note that deletion may fail with a 409 conflict error if the order is not in draft status. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `orderPosId` | integer | Yes | Id of order position resource to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Payment Method **Slug:** `SEVDESK_DELETE_PAYMENT_METHOD` Deletes a payment method in sevDesk by its ID. Use this when you need to permanently remove a payment method from the system. Requires the payment method ID which can be obtained from the Get Payment Methods or Create Payment Method actions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique ID of the payment method to delete (numeric string) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Private Transaction Rule By ID **Slug:** `SEVDESK_DELETE_PRIVATE_TRANSACTION_RULE_BY_ID` Permanently deletes a private transaction rule from sevDesk by its unique identifier. Use when you need to remove a rule that is no longer needed. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Id of the rule to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Tag By ID **Slug:** `SEVDESK_DELETE_TAG_BY_ID` Permanently deletes a tag from sevDesk by its unique identifier. Use this when you need to remove tags that are no longer needed or to clean up tag data. The tag ID must be valid and the tag must exist, otherwise a 404 error will be raised. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tagId` | integer | Yes | Id of tag to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Enshrine Check Account Transaction **Slug:** `SEVDESK_ENSHRINE_CHECK_ACCOUNT_TRANSACTION` Tool to enshrine a check account transaction by its ID. Use when you need to permanently lock or finalize a transaction to prevent further modifications. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `checkAccountTransactionId` | integer | Yes | The unique identifier of the check account transaction to enshrine | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Export Credit Note CSV **Slug:** `SEVDESK_EXPORT_CREDIT_NOTE_CSV` Tool to export credit notes as CSV from SevDesk. Use when you need to retrieve credit note data in CSV format for reporting or data analysis. The export returns CSV content (either base64-encoded or plain text) along with file metadata. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `download` | boolean | No | Specifies if the document should be downloaded. Set to true to trigger download, false to return base64-encoded content | | `sevQuery_modelName` | string | No | Model name to be exported, should be 'CreditNote' for this endpoint | | `sevQuery_objectName` | string | No | SevQuery object name, typically 'SevQuery' | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch Dictionary Entries By Type **Slug:** `SEVDESK_FETCH_DICTIONARY_ENTRIES_BY_TYPE` Tool to retrieve placeholders (dictionary entries) for a specific object type in sevDesk. Use when you need to get available template placeholders for documents like invoices, emails, or letters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `objectName` | string ("Invoice" | "CreditNote" | "Order" | "Contact" | "Letter" | "Email") | Yes | Model name to retrieve placeholders for (e.g., Invoice, Contact, Email) | | `subObjectName` | string ("Invoice" | "CreditNote" | "Order" | "Contact" | "Letter") | No | Valid sub-object types when objectName is Email. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Find Contacts By Custom Field Value **Slug:** `SEVDESK_FIND_CONTACTS_BY_CUSTOM_FIELD_VALUE` Tool to find contacts by custom field value. Use when you need to search for contacts that have a specific value in a custom field. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `value` | string | Yes | The value to be checked in the custom field | | `customFieldName` | string | No | The ContactCustomFieldSetting name, if no ContactCustomFieldSetting ID is provided. Use this or customFieldSetting_id, not both. | | `customFieldSetting_id` | string | No | ID of ContactCustomFieldSetting for which the value has to be checked. Use with customFieldSetting_objectName. | | `customFieldSetting_objectName` | string | No | Object name. Only needed if you also defined the ID of a ContactCustomFieldSetting. Must be 'ContactCustomFieldSetting'. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Generate Progress Download Hash **Slug:** `SEVDESK_GENERATE_PROGRESS_DOWNLOAD_HASH` Tool to generate a download hash for an export job progress. Use when you need to retrieve the progress status and download hash for an export job initiated through sevDesk's Export API. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `jobId` | string | Yes | The export job ID to generate a download hash for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Accounting Contact By ID **Slug:** `SEVDESK_GET_ACCOUNTING_CONTACT_BY_ID` Tool to retrieve accounting contact details by ID. Use when you need accounting information (debitor/creditor numbers) for a specific contact. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `accountingContactId` | integer | Yes | ID of accounting contact to return | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Accounting Contacts **Slug:** `SEVDESK_GET_ACCOUNTING_CONTACTS` Tool to retrieve accounting contacts from sevDesk. Use when you need to fetch accounting contact information including debitor and creditor numbers. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `contact_id` | string | No | ID of contact for which you want the accounting contact | | `contact_objectName` | string | No | Object name. Only needed if you also defined the ID of a contact | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get SevClient Account Invoices **Slug:** `SEVDESK_GET_ACCOUNT_INVOICES` Retrieves all sevDesk account invoices for the authenticated client. Returns a list of invoice objects or null if no invoices exist in the account. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Check Account Balance At Date **Slug:** `SEVDESK_GET_CHECK_ACCOUNT_BALANCE_AT_DATE` Tool to get the balance of a check account at a specific date. Use when you need to retrieve the historical balance of a bank account, considering only transactions up to the specified date at 23:59:59. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | Yes | Date for which to calculate the balance (YYYY-MM-DD format). Only considers transactions up to this date at 23:59:59 | | `checkAccountId` | integer | Yes | ID of the check account to retrieve the balance for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Check Account By ID **Slug:** `SEVDESK_GET_CHECK_ACCOUNT_BY_ID` Tool to retrieve details of a specific check account by ID. Use when you have a check account's ID and need its detailed information including balance, IBAN, currency, and status. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `checkAccountId` | integer | Yes | The unique ID of the check account to retrieve from sevDesk | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Check Accounts **Slug:** `SEVDESK_GET_CHECK_ACCOUNTS` Tool to retrieve a list of all check accounts. Use when you need to view or select available bank accounts in sevDesk. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `embed` | string | No | Comma-separated list of related objects to embed in the response (e.g., 'sevClient' to include full client details) | | `limit` | integer | No | Maximum number of results to return | | `offset` | integer | No | Number of items to skip for pagination | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Check Account Transaction By ID **Slug:** `SEVDESK_GET_CHECK_ACCOUNT_TRANSACTION_BY_ID` Tool to retrieve a specific check account transaction by its ID. Use when you need detailed information about a specific transaction. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `checkAccountTransactionId` | integer | Yes | ID of check account transaction to retrieve | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Check Account Transactions **Slug:** `SEVDESK_GET_CHECK_ACCOUNT_TRANSACTIONS` Tool to retrieve list of check account transactions. Use when you need to fetch transactions with optional filters (e.g., account ID, date, status) after verifying the check account exists. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `embed` | string | No | Comma-separated list of related objects to embed, e.g., 'checkAccount' | | `limit` | integer | No | Maximum number of transactions to return (must be >=1) | | `amount` | string | No | Filter by transaction amount | | `offset` | integer | No | Number of transactions to skip for pagination (must be >=0) | | `status` | string ("OPEN" | "ASSIGNED" | "DELETED") | No | Filter by transaction status | | `direction` | string ("IN" | "OUT") | No | Filter by transaction direction: IN or OUT | | `voucherDate` | string | No | Filter by voucher date (YYYY-MM-DD) | | `checkAccount` | string | No | UUID of the check account to filter transactions by | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get CommunicationWay By ID **Slug:** `SEVDESK_GET_COMMUNICATIONWAY_BY_ID` Tool to retrieve details of a specific communication way by ID. Use when you have a communication way's ID and need its detailed information. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `communicationWayId` | integer | Yes | ID of communication way to return | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Communication Way Keys **Slug:** `SEVDESK_GET_COMMUNICATION_WAY_KEYS` Retrieve a list of communication way keys from sevDesk. Communication way keys define the available types for contact communication methods (e.g., ID 1: Private, ID 2: Work, ID 3: Fax, ID 4: Mobile, ID 5: Empty, ID 6: Autobox, ID 7: Newsletter, ID 8: Invoicing). Use this to get the valid key IDs and names for creating or updating communication ways. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Communication Ways **Slug:** `SEVDESK_GET_COMMUNICATION_WAYS` Tool to retrieve communication ways from sevDesk. Use when you need to fetch contact information like phone numbers, emails, or web addresses for a contact. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `main` | string ("0" | "1") | No | Filter for main communication way | | `type` | string ("PHONE" | "EMAIL" | "WEB" | "MOBILE") | No | Communication way types supported by sevDesk | | `contact_id` | string | No | ID of contact for which you want the communication ways | | `contact_objectName` | string | No | Object name. Only needed if you also defined the ID of a contact | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Contact Address By ID **Slug:** `SEVDESK_GET_CONTACT_ADDRESS_BY_ID` Tool to retrieve details of a specific contact address by ID. Use when you have a contact address ID and need its detailed information. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `contactAddressId` | integer | Yes | ID of contact address to return | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Contact Addresses **Slug:** `SEVDESK_GET_CONTACT_ADDRESSES` Tool to retrieve contact addresses from sevdesk. Use when you need to fetch address information for contacts with optional pagination and embedded related objects. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `embed` | string | No | Comma-separated list of related objects to embed in the response (e.g., 'contact,country') | | `limit` | integer | No | Maximum number of contact addresses to return. Default is 100 | | `offset` | integer | No | Number of contact addresses to skip before returning results. Default is 0 | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Contact By ID **Slug:** `SEVDESK_GET_CONTACT_BY_ID` Tool to retrieve details of a specific contact by ID. Use when you have a contact's UUID and need its detailed information. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique ID of the contact to retrieve from sevDesk | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Contact Custom Field By ID **Slug:** `SEVDESK_GET_CONTACT_CUSTOM_FIELD_BY_ID` Tool to retrieve a contact custom field by its ID. Use when you need to fetch details about a specific custom field associated with a contact. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `contactCustomFieldId` | integer | Yes | The unique identifier of the contact custom field to retrieve | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Contact Custom Fields **Slug:** `SEVDESK_GET_CONTACT_CUSTOM_FIELDS` Tool to retrieve contact custom fields from sevDesk. Contact custom fields store additional user-defined information about contacts beyond standard fields. Use this when you need to fetch custom field values for contacts or list all custom field data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `embed` | string | No | Comma-separated list of related object keys to include in the response (e.g., 'contact,contactCustomFieldSetting' to get additional information about the contact and field settings). | | `limit` | integer | No | Maximum number of contact custom fields to return in the response. Use this for pagination to control result size. | | `offset` | integer | No | Number of contact custom fields to skip before returning results. Use with 'limit' for pagination (e.g., offset=10 with limit=10 gets items 11-20). | | `countAll` | integer | No | If set to 1, returns the total number of contact custom field entries matching the query in the response. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Contact Custom Field Setting By ID **Slug:** `SEVDESK_GET_CONTACT_CUSTOM_FIELD_SETTING_BY_ID` Tool to retrieve details of a specific contact custom field setting by ID. Use when you need information about a contact custom field configuration. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `contactCustomFieldSettingId` | integer | Yes | The unique ID of the contact custom field setting to retrieve from sevDesk | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Contact Custom Field Setting Reference Count **Slug:** `SEVDESK_GET_CONTACT_CUSTOM_FIELD_SETTING_REFERENCE_COUNT` Tool to receive the count of references for a contact custom field setting. Use when you need to check how many times a contact custom field is referenced before deleting it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `contactCustomFieldSettingId` | integer | Yes | ID of contact custom field setting to get the reference count for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Contact Custom Field Settings **Slug:** `SEVDESK_GET_CONTACT_CUSTOM_FIELD_SETTINGS` Tool to retrieve contact custom field settings from sevDesk. Contact custom field settings define the structure and configuration of custom fields that can be added to contacts. Use this when you need to fetch the list of available custom field configurations or understand what custom fields are defined for contacts. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `embed` | string | No | Comma-separated list of related object keys to include in the response (e.g., 'sevClient' to get additional information about the client). | | `limit` | integer | No | Maximum number of contact custom field settings to return in the response. Use this for pagination to control result size. | | `offset` | integer | No | Number of contact custom field settings to skip before returning results. Use with 'limit' for pagination (e.g., offset=10 with limit=10 gets items 11-20). | | `countAll` | integer | No | If set to 1, returns the total number of contact custom field setting entries matching the query in the response. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Contacts **Slug:** `SEVDESK_GET_CONTACTS` Tool to retrieve a list of contacts. Use when you need to fetch contacts from sevdesk with optional filters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tag` | string | No | Filter by a single tag identifier | | `type` | string | No | Filter by contact type (e.g., PERSON or COMPANY) | | `embed` | string | No | Embed related objects (comma-separated keys), e.g., 'addresses,bankAccounts' | | `field` | array | No | Name(s) of custom filter field(s) – each entry must have a matching `value` | | `limit` | integer | No | Maximum number of contacts to return | | `order` | string | No | Sort order for results, e.g., 'asc' or 'desc' | | `value` | array | No | Value(s) for each `field` filter – same length as `field` | | `offset` | integer | No | Number of contacts to skip before returning results | | `search` | string | No | Free-text search across contact fields | | `status` | integer | No | Filter by status code | | `category` | string | No | Filter by category identifier | | `customerNumber` | string | No | Filter by exact customer number | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Contact Tabs Item Count **Slug:** `SEVDESK_GET_CONTACT_TABS_ITEM_COUNT` Tool to get the count of items across all tabs for a specific contact. Use when you need to retrieve statistics about documents, invoices, orders, and other items related to a contact. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `contact_id` | integer | Yes | ID of contact to return tab item counts for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Credit Note Positions **Slug:** `SEVDESK_GET_CREDIT_NOTE_POSITIONS` Tool to retrieve credit note positions from SevDesk. Use when you need to fetch line items or positions associated with credit notes. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `creditNote_id` | integer | No | Retrieve all creditNote positions belonging to this creditNote. Must be provided with creditNote[objectName] | | `creditNote_objectName` | string | No | Only required if creditNote[id] was provided. 'CreditNote' should be used as value. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Credit Notes **Slug:** `SEVDESK_GET_CREDIT_NOTES` Tool to retrieve a list of credit notes. Use when you need to fetch multiple or filtered credit note records after confirming filters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | No | Filter by specific credit note ID (numeric) | | `embed` | string | No | Comma-separated list of related entities to embed in the response. Common values: 'contact' (contact person), 'contactPerson' (deprecated, use 'contact') | | `limit` | integer | No | Maximum number of credit notes to return, must be >= 1 | | `order` | string | No | Sort order for results, e.g., 'date_create DESC' | | `offset` | integer | No | Number of credit notes to skip for pagination, must be >= 0 | | `status` | string | No | Filter by credit note status code. Common values: 100 (DRAFT), 200 (OPEN), 1000 (PAID) | | `contact_id` | string | No | Filter by contact ID | | `customer_id` | string | No | Filter by customer ID | | `customer_name` | string | No | Filter by customer name | | `contact_surname` | string | No | Filter by contact surname | | `creditNoteNumber` | string | No | Filter by credit note number | | `contact_familyname` | string | No | Filter by contact family name | | `customer_customerNumber` | string | No | Filter by customer number | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Export Invoice CSV **Slug:** `SEVDESK_GET_EXPORT_INVOICECSV` Tool to export invoices as CSV from sevDesk. Use when you need to get invoice data in CSV format. The response contains base64-encoded CSV content when download parameter is false. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `download` | boolean | No | Specifies if the document is downloaded. Set to false to get base64 encoded content in response | | `sevQuery_modelName` | string | No | Model name which is exported, should be 'Invoice' for this endpoint | | `sevQuery_objectName` | string | No | SevQuery object name, should be 'SevQuery' | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Export Transactions CSV **Slug:** `SEVDESK_GET_EXPORT_TRANSACTIONS_CSV` Tool to export check account transactions as CSV file. Use when you need to download or retrieve transaction data in CSV format for reporting or analysis. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `download` | boolean | No | Whether to trigger a download or return base64 encoded content. Set to false to get CSV content in response. | | `sevQuery_modelName` | string | No | Model name for the query, typically 'CheckAccountTransaction' | | `sevQuery_objectName` | string | No | Object name for the query, must be 'SevQuery' | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Invoice Is Partially Paid **Slug:** `SEVDESK_GET_INVOICE_IS_PARTIALLY_PAID` Tool to check if an invoice is already partially paid. Use when you need to determine the partial payment status of a specific invoice. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `invoiceId` | integer | Yes | The unique identifier of the invoice to check partial payment status | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Invoice Positions **Slug:** `SEVDESK_GET_INVOICE_POSITIONS` Tool to retrieve all line items (positions) for a specific invoice. Use when you need detailed information about products, services, quantities, and prices on an invoice. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `embed` | array | No | List of related objects to embed in the response (e.g., 'part', 'unity'). Multiple values supported. | | `limit` | integer | No | Maximum number of positions to return (pagination) | | `offset` | integer | No | Number of positions to skip before returning results (pagination) | | `invoiceId` | integer | Yes | ID of the invoice to retrieve positions for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Invoice Positions **Slug:** `SEVDESK_GET_INVOICE_POSS` Tool to retrieve invoice positions from sevDesk. Use when you need to fetch line items or positions associated with invoices. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | No | Retrieve all InvoicePos with this InvoicePos id | | `part_id` | integer | No | Retrieve all invoice positions with this part. Must be provided with part[objectName] | | `invoice_id` | integer | No | Retrieve all invoice positions with this invoice. Must be provided with invoice[objectName] | | `part_objectName` | string | No | Only required if part[id] was provided. 'Part' should be used as value. | | `invoice_objectName` | string | No | Only required if invoice[id] was provided. 'Invoice' should be used as value. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Invoices **Slug:** `SEVDESK_GET_INVOICES` Retrieves a list of invoices from sevDesk with optional filtering and pagination. Use this tool to: - Get all invoices or filter by status (DRAFT, CONFIRMED, PAID, CANCELLED) - Search invoices by contact, date range, or invoice number - Paginate through large invoice lists using limit and offset - Include related objects (contact, sevClient) using the embed parameter - Sort results by invoice date or other fields #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `embed` | string | No | Comma-separated list of related objects to embed in the response, e.g., 'contact,sevClient' | | `limit` | integer | No | Maximum number of invoices to return per request (pagination) | | `order` | string | No | Sort order as JSON array string, e.g., '["invoiceDate DESC"]' or '["invoiceNumber ASC"]' | | `number` | string | No | Filter by exact invoice number | | `offset` | integer | No | Number of invoices to skip before returning results (pagination) | | `search` | string | No | Full-text search term to filter invoices | | `status` | string ("DRAFT" | "CONFIRMED" | "PAID" | "CANCELLED") | No | Filter invoices by their current status | | `dueDate` | string | No | Filter by due date (YYYY-MM-DD) | | `contact_id` | string | No | Filter invoices by the associated contact's ID | | `invoiceDate` | string | No | Filter by invoice date (YYYY-MM-DD) | | `deliveryDate` | string | No | Filter by delivery date (YYYY-MM-DD) | | `customerInternalNote` | string | No | Filter invoices by customer internal note content | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Letterpapers With Thumbnails **Slug:** `SEVDESK_GET_LETTERPAPERS_WITH_THUMB` Tool to retrieve all available letterpapers with thumbnails from sevDesk. Use when you need to view or select letterpapers for documents. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Next Customer Number **Slug:** `SEVDESK_GET_NEXT_CUSTOMER_NUMBER` Tool to retrieve the next free customer number from sevDesk. Use when you need to get the next available customer number for creating a new contact. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Order By ID **Slug:** `SEVDESK_GET_ORDER_BY_ID` Tool to retrieve details of a specific order by ID. Use when you have an order's ID and need its detailed information including customer, amounts, status, and line items. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `orderId` | integer | Yes | The unique ID of the order to retrieve from sevDesk | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Order Discounts **Slug:** `SEVDESK_GET_ORDER_DISCOUNTS` Tool to retrieve discounts applied to a specific order in sevDesk. Use when you need to find all discount entries associated with an order. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `embed` | string | No | Comma-separated list of related data to embed in the response. Can handle multiple values separated by comma. | | `limit` | integer | No | Maximum number of discounts to return (pagination) | | `offset` | integer | No | Number of discounts to skip before returning results (pagination) | | `orderId` | integer | Yes | ID of the order to retrieve discounts for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Order Position By ID **Slug:** `SEVDESK_GET_ORDER_POS_BY_ID` Tool to retrieve details of a specific order position by ID. Use when you have an order position's ID and need its detailed information including quantity, price, tax rate, and discounts. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `orderPosId` | integer | Yes | The unique ID of the order position to retrieve from sevDesk | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Order Positions **Slug:** `SEVDESK_GET_ORDER_POSITIONS` Tool to retrieve order positions from SevDesk. Use when you need to fetch line items or positions associated with orders. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `order_id` | integer | No | Retrieve all order positions belonging to this order. Must be provided with order[objectName] | | `order_objectName` | string | No | Only required if order[id] was provided. 'Order' should be used as value. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Orders **Slug:** `SEVDESK_GET_ORDERS` Retrieve a paginated list of orders from sevDesk. This action fetches orders with support for filtering by status, customer, search text, and pagination. All parameters are optional - calling without parameters returns all orders. Use 'embed' to include related data like contact information or addresses in a single request. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `embed` | string | No | Comma-separated related data to embed in the response. Common values: 'contact' (customer information), 'address' (delivery address). Example: 'contact,address' | | `limit` | integer | No | Maximum number of orders to return | | `order` | string ("asc" | "desc") | No | Sort direction, either 'asc' or 'desc' | | `offset` | integer | No | Zero-based offset for pagination | | `filter_search` | string | No | Free-text search filter for orders | | `filter_status` | string | No | Filter orders by status code. Common values: 100 (draft), 200 (open), 500 (cancelled), 1000 (completed). Can be a single status or comma-separated list | | `filter_customer` | string | No | Filter orders by contact/customer ID. Use the numeric ID of the contact (e.g., '12345') | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Part By ID **Slug:** `SEVDESK_GET_PART_BY_ID` Tool to retrieve details of a specific part by ID. Use when you have a part's ID and need its detailed information including pricing, stock levels, and metadata. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `part_id` | integer | Yes | The unique ID of the part to retrieve from sevDesk | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Part Contact Prices **Slug:** `SEVDESK_GET_PART_CONTACT_PRICES` Tool to retrieve a list of part contact prices. Use when you need to fetch pricing details for parts linked to contacts, with optional filters, pagination, and embedding of related objects. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `part` | string | No | Filter results by part ID (numeric string). The action automatically formats this as an object reference for the API. | | `embed` | string | No | Comma-separated related entities to embed, e.g., 'part,contact' | | `limit` | integer | No | Maximum number of price entries to return, must be >= 1 | | `fields` | string | No | Comma-separated list of specific fields to include in response | | `offset` | integer | No | Number of entries to skip for pagination, must be >= 0 | | `contact` | string | No | Filter results by contact ID (numeric string). The action automatically formats this as an object reference for the API. | | `updatedAfter` | string | No | Only show records updated after this ISO-8601 datetime | | `includeDeleted` | boolean | No | Include deleted price entries when true | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Parts **Slug:** `SEVDESK_GET_PARTS` Tool to retrieve a list of all parts. Use when you need to list available products or services for selection. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `embed` | string | No | Comma-separated list of related objects to embed in the response, e.g., 'partUnity' for unit details, 'partSupplier' for supplier info, 'partPrice' for pricing | | `limit` | integer | No | Maximum number of results to return (1-1000) | | `offset` | integer | No | Number of items to skip for pagination | | `archived` | boolean | No | Filter for archived parts. Set to true to retrieve only archived parts, false for non-archived, or omit to get all | | `countAll` | boolean | No | When set to true, includes the total count of available records in the response | | `properties` | string | No | Comma-separated list of part properties to filter or return | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Part Stock **Slug:** `SEVDESK_GET_PART_STOCK` Tool to retrieve the current stock level of a specific part. Use when you need to check inventory availability for a product or service. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `partId` | integer | Yes | ID of part for which you want the current stock. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Part Unities **Slug:** `SEVDESK_GET_PART_UNITIES` Retrieves a list of part unities (units of measurement) from SevDesk. Part unities represent units of measurement used for products/parts in the system (e.g., pieces, meters, kilograms, hours). Use this action to list all available units, with optional pagination and filtering for deleted entries. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `embed` | string | No | Comma-separated list of related objects to embed (e.g., 'customer,contact') | | `limit` | integer | No | Maximum number of part unities to return (default: 100) | | `offset` | integer | No | Number of items to skip for pagination (default: 0) | | `includeDeleted` | boolean | No | Whether to include deleted part unities in the results (default: false) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Payment Methods **Slug:** `SEVDESK_GET_PAYMENT_METHODS` Retrieves all available payment methods from sevDesk. Payment methods define how customers pay invoices (e.g., SEPA bank transfer, cash, check, online payment like PayPal). Use this to list payment methods before creating invoices or to display payment options. Supports pagination via limit and offset parameters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `embed` | string | No | Comma-separated list of related object keys to include in the response. Contact sevDesk API documentation for available embed options for PaymentMethod. | | `limit` | integer | No | Maximum number of payment methods to return in the response. Use this for pagination to control result size. | | `offset` | integer | No | Number of payment methods to skip before returning results. Use with 'limit' for pagination (e.g., offset=10 with limit=10 gets items 11-20). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Places **Slug:** `SEVDESK_GET_PLACES` Retrieve a list of places (cities/locations with geographic data) from sevDesk. Places contain location information including city names, coordinates (latitude/longitude), postal codes, and location IDs. Useful for address validation, geographic lookups, or populating location dropdowns in your application. Use pagination (limit/offset) to handle the large dataset efficiently (45,000+ places). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `depth` | integer | No | Level of embedding for related objects. Must be a non-negative integer. | | `embed` | string | No | Comma-separated list of related objects to embed, e.g., 'parentPlace'. | | `limit` | integer | No | Maximum number of places to return (pagination). Must be ≥ 1. | | `offset` | integer | No | Number of places to skip before returning results (pagination). Must be ≥ 0. | | `countAll` | boolean | No | If true, include the total count of matching places in the response metadata. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Private Transaction Rules **Slug:** `SEVDESK_GET_PRIVATE_TRANSACTION_RULES` Tool to list existing private transaction rules in SevDesk. Use when you need to retrieve all rules that automatically mark transactions as private based on counterpart name or payment purpose. This is useful for reviewing configured rules for separating personal transactions from business ones. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `embed` | string | No | Comma-separated list of related objects to embed in the response, e.g., 'sevClient' | | `limit` | integer | No | Maximum number of rules to return per request (pagination) | | `offset` | integer | No | Number of rules to skip before returning results (pagination) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Export Progress **Slug:** `SEVDESK_GET_PROGRESS` Tool to retrieve the progress of an export operation. Use when you need to check the status of a running export by its hash identifier. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `hash` | string | Yes | The hash string of an export to check progress for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Receipt Guidance For Account Number **Slug:** `SEVDESK_GET_RECEIPT_GUIDANCE_FOR_ACCOUNT_NUMBER` Tool to retrieve receipt guidance for a specific Datev account number. Use when you need to understand what receipt types and tax rules are allowed for a particular account in the accounting system. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `accountNumber` | integer | Yes | The datev account number you want to get additional information of | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Receipt Guidance For All Accounts **Slug:** `SEVDESK_GET_RECEIPT_GUIDANCE_FOR_ALL_ACCOUNTS` Tool to retrieve receipt guidance for all accounts. Provides guidance on which booking accounts can be used with which tax rules and receipt types. Use when you need to determine compatible tax rates and tax rules for specific booking accounts in voucher processing. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Receipt Guidance For Expense **Slug:** `SEVDESK_GET_RECEIPT_GUIDANCE_FOR_EXPENSE` Tool to retrieve guidance for expense accounts from sevDesk. Use when you need to determine which expense accounts are available and which tax rules and receipt types are compatible with them. This helps ensure correct account selection based on client settings and tax requirements. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Receipt Guidance For Revenue **Slug:** `SEVDESK_GET_RECEIPT_GUIDANCE_FOR_REVENUE` Tool to retrieve guidance for revenue accounts from sevDesk. Use when you need to determine which revenue accounts are available and which tax rules and receipt types are compatible with them. This helps ensure correct account selection based on client settings and tax requirements. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Receipt Guidance For Tax Rule **Slug:** `SEVDESK_GET_RECEIPT_GUIDANCE_FOR_TAX_RULE` Tool to get guidance by tax rule from sevDesk. Use when you need to determine which booking accounts are compatible with a specific tax rule. This helps ensure proper account selection for vouchers and invoices, preventing validation errors. Returns a list of accounts with allowed receipt types and tax rules. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `taxRule` | string | Yes | The code of the tax rule you want to get guidance for (e.g., 'USTPFL_UMS_EINN', 'AUSFUHREN', 'INNERGEM_LIEF'). This determines which booking accounts are compatible with the specified tax rule. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Report Invoice List **Slug:** `SEVDESK_GET_REPORT_INVOICELIST` Tool to export invoice list report from sevDesk. Use when you need to get an invoice list report, typically as a PDF. The response contains base64-encoded content when download parameter is false. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `view` | string | Yes | The view type for the invoice report (e.g., 'all' for all invoices) | | `download` | boolean | No | Specifies if the document is downloaded. Set to false to get base64 encoded content in response | | `sevQuery_limit` | integer | No | Maximum number of invoices to include in the report | | `sevQuery_modelName` | string | No | Model name which is exported, should be 'Invoice' for this endpoint | | `sevQuery_objectName` | string | No | SevQuery object name, should be 'SevQuery' | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Report Orderlist **Slug:** `SEVDESK_GET_REPORT_ORDERLIST` Tool to export the order list report from sevDesk. Use when you need to generate a report of orders. The report is typically returned as a base64-encoded PDF file that can be decoded and saved. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `view` | string | Yes | View filter for the report. Use 'all' to export all orders | | `download` | boolean | No | Whether to download the report. Set to true to force download | | `sevQuery_limit` | integer | No | Limit the number of orders to include in the exported report | | `sevQuery_modelName` | string | No | Model name for the sevQuery object. Should be 'Order' for orderlist | | `sevQuery_objectName` | string | No | Object name for the sevQuery. Typically 'SevQuery' | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get SevClient Config **Slug:** `SEVDESK_GET_SEV_CLIENT_CONFIG` Retrieves the sevClient configuration settings from sevDesk. This endpoint returns comprehensive configuration information including taxation settings, decimal precision for prices/quantities, payment integrations (PayPal, Stripe), document printing preferences, and various system settings. Use this to understand the current configuration state of the sevDesk client. No parameters are required, but you can optionally use the 'embed' parameter to get additional embedded information like full sevClient details. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `embed` | string | No | Get additional information. Can contain multiple values separated by comma. Example: 'sevClient' to embed sevClient details. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Tag By ID **Slug:** `SEVDESK_GET_TAG_BY_ID` Tool to retrieve details of a specific tag by ID. Use when you have a tag's ID and need its detailed information. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tagId` | integer | Yes | ID of tag to return | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Tag Relations **Slug:** `SEVDESK_GET_TAG_RELATIONS` Tool to retrieve tag relations from sevDesk. Use when you need to fetch associations between tags and other objects like contacts, invoices, or orders. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `embed` | array | No | List of related objects to embed in the response, e.g., ['tag', 'object'] | | `limit` | integer | No | Maximum number of tag relations to return. Defaults to 100 | | `offset` | integer | No | Number of tag relations to skip before returning results (pagination) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Tags **Slug:** `SEVDESK_GET_TAGS` Tool to retrieve tags from sevdesk. Use when you need to fetch tags for categorization or filtering purposes. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | No | ID of the Tag to filter by | | `name` | string | No | Name of the Tag to filter by | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Tax Rules **Slug:** `SEVDESK_GET_TAX_RULES` Retrieves tax rules from SevDesk. Tax rules define the tax treatment for different types of transactions (e.g., domestic sales, EU sales, reverse charge, exports). Each rule includes a name, description, code, and country information. Use this action to: - Get available tax rules for invoice line items - Understand tax treatment codes (e.g., 'USTPFL_UMS_EINN', 'AUSFUHREN', 'INNERGEM_LIEF') - Determine applicable tax rules based on country and transaction type - Support pagination with limit/offset for large result sets #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `embed` | string | No | Embed related resources to get full details instead of just references. Use 'countryClient' to get complete country information. Multiple resources can be comma-separated. | | `limit` | integer | No | Maximum number of tax rules to return | | `offset` | integer | No | Number of tax rules to skip for pagination | | `includeDeleted` | boolean | No | Include deleted tax rules in the response | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Bookkeeping System Version **Slug:** `SEVDESK_GET_TOOLS_BOOKKEEPING_SYSTEM_VERSION` Tool to retrieve the bookkeeping system version from sevDesk. Use when you need to check which bookkeeping system version (1.0 or 2.0) is currently configured for the sevDesk client. This is useful for determining which features and endpoints are available based on the accounting system in use. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Render Invoice **Slug:** `SEVDESK_RENDER_INVOICE` Tool to render the PDF document of an invoice by its ID. Use when you need to generate or regenerate the PDF representation of an invoice. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `invoiceId` | integer | Yes | The unique identifier of the invoice to render as PDF | | `forceReload` | boolean | No | Define if a forceful re-render should occur. Set to true to force regeneration of the PDF document. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Reset Credit Note To Open **Slug:** `SEVDESK_RESET_CREDIT_NOTE_TO_OPEN` Tool to reset a credit note status to open. Use when you need to revert a credit note from a higher status back to open status. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `creditNoteId` | integer | Yes | ID of the credit note to reset to open status | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Save Invoice **Slug:** `SEVDESK_SAVE_INVOICE` Tool to create a new invoice in SevDesk using the Factory endpoint. Use when you need to create an invoice for a customer with line items, tax information, and optional discounts. This is the main endpoint for invoice creation in SevDesk API. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `invoice` | object | Yes | Invoice data with all required fields | | `filename` | string | No | Filename of a previously uploaded file which should be attached | | `discountSave` | array | No | Array of discounts to save | | `discountDelete` | object | No | Reference to a discount to delete. | | `invoicePosSave` | array | Yes | Array of invoice positions (line items) to save | | `invoicePosDelete` | object | No | Reference to an invoice position to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send Credit Note By **Slug:** `SEVDESK_SEND_CREDIT_NOTE_BY` Tool to mark a credit note as sent by updating its send status and type. Use when you need to record that a credit note has been sent to the customer via print, postal, mail, or PDF download. Set sendDraft to false to actually mark it as sent. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sendType` | string ("VPR" | "VP" | "VM" | "VPDF") | Yes | Specifies the way in which the credit note was sent to the customer. VPR (print), VP (postal), VM (mail), VPDF (downloaded pdf) | | `sendDraft` | boolean | Yes | To create a draft of a credit note for internal use. This operation will not alter the status of the credit note or create bookings for reports. Set to false to mark as actually sent. | | `creditNoteId` | integer | Yes | ID of credit note to mark as sent | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send Credit Note By Printing **Slug:** `SEVDESK_SEND_CREDIT_NOTE_BY_WITH_RENDER` Tool to send a credit note by printing and render it. Use when you need to print a credit note and get render information including document ID and page count. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sendType` | string | Yes | The type you want to print. Use 'PRN' for printing. | | `creditNoteId` | integer | Yes | ID of the credit note to send by printing | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send Invoice By **Slug:** `SEVDESK_SEND_INVOICE_BY` Tool to mark an invoice as sent by specifying how it was sent to the customer. Use when you need to update an invoice's send status after it has been delivered via print, postal mail, email, or PDF download. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sendType` | string ("VPR" | "VP" | "VM" | "VPDF") | Yes | Specifies the way in which the invoice was sent to the customer. VPR = print, VP = postal, VM = mail, VPDF = downloaded PDF | | `invoiceId` | integer | Yes | The unique identifier of the invoice to mark as sent | | `sendDraft` | boolean | Yes | To create a draft of an invoice for internal use. This operation will not alter the status of the invoice or create bookings for reports | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Mark Order as Sent **Slug:** `SEVDESK_SEND_ORDER_BY` Tool to mark an order as sent in sevDesk. Use when you need to update an order's send status after delivering it to the customer. Specify the send type (print, postal, mail, or PDF download) and whether to create a draft. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `orderId` | integer | Yes | ID of the order to mark as sent | | `sendType` | string ("VPR" | "VP" | "VM" | "VPDF") | Yes | Specifies the way in which the order was sent to the customer. VPR (print), VP (postal), VM (mail), or VPDF (downloaded pdf) | | `sendDraft` | boolean | Yes | To create a draft of an order for internal use. This operation will not alter the status of the order if set to true | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Accounting Contact **Slug:** `SEVDESK_UPDATE_ACCOUNTING_CONTACT_BY_ID` Tool to update an existing accounting contact in SevDesk. Use when you need to modify creditor or debitor numbers for a contact. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `contact` | object | No | Reference to a contact object in SevDesk. | | `debitorNumber` | integer | No | Debitor number of the accounting contact | | `creditorNumber` | integer | No | Creditor number of the accounting contact | | `accountingContactId` | integer | Yes | ID of the accounting contact to update | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Check Account **Slug:** `SEVDESK_UPDATE_CHECK_ACCOUNT` Updates an existing check account (bank account) in sevDesk by ID. Use this tool to modify bank account details such as bank name, IBAN, BIC, account holder, account number, or status flags (active/default). All fields except 'id' are optional - only provide the fields you want to update. Returns the complete updated check account object. Common use cases: - Update banking information (IBAN, BIC, bank name) - Change account holder details - Set account as active/inactive or default/non-default - Add or modify account description #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The unique identifier of the check account to update | | `bic` | string | No | Business Identifier Code / SWIFT code (e.g., 'COBADEFFXXX') | | `iban` | string | No | International Bank Account Number in standard format (e.g., 'DE89370400440532013000') | | `active` | boolean | No | Set to true to activate the account, false to deactivate it | | `default` | boolean | No | Set to true to make this the default account, false otherwise | | `bankCode` | string | No | Bank code - BLZ for German banks (8 digits) or international bank code | | `bankName` | string | No | Name of the bank where the account is held (e.g., 'Deutsche Bank', 'Sparkasse') | | `customer` | object | No | Reference to a sevDesk customer or contact object. | | `description` | string | No | Free-text description or notes for this account | | `accountHolder` | string | No | Full name of the account holder or company | | `bankAccountNumber` | string | No | Bank account number (national format) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Check Account Transaction By ID **Slug:** `SEVDESK_UPDATE_CHECK_ACCOUNT_TRANSACTION_BY_ID` Tool to update an existing check account transaction in sevDesk. Use when you need to modify transaction details such as amount, payment purpose, payee/payer name, or status. Only provide the fields you want to update - all fields except checkAccountTransactionId are optional. Common use cases include correcting transaction amounts, updating payment descriptions, or changing transaction status. Returns the complete updated transaction object. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `amount` | number | No | Amount of the transaction (can be positive or negative) | | `status` | string ("created" | "linked" | "private" | "auto_booked" | "booked") | No | Status of the check account transaction. | | `entryDate` | string | No | Date the transaction was imported in ISO 8601 format (YYYY-MM-DDTHH:MM:SS+TZ) | | `valueDate` | string | No | Date the transaction was booked in ISO 8601 format (YYYY-MM-DDTHH:MM:SS+TZ) | | `checkAccount` | object | No | Reference to a check account. | | `paymtPurpose` | string | No | Purpose of the transaction (payment description) | | `payeePayerName` | string | No | Name of the payee or payer (the other party in the transaction) | | `sourceTransaction` | object | No | Reference to a check account transaction. | | `targetTransaction` | object | No | Reference to a check account transaction. | | `checkAccountTransactionId` | integer | Yes | ID of the check account transaction to update | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Communication Way By ID **Slug:** `SEVDESK_UPDATE_COMMUNICATION_WAY_BY_ID` Tool to update an existing communication way by ID in sevDesk. Use when you need to modify contact information such as email addresses, phone numbers, or websites. Only provide the fields you want to update. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `key` | object | No | Reference to a communication way key object in sevDesk. | | `main` | boolean | No | Defines whether the communication way is the main communication way for the contact. | | `type` | string ("EMAIL" | "PHONE" | "WEB" | "MOBILE") | No | Type of communication way. | | `value` | string | No | The value of the communication way. For example the phone number, e-mail address or website. | | `contact` | object | No | Reference to a contact object in sevDesk. | | `communicationWayId` | integer | Yes | ID of CommunicationWay to update | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Contact **Slug:** `SEVDESK_UPDATE_CONTACT` Tool to update an existing contact's details. Use after confirming the contact ID. Example: "Update contact with ID 123e4567-e89b-12d3-a456-426614174000". #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | UUID of the contact to update | | `name` | string | No | Company name, for COMPANY type | | `title` | string | No | Title | | `gender` | string ("m" | "w" | "d") | No | Gender: m=male, w=female, d=diverse | | `address` | object | No | Postal address for the contact | | `category` | object | No | Identifier for a contact category in SevDesk | | `surename` | string | No | Last name, for PERSON type | | `firstname` | string | No | First name, for PERSON type | | `taxNumber` | string | No | Tax number | | `vatNumber` | string | No | VAT number | | `familyname` | string | No | Family name, for PERSON type | | `salutation` | string | No | Salutation | | `bankDetails` | object | No | Bank account details for the contact | | `description` | string | No | Free-text notes | | `creditNumber` | string | No | Credit number | | `academicTitle` | string | No | Academic title (e.g., Dr.) | | `customerNumber` | string | No | Customer number | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Contact Address By ID **Slug:** `SEVDESK_UPDATE_CONTACT_ADDRESS_BY_ID` Tool to update an existing contact address by its unique identifier. Use when you need to modify street, city, zip code, name, or other address details of an existing contact address. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `zip` | string | No | Zip code | | `city` | string | No | City name | | `name` | string | No | Name in address | | `name2` | string | No | Second name in address | | `name3` | string | No | Third name in address | | `name4` | string | No | Fourth name in address | | `street` | string | No | Street name | | `contact` | object | No | Contact reference to which this address belongs | | `country` | object | No | Country reference for the contact address | | `category` | object | No | Category reference for the contact address | | `contactAddressId` | integer | Yes | ID of contact address to update | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Contact Custom Field **Slug:** `SEVDESK_UPDATE_CONTACT_CUSTOM_FIELD_BY_ID` Tool to update a contact custom field in SevDesk. Use when you need to modify the value of an existing custom field for a contact. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `value` | string | Yes | The new value for the contact custom field | | `contact` | object | Yes | Reference to the contact this custom field belongs to | | `objectName` | string | No | Internal object name which is 'ContactCustomField' | | `contactCustomFieldId` | integer | Yes | The unique ID of the contact custom field to update | | `contactCustomFieldSetting` | object | Yes | Reference to the contact custom field setting that defines this field | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Contact Custom Field Setting **Slug:** `SEVDESK_UPDATE_CONTACT_CUSTOM_FIELD_SETTING_BY_ID` Tool to update an existing contact custom field setting in SevDesk. Use when you need to modify the name or description of a custom field configuration for contacts. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Name of the contact field | | `objectName` | string | No | Internal object name which is 'ContactCustomFieldSetting' | | `description` | string | No | The description of the contact field | | `contactCustomFieldSettingId` | integer | Yes | ID of contact field setting you want to update | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Invoice Parameter **Slug:** `SEVDESK_UPDATE_INVOICE_PARAMETER` Tool to update an invoice parameter such as template, language, letterpaper, or PayPal settings. Use when you need to change the layout or configuration of an existing invoice. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `key` | string ("language" | "template" | "letterpaper" | "payPal") | Yes | The parameter type to change (language, template, letterpaper, or payPal) | | `value` | string | Yes | The ID/value of the template, letterpaper, language, or payPal setting | | `invoiceId` | integer | Yes | ID of the invoice to update | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Order By ID **Slug:** `SEVDESK_UPDATE_ORDER_BY_ID` Tool to update an existing order in sevDesk by ID. Use when you need to modify order details like header, customer notes, or text fields. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `header` | string | No | Order header - normally consists of prefix plus the order number | | `origin` | object | No | Origin reference object. | | `status` | string ("100" | "200" | "300" | "500" | "750" | "1000") | No | Status of the order. | | `taxSet` | object | No | Tax set reference object for sevdesk-Update 1.0. | | `address` | string | No | Complete address of the recipient including name, street, city, zip and country. Line breaks can be used and will be displayed on the invoice pdf | | `contact` | object | No | Contact reference object. | | `orderId` | integer | Yes | ID of the order to update | | `showNet` | boolean | No | If true, the net amount of each position will be shown on the order. Otherwise gross amount | | `taxRate` | number | No | This is not used anymore. Use the taxRate of the individual positions instead | | `taxRule` | object | No | Tax rule reference object for sevdesk-Update 2.0. | | `taxText` | string | No | A common tax text would be 'Umsatzsteuer 19%' | | `taxType` | string | No | Use this in sevdesk-Update 1.0 (instead of taxRule). Tax type: 'default', 'eu', 'noteu', 'custom', 'ss' | | `version` | integer | No | Version of the order. Can be used if you have multiple drafts for the same order. Should start with 0 | | `currency` | string | No | Currency used in the order. Needs to be currency code according to ISO-4217 | | `footText` | string | No | Footer text for the order. Certain html tags can be used here to format your text | | `headText` | string | No | Header text for the order. Certain html tags can be used here to format your text | | `sendDate` | string | No | The date the order was sent to the customer. Needs to be provided as timestamp | | `sendType` | string ("VPR" | "VPDF" | "VM" | "VP") | No | Type which was used to send the order. | | `orderDate` | string | No | Order date. Needs to be provided as timestamp or dd.mm.yyyy format | | `orderType` | string ("AN" | "AB" | "LI") | No | Type of the order. | | `paymentTerms` | string | No | Payment terms of the order | | `contactPerson` | object | No | Contact person reference object. | | `deliveryTerms` | string | No | Delivery terms of the order | | `addressCountry` | object | No | Country reference object. | | `smallSettlement` | boolean | No | Defines if the client uses the small settlement scheme. If yes, the order must not contain any vat | | `customerInternalNote` | string | No | Internal note of the customer. Contains data entered into field 'Referenz/Bestellnummer' | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Order Template **Slug:** `SEVDESK_UPDATE_ORDER_TEMPLATE` Tool to update an order parameter such as template, language, letterpaper, or PayPal settings. Use when you need to change the layout or configuration of an existing order. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `key` | string ("language" | "template" | "letterpaper" | "payPal") | Yes | The parameter type to change (language, template, letterpaper, or payPal) | | `value` | string | Yes | The ID/value of the template, letterpaper, language, or payPal setting | | `orderId` | integer | Yes | ID of the order to update | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Part By ID **Slug:** `SEVDESK_UPDATE_PART_BY_ID` Tool to update an existing part (product/service) in sevDesk. Use when you need to modify part details like name, stock, price, tax rate, or status. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Name of the part | | `text` | string | No | A text describing the part | | `price` | number | No | Net price for which the part is sold. This parameter will be deprecated - use priceNet or priceGross instead | | `stock` | number | No | The stock of the part | | `unity` | object | No | Reference to a unity (unit of measurement) object | | `partId` | integer | Yes | ID of the part to update | | `status` | string ("inactive" | "active") | No | Status of the part in sevDesk | | `taxRate` | number | No | Tax rate of the part (e.g., 19 for 19%) | | `category` | object | No | Reference to a category object | | `priceNet` | number | No | Net price for which the part is sold | | `partNumber` | string | No | The part number | | `priceGross` | number | No | Gross price for which the part is sold | | `stockEnabled` | boolean | No | Defines if the stock should be enabled | | `pricePurchase` | number | No | Purchase price of the part | | `internalComment` | string | No | An internal comment for the part. Does not appear on invoices and orders | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update SevClient Export Config **Slug:** `SEVDESK_UPDATE_SEV_CLIENT_EXPORT_CONFIG` Tool to update the export configuration for a SevClient in sevDesk. Use when you need to configure export settings including accountant number, accountant client number, and accounting year begin timestamp. This endpoint requires the SevClient ID and all three configuration parameters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sev_client_id` | integer | Yes | ID of the SevClient to update the export config for | | `accountant_number` | integer | Yes | Accountant number for the export configuration | | `accounting_year_begin` | integer | Yes | Accounting year begin timestamp (Unix timestamp in seconds) | | `accountant_client_number` | integer | Yes | Accountant client number for the export configuration | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Tag By ID **Slug:** `SEVDESK_UPDATE_TAG_BY_ID` Tool to update a tag's name in sevDesk by its ID. Use when you need to rename or modify an existing tag. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the tag you want to update | | `tagId` | integer | Yes | ID of tag you want to update | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |