Zum Inhalt springen

Angebote und Aufträge

7 Werkzeuge in dieser Gruppe, jedes mit Stufe, Eigenschaften, Beschreibung und Argumenten.

Die Beschreibung für das Modell und die Argumente stehen auf Englisch, so wie das Modell sie liest.

sevdesk_order_create_draft 

Angebot oder Auftrag entwerfen

Entwerfenchanges statesupports dryRun

Legt ein Angebot, eine Auftragsbestätigung oder einen Lieferschein als Entwurf an. Versendet wird nichts.

Für das Modell, auf Englisch

Create a draft offer (Angebot, AN), order confirmation (Auftragsbestätigung, AB) or delivery note (Lieferschein, LI) for a contact with its positions (Positionen; offers may have optional positions). Tier write: it only creates a draft; nothing is sent to the customer. Its number comes from sevDesk's number range: the preview shows the next one, saving reserves it. Defaults: today's date, net prices, EUR, the contact's invoice address, the account's only user as contact person (several users: pass contactPersonId), and the tax rule follows the account: 1 for regular VAT (0/7/19 %), 11 for Kleinunternehmer (0 %). Rules that do not fit the account and rates the rule does not allow are refused before anything is sent; the preview warns about a possible duplicate. dryRun previews without saving. Before: sevdesk_contacts_search. After: sevdesk_order_update_draft, sevdesk_order_pdf, sevdesk_order_finalize, sevdesk_invoice_create_from_order.

contactIderforderlichinteger
Customer contact id (Kontakt), from sevdesk_contacts_search.
typeerforderlichoffer | order_confirmation | delivery_note
offer (Angebot, AN), order_confirmation (Auftragsbestätigung, AB) or delivery_note (Lieferschein, LI).
positionserforderlichobject[]
Positionen in printed order; prices per priceMode.
dateoptionalstring
Angebots-/Auftragsdatum, YYYY-MM-DD; default today (Berlin).
priceModeoptionalnet | gross
Whether position unit prices are net (netto, the default for new drafts) or gross (brutto). Sets sevDesk's showNet.
taxRuleIdoptionalinteger
Tax rule (Steuerregel) id: 1 taxable domestic revenue (default), 2 exports, 3 intra-EU supplies, 4 tax-exempt §4, 5 reverse charge §13b, 11 Kleinunternehmer §19, 17 not taxable in Germany, 18–20 One-Stop-Shop, 21 reverse charge for EU services. Details: sevdesk_reference_lookup kind=tax_rules.
taxTextoptionalstring
Tax note printed on the document; default: the tax rule's German name.
currencyoptionalstring
ISO 4217 currency code (Währung); default EUR.
headeroptionalstring
Document title (Betreff); default "Angebot", "Auftragsbestätigung" or "Lieferschein".
headTextoptionalstring
Intro text above the positions (Kopftext); simple HTML allowed.
footTextoptionalstring
Closing text below the positions (Fußtext); simple HTML allowed.
paymentTermsoptionalstring
Zahlungsbedingungen as printed on the document.
deliveryTermsoptionalstring
Lieferbedingungen as printed on the document.
contactPersonIdoptionalinteger
sevDesk user (SevUser) shown as contact person (Ansprechpartner). Required only when the account has several users: sevdesk_reference_lookup kind=users lists them.
addressNameoptionalstring
Recipient name as printed. Address fields replace the matching parts of the contact's invoice address (new drafts) or of the stored address (updates); the rest is kept.
addressStreetoptionalstring
Street and number.
addressZipoptionalstring
Postcode (PLZ).
addressCityoptionalstring
City (Ort).
addressCountryoptionalstring
ISO 3166-1 alpha-2 country code of the address, e.g. DE, AT, CH; default: the country of the address it changes, else DE.
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_order_finalize 

Angebot oder Auftrag fertigstellen

Buchenchanges statedestructivesupports dryRunasks the user to confirm

Gibt einem Auftragsentwurf seine endgültige Nummer. Versendet wird nichts.

Für das Modell, auf Englisch

