API Methods

POST /OperatingCash/GetSettings

[POST] .../v1/operatingcash/getsettings

Gets cash register settings. Use this method to read settings for a retail cash register before showing POS configuration, printing behavior or device integration options. It requires operating_cash_id and returns an OperatingCash_Setting array; operating_cash_id can be supplied through filters. The caller must have operating cash select permission; missing body, invalid operating_cash_id, denied access, invalid filters and persistent 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
operating_cash_id int Operating cash ID.

Request Example

{
  "filters": [
    {
      "Field": "operating_cash_id",
      "Operator": "Equal",
      "Value": "12"
    }
  ]
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Array of OperatingCash_Setting Result object.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 41,
      "key": "ses_duration",
      "name": "Session duration",
      "name_var": "SES_DURATION",
      "value": "24"
    }
  ]
}

POST /pos/OperatingCash/getSettings

[POST] .../v1/pos/operatingcash/getsettings

Gets cash register settings. Use this method to retrieve POS cash register settings for the current accepted cashier before rendering POS behavior or validating sale operations. The request requires an object body but does not read any request fields; the operating cash register is taken from the current request user's accepted cashier binding and the response returns result with OperatingCash_Setting records. The caller must have operating cash settings access permission 84; missing body, denied access, missing accepted cash register, missing settings and persistent storage errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

No request body.

Request Example

{}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Array of OperatingCash_Setting Result object.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 1,
      "key": "string",
      "name": "string",
      "name_var": "string",
      "value": "string"
    }
  ]
}