Quotes: queries, documents and delivery
Read a quote label and gross total
/a/Quote_getOverview
Read the quote ID, customer name and gross total for a target selector.
When to use this endpoint
Use to display a selected quote in a linked-record picker. It is a compact label lookup, not a full quote read.
Authentication and permissions
Authenticate with signed API-key fields or a CRM session. Requires Quotes View (pageQuotes_view); non-admin users blocked by legacy crm_access bit 32 are denied. Client administrators inherit page permissions.
Quote visibility follows the account’s department/account-manager customer filters for non-admin users, including signed keys. Export routes additionally require pageMain_exportTableData. Linked Jobs require Jobs View and their TeamAccess scope; invoice enrichment requires Invoices View and the legacy invoice access check.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | Positive integer-compatible quote ID | Yes | Local primary ID, integer-converted. Not a quote number. Extra fields parameters are ignored by the raw reader. |
Example request
$label = FM_api('Quote_getOverview', ['id'=>'1042']);Example response
{"id":"1042","name":"Example Site","total_gross":"120.00"}Errors and unusual responses
| Response | Condition |
|---|---|
{"error":"not logged in"} | No authenticated tenant context is available. Invalid signed credentials can be rejected by the dispatcher before the handler runs. |
{"error":"invalid or missing parameter: id"} | Missing/nonpositive ID. |
{"error":"requested quote does not exist"} | No matching row or failed lookup. |
{"error":"permission denied"} | Required Quotes/Export permission is absent or legacy access restrictions apply. |
Legacy application errors may be returned with HTTP 200. Check the decoded response for error, not only the HTTP status.
Behaviour and edge cases
- Returns id, joined customer name and total_gross for an active, visible quote. The customer join excludes deleted customers and can return name=null.
- No pagination, recalculation or primary write.
- No direct caller for this endpoint was found in the mobile app or its m-service intermediary.
Side effects
- Reads active permitted records without quote cost, history, email or derived Job-cache writes.
See it in Fieldmotion
CRM1
A record target selector choosing Quote calls Quotes_list for options, then Quote_getOverview to display the selected quote; inspect targetSelector requests.
CRM2
No direct caller found. CRM2 quote-link widgets use Quote_get or mapped details.
Related endpoints
Quote_getreturns the active full record.Quotes_listsupplies picker options.