Read average Invoice sales values

When to use this endpoint

Return whole-unit average net value, net total and record count for paid Invoices. Use this for the matching saved Reports dashboard chart or table; the result is chart series, not raw object records or a PDF.

res[0] is rounded average net, res[1] is integer net total, and res[2] is count. Entries align with xLabels and, for multiple entities, xLabels1.

Authentication and permissions

Authenticate with signed API-key fields or a logged-in CRM session. The handler requires login and account feature bit 8192 in employer.features.

The dispatcher rejects these legacy Report routes for a user with configured TeamAccess record scope, including assigned-only/parent-manager access or a department hierarchy scope. It returns an explicit legacy-report scope error; it does not return a silently partial chart.

For an allowed unscoped request, the handler reads the authenticated tenant and adds no Reports/Quotes/Invoices page-permission check, account-manager restriction or per-object ownership check. Selecting user IDs is a chart filter, not authorization.

Parameters

Example request

$report = FM_api('Report_getAverageInvoicesPurchaseValue', [
	'daysFrom'=>'1768003200',
	'daysTo'=>'1768003200',
	'durationType'=>'1',
	'frequency'=>'0',
	'userType'=>'0',
	'user'=>['All'],
]);

Example response

{
  "res": [
    [
      0
    ],
    [
      0
    ],
    [
      0
    ]
  ],
  "xLabels": [
    "Jan 2026"
  ],
  "xLabels1": []
}

The example uses Unix seconds for 2026-01-10 00:00:00 UTC. The handler expands the resulting account-local date to its documented day boundaries.

Representative empty-cohort result from the real handler with a January 2026 summary axis.

res[0] is rounded average net, res[1] is integer net total, and res[2] is count. Entries align with xLabels and, for multiple entities, xLabels1.

Errors and unusual responses

Legacy application errors may be returned with HTTP 200. Check the decoded response for error, not only the HTTP status.

Behaviour and edge cases

• List controls must be native lists of strings or integers. Encoded JSON strings, nested/object-keyed arrays and nonnumeric IDs are rejected before SQL. Only the documented All, Opportunity and composite legend tokens are accepted. Empty user/status/leadSource lists are invalid; empty legends are accepted only on the status-series reports, MarketingExpense and SalesPerLeadSource.
• Selects Invoice status 2 with an inclusive range on paid_date. It sums total_net and counts non-null total_net values; null net values do not contribute to the denominator.
• Each SQL group sum is converted with intval before accumulation. The mean is then round(integer total / count), with no precision argument. It returns whole currency units rather than a precise monetary average.
• Summary mode adds the integer-converted owner groups before dividing. Individual mode assigns the matching owner bucket. Blank buckets have average, total and count zero.
• SQL and helper axis use the selected frequency. Invoice values are bucketed by paid_date, matching the selection range.
• An Invoice paid in the selected range is included in its payment period even when it was created before the range. User grouping remains created_by, not the assigned salesperson.
• There is no pagination, row limit or result checkpoint. Keep the date range and entity selection bounded; label helpers expand every selected period/entity combination.
• The underlying aggregate queries do not exclude deleted source objects. Related label/source queries also have no general active/deleted filter. Totals can differ from active-record lists; no deletion behavior is changed by this documentation.
• PHP date conversion uses the account timezone setting (missing/null falls back to Europe/Dublin; blank means UTC). SQL date/Unix functions use the database session timezone; alignment is not enforced by this handler. Date endpoints are expanded to whole local days, not retained at the supplied time of day.
• Amounts are aggregate reporting numbers without currency codes or decimal preservation. Do not treat them as an invoice/quote ledger export.
• Axis order is period then entity name. One selected entity collapses the entity labels into date labels; multiple entities repeat names in xLabels with dates in xLabels1. Temporary users whose meta.is_tmp is non-null are excluded from the user-axis lookup. Zero buckets are prefilled; unmatched entity/date keys are dropped. Weekly labels and SQL grouping use ISO week-year and enumerate actual Mondays, including ISO week 53 and calendar-year boundary weeks.
• No direct mobile-app or m-service caller was found for this route. Browser report definitions are separate from the newer Report_getData template contract.

Side effects

• Reads report data only. No record, audit, status, notification, mail, report-cache or schema writes occur. Date helpers temporarily change PHP timezone on paths noted above.

See it in Fieldmotion

CRM1

Open Reports dashboard, add or preview the Average Invoice Sales Value report, set its filters, and inspect Network for Report_getAverageInvoicesPurchaseValue. pageReportDashboard.js builds Report_get plus the saved api name and expands All selectors using reportDashboard/Constant.js; chart presentation options and labels are client-side.

CRM2

Open the saved Reports dashboard report using api=AverageInvoicesPurchaseValue, change or preview its filters, and inspect Report_getAverageInvoicesPurchaseValue. lib/displayReport.js builds this route dynamically from the saved definition, expands supported All selectors, and renders the returned series. The newer widgetReport.js instead calls Report_getData with a report template; its payload is a different contract.

Related endpoints

• Report_getInvoicesStatusUser — Compare selected Invoice statuses and an optional overall series across report periods and selected owners or customers.