Get

[POST] .../v1/cashserver/get

Returns information about cash server. Use this method to retrieve cash servers for POS synchronization setup, monitoring screens and firm-scoped administration. The response returns a CashServer array in result and supports filters id, firm_id, name and last_update while keeping ids, firm_ids and search as aliases. The caller must have cash server select permission; missing body, denied access, invalid filters 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.
search String Optional Search string for: name.

Filterable Fields

Field Type Description
firm_id int Company IDs.
id int Cash server IDs.
last_update int
name string

Request Example

{
  "filters": [
    {
      "field": "firm_id",
      "operator": "Equal",
      "value": "2"
    },
    {
      "field": "name",
      "operator": "Like",
      "value": "main"
    }
  ]
}

Response Parameters

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

Response Example

{
  "ok": true,
  "result": [
    {
      "active": true,
      "firm": {
        "address": "string",
        "bank_name": "string",
        "boss_name": "string",
        "deleted_mark": true,
        "description": "string",
        "fullname": "string",
        "group": {
          "child_count": 1,
          "id": 1,
          "last_update": 1,
          "name": "string",
          "parent_id": 1
        },
        "id": 1,
        "inn": "string",
        "last_update": 1,
        "mfo": "string",
        "name": "string",
        "oked": "string",
        "phones": "string",
        "rs": "string",
        "vat_index": "string"
      },
      "id": 1,
      "last_sync": 1,
      "last_update": 1,
      "name": "string",
      "sync_status": "Waiting"
    }
  ]
}