Zum Hauptinhalt springen
PUT
/
suppliers
/
{id}
/
legal-entities
curl --request PUT \
  --url https://api.comstruct.com/v1/suppliers/{id}/legal-entities \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "legalEntityNumbers": [
    "LE-001",
    "LE-002"
  ]
}
'
{
  "supplierId": "33333333-3333-4333-8333-333333333333",
  "legalEntityNumbers": [
    "LE-001",
    "LE-002"
  ]
}

​
Übersicht

Mit diesem Endpunkt ordnen Kundensysteme einen Lieferanten einem oder mehreren Buchungskreisen zu. Der Request ersetzt immer die vollständige Zuordnungsliste des Lieferanten.
Senden Sie ein leeres Array, um alle Buchungskreis-Zuordnungen zu entfernen. Der Lieferant ist danach wieder mandantenweit sichtbar.

​
Berechtigungen

ScopeTenant-Typ
suppliers:writeKunden-API-Schlüssel
Der API-Schlüssel muss mit einem Kunden verknüpft sein.
HeaderPflichtBeschreibung
x-api-keyJaAPI-Schlüssel mit Scope suppliers:write
Content-TypeJaapplication/json

​
Path-Parameter

ParameterBeschreibung
idUUID des Lieferanten, dessen Buchungskreise ersetzt werden

​
Request-Body

FeldPflichtBeschreibung
legalEntityNumbersJaVollständige Liste der Buchungskreisnummern für diesen Lieferanten

​
Beispiel

curl -X PUT "https://api.comstruct.com/v1/suppliers/33333333-3333-4333-8333-333333333333/legal-entities" \
  -H "x-api-key: IHR_API_SCHLUESSEL" \
  -H "Content-Type: application/json" \
  -d '{
    "legalEntityNumbers": [
      "LE-001",
      "LE-002"
    ]
  }'

​
Alle Zuordnungen entfernen

curl -X PUT "https://api.comstruct.com/v1/suppliers/33333333-3333-4333-8333-333333333333/legal-entities" \
  -H "x-api-key: IHR_API_SCHLUESSEL" \
  -H "Content-Type: application/json" \
  -d '{ "legalEntityNumbers": [] }'

​
Verhalten

  • Die übergebene Liste ersetzt alle vorhandenen Buchungskreis-Zuordnungen des Lieferanten.
  • Doppelte Nummern sind nicht erlaubt.
  • Der Lieferant muss zum Kunden des API-Schlüssels gehören.
  • Alle Buchungskreise müssen zum selben Kunden gehören.

​
Response Codes

CodeBeschreibung
200Zuordnung erfolgreich ersetzt
400Ungültige Anfrage, doppelte Nummern oder Buchungskreis gehört nicht zum Kunden
401Nicht autorisiert — API-Schlüssel ist mit keinem Kunden verknüpft
403Verboten — fehlender Scope suppliers:write
404Lieferant wurde im aktuellen Mandanten nicht gefunden
500Interner Serverfehler

Autorisierungen

​
X-API-Key
string
header
erforderlich

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.

Pfadparameter

​
id
string<uuid>
erforderlich

UUID des Lieferanten

Body

application/json
​
legalEntityNumbers
string[]
erforderlich

Vollständige Liste der Buchungskreisnummern für diesen Lieferanten. Ein leeres Array entfernt alle Zuordnungen.

Beispiel:
["LE-001", "LE-002"]

Antwort

Buchungskreis-Zuordnung erfolgreich ersetzt

​
supplierId
string<uuid>
erforderlich

UUID des Lieferanten

Beispiel:

"33333333-3333-4333-8333-333333333333"

​
legalEntityNumbers
string[]
erforderlich

Buchungskreisnummern, die nach dem Replace gespeichert sind

Beispiel:
["LE-001", "LE-002"]