GetChequeCount
[POST] .../v1/retailcustomer/getchequecount
Returns a retail customer cheque count for a period. Retrieve the number of customer cheques for the configured favorite-purchase period in POS analytics and loyalty summary screens. 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 period boundaries are applied; the response result is the cheque count. 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 | Int64 | Result object. |
Response Example
{
"ok": true,
"result": 1
}