This page lists the 12 endpoints of the purchase_requests sub-module of the procurement module, under /api/v1/procurement. Scope: Purchase request records, submit for approval, approve, cancel, and request items. The module entry page is Procurement API.
Group facts¶
| Item | Value | Source |
|---|---|---|
| Base path | /api/v1/procurement |
src/cluster_erp/core/module_base.py:37-38, src/cluster_erp/modules/procurement/module.py:70 |
| Routers | 1 router objects in 1 files; listed in the section Endpoints | src/cluster_erp/modules/procurement/module.py:35 |
| Endpoints | 12, counted from the route decorators and add_api_route calls of the routers that register_routes mounts |
src/cluster_erp/modules/procurement/purchase_requests/routes.py |
| Authentication | Bearer header or session cookie, resolved by get_current_user; see Authentication and headers |
src/cluster_erp/modules/auth/guards.py:85-167 |
| Permission guard | 12 of 12 routes declare require_permission |
src/cluster_erp/modules/auth/guards.py:205-240 |
| App entitlement gate | require_app("procurement") on every mounted router |
src/cluster_erp/modules/procurement/module.py:82 |
| Error format | JSON body {"error": {...}}; see Errors |
src/cluster_erp/server/error_handler.py:33-46 |
Endpoints¶
| Method | Path | Handler | Permission | Request | Query | Response | Status | Source |
|---|---|---|---|---|---|---|---|---|
GET |
/api/v1/procurement/purchase-requests/ |
list_purchase_requests |
purchase_request.read |
none | status, priority, search, project_id, limit, offset |
dict |
200 (default) | src/cluster_erp/modules/procurement/purchase_requests/routes.py:49 |
POST |
/api/v1/procurement/purchase-requests/ |
create_purchase_request |
purchase_request.create |
PurchaseRequestCreate |
none | PurchaseRequestRead |
201 |
src/cluster_erp/modules/procurement/purchase_requests/routes.py:87 |
GET |
/api/v1/procurement/purchase-requests/{pr_id} |
get_purchase_request |
purchase_request.read |
none | none | PurchaseRequestRead |
200 (default) | src/cluster_erp/modules/procurement/purchase_requests/routes.py:99 |
PUT |
/api/v1/procurement/purchase-requests/{pr_id} |
update_purchase_request |
purchase_request.update |
PurchaseRequestUpdate |
none | PurchaseRequestRead |
200 (default) | src/cluster_erp/modules/procurement/purchase_requests/routes.py:113 |
DELETE |
/api/v1/procurement/purchase-requests/{pr_id} |
delete_purchase_request |
purchase_request.delete |
none | none | none | 204 |
src/cluster_erp/modules/procurement/purchase_requests/routes.py:126 |
POST |
/api/v1/procurement/purchase-requests/bulk-delete |
bulk_delete_purchase_requests |
purchase_request.bulk_delete |
BulkDeleteRequest |
none | BulkDeleteResponse |
200 (default) | src/cluster_erp/modules/procurement/purchase_requests/routes.py:138 |
POST |
/api/v1/procurement/purchase-requests/{pr_id}/submit-approval |
submit_for_approval |
purchase_request.update |
none | none | PurchaseRequestRead |
200 (default) | src/cluster_erp/modules/procurement/purchase_requests/routes.py:150 |
POST |
/api/v1/procurement/purchase-requests/{pr_id}/approve |
approve_purchase_request |
purchase_request.approve |
none | none | PurchaseRequestRead |
200 (default) | src/cluster_erp/modules/procurement/purchase_requests/routes.py:165 |
POST |
/api/v1/procurement/purchase-requests/{pr_id}/cancel |
cancel_purchase_request |
purchase_request.update |
PrCancelRequest |
none | PurchaseRequestRead |
200 (default) | src/cluster_erp/modules/procurement/purchase_requests/routes.py:180 |
POST |
/api/v1/procurement/purchase-requests/{pr_id}/items |
add_item |
purchase_request.update |
PurchaseRequestItemCreate |
none | PurchaseRequestItemRead |
201 |
src/cluster_erp/modules/procurement/purchase_requests/routes.py:196 |
PUT |
/api/v1/procurement/purchase-requests/{pr_id}/items/{item_id} |
update_item |
purchase_request.update |
PurchaseRequestItemUpdate |
none | PurchaseRequestItemRead |
200 (default) | src/cluster_erp/modules/procurement/purchase_requests/routes.py:213 |
DELETE |
/api/v1/procurement/purchase-requests/{pr_id}/items/{item_id} |
remove_item |
purchase_request.update |
none | none | none | 204 |
src/cluster_erp/modules/procurement/purchase_requests/routes.py:230 |
Error codes¶
The table lists the error codes that code under src/cluster_erp/modules/procurement/purchase_requests/ raises, found by a syntax-tree scan for AppError(...), the factories in src/cluster_erp/core/errors.py (not_found, conflict, protected, permission_denied, privilege_escalation, check_version), and HTTPException(...). A status of 400 is the AppError default (src/cluster_erp/core/errors.py:23). Guard errors (401, 403), the entitlement codes, and validation errors (422) apply to every route and are listed on Errors.
| Code | HTTP status | Raised in | First site |
|---|---|---|---|
CONCURRENCY_VERSION_CONFLICT |
409 |
services |
src/cluster_erp/modules/procurement/purchase_requests/services.py:303 |
PR_INVALID_STATUS |
400 |
services |
src/cluster_erp/modules/procurement/purchase_requests/services.py:115 |
PR_NO_ITEMS |
400 |
services |
src/cluster_erp/modules/procurement/purchase_requests/services.py:469 |
RESOURCE_NOT_FOUND |
404 |
routes, services |
src/cluster_erp/modules/procurement/purchase_requests/routes.py:109 |
Related pages¶
Verified against commit 92f8051 on 2026-11-13.