GetAvgChequeAmount

[POST] .../v1/retailcustomer/getavgchequeamount

Returns average customer cheque amount. Use this method to calculate the average cheque amount for a customer in POS customer analytics and cashier-facing customer summary views. The request filters by customer_id and operating_cash_id and server settings decide whether the operating cash resolves to the current stock and which favorite-purchase period is used; the response result is the average amount rounded by the persistent calculation. The method checks the current request user and requires retail customer select permission; missing body, missing customer_id, missing or unresolved operating_cash_id, denied permission and storage errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.

Filterable Fields

Field Type Description
customer_id int Customer ID.
operating_cash_id int Operating cash ID.
price_type_id int Price type ID used to calculate purchases.

Request Example

{
  "filters": [
    {
      "Field": "customer_id",
      "Operator": "Equal",
      "Value": "string"
    }
  ]
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Decimal Result object.

Response Example

{
  "ok": true,
  "result": 1.0
}