API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen

Verträge

Alle Operationen rund um Verträge.

Datenmodell

Die Endpoints dieses Moduls arbeiten auf folgender Entität. Die Schema-Referenz listet jedes Feld mit Typ, Validierung und Beziehungen:

Entität Schema-ID Felder Sequenz Permissions
Contract contract 57 contract_*

Endpoints

Methode Pfad Operation Beschreibung
POST /v1/contracts Create contract Create a new contract in the active tenant.
DELETE /v1/contracts/{id} Delete contract Soft delete entity.
GET /v1/contracts/{id} Get contract by id Fetch a single contract.
GET /v1/contracts/{id}/contingent-summary GET /v1/contracts/{id}/contingent-summary CodeMeta OS API endpoint.
GET /v1/contracts/coverage-summary GET /v1/contracts/coverage-summary CodeMeta OS API endpoint.
GET /v1/contracts/{id}/covered-records GET /v1/contracts/{id}/covered-records CodeMeta OS API endpoint.
GET /v1/contracts/{id}/datasources GET /v1/contracts/{id}/datasources CodeMeta OS API endpoint.
GET /v1/contracts/{id}/linked Get linked entities CodeMeta OS API endpoint.
GET /v1/contracts/{id}/profitability GET /v1/contracts/{id}/profitability CodeMeta OS API endpoint.
GET /v1/contracts/resolve GET /v1/contracts/resolve CodeMeta OS API endpoint.
GET /v1/contracts/{id}/service-targets GET /v1/contracts/{id}/service-targets CodeMeta OS API endpoint.
GET /v1/contracts/{id}/timeline Get timeline CodeMeta OS API endpoint.
GET /v1/contracts/{id}/transitions List transitions CodeMeta OS API endpoint.
GET /v1/contracts/{id}/weclapp/article-price GET /v1/contracts/{id}/weclapp/article-price CodeMeta OS API endpoint.
GET /v1/contracts/weclapp/article-price GET /v1/contracts/weclapp/article-price CodeMeta OS API endpoint.
GET /v1/contracts/weclapp/articles GET /v1/contracts/weclapp/articles CodeMeta OS API endpoint.
GET /v1/contracts/weclapp/articles/{articleId} GET /v1/contracts/weclapp/articles/{articleId} CodeMeta OS API endpoint.
GET /v1/contracts/weclapp/search-invoices GET /v1/contracts/weclapp/search-invoices CodeMeta OS API endpoint.
GET /v1/contracts List contracts List contracts for the active tenant.
PATCH /v1/contracts/{id} Patch contract JSON Merge Patch update.
POST /v1/contracts/{id}/activate POST /v1/contracts/{id}/activate CodeMeta OS API endpoint.
POST /v1/contracts/bulk Bulk operation CodeMeta OS API endpoint.
POST /v1/contracts/{id}/cancel POST /v1/contracts/{id}/cancel CodeMeta OS API endpoint.
POST /v1/contracts/{id}/check-billing-eligibility POST /v1/contracts/{id}/check-billing-eligibility CodeMeta OS API endpoint.
POST /v1/contracts/{id}/contingents/{contingentId}/deduct POST /v1/contracts/{id}/contingents/{contingentId}/deduct CodeMeta OS API endpoint.
POST /v1/contracts/{id}/contingents/{contingentId}/refill POST /v1/contracts/{id}/contingents/{contingentId}/refill CodeMeta OS API endpoint.
POST /v1/contracts/{id}/renew POST /v1/contracts/{id}/renew CodeMeta OS API endpoint.
POST /v1/contracts/{id}/submit-for-approval POST /v1/contracts/{id}/submit-for-approval CodeMeta OS API endpoint.
POST /v1/contracts/{id}/to-draft POST /v1/contracts/{id}/to-draft CodeMeta OS API endpoint.
POST /v1/contracts/{id}/transition POST /v1/contracts/{id}/transition CodeMeta OS API endpoint.
POST /v1/contracts/{id}/transitions/{transitionKey} Execute transition CodeMeta OS API endpoint.
POST /v1/contracts/{id}/weclapp/create-invoice POST /v1/contracts/{id}/weclapp/create-invoice CodeMeta OS API endpoint.
POST /v1/contracts/weclapp/import-invoice POST /v1/contracts/weclapp/import-invoice CodeMeta OS API endpoint.
POST /v1/contracts/{id}/weclapp/refresh-prices POST /v1/contracts/{id}/weclapp/refresh-prices CodeMeta OS API endpoint.
PUT /v1/contracts/{id} Replace contract Full replace with optimistic locking.

Suche