options¶

BMS > bms.transaction

What it does¶

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

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

Call chain:

→ bmsArBillingOptions() — app/systems/BMS/ar-billing/foundation_helper.php:711
↳ 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:

public/assets/js/modules/bms/ar-billing.js
public/assets/js/modules/shared/kj-view-company.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 ID, HEX(UUID) AS UUID_HEX, DISPLAY_NAME, COMPANY_NAME, QBO_CUSTOMER_REF

SELECT HEX(UUID) AS UUID_HEX, DESCRIPTION, SERVICE_CODE, QBO_ITEM_REF

SELECT COMMODITY_NAME, COMMODITY_TYPE

Data¶

Tables reached from the owner function:

T_COMMODITY
T_COMPANY
T_TRANSACTION_TYPE

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/options¶