Skip to content

Contacts

5 tools in this toolset, each with its tier, traits, description and arguments.

sevdesk_contact_create 

Create a sevDesk contact

Draftchanges statesupports dryRun

Create a contact (Kontakt anlegen): an organisation (organisationName) or a person (firstName/lastName), as customer (Kunde, default), supplier (Lieferant), partner or prospect, with optional customer number (Kundennummer; default: sevDesk assigns the next free one), USt-IdNr., Steuernummer, Leitweg-ID, billing address (Rechnungsanschrift) and e-mail, phone, website. Tier write. Checks first that no contact with the same name or e-mail exists (allowDuplicate: true creates one anyway) and that the customer number is free. Search with sevdesk_contacts_search before; change it later with sevdesk_contact_update.

organisationNameoptionalstring
Organisation (company) name. Leave firstName/lastName out for organisations.
firstNameoptionalstring
Person: first name (sevDesk field surename). Leave organisationName out.
lastNameoptionalstring
Person: last name (sevDesk field familyname).
customerNumberoptionalstring
Kundennummer; must not be used yet.
vatNumberoptionalstring
USt-IdNr. (VAT ID), e.g. DE123456789.
taxNumberoptionalstring
Steuernummer (tax number).
buyerReferenceoptionalstring
Leitweg-ID / buyer reference for e-invoices (XRechnung) to public bodies.
categoryoptionalsupplier | customer | partner | prospect
customer (Kunde), supplier (Lieferant), partner or prospect (Interessent). Default: "customer".
streetoptionalstring
Street and house number (Straße).
zipoptionalstring
Postal code (PLZ).
cityoptionalstring
City (Ort).
countryoptionalstring
Country as ISO 3166-1 alpha-2 code, e.g. DE (default for a new address), AT, CH.
emailoptionalstring
E-mail address.
phoneoptionalstring
Phone number (Telefon).
websiteoptionalstring
Website, e.g. https://example.com.
allowDuplicateoptionalboolean
Create the contact even though one with the same name or e-mail exists. Only after checking that the existing one is really someone else. Default: false.
dryRunoptionalboolean
Preview only: check the action and return exactly what it would do, without changing anything in sevDesk and without asking the user. Defaults to false.

sevdesk_contact_get 

Get a sevDesk contact

Readread-onlyidempotent

Get one contact (Kontakt) by its sevDesk id, with its postal addresses (Adressen, e.g. Rechnungsanschrift) and communication ways (email, phone, website). Use it after sevdesk_contacts_search to check a customer's (Kunde) or supplier's (Lieferant) details, e.g. the billing address or invoice email, before working with their documents. ISO country codes are included when the country table resolves the ids.

idrequiredinteger
Contact id, e.g. from sevdesk_contacts_search.

sevdesk_contact_update 

Update a sevDesk contact

Draftchanges statedestructiveidempotentsupports dryRun

Change a contact (Kontakt ändern): only the fields you give are changed, everything else stays; fields cannot be cleared. Name (organisationName for organisations, firstName/lastName for persons; the kind cannot change), category, Kundennummer (must be free), USt-IdNr., Steuernummer, Leitweg-ID; street/zip/city/country change the billing address (Rechnungsanschrift, or the only address; added when there is none); email/phone/website change the main entry of that type or add one. Tier write. Reads the contact first (sevdesk_contact_get shows the current values) and fails when nothing would change.

idrequiredinteger
Contact id, e.g. from sevdesk_contacts_search.
organisationNameoptionalstring
Organisation (company) name. Leave firstName/lastName out for organisations.
firstNameoptionalstring
Person: first name (sevDesk field surename). Leave organisationName out.
lastNameoptionalstring
Person: last name (sevDesk field familyname).
customerNumberoptionalstring
Kundennummer; must not be used yet.
vatNumberoptionalstring
USt-IdNr. (VAT ID), e.g. DE123456789.
taxNumberoptionalstring
Steuernummer (tax number).
buyerReferenceoptionalstring
Leitweg-ID / buyer reference for e-invoices (XRechnung) to public bodies.
categoryoptionalsupplier | customer | partner | prospect
customer (Kunde), supplier (Lieferant), partner or prospect (Interessent).
streetoptionalstring
Street and house number (Straße).
zipoptionalstring
Postal code (PLZ).
cityoptionalstring
City (Ort).
countryoptionalstring
Country as ISO 3166-1 alpha-2 code, e.g. DE (default for a new address), AT, CH.
emailoptionalstring
E-mail address.
phoneoptionalstring
Phone number (Telefon).
websiteoptionalstring
Website, e.g. https://example.com.
dryRunoptionalboolean
Preview only: check the action and return exactly what it would do, without changing anything in sevDesk and without asking the user. Defaults to false.

sevdesk_contacts_next_customer_number 

Next free sevDesk customer number

Readread-onlyidempotent

Get the next free customer number (Kundennummer) from the sevDesk number range, to use when creating a contact (Kontakt) so numbering stays consecutive and free of duplicates. Reading it does not reserve it: create the contact right after, and read it again if some time has passed.

No arguments.

Search sevDesk contacts

Readread-onlyidempotent

Search contacts (Kontakte) in sevDesk: organisations and persons, such as customers (Kunden), suppliers (Lieferanten), partners and prospects (Interessenten). Filter by name, exact customer number (Kundennummer) and category. sevDesk does the name matching against organisation names and persons' first and last names; if nothing is found, try a shorter or different part of the name. Results are compact and paged (limit/offset, total, hasMore). Use detail=summary to browse/find. Use sevdesk_contact_get for addresses, emails and phone numbers.

detailoptionalsummary | full
Use summary to browse/find; full (default) or the matching get tool for details. Default: "full".
queryoptionalstring
Name or part of a name, e.g. 'Musterfirma' or 'Mustermann'.
customerNumberoptionalstring
Exact customer number (Kundennummer), e.g. 'K-1001'.
categoryoptionalsupplier | customer | partner | prospect
customer (Kunde), supplier (Lieferant), partner or prospect (Interessent).
limitoptionalinteger
Page size, 1–100. Default: 25.
offsetoptionalinteger
Rows to skip, for paging: pass the previous result's nextOffset. Default: 0.