GetAvgChequeAmount

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

Returns average customer cheque amount. 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 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.

Request Parameters

Name Type Required Description
filters Array of Filter Required Filters by fields available for this API method. Required filter fields: customer_id, operating_cash_id.

Filterable Fields

Field Type Required Description
customer_id int Required Customer ID.
operating_cash_id int Required Operating cash ID.
price_type_id int Optional 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
}