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

Payment Schema

Schema-ID
payment
Collection
payments
Permissions
  • Lesenpayment_view
  • Anlegenpayment_create
  • Ändernpayment_edit
  • Löschenpayment_delete
Beziehungen

Felder

Payment Schema

payments4 Permissions

Schema for validating Zahlungseingang (payment received) entities

invoiceIduuiderforderlich→ invoice

Invoice UUID this payment is for

amountstringerforderlich

Payment amount as decimal string, e.g. "1500.00"

Pattern
paymentDatedateerforderlich

Date payment was received (YYYY-MM-DD)

paymentMethodstringerforderlich

How the payment was made

Werte
BANK_TRANSFERSEPA_DIRECT_DEBITCREDIT_CARDCASHPAYPALOTHER
referencestringoptional

Bank transaction reference / booking reference

max 500 ZeichenDefault: nullnullable
notestringoptional

Internal note about the payment

max 2000 ZeichenDefault: nullnullable

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

Suche