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

Contingent Usage Schema

Schema-ID
contingent_usage
Collection
contingent_usages
Permissions
  • Lesencontingent_usage_view
  • Anlegencontingent_usage_create
  • Änderncontingent_usage_edit
  • Löschencontingent_usage_delete
Beziehungen

Felder

Contingent Usage Schema

contingent_usages4 Permissions

Schema for validating contingent usage entities

contractIduuiderforderlich→ contract

Associated contract UUID. Stays set even when the contract is soft-deleted — the reference remains intact for audit/reporting; the contract is just hidden from `deletedAt: null` listings (relationship policy `onDelete: ignore`, ADR 0064 follow-up).

contingentIduuiderforderlich

Associated contingent UUID

sourceTypestringerforderlich

Source of the entry. TIME_RECORD/TRIP/EXPENSE = automatischer Verbrauch, MANUAL = manueller Verbrauch, REFILL = manuelle oder automatische Aufladung (positive Saldo-Bewegung).

Werte
TIME_RECORDTRIPEXPENSEMANUALREFILL
sourceIduuidoptional

Source entity UUID

nullable
amountstringerforderlich

Usage amount as decimal string

Pattern
unitstringerforderlich

Usage unit

Werte
HOURSMINUTESEURTRIPS
convertedAmountstringoptional

Converted amount in contingent unit

Patternnullable
datedateerforderlich

Usage date (YYYY-MM-DD)

userIduuidoptional

User who performed the work

nullable
ticketIduuidoptional

Associated ticket UUID

nullable
descriptionstringoptional

Usage description

nullable
rateAppliedstringoptional

Rate applied for conversion

Patternnullable
isOveragebooleanerforderlich

Whether this usage exceeds the contingent limit

overageSurchargestringoptional

Overage surcharge amount

Patternnullable

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

Suche