Octibiz
Demo

Durchsucht Website und Dokumentation gemeinsam. Enter zeigt alle Treffer, Esc schließt.

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

MethodPathPurposePermissionParameters
GET/api/v1/procurement/framework-agreementsCollection of ProcurementFrameworkAgreementprocurement.supplier.viewpage, supplierRoleId, brandId
POST/api/v1/procurement/framework-agreementsCreate a ProcurementFrameworkAgreementprocurement.supplier.manage+ body
DELETE/api/v1/procurement/framework-agreements/{ulid}Delete a ProcurementFrameworkAgreementprocurement.supplier.manageulid
GET/api/v1/procurement/framework-agreements/{ulid}Read one ProcurementFrameworkAgreementprocurement.supplier.viewulid
PATCH/api/v1/procurement/framework-agreements/{ulid}Update a ProcurementFrameworkAgreementprocurement.supplier.manageulid, + body
POST/api/v1/procurement/framework-agreements/{ulid}/call-offMengenabruf 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.createulid, + body
GET/api/v1/procurement/purchase-order-statusesCollection of ProcurementPurchaseOrderStatusprocurement.supplier.view—
POST/api/v1/procurement/purchase-order-statusesCreate a ProcurementPurchaseOrderStatusprocurement.config.manage+ body
DELETE/api/v1/procurement/purchase-order-statuses/{key}Delete a ProcurementPurchaseOrderStatusprocurement.config.managekey
GET/api/v1/procurement/purchase-order-statuses/{key}Read one ProcurementPurchaseOrderStatusprocurement.supplier.viewkey
PATCH/api/v1/procurement/purchase-order-statuses/{key}Update a ProcurementPurchaseOrderStatusprocurement.config.managekey, + body
GET/api/v1/procurement/purchase-order-summaryCollection of ProcurementPurchaseOrderSummaryprocurement.po.editstatus, supplierRoleId, projectId, q
GET/api/v1/procurement/purchase-ordersCollection of ProcurementPurchaseOrderprocurement.po.editpage, 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-ordersCreate a ProcurementPurchaseOrderprocurement.po.create+ body
DELETE/api/v1/procurement/purchase-orders/{ulid}Delete a ProcurementPurchaseOrderprocurement.po.editulid
GET/api/v1/procurement/purchase-orders/{ulid}Read one ProcurementPurchaseOrderprocurement.po.editulid
PATCH/api/v1/procurement/purchase-orders/{ulid}Update a ProcurementPurchaseOrderprocurement.po.editulid, + body
POST/api/v1/procurement/purchase-orders/{ulid}/approveApprove purchase order — Approve purchase order. Dedicated action endpoint — not a standard CRUD create.procurement.po.approveulid, + body
POST/api/v1/procurement/purchase-orders/{ulid}/cancelCancel purchase order — Cancel purchase order. Dedicated action endpoint — not a standard CRUD create.procurement.po.editulid, + body
POST/api/v1/procurement/purchase-orders/{ulid}/deliverLieferung zur Bestellung vermerken — Vermerkt die Lieferung zur Bestellung. Ohne ausdrückliches partial: false gilt sie als TEILlieferung — der sichere Vorgabewert.procurement.po.editulid, + body
GET/api/v1/procurement/purchase-orders/{ulid}/pdfRead one ProcurementPurchaseOrderprocurement.po.editulid
POST/api/v1/procurement/purchase-orders/{ulid}/record-actualIst-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_projectulid, + body
POST/api/v1/procurement/purchase-orders/{ulid}/sendBestellung 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.editulid, + body
GET/api/v1/procurement/reportCollection of ProcurementReportprocurement.report.viewfrom, to, supplierRoleId, projectId, brandId
GET/api/v1/procurement/supplier-ratingsCollection of ProcurementSupplierRatingprocurement.supplier.viewpage, supplierRoleId
POST/api/v1/procurement/supplier-ratingsCreate a ProcurementSupplierRatingprocurement.rating.manage+ body
DELETE/api/v1/procurement/supplier-ratings/{ulid}Delete a ProcurementSupplierRatingprocurement.rating.manageulid
GET/api/v1/procurement/supplier-ratings/{ulid}Read one ProcurementSupplierRatingprocurement.supplier.viewulid

Purpose texts that do not follow the standard pattern are taken verbatim from the interface description in the code.

referenz.api-procurement · Available from version 0.5.4