workbench¶

BMS > bms.transaction

What it does¶

/bms/ar-billing/workbench accepts GET and is declared in app/systems/BMS/ar-billing/api_routes.php:403 as a path.

The route handler delegates to bmsArBillingWorkbenchPage(). That function is the owner of this behaviour; the route entry is only dispatch.

Call chain:

→ bmsArBillingWorkbenchPage() — app/systems/BMS/ar-billing/workbench_helper.php:46
↳ bmsArBillingAssertSchema() — app/systems/BMS/ar-billing/foundation_helper.php:16
↳ bmsArBillingRequiredColumns() — app/systems/BMS/ar-billing/foundation_helper.php:2

Who calls it¶

Called from:

app/platform/api_catalog.php
public/assets/js/modules/bms/ar-billing.js

A caller is the strongest available evidence of the intended use.

Input¶

No named input key is visible in the handler or its owner function. The endpoint either takes no parameters or reads them through a shared helper in app/shared/api/.

Output¶

The response is produced by a shared helper, so the key set is not visible at the route. Read the owner function to confirm the shape before writing a client.

SQL executed¶

SELECT BK.ID AS BOOKING_ID,

Data¶

Tables reached from the owner function:

T_BOOKING
T_COMPANY
T_DELIVERY
T_EQUIPMENT
T_EQUIPMENT_LOAD
T_TRANSLOAD

Access¶

module-gated on bms.transaction, so tenant module access applies

Validation and failure messages¶

AR Billing schema migration is required. Missing {$tableName}.{$column}.

These strings come from the owner function and are the messages a client can receive. They are also the cheapest way to tell a rejected request from a broken one.

GET /bms/ar-billing/workbench¶