GetChequeTemplate

[POST] .../v1/operatingcash/getchequetemplate

Returns cheque templates. Use this method to retrieve cheque print templates for retail cash registers before editing receipt layout or POS printing settings. The response returns OperatingCashChequeTemplate records with next_offset and total and supports id, operating_cash_id and cheque_type_id filters while ids, operating_cash_ids and cheque_type_ids fields. The caller must have operating cash select permission; missing body, denied access, invalid filters, missing templates 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
cheque_type_id int Cheque type IDs.
id int Cheque template IDs.
operating_cash_id int Operating cash IDs.

Request Example

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

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of OperatingCashChequeTemplate Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 21,
      "type_id": 1,
      "operating_cash_id": 12,
      "template": "{\u0022width\u0022:80,\u0022DPI\u0022:203,\u0022margin_left\u0022:0,\u0022margin_right\u0022:0,\u0022img_id\u0022:0}",
      "logo": null,
      "logo_width": null,
      "logo_height": null,
      "last_update": 1712345600
    }
  ],
  "next_offset": 0,
  "total": 1
}