Finalize a draft order (Angebot, Auftragsbestätigung or Lieferschein fertigstellen): sevDesk marks it as sent and assigns its final number (draft 100 → sent 200). Nothing is sent to the customer: sentVia only records how you send it. To email it through sevDesk use sevdesk_order_send_email instead. Commit tier: asks a human to confirm the shown preview; dryRun only previews. Drafts only (create one with sevdesk_order_create_draft). Next: sevdesk_order_pdf, sevdesk_invoice_create_from_order.

iderforderlichinteger
Order id (not the order number), e.g. from sevdesk_orders_list.
sentViaoptionalpdf_download | post | print | email
How the document is or was sent, recorded as its send type: pdf_download (VPDF, default: PDF downloaded and sent your own way), post (VP, Briefversand), print (VPR, printed and handed over), email (VM, emailed outside sevDesk).
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_order_get 

Angebot oder Auftrag abrufen

Lesenread-onlyidempotent

Zeigt ein Angebot, eine Auftragsbestätigung oder einen Lieferschein mit Positionen, Summen und Bedingungen.

Für das Modell, auf Englisch

Get one order by its sevDesk id: an offer (Angebot), order confirmation (Auftragsbestätigung) or delivery note (Lieferschein), with its positions (name, quantity, unit, unit price net/gross, tax rate, discount, optional positions), totals (net, Umsatzsteuer, gross), tax rule, payment and delivery terms, recipient address, the order it was created from (origin) and related documents such as the invoices created from it (open them with sevdesk_invoice_get). Use it after sevdesk_orders_list.

iderforderlichinteger
Order id (not its number), e.g. from sevdesk_orders_list.

sevdesk_order_pdf 

Angebots-PDF ansehen

Lesenread-onlyidempotent

Zeigt das PDF eines Angebots, einer Auftragsbestätigung oder eines Lieferscheins, ohne etwas zu ändern.

Für das Modell, auf Englisch

Get the PDF of an order: Angebot (AN, quote), Auftragsbestätigung (AB) or Lieferschein (LI), e.g. to show, check or forward it. Read-only preview: it is fetched with preventSendBy, so it never marks the order as sent or commits it, and its status and editability stay as they are. The result holds the file's metadata and a resource link; the client loads the file itself via resources/read, its content is never put into the text. To save a copy to disk or as a download link use sevdesk_document_save (available with SEVDESK_OUTPUT_DIR or on a remote server). Find the id with the order list tools first.

iderforderlichinteger
sevDesk id of the document (not its number such as RE-1001).

sevdesk_order_send_email 

Angebot per E-Mail senden

Versendenchanges statedestructivereaches third partiessupports dryRunasks the user to confirm

Schickt ein Angebot, eine Auftragsbestätigung oder einen Lieferschein per E-Mail. Du bestätigst vorher Empfänger, Betreff und Text.

Für das Modell, auf Englisch

Email an order (Angebot, Auftragsbestätigung or Lieferschein per E-Mail versenden) through sevDesk: sevDesk sends the PDF to the recipients and marks the order as sent; a draft is finalized by this and gets its final number (only allowed when the commit tier is enabled too). External tier: the email reaches the customer and cannot be recalled, so a human confirms the preview with every recipient, the subject and the text first; dryRun only previews. Addresses are checked locally; cc/bcc up to 10 each. To only record that you sent it yourself, use sevdesk_order_finalize. Before: sevdesk_order_get, sevdesk_contact_get, sevdesk_order_pdf.

iderforderlichinteger
Order id (not the order number), e.g. from sevdesk_orders_list.
toerforderlichstring
Recipient (Empfänger): one email address.
ccoptionalstring[]
Cc recipients, up to 10.
bccoptionalstring[]
Bcc recipients, up to 10.
subjecterforderlichstring
Subject (Betreff), one line.
texterforderlichstring
Email text; simple HTML allowed. sevDesk attaches the document itself.
sendCopyToMeoptionalboolean
Also send a copy to the sevDesk user's own address. Defaults to 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_order_update_draft 

Auftragsentwurf ändern

Entwerfenchanges statedestructiveidempotentsupports dryRun

Ändert einen Auftragsentwurf. Was du nicht angibst, bleibt; neue Positionen ersetzen alle bisherigen.

Für das Modell, auf Englisch

