get

[POST] …/v1/DocOpeningBalance/get

Возвращает информацию о документе начальных взаиморасчётов с контрагентом

Входные параметры

Название Тип данных Обязательность Описание параметра
start_date Int64 Необязательный Дата начала периода в формате unixtime в секундах
end_date Int64 Необязательный Дата окончания периода в формате unixtime в секундах
ids array of int64 Необязательный Массив id документов начальных взаиморасчётов с контрагентом
partner_ids array of int64 Необязательный Массив id контрагентов
firm_ids array of int64 Необязательный Массив id предприятий
sort_orders Sort_orders Необязательный Сортировка выходных данных - Объект класса Sort_orders
search string Необязательный Строка поиска по полям code, firm(name, inn), partner(name, inn)
limit Int32 Необязательный Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000
offset Int32 Необязательный Смещение от начала выборки


Sort_orders

Модель сортировки выходных параметров

Название Тип данных Описание параметра
column enum Значение для сортировки: Id (Id документа), Code (Код документа), Date (Дата), PartnerName (Наименование контрагента), FirmName (Наименование предприятия), Debit (Сумма дебита), Credit (Сумма кредита), CurrencyName (Наименование валюты), Performed (Проведен), DeletedMark (Метка на удаление), LastUpdate (Дата изменения)
direction enum Порядок сортировки: ASC (По возрастанию), DESC (По убыванию)

Пример запроса

{
   "start_date":1540494000,
   "end_date":1608922799,
   "ids":null,
   "partner_ids":null,
   "firm_ids":null,
   "sort_orders":[
      {
         "column":"Date",
         "direction":"ASC"
      }
   ],
   "search":null,
   "limit":50,
   "offset":0
}

Выходные параметры

Название Тип данных Обязательность Описание параметра
Result Array of DocOpeningBalance Обязательный Массив объектов DocOpeningBalance

Пример ответа

{
    "ok": true,
    "result": [
   {
      "id":1,
      "date":1575982758,
      "code":"OBL-0000001",
      "partner":{
         "id":1,
         "group":{
            "id":1,
            "parent_id":0,
            "name":"Поставщики",
            "child_count":0,
            "last_update":1604489489
         },
         "deleted_mark":false,
         "last_update":1602078632,
         "legal_status":"Legal",
         "name":"AliExpress",
         "fullname":"",
         "boss_name":"",
         "address":"ул. Регистан",
         "phones":"",
         "description":"",
         "inn":"012345678",
         "bank_name":"",
         "mfo":"",
         "rs":"",
         "oked":"",
         "vat_index":""
      },
      "firm":{
         "id":1,
         "group":{
            "id":1,
            "parent_id":0,
            "name":"Firm 2",
            "child_count":0,
            "last_update":1595177446
         },
         "deleted_mark":false,
         "last_update":1601991809,
         "name":"OOO \"REGOS SOFTWARE\"",
         "fullname":"",
         "boss_name":"",
         "address":"г. Ташкент, Абдулла Каххора, 2а",
         "phones":"+998(95) 177-89-30",
         "description":"",
         "inn":"123456789",
         "bank_name":"",
         "mfo":"",
         "rs":"",
         "oked":"",
         "vat_index":""
      },
      "debit":100.000,
      "credit":1.000,
      "exchange_rate":1.000,
      "currency":{
         "id":1,
         "code_num":860,
         "code_chr":"UZS",
         "name":"Узбекский сум",
         "exchange_rate":1.000,
         "is_base":true,
         "last_update":1574075456
      },
      "performed":false,
      "deleted_mark":false,
      "last_update":1575982820
   }
],
    "next_offset": 1,
    "total": 5
}