Al Maida ERP API — API reference

Create or fully replace the matrix + levels for a document type.

Requests pending THIS user's action (holds the current level's approver role, didn't raise it).

Approve at the current level. The engine rejects (422) an ineligible actor or the raiser.

Reject at the current level. The engine rejects (422) an ineligible actor or the raiser.

Every pending approval in the company: what it waits on, since when, and whether it is stranded.

Break-glass: approve a pending request past its remaining levels with a logged reason (§13.2). The engine re-checks the permission and raiser ≠ overrider, and it works even on a stranded document (it does not read the — possibly deleted — current level). 422 on an empty reason or the raiser.

Audit entries for the active company, newest first — paged and filterable.

Award one bid — refused if it is not the lowest and no justification is given.

Close — requires the receipt image and the inspection flag.

Disburse — refused if the custodian is the requester (§7.3).

List nodes, optionally filtered by parent and/or level.

Create a catalog node (optionally under a parent).

Rename / re-UoM / (de)activate a node.

The rate effective at asOf (default today). 404 unknown node, 422 no rate — no parent fallback.

A node's rates, optionally those covering a given date; newest-effective first.

Add a time-bounded rate to a node.

Book a material consumption — over the allocation requires an explicit variance + reason.

Sign the contract — gate G1: mints the project number. Concurrency-guarded by rowVersion.

The client 360 — the customer plus their lead pipeline, quotation position and AR (one call).

The customer's statement: per-project contract value, cash received, and outstanding, with totals.

The caller's own role-scoped dashboard — each KPI present only if they hold its view permission.

Release — gated on review approval; supersedes the prior released revision.

The seam production consumes: may work proceed against this drawing revision?

Create the next revision (a new row); the prior revision is left immutable.

Submit a draft revision for review — routes through the approval engine.

Create a draft estimate.

The estimate with its priced lines and rolled-up totals. The cost basis (unit/line cost, overhead, margin, total cost) is MASKED to null for a caller without `estimates.cost.view` — a price-only reader (e.g. Sales) sees quantities and selling, never the cost behind them.

Approver signs a verified estimate — it becomes immutable (cannot be the maker or verifier). Verified → Approved.

Add a catalog line (CatalogNodeId) or a custom line (CustomDescription + CustomUnitCost).

Attach/replace the cost justification on a custom line (draft only). 422 on a catalog line or empty evidence.

Run the pricing engine on a line and return the breakdown (422 if the line's node has no rate).

Promote a proven custom line (on an approved estimate) into the catalog as a new node + a 'promoted' rate at the line's unit cost. Needs `catalog.manage` — it writes to the shared catalog. Returns the new node id. 422 on a catalog line, an already-promoted line, or a non-approved estimate.

Bulk-add lines from a BOQ in one atomic call — all land or none do. Returns the new line numbers.

Send a submitted or verified estimate back to the maker for rework. → Draft.

Maker submits a draft for verification (needs at least one line). Draft → Submitted.

Verifier signs a submitted estimate (cannot be the maker). Submitted → Verified.

Approval-matrix configuration health per document type: unconfigured / partial / complete, with the blank levels named (F1-14b). A partial matrix routes documents past its blank levels' approvers, so this is how that silent gap becomes visible.