Purchasing / Procurement — API and MCP
Overview
This area exposes 28 operations. Each of them is at the same time an MCP tool.
This area is behind the module switch module.procurement. With the module off, these operations answer 404.
Operations
| Method | Path | Purpose | Permission | Parameters |
|---|---|---|---|---|
GET | /api/v1/procurement/framework-agreements | Collection of ProcurementFrameworkAgreement | procurement.supplier.view | page, supplierRoleId, brandId |
POST | /api/v1/procurement/framework-agreements | Create a ProcurementFrameworkAgreement | procurement.supplier.manage | + body |
DELETE | /api/v1/procurement/framework-agreements/{ulid} | Delete a ProcurementFrameworkAgreement | procurement.supplier.manage | ulid |
GET | /api/v1/procurement/framework-agreements/{ulid} | Read one ProcurementFrameworkAgreement | procurement.supplier.view | ulid |
PATCH | /api/v1/procurement/framework-agreements/{ulid} | Update a ProcurementFrameworkAgreement | procurement.supplier.manage | ulid, + body |
POST | /api/v1/procurement/framework-agreements/{ulid}/call-off | Mengenabruf gegen eine Rahmenvereinbarung — Verbucht abgerufene Mengen gegen das vereinbarte Kontingent (Nutzlast: items als Map „Positions-ULID => Menge") und legt daraus EINE Bestellung (Entwurf) zum vereinbarten Preis an. Marke der Bestellung = Marke der Vereinbarung; bei einer markenlosen Vereinbarung ist brandId Pflicht. Verlangt das Recht, Bestellungen in dieser Marke anzulegen. Antwort: Vereinbarung mit Restkontingent und Abruf-Journal (callOffs, je Zeile die Bestellung). Ueber das Kontingent hinaus: 409, keine Bestellung. Storno der Bestellung gibt die Menge zurueck. | procurement.supplier.manage · procurement.po.create | ulid, + body |
GET | /api/v1/procurement/purchase-order-statuses | Collection of ProcurementPurchaseOrderStatus | procurement.supplier.view | — |
POST | /api/v1/procurement/purchase-order-statuses | Create a ProcurementPurchaseOrderStatus | procurement.config.manage | + body |
DELETE | /api/v1/procurement/purchase-order-statuses/{key} | Delete a ProcurementPurchaseOrderStatus | procurement.config.manage | key |
GET | /api/v1/procurement/purchase-order-statuses/{key} | Read one ProcurementPurchaseOrderStatus | procurement.supplier.view | key |
PATCH | /api/v1/procurement/purchase-order-statuses/{key} | Update a ProcurementPurchaseOrderStatus | procurement.config.manage | key, + body |
GET | /api/v1/procurement/purchase-order-summary | Collection of ProcurementPurchaseOrderSummary | procurement.po.edit | status, supplierRoleId, projectId, q |
GET | /api/v1/procurement/purchase-orders | Collection of ProcurementPurchaseOrder | procurement.po.edit | page, status, supplierRoleId, projectId, q, order[poNumber], order[title], order[status], order[totalAmount], order[orderDate], order[deliveryDeadline], order[createdAt], order[budgetConsumed] |
POST | /api/v1/procurement/purchase-orders | Create a ProcurementPurchaseOrder | procurement.po.create | + body |
DELETE | /api/v1/procurement/purchase-orders/{ulid} | Delete a ProcurementPurchaseOrder | procurement.po.edit | ulid |
GET | /api/v1/procurement/purchase-orders/{ulid} | Read one ProcurementPurchaseOrder | procurement.po.edit | ulid |
PATCH | /api/v1/procurement/purchase-orders/{ulid} | Update a ProcurementPurchaseOrder | procurement.po.edit | ulid, + body |
POST | /api/v1/procurement/purchase-orders/{ulid}/approve | Approve purchase order — Approve purchase order. Dedicated action endpoint — not a standard CRUD create. | procurement.po.approve | ulid, + body |
POST | /api/v1/procurement/purchase-orders/{ulid}/cancel | Cancel purchase order — Cancel purchase order. Dedicated action endpoint — not a standard CRUD create. | procurement.po.edit | ulid, + body |
POST | /api/v1/procurement/purchase-orders/{ulid}/deliver | Lieferung zur Bestellung vermerken — Vermerkt die Lieferung zur Bestellung. Ohne ausdrückliches partial: false gilt sie als TEILlieferung — der sichere Vorgabewert. | procurement.po.edit | ulid, + body |
GET | /api/v1/procurement/purchase-orders/{ulid}/pdf | Read one ProcurementPurchaseOrder | procurement.po.edit | ulid |
POST | /api/v1/procurement/purchase-orders/{ulid}/record-actual | Ist-Kosten manuell fortschreiben (Rückfall) — Schreibt die tatsächlichen Kosten der Bestellung auf das Projekt fort — nur solange keine Eingangsrechnung zugeordnet ist (sonst 409). Bei Budget-Sperre (budgetCapMode=hard_cap) wird ein Ist jenseits Budget + Toleranz mit 422 abgewiesen. Verlangt das eigene Kostenzuordnungsrecht. | procurement.cost.assign_project | ulid, + body |
POST | /api/v1/procurement/purchase-orders/{ulid}/send | Bestellung an den Lieferanten versenden — Zieht die Bestellnummer und versendet das PDF an den Lieferanten. Gelöschter Lieferant: 422. Das Mail-Ergebnis steht in mailOutcome (z. B. skipped_no_email). | procurement.po.edit | ulid, + body |
GET | /api/v1/procurement/report | Collection of ProcurementReport | procurement.report.view | from, to, supplierRoleId, projectId, brandId |
GET | /api/v1/procurement/supplier-ratings | Collection of ProcurementSupplierRating | procurement.supplier.view | page, supplierRoleId |
POST | /api/v1/procurement/supplier-ratings | Create a ProcurementSupplierRating | procurement.rating.manage | + body |
DELETE | /api/v1/procurement/supplier-ratings/{ulid} | Delete a ProcurementSupplierRating | procurement.rating.manage | ulid |
GET | /api/v1/procurement/supplier-ratings/{ulid} | Read one ProcurementSupplierRating | procurement.supplier.view | ulid |
Purpose texts that do not follow the standard pattern are taken verbatim from the interface description in the code.