Documents API (documents)

The documents module serves document types, documents linked to entities, document versions with file download, and the version approval lifecycle. All 23 endpoints sit under /api/v1/documents. For business meaning see the Documents module page.

Group facts¶

Endpoint summary¶

One row per sub-module folder. The router prefix is added to the base path.

Document types endpoints¶

Document type records and a seed of defaults.

Documents and versions endpoints¶

Document records, the list of entity types, versions per document, version file download, submit for approval, activate, and withdraw.

Error codes¶

The table lists the error codes that code under src/cluster_erp/modules/documents/ 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.

Events emitted¶

The table lists the contract classes that code under src/cluster_erp/modules/documents/ passes directly to EventBus.emit, found by a syntax-tree scan. Events built in a variable first are not counted. The contracts are described in Contracts reference.

Related pages¶

• API reference
• Documents module
• API conventions
• Errors
• Authentication and headers

Verified against commit 92f8051 on 2026-11-13.