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

Platform Invoice Schema

Schema-ID
platform_invoice
Collection
platform_invoices
Permissions
  • Lesenplatform_invoice_view
  • Anlegenadmin_bypass
  • Ändernadmin_bypass
  • Löschenadmin_bypass

Felder

Platform Invoice Schema

platform_invoices4 Permissions

Codemeta-issued invoice TO a tenant, with weclapp PDF and email dispatch trail.

tenantIdstringoptional
read-only
kindstringerforderlich
Werte
licensewholesale
read-only
billingProviderstringoptional
Werte
stripeweclappnull
nullable
sourcestringoptional
Werte
monthly-enginetrial-end-enginebooking-enginestripe-webhookmanualnull
nullable
sourceRefstringoptional
max 200 Zeichennullable
engineMetaobjectoptional
nullable
invoiceNumberstringoptional
max 64 Zeichenread-onlynullable
stripeInvoiceIdstringoptional
read-onlynullable
weclappIdstringoptional
read-onlynullable
pdfFileIdstringoptional
read-onlynullable
weclappPdfFileIdstringoptional
nullable
stripePdfFileIdstringoptional
nullable
periodFromdateerforderlich
read-only
periodTodateerforderlich
read-only
statusstringerforderlich
Werte
draftopenpaidpast_duepayment_failedvoiduncollectible
read-only
paymentProviderStatusstringoptional
max 64 Zeichennullable
currencystringerforderlich
Werte
EUR
netCentsintegeroptional
≥ 0read-only
vatCentsintegeroptional
≥ 0read-only
grossCentsintegeroptional
≥ 0read-only
itemsobject[]optional
read-only
descriptionstringerforderlich
max 500 Zeichen
quantitynumbererforderlich
≥ 0
unitPriceCentsintegeroptional
netCentsintegererforderlich
read-only
periodobjectoptional
nullable
metadataobjectoptional
dueDatedateoptional
nullable
issuedAtdatetimeoptional
read-onlynullable
paidAtdatetimeoptional
read-onlynullable
weclappPaidAtdatetimeoptional
nullable
dunningobjectoptional
nullable
recipientEmailsemail[]optional
lastSentAtdatetimeoptional
nullable
sendAttemptsobject[]optional
read-only
atdatetimeerforderlich
recipientsemail[]erforderlich
messageIdstringoptional
nullable
statusstringerforderlich
Werte
sentbouncedcomplainedfailed
read-only
errorstringoptional
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/platform_invoices — Liste, paginiert + filterbar
  • GET /api/v1/platform_invoices/<id> — Einzelne Entity
  • POST /api/v1/platform_invoices — Anlegen
  • PATCH /api/v1/platform_invoices/<id> — Teil-Update
  • DELETE /api/v1/platform_invoices/<id> — Soft-Delete
  • GET /api/v1/platform_invoices/<id>/timeline — Audit + Aktivitäten

Suche