Get

[POST] .../v1/firm/get

Returns company information. Use this method to retrieve companies for documents, stock ownership, cash register setup and firm reference selectors. The response returns paged Firm records with next_offset and total and supports filters, sort_orders, limit and offset for company id, firm group id, deleted_mark and text search across firm requisites. The caller must have firm select permission; missing body, denied access, invalid filters or sorting 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.
limit Int32 Optional Maximum number of records to return. The value is limited by server settings.
offset Int32 Optional Offset from the beginning of the result set.
search String Optional Search string for the name, fullname, address, inn and rs fields.
sort_orders Array of FirmSortOrder Optional Output data sorting.

Filterable Fields

Field Type Description
deleted_mark bool Deletion mark filter: null - all firms, true - only marked for deletion, false - only not marked for deletion.
group_id int Firm group IDs.
id int Company IDs.

Sortable Fields

Field
address
bank_name
bossname
fullname
id
inn
last_update
mfo
name
oked
phones
rs
vat_index

Request Example

{
  "filters": [
    {
      "field": "group_id",
      "operator": "In",
      "value": "1"
    },
    {
      "field": "search",
      "operator": "Like",
      "value": "REGOS"
    },
    {
      "field": "deleted_mark",
      "operator": "Equal",
      "value": "false"
    }
  ],
  "sort_orders": [
    {
      "column": "name",
      "direction": "ASC"
    }
  ],
  "limit": 50,
  "offset": 0
}

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 Firm Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 2,
      "name": "REGOS Retail",
      "fullname": "REGOS Retail LLC",
      "boss_name": "Ali Karimov",
      "address": "Tashkent, Buyuk Ipak Yuli 10",
      "phones": "\u002B998901234567",
      "description": "Retail operating company",
      "inn": "123456789",
      "bank_name": "REGOS Bank",
      "mfo": "00444",
      "rs": "20208000123456789001",
      "oked": "47110",
      "vat_index": "326000123456",
      "group": {
        "id": 1,
        "parent_id": 0,
        "name": "Retail group",
        "child_count": 0,
        "last_update": 1712345600
      },
      "deleted_mark": false,
      "last_update": 1712345600
    }
  ],
  "next_offset": 0,
  "total": 1
}