Belege
Jedes Tool rufst du mit POST /api/app-tools und dem Tool-Namen auf. Klapp ein Tool auf, um Eingabefelder, nötige Rechte und eine Beispiel-Anfrage zu sehen. Ob dein API-Key ein Tool nutzen darf, zeigt der Katalog deiner Instanz (App-Tools-API).
Wie die App in der Oberfläche funktioniert, steht in der Hilfe unter Belege.
Kein Tool passt zu deiner Eingabe.
Datenobjekte
Die Standard-Aktionen je Datenobjekt: list (suchen und blättern), get (einen Datensatz lesen), create, update und delete. Nicht jedes Objekt bietet alle fünf an.
Belege belege.beleg.*
belege.beleg.list Lesen Liste/Suche: Belege
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
search | string | nein | Freitextsuche |
filters | object | nein | Feld=Wert-Filter |
limit | integer | nein | |
offset | integer | nein | |
orderBy | string | nein |
{
"name": "belege.beleg.list",
"input": {}
} belege.beleg.get Lesen Detail: Belege
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "belege.beleg.get",
"input": {
"id": "<id>"
}
} belege.beleg.create Anlegen Bestätigung Anlegen: Belege
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
belegtypCode | string | ja | z.B. angebot, auftrag, rechnung, lieferschein |
datum | string | nein | |
statusCode | string | nein | |
organisationId | string | nein | |
personId | string | nein | |
betreff | string | nein | |
liefertermin | string | nein | |
gueltigBis | string | nein | |
frist | number | nein | |
zahlungsbedingungCode | string | nein | |
lieferbedingungCode | string | nein | |
waehrung | string | nein | |
ustFrei | boolean | nein | |
ustId | string | nein | |
kopftext | string | nein | |
fusstext | string | nein | |
eroeffnungstext | string | nein | |
bemerkungen | string | nein | |
internerVermerk | string | nein | |
rabatt | number | nein | |
rabattProzent | number | nein |
{
"name": "belege.beleg.create",
"input": {
"belegtypCode": "<belegtypCode>"
}
} belege.beleg.update Ändern Bestätigung Ändern: Belege
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja | ID des Datensatzes |
belegtypCode | string | nein | z.B. angebot, auftrag, rechnung, lieferschein |
datum | string | nein | |
statusCode | string | nein | |
organisationId | string | nein | |
personId | string | nein | |
betreff | string | nein | |
liefertermin | string | nein | |
gueltigBis | string | nein | |
frist | number | nein | |
zahlungsbedingungCode | string | nein | |
lieferbedingungCode | string | nein | |
waehrung | string | nein | |
ustFrei | boolean | nein | |
ustId | string | nein | |
kopftext | string | nein | |
fusstext | string | nein | |
eroeffnungstext | string | nein | |
bemerkungen | string | nein | |
internerVermerk | string | nein | |
rabatt | number | nein | |
rabattProzent | number | nein |
{
"name": "belege.beleg.update",
"input": {
"id": "<id>"
}
} belege.beleg.delete Löschen Bestätigung Löschen: Belege
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "belege.beleg.delete",
"input": {
"id": "<id>"
}
} Belegpositionen belege.position.*
belege.position.list Lesen Liste/Suche: Belegpositionen
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
search | string | nein | Freitextsuche |
filters | object | nein | Feld=Wert-Filter |
limit | integer | nein | |
offset | integer | nein | |
orderBy | string | nein |
{
"name": "belege.position.list",
"input": {}
} belege.position.create Anlegen Bestätigung Anlegen: Belegpositionen
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
belegId | string | ja | |
position | number | nein | |
zeilentyp | string | nein | AB=Artikel, TX=Text, SP=Summe |
produktId | string | nein | |
produkt | string | nein | |
produktnummer | string | nein | |
menge | number | nein | |
einzelpreis | number | nein | |
rabatt | number | nein | |
rabattProzent | number | nein | |
steuersatz | number | nein | |
steuersatzCode | string | nein | |
mengeneinheit | string | nein | |
beschreibung | string | nein | |
positionstext | string | nein |
{
"name": "belege.position.create",
"input": {
"belegId": "<belegId>"
}
} belege.position.update Ändern Bestätigung Ändern: Belegpositionen
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja | ID des Datensatzes |
belegId | string | nein | |
position | number | nein | |
zeilentyp | string | nein | AB=Artikel, TX=Text, SP=Summe |
produktId | string | nein | |
produkt | string | nein | |
produktnummer | string | nein | |
menge | number | nein | |
einzelpreis | number | nein | |
rabatt | number | nein | |
rabattProzent | number | nein | |
steuersatz | number | nein | |
steuersatzCode | string | nein | |
mengeneinheit | string | nein | |
beschreibung | string | nein | |
positionstext | string | nein |
{
"name": "belege.position.update",
"input": {
"id": "<id>"
}
} Wertelisten
Auswahllisten der App wie Status, Arten oder Kategorien. Du pflegst sie mit denselben fünf Aktionen. Die Werte (code) nutzt du in den Feldern der Datenobjekte.
Belegtypen belege.belegtyp.* list · get · create · update · delete
belege.belegtyp.list Lesen Liste/Suche: Katalog „Belegtypen" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
onlyAktiv | boolean | nein | Nur aktive Einträge |
{
"name": "belege.belegtyp.list",
"input": {}
} belege.belegtyp.get Lesen Detail: Katalog „Belegtypen" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "belege.belegtyp.get",
"input": {
"id": "<id>"
}
} belege.belegtyp.create Anlegen Bestätigung Anlegen: Katalog „Belegtypen" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
label | string | ja | Anzeige-Text |
code | string | nein | Optional, sonst aus label abgeleitet. Immutable. |
color | string | nein | Tailwind-Paar, z.B. "bg-blue-100 text-blue-700" |
icon | string | nein | Lucide-Icon-Name |
beschreibung | string | nein |
{
"name": "belege.belegtyp.create",
"input": {
"label": "<label>"
}
} belege.belegtyp.update Ändern Bestätigung Ändern: Katalog „Belegtypen" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja | |
label | string | nein | |
color | string | nein | |
icon | string | nein | |
beschreibung | string | nein | |
aktiv | boolean | nein |
{
"name": "belege.belegtyp.update",
"input": {
"id": "<id>"
}
} belege.belegtyp.delete Löschen Bestätigung Löschen: Katalog „Belegtypen" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "belege.belegtyp.delete",
"input": {
"id": "<id>"
}
} Lieferbedingungen belege.lieferbedingung.* list · get · create · update · delete
belege.lieferbedingung.list Lesen Liste/Suche: Katalog „Lieferbedingungen" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
onlyAktiv | boolean | nein | Nur aktive Einträge |
{
"name": "belege.lieferbedingung.list",
"input": {}
} belege.lieferbedingung.get Lesen Detail: Katalog „Lieferbedingungen" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "belege.lieferbedingung.get",
"input": {
"id": "<id>"
}
} belege.lieferbedingung.create Anlegen Bestätigung Anlegen: Katalog „Lieferbedingungen" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
label | string | ja | Anzeige-Text |
code | string | nein | Optional, sonst aus label abgeleitet. Immutable. |
color | string | nein | Tailwind-Paar, z.B. "bg-blue-100 text-blue-700" |
icon | string | nein | Lucide-Icon-Name |
beschreibung | string | nein |
{
"name": "belege.lieferbedingung.create",
"input": {
"label": "<label>"
}
} belege.lieferbedingung.update Ändern Bestätigung Ändern: Katalog „Lieferbedingungen" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja | |
label | string | nein | |
color | string | nein | |
icon | string | nein | |
beschreibung | string | nein | |
aktiv | boolean | nein |
{
"name": "belege.lieferbedingung.update",
"input": {
"id": "<id>"
}
} belege.lieferbedingung.delete Löschen Bestätigung Löschen: Katalog „Lieferbedingungen" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "belege.lieferbedingung.delete",
"input": {
"id": "<id>"
}
} Status belege.status.* list · get · create · update · delete
belege.status.list Lesen Liste/Suche: Katalog „Status" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
onlyAktiv | boolean | nein | Nur aktive Einträge |
{
"name": "belege.status.list",
"input": {}
} belege.status.get Lesen Detail: Katalog „Status" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "belege.status.get",
"input": {
"id": "<id>"
}
} belege.status.create Anlegen Bestätigung Anlegen: Katalog „Status" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
label | string | ja | Anzeige-Text |
code | string | nein | Optional, sonst aus label abgeleitet. Immutable. |
color | string | nein | Tailwind-Paar, z.B. "bg-blue-100 text-blue-700" |
icon | string | nein | Lucide-Icon-Name |
beschreibung | string | nein |
{
"name": "belege.status.create",
"input": {
"label": "<label>"
}
} belege.status.update Ändern Bestätigung Ändern: Katalog „Status" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja | |
label | string | nein | |
color | string | nein | |
icon | string | nein | |
beschreibung | string | nein | |
aktiv | boolean | nein |
{
"name": "belege.status.update",
"input": {
"id": "<id>"
}
} belege.status.delete Löschen Bestätigung Löschen: Katalog „Status" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "belege.status.delete",
"input": {
"id": "<id>"
}
} Steuersätze belege.steuersatz.* list · get · create · update · delete
belege.steuersatz.list Lesen Liste/Suche: Katalog „Steuersätze" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
onlyAktiv | boolean | nein | Nur aktive Einträge |
{
"name": "belege.steuersatz.list",
"input": {}
} belege.steuersatz.get Lesen Detail: Katalog „Steuersätze" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "belege.steuersatz.get",
"input": {
"id": "<id>"
}
} belege.steuersatz.create Anlegen Bestätigung Anlegen: Katalog „Steuersätze" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
label | string | ja | Anzeige-Text |
code | string | nein | Optional, sonst aus label abgeleitet. Immutable. |
color | string | nein | Tailwind-Paar, z.B. "bg-blue-100 text-blue-700" |
icon | string | nein | Lucide-Icon-Name |
beschreibung | string | nein |
{
"name": "belege.steuersatz.create",
"input": {
"label": "<label>"
}
} belege.steuersatz.update Ändern Bestätigung Ändern: Katalog „Steuersätze" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja | |
label | string | nein | |
color | string | nein | |
icon | string | nein | |
beschreibung | string | nein | |
aktiv | boolean | nein |
{
"name": "belege.steuersatz.update",
"input": {
"id": "<id>"
}
} belege.steuersatz.delete Löschen Bestätigung Löschen: Katalog „Steuersätze" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "belege.steuersatz.delete",
"input": {
"id": "<id>"
}
} Vertriebswege belege.distribution.* list · get · create · update · delete
belege.distribution.list Lesen Liste/Suche: Katalog „Vertriebswege" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
onlyAktiv | boolean | nein | Nur aktive Einträge |
{
"name": "belege.distribution.list",
"input": {}
} belege.distribution.get Lesen Detail: Katalog „Vertriebswege" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "belege.distribution.get",
"input": {
"id": "<id>"
}
} belege.distribution.create Anlegen Bestätigung Anlegen: Katalog „Vertriebswege" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
label | string | ja | Anzeige-Text |
code | string | nein | Optional, sonst aus label abgeleitet. Immutable. |
color | string | nein | Tailwind-Paar, z.B. "bg-blue-100 text-blue-700" |
icon | string | nein | Lucide-Icon-Name |
beschreibung | string | nein |
{
"name": "belege.distribution.create",
"input": {
"label": "<label>"
}
} belege.distribution.update Ändern Bestätigung Ändern: Katalog „Vertriebswege" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja | |
label | string | nein | |
color | string | nein | |
icon | string | nein | |
beschreibung | string | nein | |
aktiv | boolean | nein |
{
"name": "belege.distribution.update",
"input": {
"id": "<id>"
}
} belege.distribution.delete Löschen Bestätigung Löschen: Katalog „Vertriebswege" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "belege.distribution.delete",
"input": {
"id": "<id>"
}
} Vorlagen-Kategorien belege.vorlage_kategorie.* list · get · create · update · delete
belege.vorlage_kategorie.list Lesen Liste/Suche: Katalog „Vorlagen-Kategorien" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
onlyAktiv | boolean | nein | Nur aktive Einträge |
{
"name": "belege.vorlage_kategorie.list",
"input": {}
} belege.vorlage_kategorie.get Lesen Detail: Katalog „Vorlagen-Kategorien" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "belege.vorlage_kategorie.get",
"input": {
"id": "<id>"
}
} belege.vorlage_kategorie.create Anlegen Bestätigung Anlegen: Katalog „Vorlagen-Kategorien" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
label | string | ja | Anzeige-Text |
code | string | nein | Optional, sonst aus label abgeleitet. Immutable. |
color | string | nein | Tailwind-Paar, z.B. "bg-blue-100 text-blue-700" |
icon | string | nein | Lucide-Icon-Name |
beschreibung | string | nein |
{
"name": "belege.vorlage_kategorie.create",
"input": {
"label": "<label>"
}
} belege.vorlage_kategorie.update Ändern Bestätigung Ändern: Katalog „Vorlagen-Kategorien" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja | |
label | string | nein | |
color | string | nein | |
icon | string | nein | |
beschreibung | string | nein | |
aktiv | boolean | nein |
{
"name": "belege.vorlage_kategorie.update",
"input": {
"id": "<id>"
}
} belege.vorlage_kategorie.delete Löschen Bestätigung Löschen: Katalog „Vorlagen-Kategorien" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "belege.vorlage_kategorie.delete",
"input": {
"id": "<id>"
}
} Zahlungsbedingungen belege.zahlungsbedingung.* list · get · create · update · delete
belege.zahlungsbedingung.list Lesen Liste/Suche: Katalog „Zahlungsbedingungen" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
onlyAktiv | boolean | nein | Nur aktive Einträge |
{
"name": "belege.zahlungsbedingung.list",
"input": {}
} belege.zahlungsbedingung.get Lesen Detail: Katalog „Zahlungsbedingungen" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "belege.zahlungsbedingung.get",
"input": {
"id": "<id>"
}
} belege.zahlungsbedingung.create Anlegen Bestätigung Anlegen: Katalog „Zahlungsbedingungen" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
label | string | ja | Anzeige-Text |
code | string | nein | Optional, sonst aus label abgeleitet. Immutable. |
color | string | nein | Tailwind-Paar, z.B. "bg-blue-100 text-blue-700" |
icon | string | nein | Lucide-Icon-Name |
beschreibung | string | nein |
{
"name": "belege.zahlungsbedingung.create",
"input": {
"label": "<label>"
}
} belege.zahlungsbedingung.update Ändern Bestätigung Ändern: Katalog „Zahlungsbedingungen" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja | |
label | string | nein | |
color | string | nein | |
icon | string | nein | |
beschreibung | string | nein | |
aktiv | boolean | nein |
{
"name": "belege.zahlungsbedingung.update",
"input": {
"id": "<id>"
}
} belege.zahlungsbedingung.delete Löschen Bestätigung Löschen: Katalog „Zahlungsbedingungen" (belege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "belege.zahlungsbedingung.delete",
"input": {
"id": "<id>"
}
} Weitere Aktionen
Eigene Aktionen der App, zum Beispiel Auswertungen, Versand, Zuordnungen oder Abläufe über mehrere Datensätze.
belege.festschreibe Ändern Bestätigung Schreibt einen Beleg GoBD-fest (ab dann unveränderbar).
Schreibt einen Beleg GoBD-fest (ab dann unveränderbar). Optional vorher PDF erzeugen.
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
belegId | string | ja |
{
"name": "belege.festschreibe",
"input": {
"belegId": "<belegId>"
}
} belege.rechnung_aus_zeiten Anlegen Bestätigung Fasst die Zeitbuchungen eines Projekts (projektId) ODER aller Aufgaben eines CRM-Kontos (crmGbzId), optional …
Fasst die Zeitbuchungen eines Projekts (projektId) ODER aller Aufgaben eines CRM-Kontos (crmGbzId), optional im Zeitraum, zusammen und legt daraus eine Rechnung mit Positionen an (Entwurf, nicht festgeschrieben). Eines von projektId/crmGbzId ist Pflicht.
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
projektId | string | nein | Projekt-ID (Zeiten aller Aufgaben des Projekts) |
crmGbzId | string | nein | CRM-Konto-ID (Zeiten aller Aufgaben des Kontos), Alternative zu projektId |
stundensatz | number | ja | € pro Stunde |
von | string | nein | YYYY-MM-DD (optional) |
bis | string | nein | YYYY-MM-DD (optional) |
steuersatz | number | nein | Default 19 |
betreff | string | nein |
{
"name": "belege.rechnung_aus_zeiten",
"input": {
"stundensatz": 1
}
} belege.versende Ändern Bestätigung Versendet einen Beleg per E-Mail über den Mailservice und legt dazu eine Mitteilung an.
Versendet einen Beleg per E-Mail über den Mailservice und legt dazu eine Mitteilung an. dryRun=true (Default) macht nur Vorschau + Mitteilung; dryRun=false versendet echt.
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
belegId | string | ja | |
dryRun | boolean | nein | Default true (Vorschau). false = echter Versand. |
empfaenger | string | nein | E-Mail-Override (sonst aus Rechnungsadresse) |
betreff | string | nein | |
text | string | nein | HTML-Body (optional) |
{
"name": "belege.versende",
"input": {
"belegId": "<belegId>"
}
} Als Klartext für KI-Assistenten: diese App, alle Apps und Artikel zur API in einer Datei: /api/llms.txt