curl --request POST \
--url https://api.comstruct.com/v1/legal-entities \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
[
{
"title": "Company ABC GmbH",
"number": "1000"
}
]
'[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "Company ABC GmbH",
"number": "1000",
"parent_legal_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"active": true,
"description": "Hauptgesellschaft",
"is_favorite": false
}
]Create or update company codes
Erforderliche Berechtigungen: legal_entities:write
Erstellt oder aktualisiert einen oder mehrere Buchungskreise (juristische Einheiten) für den aktuellen Mandanten.
Verwendet das number-Feld zum Abgleich bestehender Buchungskreise für Aktualisierungen.
titlewird bei bestehenden Buchungskreisen immer überschrieben.activewird nur überschrieben, wenn es im jeweiligen Eintrag enthalten ist. Weglassen behält den gespeicherten Wert; neue Buchungskreise sind standardmäßig aktiv.description,is_favoriteundparent_legal_entity_idwerden bei bestehenden Buchungskreisen nur aktualisiert, wenn jeder Eintrag der Anfrage das jeweilige Feld enthält. Fehlt es in mindestens einem Eintrag, bleiben die gespeicherten Werte aller Einträge unverändert.parent_legal_entity_idmuss ein bestehender Buchungskreis des Mandanten sein. Unbekannte IDs, ein Buchungskreis als sein eigener übergeordneter Buchungskreis und Zuordnungen, die einen Zyklus in der Hierarchie erzeugen würden, werden mit400 Bad Requestabgelehnt.- Jede
numberdarf pro Anfrage nur einmal vorkommen. Doppelte Nummern werden mit400 Bad Requestabgelehnt.
curl --request POST \
--url https://api.comstruct.com/v1/legal-entities \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
[
{
"title": "Company ABC GmbH",
"number": "1000"
}
]
'[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "Company ABC GmbH",
"number": "1000",
"parent_legal_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"active": true,
"description": "Hauptgesellschaft",
"is_favorite": false
}
]Authorizations
API-Schlüssel zur Authentifizierung. Kontaktieren Sie Ihren Customer Success Manager, um einen API-Schlüssel zu erhalten.
Jeder Endpunkt erfordert spezifische Berechtigungen (Scopes); die erforderlichen Scopes werden pro Endpunkt angezeigt.
Body
Der Name des Buchungskreises (juristische Einheit). Wird bei bestehenden Buchungskreisen immer überschrieben.
"Company ABC GmbH"
Die Nummer/der Code des Buchungskreises. Eindeutig pro Mandant und Abgleichsschlüssel für Aktualisierungen.
"1000"
Ob der Buchungskreis aktiv ist. Standardmäßig true für neue Buchungskreise; weglassen behält den gespeicherten Wert eines bestehenden Buchungskreises.
true
Optionale Freitext-Beschreibung. null löscht sie. Wird bei bestehenden Buchungskreisen nur aktualisiert, wenn alle Einträge der Anfrage das Feld enthalten.
"Hauptgesellschaft"
Ob der Buchungskreis ein Favorit ist. Standardmäßig false für neue Buchungskreise. Wird bei bestehenden Buchungskreisen nur aktualisiert, wenn alle Einträge der Anfrage das Feld enthalten.
false
Die ID eines bestehenden übergeordneten Buchungskreises des Mandanten. null entfernt die Zuordnung. Wird bei bestehenden Buchungskreisen nur aktualisiert, wenn alle Einträge der Anfrage das Feld enthalten. Zyklen in der Hierarchie werden mit 400 Bad Request abgelehnt.
"a1b2c3d4-e5f6-4890-abcd-ef1234567890"
Response
Buchungskreise erfolgreich erstellt oder aktualisiert
Die eindeutige Kennung des Buchungskreises
Der Name des Buchungskreises (juristische Einheit)
"Company ABC GmbH"
Die Nummer/der Code des Buchungskreises
"1000"
Die ID des übergeordneten Buchungskreises, falls vorhanden
Die Mandanten-ID
Ob der Buchungskreis aktiv ist
true
Freitext-Beschreibung des Buchungskreises
"Hauptgesellschaft"
Ob der Buchungskreis ein Favorit ist
false