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

Party Product Schema

Schema-ID
party_product
Collection
party_products
Permissions
  • Lesenparty_product_view
  • Anlegenparty_product_create
  • Ändernparty_product_edit
  • Löschenparty_product_delete

Felder

Party Product Schema

party_products4 Permissions

Schema for tracking which products/services a customer (party) is using

partyIduuiderforderlich

Customer party UUID

productIduuiderforderlich

Product UUID

articleIduuidoptional

Specific article (optional, for granular tracking)

nullable
statusstringerforderlich

Current status of this product assignment

Werte
ACTIVETRIALPENDINGCHURNEDPAUSED
monthlyRevenuestringoptional

Monthly recurring revenue for this product (Decimal128 as string)

Patternnullable
billingIntervalstringoptional

Billing interval

Werte
MONTHLYQUARTERLYSEMI_ANNUALYEARLY
nullable
quantitynumberoptional

Number of seats / licenses / units

≥ 1nullable
contractStartdateoptional

Contract start date (YYYY-MM-DD)

nullable
contractEnddateoptional

Contract end date (YYYY-MM-DD)

nullable
contractIduuidoptional

Linked contract UUID

nullable
churnProbabilitynumberoptional

Churn probability in percent (0 = very sticky, 100 = will churn)

0 – 100nullable
churnReasonstringoptional

Reason / risk factors for potential churn

max 2000 Zeichennullable
churnRiskLevelstringoptional

Churn risk classification

Werte
LOWMEDIUMHIGHCRITICAL
nullable
lastReviewedAtdatetimeoptional

Last time churn risk was reviewed

nullable
firstInvoiceAtdateoptional

Date of the first invoice that referenced this article (YYYY-MM-DD)

nullable
lastInvoiceAtdateoptional

Date of the most recent invoice that referenced this article

nullable
lastInvoiceIduuidoptional

Most recent invoice UUID

nullable
lifetimeRevenuestringoptional

Total net revenue from this article across all invoices

Patternnullable
invoiceCountintegeroptional

Number of invoices billing this article

≥ 0nullable
notesstringoptional

Internal notes

max 4000 Zeichennullable
tagsstring[]optional

Tags

Default: []nullable

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

Suche