API-Referenz
Integrieren Sie Kontakte, Produkte, Angebote, Rechnungen, Belege, Transaktionen, Zahlungen und das Mahnwesen direkt in Ihre eigenen Systeme. Hier finden Sie alle Endpunkte, Datenmodelle und ausführbare Beispiele.
Auf dieser Seite+
Schnellstart
Die Sysbalance REST-API stellt die zentralen Buchhaltungs- und Belegdaten Ihres Unternehmens bereit. Jede Anfrage ist strikt auf das Unternehmen des verwendeten API-Schlüssels begrenzt.
Basis-URL
https://beta.sysbalance.de/api/v1Authentifizierung
Bearer TokenErstellen Sie Ihren API-Schlüssel im Dashboard unter Schlüssel. Übergeben Sie ihn anschließend bei jeder Anfrage im Header Authorization: Bearer <Ihr-Schlüssel>.
curl https://beta.sysbalance.de/api/v1/invoices \
-H "Authorization: Bearer sb_live_ihr-schluessel"sb_live_ und werden nur einmal vollständig angezeigt. Bewahren Sie sie ausschließlich serverseitig auf.Authentifizierte Anfragen erscheinen unter API-Aktivität. Ungültige, widerrufene oder abgelaufene Schlüssel liefern 401 unauthorized.
Die öffentliche API deckt die tenant-gebundenen Buchhaltungsabläufe ab. Anmeldung, Konto-, Team- und Supportverwaltung sowie das getrennt authentifizierte Mitarbeiterportal bleiben bewusst sitzungsgebunden und sind nicht Teil von v1.
Antwortformat
Erfolgreiche Antworten liefern Nutzdaten im Feld data. Listen enthalten zusätzlich ein meta-Objekt mit den Paginierungsangaben.
{
"data": [
{ "id": "clx…", "type": "COMPANY", "companyName": "Muster GmbH", "email": "buchhaltung@muster.de" }
],
"meta": { "page": 1, "pageSize": 25, "pageCount": 4, "total": 92 }
}Der Content-Type ist application/json. Geldbeträge werden als Ganzzahl in Cent übertragen, Datumswerte im ISO-Format.
Dokumentendpunkte liefern abhängig vom Endpunkt HTML, PDF, XML oder die hochgeladene Originaldatei. Der Upload eines Belegdokuments verwendet multipart/form-data; alle übrigen Anfragekörper sind JSON.
Paginierung & Filter
Listenendpunkte akzeptieren die Query-Parameter page (ab 1) und pageSize (Standard 25, maximal 100). Die Angaben zur Gesamtzahl und Seitenanzahl stehen im meta-Objekt der Antwort.
https://beta.sysbalance.de/api/v1/contacts?page=2&pageSize=50&search=musterJe nach Ressource stehen weitere Filter zur Verfügung, etwa search, status, type oder role. Die genauen Parameter finden Sie beim jeweiligen Endpunkt.
Fehler
Fehler verwenden ein einheitliches Format mit maschinenlesbarem code, einer message und - bei Validierungsfehlern - feldweisen details.
{
"error": {
"code": "validation_error",
"message": "Bitte korrigieren Sie die markierten Felder.",
"details": {
"fields": { "companyName": ["Bitte geben Sie einen Firmennamen ein."] },
"form": []
}
}
}| Code | HTTP | Bedeutung |
|---|---|---|
unauthorized | 401 | Schlüssel fehlt, ist ungültig, widerrufen oder abgelaufen. |
forbidden | 403 | Zugriff auf die angeforderte Ressource nicht erlaubt. |
not_found | 404 | Die Ressource existiert nicht. |
validation_error | 400 | Übergebene Felder sind ungültig (Details unter details.fields). |
invalid_body | 400 | Der Anfragekörper ist kein gültiges JSON. |
method_not_allowed | 405 | Die HTTP-Methode wird für diesen Endpunkt nicht unterstützt. |
conflict | 409 | Konflikt mit dem aktuellen Zustand der Ressource. |
immutable_record | 409 | Der Datensatz ist festgeschrieben und darf nicht mehr verändert werden. |
immutable_original | 409 | Das gespeicherte Originaldokument ist unveränderlich. |
retention_required | 409 | Die Aufbewahrungsregeln verhindern die angeforderte Änderung oder Löschung. |
unprocessable | 422 | Anfrage verstanden, im aktuellen Zustand aber nicht ausführbar. |
rate_limited | 429 | Das Zugriffslimit wurde überschritten; Anfrage später wiederholen. |
internal_error | 500 | Unerwarteter Fehler auf dem Server. |
Datenmodelle
Diese Modelle beschreiben die Felder, die die API zurückgibt. Anfragekörper erwarten je Endpunkt nur die dort genannten Felder.
Rechnung (Invoice)
Vollständige Rechnung mit Positionen, Beträgen (netto/Steuer/brutto in Cent) und Zahlungsstand. Festgeschriebene Rechnungen sind unveränderlich.
| Feld | Typ | Beschreibung |
|---|---|---|
id | string | Eindeutige ID der Rechnung. |
status | enum | DRAFT, ISSUED, PAID oder CANCELLED. |
kind | enum | SINGLE (Einzelrechnung) oder COLLECTIVE (Sammelrechnung). |
type | enum | INVOICE (regulär) oder STORNO (Stornorechnung). |
number | string | null | Rechnungsnummer (erst nach dem Festschreiben vergeben). |
sequence | number | null | Lückenlose laufende Nummer innerhalb des Nummernkreises. |
issueDate | string (ISO) | Rechnungsdatum. |
serviceDate | string | null | Leistungs-/Lieferdatum. |
servicePeriodStart | string | null | Beginn des Abrechnungszeitraums einer Sammelrechnung. |
servicePeriodEnd | string | null | Ende des Abrechnungszeitraums einer Sammelrechnung. |
dueDate | string | null | Fälligkeitsdatum. |
currency | string | ISO-4217-Währungscode, z. B. EUR. |
smallBusiness | boolean | Kleinunternehmerregelung (§19 UStG) angewandt. |
taxScheme | enum | STANDARD, REVERSE_CHARGE oder NOT_TAXABLE. |
netTotalCents | number | Nettosumme in Cent. |
taxTotalCents | number | Umsatzsteuersumme in Cent. |
grossTotalCents | number | Bruttosumme in Cent. |
paymentTerms | string | null | Zahlungsziel als Freitext. |
buyerReference | string | null | Käuferreferenz (Leitweg-ID / B2G). |
introText | string | null | Einleitung oberhalb der Positionen. |
closingText | string | null | Schlusstext unterhalb der Summen. |
footer | string | null | Fußzeilentext des Dokuments. |
showBankDetails | boolean | Bankverbindung im Dokument anzeigen. |
showContactDetails | boolean | Kontaktdaten des Absenders anzeigen. |
showCompanyName | boolean | Unternehmensname im Briefkopf anzeigen. |
showCompanyLogo | boolean | Unternehmenslogo im Briefkopf anzeigen. |
bankAccountId | string | null | ID der gewählten Bankverbindung; null verwendet das Standardkonto. |
sellerBankHolder | string | null | Kontoinhaber der Absender-Momentaufnahme. |
sellerBankName | string | null | Bank der Absender-Momentaufnahme. |
sellerIban | string | null | IBAN der Absender-Momentaufnahme. |
sellerBic | string | null | BIC der Absender-Momentaufnahme. |
templateKey | string | Verwendeter Vorlagen-Schlüssel. |
contactId | string | null | ID des Empfänger-Kontakts. |
buyerName | string | null | Name des Empfängers (Momentaufnahme). |
buyerVatId | string | null | USt-IdNr. des Empfängers (Momentaufnahme). |
hasEInvoice | boolean | Eine XRechnung ist gespeichert. |
cancelledAt | string | null | Zeitpunkt der Stornierung. |
cancelledReason | string | null | Grund der Stornierung. |
stornoOfId | string | null | Auf Stornorechnungen: ID der aufgehobenen Rechnung. |
stornoOfNumber | string | null | Nummer der aufgehobenen Rechnung. |
stornoInvoiceId | string | null | Auf stornierten Rechnungen: ID der Stornorechnung. |
stornoInvoiceNumber | string | null | Nummer der zugehörigen Stornorechnung. |
paidAmountCents | number | Summe aller erfassten Zahlungen in Cent. |
openAmountCents | number | Noch offener Betrag in Cent (Brutto − Zahlungen). |
payments | Payment[] | Erfasste Zahlungen, neueste zuerst. |
items | InvoiceItem[] | Rechnungspositionen. |
createdAt | string (ISO) | Zeitpunkt der Erstellung. |
updatedAt | string (ISO) | Zeitpunkt der letzten Änderung. |
issuedAt | string | null | Zeitpunkt des Festschreibens. |
paidAt | string | null | Zeitpunkt der vollständigen Bezahlung. |
archivedAt | string | null | Zeitpunkt der Archivierung. |
Rechnungsposition (InvoiceItem)
Eine einzelne Position einer Rechnung.
| Feld | Typ | Beschreibung |
|---|---|---|
id | string | ID der Position. |
position | number | Reihenfolge (1-basiert). |
title | string | Titel/Bezeichnung der Position. |
icon | string | Optionaler Icon-Schlüssel ("" = keins). |
description | string | Beschreibungstext (kann leer sein). |
quantity | number | Menge. |
unit | string | Einheit, z. B. Stk, Std, Pauschal. |
unitPriceCents | number | Einzelpreis netto in Cent. |
vatRate | number | Umsatzsteuersatz in Prozent. |
netAmountCents | number | Berechneter Nettobetrag der Position in Cent. |
Zahlung (Payment)
Eine erfasste Zahlung zu einer Rechnung.
| Feld | Typ | Beschreibung |
|---|---|---|
id | string | ID der Zahlung. |
amountCents | number | Betrag in Cent (positiv = Eingang, negativ = Rückzahlung). |
method | enum | BANK_TRANSFER, CASH, CARD, DIRECT_DEBIT, PAYPAL oder OTHER. |
paidAt | string (ISO) | Datum des Geldflusses. |
note | string | null | Freie Notiz. |
reversal | boolean | Rück- oder Gegenbuchung; der Eintrag bleibt unveränderlich. |
reversalOfId | string | null | ID der ursprünglichen Zahlung bei einer gezielten Korrekturbuchung. |
createdAt | string (ISO) | Zeitpunkt der Erfassung. |
Kontakt (Contact)
Ein Kunde oder Lieferant – Person oder Unternehmen.
| Feld | Typ | Beschreibung |
|---|---|---|
id | string | ID des Kontakts. |
type | enum | PERSON oder COMPANY. |
role | enum | CUSTOMER, SUPPLIER oder BOTH. |
firstName | string | null | Vorname (bei Personen). |
lastName | string | null | Nachname (bei Personen). |
companyName | string | null | Firmenname (bei Unternehmen). |
email | string | null | E-Mail-Adresse. |
phone | string | null | Telefonnummer. |
street | string | null | Straße und Hausnummer. |
zip | string | null | Postleitzahl. |
city | string | null | Ort. |
country | string | null | Land. |
vatId | string | null | Umsatzsteuer-Identifikationsnummer. |
notes | string | null | Interne Notizen. |
status | enum | ACTIVE oder INACTIVE. |
createdAt | string (ISO) | Zeitpunkt der Erstellung. |
updatedAt | string (ISO) | Zeitpunkt der letzten Änderung. |
Produkt (Product)
Ein Produkt oder eine Dienstleistung aus dem Katalog.
| Feld | Typ | Beschreibung |
|---|---|---|
id | string | ID des Produkts. |
type | enum | PRODUCT oder SERVICE. |
name | string | Bezeichnung. |
description | string | null | Beschreibung. |
articleNumber | string | null | Artikelnummer. |
unit | string | null | Einheit, z. B. Stk, Std. |
unitPriceCents | number | Einzelpreis netto in Cent. |
vatRate | number | Umsatzsteuersatz in Prozent. |
status | enum | ACTIVE oder INACTIVE. |
createdAt | string (ISO) | Zeitpunkt der Erstellung. |
updatedAt | string (ISO) | Zeitpunkt der letzten Änderung. |
Angebot (Quote)
Angebot mit Empfänger-Momentaufnahme, Positionen, Summen und Kundenentscheidung.
| Feld | Typ | Beschreibung |
|---|---|---|
id | string | Eindeutige ID. |
status | enum | DRAFT, SENT, ACCEPTED, REJECTED oder EXPIRED. |
number | string | null | Angebotsnummer; ab dem Festschreiben gesetzt. |
sequence | integer | null | Laufende Nummer im Nummernkreis. |
publicToken | string | Nicht erratbarer Token für den Kundenlink. |
issueDate | string (ISO) | Angebotsdatum. |
validUntil | string | null | Gültigkeitsdatum. |
currency | string | Währung, derzeit EUR. |
smallBusiness | boolean | Kleinunternehmerregelung angewandt. |
taxScheme | enum | STANDARD, REVERSE_CHARGE oder NOT_TAXABLE. |
netTotalCents | integer | Nettosumme in Cent. |
taxTotalCents | integer | Steuersumme in Cent. |
grossTotalCents | integer | Bruttosumme in Cent. |
introText | string | null | Einleitung. |
closingText | string | null | Schlusstext. |
footer | string | null | Fußzeile. |
templateKey | string | Verwendeter Vorlagen-Schlüssel. |
contactId | string | null | Verknüpfter Empfänger-Kontakt. |
buyerName | string | null | Empfängername als Momentaufnahme. |
buyerEmail | string | null | Empfänger-E-Mail als Momentaufnahme. |
buyerVatId | string | null | USt-IdNr. des Empfängers. |
sentAt | string | null | Zeitpunkt des Festschreibens. |
respondedAt | string | null | Zeitpunkt der Kundenentscheidung. |
responseNote | string | null | Optionale Nachricht des Kunden. |
items | QuoteItem[] | Angebotspositionen. |
createdAt | string (ISO) | Erstellungszeitpunkt. |
updatedAt | string (ISO) | Änderungszeitpunkt. |
Angebotsposition (QuoteItem)
Eine Position eines Angebots.
| Feld | Typ | Beschreibung |
|---|---|---|
id | string | ID der Position. |
position | integer | 1-basierte Reihenfolge. |
title | string | Bezeichnung. |
icon | string | Optionaler Icon-Schlüssel. |
description | string | Beschreibung. |
quantity | number | Menge. |
unit | string | Einheit. |
unitPriceCents | integer | Netto-Einzelpreis in Cent. |
vatRate | integer | Umsatzsteuersatz in Prozent. |
netAmountCents | integer | Berechneter Nettobetrag. |
Beleg (Receipt)
Strukturierter Ein- oder Ausgangsbeleg mit optionalem Originaldokument.
| Feld | Typ | Beschreibung |
|---|---|---|
id | string | Eindeutige ID. |
direction | enum | INCOMING oder OUTGOING. |
status | enum | ERFASST, GEPRUEFT oder VERBUCHT. |
category | enum | Fachliche Belegkategorie. |
number | string | null | Belegnummer. |
partnerName | string | null | Geschäftspartner als Freitext. |
contactId | string | null | Optional verknüpfter Kontakt. |
contactName | string | null | Anzeigename des Kontakts. |
description | string | null | Kurzbeschreibung. |
notes | string | null | Interne Notiz. |
belegDate | string (ISO) | Belegdatum. |
netAmountCents | integer | Nettobetrag in Cent. |
taxAmountCents | integer | Steuerbetrag in Cent. |
grossAmountCents | integer | Bruttobetrag in Cent. |
vatRate | integer | Umsatzsteuersatz. |
currency | enum | EUR, USD, GBP oder CHF. |
file | object | null | Dateiname, MIME-Typ, Größe, SHA-256, Speicherzeitpunkt und API-URL des unveränderlichen Originals. |
createdAt | string (ISO) | Erstellungszeitpunkt. |
updatedAt | string (ISO) | Änderungszeitpunkt. |
Mahnung (Dunning)
Zahlungsaufforderung zu einer überfälligen Rechnung.
| Feld | Typ | Beschreibung |
|---|---|---|
id | string | Eindeutige ID. |
level | enum | REMINDER, FIRST, SECOND oder THIRD. |
status | enum | OPEN, SETTLED oder CANCELLED. |
invoiceId | string | ID der Rechnung. |
invoiceNumber | string | null | Rechnungsnummer als Momentaufnahme. |
recipientName | string | null | Empfängername als Momentaufnahme. |
issuedAt | string (ISO) | Ausstellungsdatum. |
dueDate | string (ISO) | Neue Zahlungsfrist. |
outstandingAmountCents | integer | Offener Rechnungsbetrag. |
feeCents | integer | Mahngebühr. |
interestCents | integer | Verzugszinsen. |
totalDueCents | integer | Gesamtforderung. |
note | string | null | Optionale Notiz. |
previousDunningId | string | null | Vorherige Stufe. |
createdAt | string (ISO) | Erstellungszeitpunkt. |
updatedAt | string (ISO) | Änderungszeitpunkt. |
Bankverbindung (BankAccount)
Bankverbindung des Unternehmens zur Verwendung auf Rechnungen.
| Feld | Typ | Beschreibung |
|---|---|---|
id | string | Eindeutige ID. |
label | string | null | Optionale interne Bezeichnung. |
accountHolder | string | Kontoinhaber. |
bankName | string | Name der Bank. |
iban | string | Normalisierte IBAN. |
bic | string | Normalisierter BIC. |
isDefault | boolean | Als Standardkonto markiert. |
Transaktion (Transaction)
Konsolidierter Geldfluss aus Belegen und Rechnungszahlungen.
| Feld | Typ | Beschreibung |
|---|---|---|
id | string | Quellenübergreifende ID. |
source | enum | BELEG oder ZAHLUNG. |
flow | enum | IN (Eingang) oder OUT (Ausgang). |
date | string (ISO) | Wertstellungs- oder Belegdatum. |
title | string | Geschäftspartner oder Beschreibung. |
reference | string | null | Beleg- oder Rechnungsnummer. |
detail | string | null | Kategorie oder Zahlungsart. |
amountCents | integer | Vorzeichenloser Betrag; Richtung steht in flow. |
currency | string | ISO-4217-Währungscode. |
href | string | null | Interner Link zur Ursprungsressource. |
Rechnungen
Rechnungen anlegen, bearbeiten, festschreiben, bezahlen und stornieren. Bearbeiten und Löschen sind nur für Entwürfe möglich; festgeschriebene Rechnungen werden storniert.
/invoicesRechnungen auflisten
Gibt eine paginierte, filterbare Liste der Rechnungen zurück.
Query-Parameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
page | integer | 1 | Seitennummer (ab 1). |
pageSize | integer | 25 | Einträge pro Seite (1–100). |
search | string | – | Volltextsuche über Nummer und Empfänger. |
status | enum | ALL | Filter: DRAFT, ISSUED, PAID, CANCELLED oder ARCHIVED. |
Beispielanfrage
curl https://beta.sysbalance.de/api/v1/invoices \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{
"data": [
{
"id": "clx8f3a1b0000qz01k4p2h9dz",
"status": "ISSUED",
"type": "INVOICE",
"number": "RE-2026-0042",
"buyerName": "Muster GmbH",
"issueDate": "2026-08-01",
"dueDate": "2026-08-15",
"grossTotalCents": 119000,
"currency": "EUR",
"paidAmountCents": 0,
"openAmountCents": 119000,
"createdAt": "2026-08-01T08:30:00.000Z"
}
],
"meta": { "page": 1, "pageSize": 25, "pageCount": 1, "total": 1 }
}/invoicesRechnung anlegen
Legt einen Rechnungsentwurf an. Mit ?finalize=1 (oder "finalize": true im Körper) wird sie direkt festgeschrieben.
Query-Parameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
finalize | boolean | false | Bei 1/true wird die Rechnung sofort festgeschrieben. |
Anfragekörper
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
bankAccountId | string | nein | ID der zu verwendenden Bankverbindung. Ausgelassen greift das Standardkonto des Unternehmens. |
contactId | string | ja | ID des Empfänger-Kontakts. |
kind | enum | nein | SINGLE (Standard) oder COLLECTIVE. Sammelrechnungen benötigen einen Abrechnungszeitraum. |
templateKey | string | nein | Vorlagen-Schlüssel. Ausgelassen greift die Standardvorlage. |
taxScheme | enum | nein | STANDARD (Standard), REVERSE_CHARGE oder NOT_TAXABLE. |
issueDate | string (yyyy-mm-dd) | ja | Rechnungsdatum. |
serviceDate | string (yyyy-mm-dd) | nein | Leistungsdatum. |
servicePeriodStart | string (yyyy-mm-dd) | nein | Beginn des Abrechnungszeitraums. |
servicePeriodEnd | string (yyyy-mm-dd) | nein | Ende des Abrechnungszeitraums. |
dueDate | string (yyyy-mm-dd) | nein | Fälligkeitsdatum. |
paymentTerms | string | nein | Zahlungsziel (max. 200 Zeichen). |
buyerReference | string | nein | Käuferreferenz (max. 100 Zeichen). |
introText | string | nein | Einleitung (max. 2000 Zeichen). |
closingText | string | nein | Schlusstext (max. 2000 Zeichen). |
footer | string | nein | Fußzeile (max. 2000 Zeichen). |
showBankDetails | boolean | nein | Bankverbindung anzeigen (Standard true). |
showContactDetails | boolean | nein | Absender-Kontaktdaten anzeigen (Standard true). |
showCompanyName | boolean | nein | Unternehmensname anzeigen (Standard true). |
showCompanyLogo | boolean | nein | Unternehmenslogo anzeigen (Standard true). |
items | InvoiceItem[] | ja | 1–50 Positionen mit title, quantity, unitPriceCents und vatRate. |
- Positionsfelder: title (max. 200), description (max. 1000), quantity (> 0), unit (max. 20), unitPriceCents (Ganzzahl), vatRate (0–100).
- Beträge werden immer in Cent als Ganzzahl übergeben.
Beispielanfrage
curl -X POST https://beta.sysbalance.de/api/v1/invoices \
-H "Authorization: Bearer sb_live_ihr-schluessel" \
-H "Content-Type: application/json" \
-d '{
"contactId": "clx7a9c2d0000qz01m3n8k1ab",
"issueDate": "2026-08-25",
"dueDate": "2026-09-08",
"items": [
{
"title": "Beratung",
"description": "Konzeption und Umsetzung",
"quantity": 8,
"unit": "Std",
"unitPriceCents": 12500,
"vatRate": 19
}
]
}'Antwort · 201 Created
{
"data": {
"id": "clx8f3a1b0000qz01k4p2h9dz",
"status": "DRAFT",
"type": "INVOICE",
"number": null,
"issueDate": "2026-08-25",
"dueDate": "2026-09-08",
"netTotalCents": 100000,
"taxTotalCents": 19000,
"grossTotalCents": 119000,
"paidAmountCents": 0,
"openAmountCents": 119000,
"items": [
{
"id": "clx0p1…",
"position": 1,
"title": "Beratung",
"quantity": 8,
"unit": "Std",
"unitPriceCents": 12500,
"vatRate": 19,
"netAmountCents": 100000
}
],
"createdAt": "2026-08-25T09:00:00.000Z",
"updatedAt": "2026-08-25T09:00:00.000Z"
}
}/invoices/:idRechnung abrufen
Ruft eine einzelne Rechnung mit allen Positionen und Zahlungen ab.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID der Rechnung. |
Beispielanfrage
curl https://beta.sysbalance.de/api/v1/invoices/clx8f3a1b0000qz01k4p2h9dz \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{
"data": {
"id": "clx8f3a1b0000qz01k4p2h9dz",
"status": "ISSUED",
"type": "INVOICE",
"number": "RE-2026-0042",
"buyerName": "Muster GmbH",
"issueDate": "2026-08-01",
"dueDate": "2026-08-15",
"netTotalCents": 100000,
"taxTotalCents": 19000,
"grossTotalCents": 119000,
"paidAmountCents": 0,
"openAmountCents": 119000,
"payments": [],
"items": [ /* … */ ]
}
}/invoices/:idEntwurf aktualisieren
Aktualisiert einen Rechnungsentwurf. Nur übergebene Felder werden geändert; fehlende Felder behalten ihren Wert. Nur für Entwürfe möglich.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID der Rechnung. |
Anfragekörper
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
dueDate | string (yyyy-mm-dd) | nein | Beispielhaft geändertes Feld. |
… | - | nein | Alle Felder aus „Rechnung anlegen“ sind zulässig. |
Beispielanfrage
curl -X PATCH https://beta.sysbalance.de/api/v1/invoices/clx8f3a1b0000qz01k4p2h9dz \
-H "Authorization: Bearer sb_live_ihr-schluessel" \
-H "Content-Type: application/json" \
-d '{
"dueDate": "2026-09-15",
"paymentTerms": "Zahlbar innerhalb von 21 Tagen"
}'Antwort · 200 OK
{
"data": {
"id": "clx8f3a1b0000qz01k4p2h9dz",
"status": "DRAFT",
"dueDate": "2026-09-15",
"paymentTerms": "Zahlbar innerhalb von 21 Tagen"
}
}/invoices/:idEntwurf löschen
Löscht einen Rechnungsentwurf. Festgeschriebene Rechnungen können nicht gelöscht, sondern nur storniert werden.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID der Rechnung. |
Beispielanfrage
curl -X DELETE https://beta.sysbalance.de/api/v1/invoices/clx8f3a1b0000qz01k4p2h9dz \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{ "data": { "id": "clx8f3a1b0000qz01k4p2h9dz", "deleted": true } }/invoices/:id/finalizeRechnung festschreiben
Schreibt einen Entwurf GoBD-konform fest: vergibt lückenlos die Rechnungsnummer, friert die Absenderdaten ein und erzeugt HTML sowie XRechnung.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID der Rechnung. |
Beispielanfrage
curl -X POST https://beta.sysbalance.de/api/v1/invoices/clx8f3a1b0000qz01k4p2h9dz/finalize \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{
"data": {
"id": "clx8f3a1b0000qz01k4p2h9dz",
"status": "ISSUED",
"number": "RE-2026-0042",
"issuedAt": "2026-08-25T09:05:00.000Z",
"hasEInvoice": true
}
}/invoices/:id/payAls bezahlt markieren
Markiert eine festgeschriebene Rechnung als vollständig bezahlt.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID der Rechnung. |
Beispielanfrage
curl -X POST https://beta.sysbalance.de/api/v1/invoices/clx8f3a1b0000qz01k4p2h9dz/pay \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{
"data": {
"id": "clx8f3a1b0000qz01k4p2h9dz",
"status": "PAID",
"paidAmountCents": 119000,
"openAmountCents": 0,
"paidAt": "2026-08-25T09:10:00.000Z"
}
}/invoices/:id/cancelRechnung stornieren
Storniert eine festgeschriebene oder bezahlte Rechnung GoBD-konform. Es entsteht eine eigene Stornorechnung mit negierten Beträgen; erfasste Zahlungen werden automatisch zurückgebucht.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID der Rechnung. |
Anfragekörper
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
reason | string | nein | Optionaler Stornogrund. |
Beispielanfrage
curl -X POST https://beta.sysbalance.de/api/v1/invoices/clx8f3a1b0000qz01k4p2h9dz/cancel \
-H "Authorization: Bearer sb_live_ihr-schluessel" \
-H "Content-Type: application/json" \
-d '{ "reason": "Falscher Empfänger" }'Antwort · 200 OK
{
"data": {
"id": "clx8f3a1b0000qz01k4p2h9dz",
"status": "CANCELLED",
"cancelledAt": "2026-08-25T09:15:00.000Z",
"cancelledReason": "Falscher Empfänger",
"stornoInvoiceId": "clxstorno…",
"stornoInvoiceNumber": "RE-2026-0043"
}
}/invoices/:id/archiveRechnung archivieren
Archiviert eine festgeschriebene Rechnung. Entwürfe können nicht archiviert werden.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID der Rechnung. |
Beispielanfrage
curl -X POST https://beta.sysbalance.de/api/v1/invoices/clx8f3a1b0000qz01k4p2h9dz/archive \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{ "data": { "id": "clx8f3a1b0000qz01k4p2h9dz", "archivedAt": "2026-09-06T10:00:00.000Z" } }/invoices/:id/archiveRechnung wiederherstellen
Holt eine archivierte Rechnung zurück in die reguläre Übersicht.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID der Rechnung. |
Beispielanfrage
curl -X DELETE https://beta.sysbalance.de/api/v1/invoices/clx8f3a1b0000qz01k4p2h9dz/archive \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{ "data": { "id": "clx8f3a1b0000qz01k4p2h9dz", "archivedAt": null } }/invoices/:id/documentRechnungsdokument abrufen
Liefert die menschenlesbare Rechnung als abgesichertes HTML oder als A4-PDF.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID der Rechnung. |
Query-Parameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
format | enum | html | html oder pdf. |
Beispielanfrage
curl https://beta.sysbalance.de/api/v1/invoices/clx8f3a1b0000qz01k4p2h9dz/document \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
<html>… gerendertes Rechnungsdokument …</html>/invoices/:id/xrechnungE-Rechnung abrufen
Liefert die strukturierte E-Rechnung (XRechnung/UBL nach EN 16931) als XML. Für festgeschriebene Rechnungen wird die gespeicherte Momentaufnahme ausgeliefert.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID der Rechnung. |
Query-Parameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
download | boolean | false | Bei 1 wird die Datei als Download (Content-Disposition) angeboten. |
Beispielanfrage
curl https://beta.sysbalance.de/api/v1/invoices/clx8f3a1b0000qz01k4p2h9dz/xrechnung \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<Invoice xmlns="urn:oasis:names:specification:ubl:schema:xsd:Invoice-2">
<cbc:ID>RE-2026-0042</cbc:ID>
<cbc:IssueDate>2026-08-01</cbc:IssueDate>
<!-- … EN 16931 / XRechnung … -->
</Invoice>/invoices/:id/paymentsZahlungen auflisten
Listet die erfassten Zahlungen einer Rechnung samt Zahlungsstand auf.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID der Rechnung. |
Beispielanfrage
curl https://beta.sysbalance.de/api/v1/invoices/clx8f3a1b0000qz01k4p2h9dz/payments \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{
"data": [
{
"id": "clx9d4g6h0000qz01s2u8w0ef",
"amountCents": 59500,
"method": "BANK_TRANSFER",
"paidAt": "2026-08-20",
"note": "Teilzahlung",
"reversal": false,
"reversalOfId": null,
"createdAt": "2026-08-20T10:00:00.000Z"
}
],
"meta": { "paidAmountCents": 59500, "openAmountCents": 59500, "grossTotalCents": 119000 }
}/invoices/:id/paymentsZahlung erfassen
Erfasst eine (Teil-)Zahlung zu einer festgeschriebenen Rechnung.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID der Rechnung. |
Anfragekörper
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
amountCents | integer | ja | Betrag in Cent (> 0). |
method | enum | nein | BANK_TRANSFER (Standard), CASH, CARD, DIRECT_DEBIT, PAYPAL, OTHER. |
paidAt | string (yyyy-mm-dd) | ja | Datum des Geldflusses. |
note | string | nein | Freie Notiz (max. 500 Zeichen). |
Beispielanfrage
curl -X POST https://beta.sysbalance.de/api/v1/invoices/clx8f3a1b0000qz01k4p2h9dz/payments \
-H "Authorization: Bearer sb_live_ihr-schluessel" \
-H "Content-Type: application/json" \
-d '{
"amountCents": 59500,
"method": "BANK_TRANSFER",
"paidAt": "2026-08-20",
"note": "Teilzahlung"
}'Antwort · 201 Created
{
"data": {
"id": "clx8f3a1b0000qz01k4p2h9dz",
"status": "ISSUED",
"grossTotalCents": 119000,
"paidAmountCents": 59500,
"openAmountCents": 59500,
"payments": [
{
"id": "clx9d4g6h0000qz01s2u8w0ef",
"amountCents": 59500,
"method": "BANK_TRANSFER",
"paidAt": "2026-08-20T00:00:00.000Z",
"note": "Teilzahlung",
"reversal": false,
"reversalOfId": null
}
]
}
}/invoices/:id/payments/:paymentIdZahlung korrigieren
Erstellt eine negative Gegenbuchung zur manuell erfassten Zahlung. Der ursprüngliche Eintrag und die Korrektur bleiben dauerhaft erhalten; Rückbuchungen können nicht erneut korrigiert werden.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID der Rechnung. |
paymentIderforderlich | string | – | ID der Zahlung. |
Beispielanfrage
curl -X DELETE https://beta.sysbalance.de/api/v1/invoices/clx8f3a1b0000qz01k4p2h9dz/payments/clx9d4g6h0000qz01s2u8w0ef \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{ "data": { "id": "clx8f3a1b0000qz01k4p2h9dz", "paidAmountCents": 0, "openAmountCents": 119000, "payments": [{ "id": "clxcorrection0001", "amountCents": -59500, "reversal": true, "reversalOfId": "clx9d4g6h0000qz01s2u8w0ef" }, { "id": "clx9d4g6h0000qz01s2u8w0ef", "amountCents": 59500, "reversal": false, "reversalOfId": null }] } }Produkte
Produkte und Dienstleistungen aus dem Katalog verwalten.
/productsProdukte auflisten
Gibt eine paginierte, filterbare Liste von Produkten und Dienstleistungen zurück.
Query-Parameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
page | integer | 1 | Seitennummer (ab 1). |
pageSize | integer | 25 | Einträge pro Seite (1–100). |
search | string | – | Volltextsuche über Name und Artikelnummer. |
type | enum | ALL | Filter: PRODUCT oder SERVICE. |
status | enum | ALL | Filter: ACTIVE oder INACTIVE. |
Beispielanfrage
curl https://beta.sysbalance.de/api/v1/products \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{
"data": [
{
"id": "clx6b2e4f0000qz01p7r5t3cd",
"type": "SERVICE",
"name": "Beratung",
"unit": "Std",
"unitPriceCents": 12500,
"vatRate": 19,
"status": "ACTIVE"
}
],
"meta": { "page": 1, "pageSize": 25, "pageCount": 1, "total": 1 }
}/productsProdukt anlegen
Legt ein Produkt oder eine Dienstleistung an.
Anfragekörper
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
type | enum | ja | PRODUCT oder SERVICE. |
name | string | ja | Bezeichnung (max. 160 Zeichen). |
description | string | nein | Beschreibung (max. 1000 Zeichen). |
articleNumber | string | nein | Artikelnummer (max. 60 Zeichen). |
unit | string | nein | Einheit (max. 20 Zeichen). |
unitPriceCents | integer | ja | Einzelpreis netto in Cent (≥ 0). |
vatRate | integer | ja | Umsatzsteuersatz in Prozent (0–100). |
status | enum | nein | ACTIVE (Standard) oder INACTIVE. |
Beispielanfrage
curl -X POST https://beta.sysbalance.de/api/v1/products \
-H "Authorization: Bearer sb_live_ihr-schluessel" \
-H "Content-Type: application/json" \
-d '{
"type": "SERVICE",
"name": "Beratung",
"unit": "Std",
"unitPriceCents": 12500,
"vatRate": 19
}'Antwort · 201 Created
{
"data": {
"id": "clx6b2e4f0000qz01p7r5t3cd",
"type": "SERVICE",
"name": "Beratung",
"description": null,
"articleNumber": null,
"unit": "Std",
"unitPriceCents": 12500,
"vatRate": 19,
"status": "ACTIVE",
"createdAt": "2026-08-25T09:00:00.000Z",
"updatedAt": "2026-08-25T09:00:00.000Z"
}
}/products/:idProdukt abrufen
Ruft ein einzelnes Produkt ab.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID des Produkts. |
Beispielanfrage
curl https://beta.sysbalance.de/api/v1/products/clx6b2e4f0000qz01p7r5t3cd \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{
"data": {
"id": "clx6b2e4f0000qz01p7r5t3cd",
"type": "SERVICE",
"name": "Beratung",
"unit": "Std",
"unitPriceCents": 12500,
"vatRate": 19,
"status": "ACTIVE"
}
}/products/:idProdukt aktualisieren
Aktualisiert ein Produkt. Nur übergebene Felder werden geändert.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID des Produkts. |
Anfragekörper
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
unitPriceCents | integer | nein | Beispielhaft geändertes Feld. |
… | - | nein | Alle Felder aus „Produkt anlegen“ sind zulässig. |
Beispielanfrage
curl -X PATCH https://beta.sysbalance.de/api/v1/products/clx6b2e4f0000qz01p7r5t3cd \
-H "Authorization: Bearer sb_live_ihr-schluessel" \
-H "Content-Type: application/json" \
-d '{ "unitPriceCents": 13500 }'Antwort · 200 OK
{
"data": {
"id": "clx6b2e4f0000qz01p7r5t3cd",
"type": "SERVICE",
"name": "Beratung",
"unitPriceCents": 13500,
"vatRate": 19,
"status": "ACTIVE"
}
}/products/:idProdukt löschen
Löscht ein Produkt aus dem Katalog.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID des Produkts. |
Beispielanfrage
curl -X DELETE https://beta.sysbalance.de/api/v1/products/clx6b2e4f0000qz01p7r5t3cd \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{ "data": { "id": "clx6b2e4f0000qz01p7r5t3cd", "deleted": true } }Kontakte
Kunden und Lieferanten verwalten – Personen wie Unternehmen.
/contactsKontakte auflisten
Gibt eine paginierte, filterbare Liste der Kontakte zurück.
Query-Parameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
page | integer | 1 | Seitennummer (ab 1). |
pageSize | integer | 25 | Einträge pro Seite (1–100). |
search | string | – | Volltextsuche über Name, Firma und E-Mail. |
type | enum | ALL | Filter: PERSON oder COMPANY. |
role | enum | ALL | Filter: CUSTOMER, SUPPLIER oder BOTH. |
status | enum | ALL | Filter: ACTIVE oder INACTIVE. |
Beispielanfrage
curl https://beta.sysbalance.de/api/v1/contacts \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{
"data": [
{
"id": "clx7a9c2d0000qz01m3n8k1ab",
"type": "COMPANY",
"role": "CUSTOMER",
"companyName": "Muster GmbH",
"email": "buchhaltung@muster.de",
"city": "Berlin",
"status": "ACTIVE"
}
],
"meta": { "page": 1, "pageSize": 25, "pageCount": 1, "total": 1 }
}/contactsKontakt anlegen
Legt einen Kontakt an. Personen benötigen einen Vor- oder Nachnamen, Unternehmen einen Firmennamen.
Anfragekörper
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
type | enum | ja | PERSON oder COMPANY. |
role | enum | nein | CUSTOMER (Standard), SUPPLIER oder BOTH. |
firstName | string | nein | Vorname (Person, max. 100). |
lastName | string | nein | Nachname (Person, max. 100). |
companyName | string | nein | Firmenname (Unternehmen, max. 160). |
email | string | nein | Gültige E-Mail-Adresse (max. 254). |
phone | string | nein | Telefonnummer (max. 40). |
street | string | nein | Straße (max. 160). |
zip | string | nein | Postleitzahl (max. 20). |
city | string | nein | Ort (max. 100). |
country | string | nein | Land (max. 100). |
vatId | string | nein | USt-IdNr. (max. 30). |
notes | string | nein | Notizen (max. 1000). |
status | enum | nein | ACTIVE (Standard) oder INACTIVE. |
Beispielanfrage
curl -X POST https://beta.sysbalance.de/api/v1/contacts \
-H "Authorization: Bearer sb_live_ihr-schluessel" \
-H "Content-Type: application/json" \
-d '{
"type": "COMPANY",
"role": "CUSTOMER",
"companyName": "Muster GmbH",
"email": "buchhaltung@muster.de",
"city": "Berlin"
}'Antwort · 201 Created
{
"data": {
"id": "clx7a9c2d0000qz01m3n8k1ab",
"type": "COMPANY",
"role": "CUSTOMER",
"companyName": "Muster GmbH",
"email": "buchhaltung@muster.de",
"city": "Berlin",
"status": "ACTIVE",
"createdAt": "2026-08-25T09:00:00.000Z",
"updatedAt": "2026-08-25T09:00:00.000Z"
}
}/contacts/:idKontakt abrufen
Ruft einen einzelnen Kontakt ab.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID des Kontakts. |
Beispielanfrage
curl https://beta.sysbalance.de/api/v1/contacts/clx7a9c2d0000qz01m3n8k1ab \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{
"data": {
"id": "clx7a9c2d0000qz01m3n8k1ab",
"type": "COMPANY",
"role": "CUSTOMER",
"companyName": "Muster GmbH",
"email": "buchhaltung@muster.de",
"city": "Berlin",
"status": "ACTIVE"
}
}/contacts/:idKontakt aktualisieren
Aktualisiert einen Kontakt. Nur übergebene Felder werden geändert.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID des Kontakts. |
Anfragekörper
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
city | string | nein | Beispielhaft geändertes Feld. |
… | - | nein | Alle Felder aus „Kontakt anlegen“ sind zulässig. |
Beispielanfrage
curl -X PATCH https://beta.sysbalance.de/api/v1/contacts/clx7a9c2d0000qz01m3n8k1ab \
-H "Authorization: Bearer sb_live_ihr-schluessel" \
-H "Content-Type: application/json" \
-d '{ "city": "Hamburg" }'Antwort · 200 OK
{
"data": {
"id": "clx7a9c2d0000qz01m3n8k1ab",
"type": "COMPANY",
"companyName": "Muster GmbH",
"city": "Hamburg",
"status": "ACTIVE"
}
}/contacts/:idKontakt löschen
Löscht einen Kontakt.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID des Kontakts. |
Beispielanfrage
curl -X DELETE https://beta.sysbalance.de/api/v1/contacts/clx7a9c2d0000qz01m3n8k1ab \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{ "data": { "id": "clx7a9c2d0000qz01m3n8k1ab", "deleted": true } }Statistiken
Aggregierte Auswertungen zu Liquidität, Prognose und Jahresergebnis (Beträge in Cent).
/statistics/liquiditaetLiquiditätsübersicht
Einnahmen und Ausgaben je Monat, Summen, Gesamtsaldo und Durchschnitt.
Query-Parameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
months | integer | 12 | Betrachtetes Zeitfenster (1–36). |
Beispielanfrage
curl https://beta.sysbalance.de/api/v1/statistics/liquiditaet \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{
"data": {
"points": [
{ "month": "2026-08", "label": "Aug 26", "incomeCents": 250000, "expenseCents": 90000, "netCents": 160000 }
],
"totals": { "incomeCents": 250000, "expenseCents": 90000, "netCents": 160000 },
"currentBalanceCents": 1200000,
"avgMonthlyNetCents": 160000,
"monthCount": 12
}
}/statistics/prognoseUmsatzprognose
Fortschreibung auf Basis der Vergangenheitswerte inklusive der offenen Forderungen (festgeschriebene, unbezahlte Rechnungen).
Query-Parameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
historyMonths | integer | 6 | Zugrunde gelegte Ist-Monate (1–24). |
projectionMonths | integer | 6 | Prognostizierte Monate (1–24). |
Beispielanfrage
curl https://beta.sysbalance.de/api/v1/statistics/prognose \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{
"data": {
"history": [ { "month": "2026-08", "label": "Aug 26", "incomeCents": 250000, "expenseCents": 90000, "netCents": 160000 } ],
"projection": [ { "month": "2026-09", "label": "Sep 26", "incomeCents": 240000, "expenseCents": 88000, "netCents": 152000, "cumulativeCents": 1352000 } ],
"avgIncomeCents": 240000,
"avgExpenseCents": 88000,
"avgNetCents": 152000,
"openReceivables": { "items": [], "totalCents": 0, "overdueCents": 0, "count": 0 },
"startBalanceCents": 1200000
}
}/statistics/jahresberichtJahresbericht
Gewinn/Verlust, Monatsverlauf, Aufschlüsselung nach Kategorien und Umsatzsteuer.
Query-Parameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
year | integer | laufendes Jahr | Berichtsjahr (2000 bis aktuelles Jahr + 1). |
Beispielanfrage
curl https://beta.sysbalance.de/api/v1/statistics/jahresbericht \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{
"data": {
"year": 2026,
"availableYears": [2026, 2025],
"incomeCents": 2500000,
"expenseCents": 900000,
"resultCents": 1600000,
"monthly": [ { "month": "2026-01", "label": "Jan 26", "incomeCents": 200000, "expenseCents": 70000, "netCents": 130000 } ],
"expenseByCategory": [ { "category": "OFFICE", "grossCents": 300000 } ],
"incomeByCategory": [ { "category": "SALES", "grossCents": 2500000 } ],
"vat": { "outputCents": 475000, "inputCents": 171000, "payloadCents": 304000 },
"belegCount": 128
}
}Transaktionen
Konsolidierter, chronologischer Kontoauszug aus Belegen und Rechnungszahlungen.
/transactionsTransaktionen auflisten
Gibt Geldflüsse samt gefilterten Summen zurück.
Query-Parameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
page | integer | 1 | Seitennummer (ab 1). |
pageSize | integer | 25 | Einträge pro Seite (1–100). |
search | string | – | Suche über Titel, Referenz und Notiz. |
flow | enum | ALL | IN oder OUT. |
source | enum | ALL | BELEG oder ZAHLUNG. |
Beispielanfrage
curl https://beta.sysbalance.de/api/v1/transactions \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{ "data": [{ "id": "payment:clx…", "source": "ZAHLUNG", "flow": "IN", "date": "2026-09-06T00:00:00.000Z", "title": "Muster GmbH", "reference": "RE-0042", "amountCents": 119000, "currency": "EUR" }], "meta": { "page": 1, "pageSize": 25, "pageCount": 1, "total": 1, "summary": { "count": 1, "inflowCents": 119000, "outflowCents": 0, "netCents": 119000 } } }Angebote
Angebote anlegen, bearbeiten, festschreiben und als HTML oder PDF abrufen.
/quotesAngebote auflisten
Gibt eine paginierte, filterbare Angebotsliste zurück.
Query-Parameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
page | integer | 1 | Seitennummer (ab 1). |
pageSize | integer | 25 | Einträge pro Seite (1–100). |
search | string | – | Suche über Nummer und Empfänger. |
status | enum | ALL | DRAFT, SENT, ACCEPTED, REJECTED oder EXPIRED. |
Beispielanfrage
curl https://beta.sysbalance.de/api/v1/quotes \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{ "data": [{ "id": "clxqa3a1b0000qz01k4p2h9dz", "status": "SENT", "number": "AN-0042", "buyerName": "Muster GmbH", "grossTotalCents": 119000 }], "meta": { "page": 1, "pageSize": 25, "pageCount": 1, "total": 1 } }/quotesAngebot anlegen
Legt einen Entwurf an. Mit ?send=1 oder send:true wird er direkt festgeschrieben.
Query-Parameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
send | boolean | false | Angebot direkt festschreiben. |
Anfragekörper
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
contactId | string | ja | ID des Empfänger-Kontakts. |
templateKey | string | nein | Vorlage; ausgelassen wird die Standardvorlage verwendet. |
taxScheme | enum | nein | STANDARD, REVERSE_CHARGE oder NOT_TAXABLE. |
issueDate | string (yyyy-mm-dd) | ja | Angebotsdatum. |
validUntil | string (yyyy-mm-dd) | nein | Gültig bis; Standard gemäß Unternehmenseinstellung. |
introText | string | nein | Einleitung, maximal 2000 Zeichen. |
closingText | string | nein | Schlusstext, maximal 2000 Zeichen. |
footer | string | nein | Fußzeile, maximal 2000 Zeichen. |
items | QuoteItem[] | ja | 1–50 Positionen. |
Beispielanfrage
curl -X POST https://beta.sysbalance.de/api/v1/quotes \
-H "Authorization: Bearer sb_live_ihr-schluessel" \
-H "Content-Type: application/json" \
-d '{ "contactId": "clx7a9c2d0000qz01m3n8k1ab", "issueDate": "2026-09-06", "items": [{ "title": "Beratung", "quantity": 8, "unit": "Std", "unitPriceCents": 12500, "vatRate": 19 }] }'Antwort · 201 Created
{ "data": { "id": "clxqa3a1b0000qz01k4p2h9dz", "status": "DRAFT", "number": null, "grossTotalCents": 119000 } }/quotes/:idAngebot abrufen
Ruft ein Angebot mit Positionen und Kundenentscheidung ab.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID des Angebots. |
Beispielanfrage
curl https://beta.sysbalance.de/api/v1/quotes/clxqa3a1b0000qz01k4p2h9dz \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{ "data": { "id": "clxqa3a1b0000qz01k4p2h9dz", "status": "SENT", "number": "AN-0042", "items": [] } }/quotes/:idAngebotsentwurf aktualisieren
Aktualisiert übergebene Felder eines Entwurfs. Festgeschriebene Angebote sind unveränderlich.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID des Angebots. |
Anfragekörper
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
contactId | string | nein | ID des Empfänger-Kontakts. |
templateKey | string | nein | Vorlage; ausgelassen wird die Standardvorlage verwendet. |
taxScheme | enum | nein | STANDARD, REVERSE_CHARGE oder NOT_TAXABLE. |
issueDate | string (yyyy-mm-dd) | nein | Angebotsdatum. |
validUntil | string (yyyy-mm-dd) | nein | Gültig bis; Standard gemäß Unternehmenseinstellung. |
introText | string | nein | Einleitung, maximal 2000 Zeichen. |
closingText | string | nein | Schlusstext, maximal 2000 Zeichen. |
footer | string | nein | Fußzeile, maximal 2000 Zeichen. |
items | QuoteItem[] | nein | 1–50 Positionen. |
Beispielanfrage
curl -X PATCH https://beta.sysbalance.de/api/v1/quotes/clxqa3a1b0000qz01k4p2h9dz \
-H "Authorization: Bearer sb_live_ihr-schluessel" \
-H "Content-Type: application/json" \
-d '{ "validUntil": "2026-10-06" }'Antwort · 200 OK
{ "data": { "id": "clxqa3a1b0000qz01k4p2h9dz", "status": "DRAFT", "validUntil": "2026-10-06T00:00:00.000Z" } }/quotes/:idAngebotsentwurf löschen
Löscht einen noch nicht festgeschriebenen Entwurf.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID des Angebots. |
Beispielanfrage
curl -X DELETE https://beta.sysbalance.de/api/v1/quotes/clxqa3a1b0000qz01k4p2h9dz \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{ "data": { "id": "clxqa3a1b0000qz01k4p2h9dz", "deleted": true } }/quotes/:id/sendAngebot festschreiben
Vergibt die Angebotsnummer, friert das Dokument ein und aktiviert den Kundenlink.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID des Angebots. |
Beispielanfrage
curl -X POST https://beta.sysbalance.de/api/v1/quotes/clxqa3a1b0000qz01k4p2h9dz/send \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{ "data": { "id": "clxqa3a1b0000qz01k4p2h9dz", "status": "SENT", "number": "AN-0042", "sentAt": "2026-09-06T10:00:00.000Z" } }/quotes/:id/documentAngebotsdokument abrufen
Liefert das Angebot als abgesichertes HTML oder A4-PDF.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID des Angebots. |
Query-Parameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
format | enum | html | html oder pdf. |
Beispielanfrage
curl https://beta.sysbalance.de/api/v1/quotes/clxqa3a1b0000qz01k4p2h9dz/document \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
<html>… gerendertes Angebotsdokument …</html>Belege
Ein- und Ausgangsbelege verwalten und Originaldokumente sicher übertragen.
/receiptsBelege auflisten
Gibt Belege samt Summen des aktiven Filters zurück.
Query-Parameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
page | integer | 1 | Seitennummer (ab 1). |
pageSize | integer | 25 | Einträge pro Seite (1–100). |
search | string | – | Suche über Partner, Nummer, Beschreibung und Kontakt. |
direction | enum | ALL | INCOMING oder OUTGOING. |
status | enum | ALL | ERFASST, GEPRUEFT oder VERBUCHT. |
category | enum | ALL | Fachliche Belegkategorie. |
Beispielanfrage
curl https://beta.sysbalance.de/api/v1/receipts \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{ "data": [{ "id": "clxrb3a1b0000qz01k4p2h9dz", "direction": "INCOMING", "grossAmountCents": 11900, "file": null }], "meta": { "page": 1, "pageSize": 25, "pageCount": 1, "total": 1, "summary": { "count": 1, "grossTotalCents": 11900, "openCount": 1 } } }/receiptsBeleg anlegen
Legt die strukturierten Belegdaten im Status ERFASST an. Das Originaldokument wird anschließend separat hochgeladen; erst danach ist die Festschreibung per PATCH möglich.
Anfragekörper
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
direction | enum | ja | INCOMING oder OUTGOING. |
status | enum | nein | ERFASST (Standard), GEPRUEFT oder VERBUCHT. |
category | enum | nein | Belegkategorie; Standard SONSTIGES. |
number | string | nein | Belegnummer, maximal 60 Zeichen. |
partnerName | string | nein | Geschäftspartner, maximal 160 Zeichen. |
contactId | string | nein | Optional verknüpfter Kontakt. |
description | string | nein | Kurzbeschreibung, maximal 200 Zeichen. |
notes | string | nein | Interne Notiz, maximal 1000 Zeichen. |
belegDate | string (yyyy-mm-dd) | ja | Belegdatum. |
grossAmountCents | integer | ja | Bruttobetrag in Cent. |
vatRate | integer | ja | Umsatzsteuersatz von 0 bis 100. |
currency | enum | nein | EUR (Standard), USD, GBP oder CHF. |
Beispielanfrage
curl -X POST https://beta.sysbalance.de/api/v1/receipts \
-H "Authorization: Bearer sb_live_ihr-schluessel" \
-H "Content-Type: application/json" \
-d '{ "direction": "INCOMING", "category": "IT_SOFTWARE", "partnerName": "Software GmbH", "belegDate": "2026-09-06", "grossAmountCents": 11900, "vatRate": 19 }'Antwort · 201 Created
{ "data": { "id": "clxrb3a1b0000qz01k4p2h9dz", "netAmountCents": 10000, "taxAmountCents": 1900, "grossAmountCents": 11900, "file": null } }/receipts/:idBeleg abrufen
Ruft einen einzelnen Beleg samt Dateimetadaten ab.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID des Belegs. |
Beispielanfrage
curl https://beta.sysbalance.de/api/v1/receipts/clxrb3a1b0000qz01k4p2h9dz \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{ "data": { "id": "clxrb3a1b0000qz01k4p2h9dz", "direction": "INCOMING", "status": "ERFASST", "grossAmountCents": 11900, "file": null } }/receipts/:idBeleg aktualisieren
Aktualisiert nur einen Beleg im Status ERFASST. Der Wechsel zu GEPRUEFT oder VERBUCHT schreibt ihn fest und setzt ein zuvor hochgeladenes Original voraus.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID des Belegs. |
Anfragekörper
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
direction | enum | nein | INCOMING oder OUTGOING. |
status | enum | nein | ERFASST (Standard), GEPRUEFT oder VERBUCHT. |
category | enum | nein | Belegkategorie; Standard SONSTIGES. |
number | string | nein | Belegnummer, maximal 60 Zeichen. |
partnerName | string | nein | Geschäftspartner, maximal 160 Zeichen. |
contactId | string | nein | Optional verknüpfter Kontakt. |
description | string | nein | Kurzbeschreibung, maximal 200 Zeichen. |
notes | string | nein | Interne Notiz, maximal 1000 Zeichen. |
belegDate | string (yyyy-mm-dd) | nein | Belegdatum. |
grossAmountCents | integer | nein | Bruttobetrag in Cent. |
vatRate | integer | nein | Umsatzsteuersatz von 0 bis 100. |
currency | enum | nein | EUR (Standard), USD, GBP oder CHF. |
Beispielanfrage
curl -X PATCH https://beta.sysbalance.de/api/v1/receipts/clxrb3a1b0000qz01k4p2h9dz \
-H "Authorization: Bearer sb_live_ihr-schluessel" \
-H "Content-Type: application/json" \
-d '{ "status": "GEPRUEFT" }'Antwort · 200 OK
{ "data": { "id": "clxrb3a1b0000qz01k4p2h9dz", "status": "GEPRUEFT" } }/receipts/:idBeleg löschen
Löscht ausschließlich eine noch nicht festgeschriebene Erfassung ohne Originaldokument. Aufbewahrungspflichtige Belege bleiben erhalten.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID des Belegs. |
Beispielanfrage
curl -X DELETE https://beta.sysbalance.de/api/v1/receipts/clxrb3a1b0000qz01k4p2h9dz \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{ "data": { "id": "clxrb3a1b0000qz01k4p2h9dz", "deleted": true } }/receipts/:id/fileOriginaldokument abrufen
Liefert das gespeicherte PDF, Bild oder die strukturierte XML-E-Rechnung unverändert mit ihrem ursprünglichen MIME-Typ.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID des Belegs. |
Beispielanfrage
curl https://beta.sysbalance.de/api/v1/receipts/clxrb3a1b0000qz01k4p2h9dz/file \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
Unveränderte Binärdaten des Originaldokuments/receipts/:id/fileOriginaldokument hochladen
Speichert einmalig ein PDF, eine XML-E-Rechnung, PNG, JPG oder WEBP bis 10 MB. Ein vorhandenes Original kann weder ersetzt noch entfernt werden; der Beleg muss ERFASST sein.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID des Belegs. |
Anfragekörper
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
file | binary | ja | Datei als multipart/form-data. |
Beispielanfrage
curl -X POST https://beta.sysbalance.de/api/v1/receipts/clxrb3a1b0000qz01k4p2h9dz/file \
-H "Authorization: Bearer sb_live_ihr-schluessel" \
-F "file=@/pfad/zum/beleg.pdf"Antwort · 200 OK
{ "data": { "fileName": "beleg.pdf", "mimeType": "application/pdf", "size": 42420, "sha256": "8d969eef6ecad3c29a3a629280e686cff8ca…", "createdAt": "2026-09-06T10:00:00.000Z", "url": "/api/v1/receipts/clxrb3a1b0000qz01k4p2h9dz/file" } }/receipts/:id/fileOriginaldokument-Löschung (gesperrt)
Der Endpunkt bleibt zur eindeutigen Behandlung älterer Clients bestehen, lehnt die Löschung eines gespeicherten Originals aber immer mit 409 immutable_original ab.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID des Belegs. |
Beispielanfrage
curl -X DELETE https://beta.sysbalance.de/api/v1/receipts/clxrb3a1b0000qz01k4p2h9dz/file \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 409 Conflict
{ "error": { "code": "immutable_original", "message": "Originaldokumente unterliegen der Aufbewahrung und können nicht entfernt werden." } }Mahnwesen
Überfällige Rechnungen ermitteln, Mahnungen erstellen und Mahnverläufe abrufen.
/dunningsMahnungen auflisten
Gibt eine paginierte Mahnungsliste zurück.
Query-Parameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
page | integer | 1 | Seitennummer (ab 1). |
pageSize | integer | 25 | Einträge pro Seite (1–100). |
search | string | – | Suche über Rechnung und Empfänger. |
status | enum | ALL | OPEN, SETTLED oder CANCELLED. |
level | enum | ALL | REMINDER, FIRST, SECOND oder THIRD. |
Beispielanfrage
curl https://beta.sysbalance.de/api/v1/dunnings \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{ "data": [{ "id": "clxda3a1b0000qz01k4p2h9dz", "level": "REMINDER", "status": "OPEN", "invoiceId": "clx8f3a1b0000qz01k4p2h9dz", "totalDueCents": 119000 }], "meta": { "page": 1, "pageSize": 25, "pageCount": 1, "total": 1 } }/dunningsMahnung erstellen
Erstellt die logisch nächste Mahnstufe für eine überfällige Rechnung.
Anfragekörper
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
invoiceId | string | ja | ID der überfälligen Rechnung. |
level | enum | ja | REMINDER, FIRST, SECOND oder THIRD. |
note | string | nein | Optionale Notiz, maximal 1000 Zeichen. |
Beispielanfrage
curl -X POST https://beta.sysbalance.de/api/v1/dunnings \
-H "Authorization: Bearer sb_live_ihr-schluessel" \
-H "Content-Type: application/json" \
-d '{ "invoiceId": "clx8f3a1b0000qz01k4p2h9dz", "level": "REMINDER" }'Antwort · 201 Created
{ "data": { "id": "clxda3a1b0000qz01k4p2h9dz", "level": "REMINDER", "status": "OPEN", "invoiceId": "clx8f3a1b0000qz01k4p2h9dz", "totalDueCents": 119000 } }/dunnings/:idMahnung abrufen
Ruft eine Mahnung mit Gebühren, Zinsen und Verknüpfung ab.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID der Mahnung. |
Beispielanfrage
curl https://beta.sysbalance.de/api/v1/dunnings/clxda3a1b0000qz01k4p2h9dz \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{ "data": { "id": "clxda3a1b0000qz01k4p2h9dz", "level": "REMINDER", "status": "OPEN", "feeCents": 0, "interestCents": 0 } }/dunnings/:id/cancelMahnung aufheben
Hebt eine offene Mahnung auf.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID der Mahnung. |
Beispielanfrage
curl -X POST https://beta.sysbalance.de/api/v1/dunnings/clxda3a1b0000qz01k4p2h9dz/cancel \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{ "data": { "id": "clxda3a1b0000qz01k4p2h9dz", "status": "CANCELLED" } }/dunnings/overdue-invoicesÜberfällige Rechnungen
Listet offene, fällige Rechnungen samt nächster zulässiger Mahnstufe.
Query-Parameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
graceDays | integer | 3 | Karenzzeit für withinGracePeriod (0–90). |
Beispielanfrage
curl https://beta.sysbalance.de/api/v1/dunnings/overdue-invoices \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{ "data": [{ "id": "clx8f3a1b0000qz01k4p2h9dz", "openAmountCents": 119000, "daysOverdue": 5, "withinGracePeriod": false, "nextDunningLevel": "REMINDER" }] }/invoices/:id/dunningsMahnverlauf einer Rechnung
Listet alle Mahnstufen einer Rechnung, höchste Stufe zuerst.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID der Rechnung. |
Beispielanfrage
curl https://beta.sysbalance.de/api/v1/invoices/clx8f3a1b0000qz01k4p2h9dz/dunnings \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{ "data": [{ "id": "clxda3a1b0000qz01k4p2h9dz", "level": "REMINDER", "status": "OPEN" }] }Bankverbindungen
Bankverbindungen verwalten und das Standardkonto für neue Rechnungen festlegen.
/bank-accountsBankverbindungen auflisten
Listet alle Konten; das Standardkonto steht zuerst.
Beispielanfrage
curl https://beta.sysbalance.de/api/v1/bank-accounts \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{ "data": [{ "id": "clxba3a1b0000qz01k4p2h9dz", "label": "Geschäftskonto", "accountHolder": "Muster GmbH", "bankName": "Musterbank", "iban": "DE02120300000000202051", "bic": "BYLADEM1001", "isDefault": true }] }/bank-accountsBankverbindung anlegen
Legt ein Konto an; das erste Konto wird automatisch Standard.
Anfragekörper
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
label | string | nein | Optionale Bezeichnung, maximal 80 Zeichen. |
accountHolder | string | ja | Kontoinhaber. |
bankName | string | ja | Name der Bank. |
iban | string | ja | IBAN; Leerzeichen werden entfernt. |
bic | string | ja | BIC. |
isDefault | boolean | ja | Als Standardkonto verwenden; das erste Konto wird immer Standard. |
Beispielanfrage
curl -X POST https://beta.sysbalance.de/api/v1/bank-accounts \
-H "Authorization: Bearer sb_live_ihr-schluessel" \
-H "Content-Type: application/json" \
-d '{ "label": "Geschäftskonto", "accountHolder": "Muster GmbH", "bankName": "Musterbank", "iban": "DE02120300000000202051", "bic": "BYLADEM1001", "isDefault": true }'Antwort · 201 Created
{ "data": { "id": "clxba3a1b0000qz01k4p2h9dz", "label": "Geschäftskonto", "isDefault": true } }/bank-accounts/:idBankverbindung abrufen
Ruft eine einzelne Bankverbindung ab.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID der Bankverbindung. |
Beispielanfrage
curl https://beta.sysbalance.de/api/v1/bank-accounts/clxba3a1b0000qz01k4p2h9dz \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{ "data": { "id": "clxba3a1b0000qz01k4p2h9dz", "label": "Geschäftskonto", "isDefault": true } }/bank-accounts/:idBankverbindung aktualisieren
Aktualisiert die übergebenen Kontofelder.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID der Bankverbindung. |
Anfragekörper
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
label | string | nein | Optionale Bezeichnung, maximal 80 Zeichen. |
accountHolder | string | nein | Kontoinhaber. |
bankName | string | nein | Name der Bank. |
iban | string | nein | IBAN; Leerzeichen werden entfernt. |
bic | string | nein | BIC. |
isDefault | boolean | nein | Als Standardkonto verwenden; das erste Konto wird immer Standard. |
Beispielanfrage
curl -X PATCH https://beta.sysbalance.de/api/v1/bank-accounts/clxba3a1b0000qz01k4p2h9dz \
-H "Authorization: Bearer sb_live_ihr-schluessel" \
-H "Content-Type: application/json" \
-d '{ "label": "Hauptkonto" }'Antwort · 200 OK
{ "data": { "id": "clxba3a1b0000qz01k4p2h9dz", "label": "Hauptkonto", "isDefault": true } }/bank-accounts/:idBankverbindung löschen
Löscht das Konto. Falls nötig, wird ein anderes Konto zum Standard.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID der Bankverbindung. |
Beispielanfrage
curl -X DELETE https://beta.sysbalance.de/api/v1/bank-accounts/clxba3a1b0000qz01k4p2h9dz \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{ "data": { "id": "clxba3a1b0000qz01k4p2h9dz", "deleted": true } }/bank-accounts/:id/defaultStandardkonto festlegen
Markiert genau diese Bankverbindung als Standardkonto.
Pfadparameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
iderforderlich | string | – | ID der Bankverbindung. |
Beispielanfrage
curl -X POST https://beta.sysbalance.de/api/v1/bank-accounts/clxba3a1b0000qz01k4p2h9dz/default \
-H "Authorization: Bearer sb_live_ihr-schluessel"Antwort · 200 OK
{ "data": { "id": "clxba3a1b0000qz01k4p2h9dz", "isDefault": true } }Beispiel-Workflow
Ein typischer Ablauf von der Anlage bis zum Zahlungseingang - Kontakt anlegen, Rechnung als Entwurf erstellen, festschreiben und die Zahlung erfassen:
# 1) Kontakt anlegen
curl -X POST https://beta.sysbalance.de/api/v1/contacts \
-H "Authorization: Bearer sb_live_ihr-schluessel" \
-H "Content-Type: application/json" \
-d '{ "type": "COMPANY", "companyName": "Muster GmbH", "email": "buchhaltung@muster.de" }'
# 2) Rechnung als Entwurf anlegen (contactId aus Schritt 1)
curl -X POST https://beta.sysbalance.de/api/v1/invoices \
-H "Authorization: Bearer sb_live_ihr-schluessel" \
-H "Content-Type: application/json" \
-d '{
"contactId": "clx7a9c2d0000qz01m3n8k1ab",
"issueDate": "2026-08-25",
"items": [{ "title": "Beratung", "quantity": 8, "unit": "Std", "unitPriceCents": 12500, "vatRate": 19 }]
}'
# 3) Rechnung festschreiben (vergibt die endgültige Nummer)
curl -X POST https://beta.sysbalance.de/api/v1/invoices/clx8f3a1b0000qz01k4p2h9dz/finalize \
-H "Authorization: Bearer sb_live_ihr-schluessel"
# 4) Zahlungseingang erfassen
curl -X POST https://beta.sysbalance.de/api/v1/invoices/clx8f3a1b0000qz01k4p2h9dz/payments \
-H "Authorization: Bearer sb_live_ihr-schluessel" \
-H "Content-Type: application/json" \
-d '{ "amountCents": 119000, "method": "BANK_TRANSFER", "paidAt": "2026-09-01" }'Verwendete Endpunkte:POST /invoicesPOST /invoices/:id/finalize

