API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · partners

Partner Schema

Schema-ID
partner
Collection
partners
Permissions
  • Lesenpartner_manage
  • Anlegenadmin_bypass
  • Ändernadmin_bypass
  • Löschenadmin_bypass

Felder

Partner Schema

partners4 Permissions

Tippgeber (Vermittler) mit versionierten Provisionsvereinbarungen. Plattform-global.

tenantIdstringoptional
read-onlynullable
namestringerforderlich
1–200 Zeichen
legalNamestringoptional
max 200 Zeichennullable
refCodestringerforderlich
2–40 ZeichenPatternread-only
refCodeNormalizedstringoptional
2–40 Zeichenread-only
statusstringerforderlich
Werte
prospectactivesuspendedterminated
read-only
partyIdstringoptional
read-onlynullable
weclappobjectoptional
nullable
contactsobject[]optional
max 50 Items
namestringerforderlich
1–200 Zeichen
emailstringoptional
max 320 Zeichennullable
phonestringoptional
max 60 Zeichennullable
rolestringoptional
max 100 Zeichennullable
agreementsobject[]optional
max 50 Itemsread-only
versionintegererforderlich
≥ 1read-only
validFromdateerforderlich
validUntildateoptional
nullable
commissionTiersobject[]erforderlich
1–10 Items
fromMonthintegererforderlich
≥ 1
toMonthintegeroptional
≥ 1nullable
percentnumbererforderlich
0 – 100
baseobjectoptional
invoiceKindsstring[]optional
excludeChargeTypesstring[]optional
durationMonthsintegeroptional
≥ 1nullable
postTerminationMonthsintegeroptional
≥ 0
leadProtectionMonthsintegeroptional
≥ 0
leadProtectionExtensionMonthsintegeroptional
≥ 0
minPayoutCentsintegeroptional
≥ 0
paymentTermDaysintegeroptional
≥ 0
objectionPeriodDaysintegeroptional
≥ 0
selfBillingbooleanoptional
reverseChargebooleanoptional
vatIdstringoptional
max 40 Zeichennullable
currencystringoptional
Werte
EUR
contractDocumentIdstringoptional
nullable
notesstringoptional
max 2000 Zeichennullable
notesstringoptional
max 4000 Zeichennullable

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/partners — Liste, paginiert + filterbar
  • GET /api/v1/partners/<id> — Einzelne Entity
  • POST /api/v1/partners — Anlegen
  • PATCH /api/v1/partners/<id> — Teil-Update
  • DELETE /api/v1/partners/<id> — Soft-Delete
  • GET /api/v1/partners/<id>/timeline — Audit + Aktivitäten

Suche