Get

[POST] .../v1/partner/get

Returns partner information. Use this method to load partners for supplier/customer catalogs, document forms, settlement reports and integrations that need partner master data. The response returns paged Partner records with group, legal status, contact and bank details, deletion mark, custom fields, next_offset and total. The request body is required and supports body filters, unified filters for standard and custom partner fields, sort_orders, search, limit and offset. The current request user must have partner select permission and cached catalog results are scoped by the current account context. Missing body, denied access, invalid filters or sort fields, cache deserialization problems 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.
offset Int32 Optional Offset from the beginning of the result set.
search String Optional Search string for the name, fullname, address, inn, rs, phones and email fields.
sort_orders Array of PartnerSortOrder Optional Output parameter sorting.

Filterable Fields

Field Type Description
deleted_mark bool Deletion mark filter: true - marked for deletion, false - not marked for deletion.
email string
group_id int Partner group IDs.
id int Partner IDs.
inn string
legal_status string Legal status: Legal - legal entity, Natural - individual.
mfo string
name string
oked string
phones string
rs string
vat_index string

Sortable Fields

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

Request Example

{
  "filters": [
    {
      "Field": "name",
      "Operator": "Like",
      "Value": "Coca"
    },
    {
      "Field": "inn",
      "Operator": "Equal",
      "Value": "123456789"
    }
  ],
  "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 Partner Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 15,
      "group": {
        "id": 2,
        "parent_id": 0,
        "name": "Suppliers",
        "child_count": 0,
        "last_update": 1714550400
      },
      "legal_status": "Legal",
      "name": "Coca-Cola Bottlers",
      "fullname": "Coca-Cola Bottlers Uzbekistan LLC",
      "boss_name": "John Smith",
      "address": "Tashkent",
      "phones": "\u002B998901234567",
      "email": "billing@example.test",
      "description": "Beverage supplier",
      "inn": "123456789",
      "bank_name": "National Bank",
      "mfo": "00444",
      "rs": "20208000900000000001",
      "oked": "46390",
      "vat_index": "326010001234",
      "deleted_mark": false,
      "fields": [],
      "last_update": 1714550400
    }
  ],
  "next_offset": 0,
  "total": 1
}