Change a draft offer (Angebot), order confirmation (Auftragsbestätigung) or delivery note (Lieferschein). Tier write. Only the fields you give change; everything else keeps its stored value, the type stays. positions, when given, replace ALL stored positions in one request (saveOrder with the order's id); leave them out to keep them. Changing priceMode needs the positions too, and a new tax rule must allow every stored rate and fit the account's VAT regulation (regular or Kleinunternehmer). A new contactId also takes that contact's invoice address unless you give an address. Only drafts can be changed; for a sent offer create a new draft. dryRun shows the changes without saving. Before: sevdesk_order_get. After: sevdesk_order_pdf, sevdesk_order_finalize.

iderforderlichinteger
Id of the draft order (not its number), e.g. from sevdesk_orders_list.
positionsoptionalobject[]
When given, replaces ALL positions; leave out to keep them.
contactIdoptionalinteger
Customer contact id (Kontakt), from sevdesk_contacts_search.
dateoptionalstring
Angebots-/Auftragsdatum, YYYY-MM-DD.
priceModeoptionalnet | gross
Net or gross unit prices (showNet). Changing it requires positions too.
taxRuleIdoptionalinteger
New tax rule (Steuerregel) id; see sevdesk_reference_lookup kind=tax_rules.
taxTextoptionalstring
Tax note printed on the document; default: the tax rule's German name.
currencyoptionalstring
ISO 4217 currency code (Währung); default EUR.
headeroptionalstring
Document title (Betreff).
headTextoptionalstring
Intro text above the positions (Kopftext); simple HTML allowed.
footTextoptionalstring
Closing text below the positions (Fußtext); simple HTML allowed.
paymentTermsoptionalstring
Zahlungsbedingungen as printed on the document.
deliveryTermsoptionalstring
Lieferbedingungen as printed on the document.
contactPersonIdoptionalinteger
sevDesk user (SevUser) shown as contact person (Ansprechpartner). Required only when the account has several users: sevdesk_reference_lookup kind=users lists them.
addressNameoptionalstring
Recipient name as printed. Address fields replace the matching parts of the contact's invoice address (new drafts) or of the stored address (updates); the rest is kept.
addressStreetoptionalstring
Street and number.
addressZipoptionalstring
Postcode (PLZ).
addressCityoptionalstring
City (Ort).
addressCountryoptionalstring
ISO 3166-1 alpha-2 country code of the address, e.g. DE, AT, CH; default: the country of the address it changes, else DE.
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_orders_list 

Angebote und Aufträge auflisten

Lesenread-onlyidempotent

Listet Angebote, Auftragsbestätigungen und Lieferscheine, gefiltert nach Typ, Status, Kontakt oder Zeitraum.

Für das Modell, auf Englisch

List orders in sevDesk: offers (Angebote, AN), order confirmations (Auftragsbestätigungen, AB) and delivery notes (Lieferscheine, LI), with compact rows: number, type, status, contact, date, net/tax/gross. Filter by type, status (draft = Entwurf, sent = versendet, rejected = abgelehnt, accepted = angenommen, partially_invoiced, invoiced = berechnet), contactId, exact order number and date range. Type and number are also checked here (up to 1,000 rows scanned per call; total left out, filteredLocally set). Page with offset = nextOffset while hasMore. Use detail=summary to browse/find. Use sevdesk_order_get for details and positions.

detailoptionalsummary | full
Use summary to browse/find; full (default) or the matching get tool for details. Default: "full".
typeoptionaloffer | order_confirmation | delivery_note
offer (AN), order_confirmation (AB) or delivery_note (LI).
statusoptionaldraft | sent | rejected | accepted | partially_invoiced | invoiced
draft 100, sent 200, rejected 300, accepted 500, partially_invoiced 750, invoiced 1000.
contactIdoptionalinteger
Only orders of this contact.
numberoptionalstring
Exact order number, e.g. 'AN-1000'.
fromoptionalstring
First day to include, YYYY-MM-DD (Berlin time).
tooptionalstring
Last day to include, YYYY-MM-DD (Berlin time).
limitoptionalinteger
Page size, 1–100. Default: 25.
offsetoptionalinteger
Rows to skip, for paging: pass the previous result's nextOffset. Default: 0.