get

[POST] …/DocPaymentAggregation/get

Возвращает информацию о документах агрегированных платежей

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

Название Тип данных Обязательность Описание параметра
ids Array of Int64 Необязательный Массив id документов агрегированных платежей
firm_ids Array of int64 Необязательный Массив Id предпреятий
start_date Int64 Необязательный Дата начала периода в формате unixtime в секундах
end_date Int64 Необязательный Дата окончания периода в формате unixtime в секундах
sort_orders Sort_orders Необязательный Сортировка выходных данных - Объект класса Sort_orders
limit Int32 Необязательный Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000
offset Int32 Необязательный Смещение от начала выборки


Sort_orders

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

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

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

{
   "ids":null,
   "firm_ids":null,
   "start_date":1626462000,
   "end_date":1631732399,
   "sort_orders":[
      {
         "column":3,
         "direction":2
      }
   ],
   "limit":5,

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

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

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

{
   "ok":true,
   "result":[
      {
         "id":24,
         "firm":{
            "id":1,
            "group":{
               "id":1,
               "parent_id":0,
               "name":"Предприятие",
               "child_count":0,
               "last_update":1623234128
            },
            "deleted_mark":false,
            "last_update":1623234128,
            "name":"Предприятие",
            "fullname":null,
            "boss_name":null,
            "address":null,
            "phones":null,
            "description":null,
            "inn":null,
            "bank_name":null,
            "mfo":null,
            "rs":null,
            "oked":null,
            "vat_index":null
         },
         "date":1629745200,
         "code":"PAG-0000024",
         "type":{
            "id":2,
            "name":"Пласт. карта",
            "account":{
               "id":1,
               "code":"00001",
               "name":"Основной счет",
               "currency":{
                  "id":1,
                  "code_num":860,
                  "code_chr":"UZS",
                  "name":"Узбекский сум",
                  "exchange_rate":1.000,
                  "is_base":true,
                  "deleted":false,
                  "last_update":1623234128
               },
               "last_update":1623234128
            },
            "shortkey":0,
            "is_cash":false,
            "kkm_code":-1,
            "last_update":1623234128,
            "image_url": "https://cdn.regos.uz/5fbc650b-6166-4e1b-8864-f93c0617bbf8/i_1678063359_905ee850-3e41-4ec9-b70a-b78b5d7d52f0.png",
            "enabled":"True"
         },
         "amount":-3000.000,
         "performed":true,
         "last_update":1631304000
      }
   ],
   "next_offset":5,
   "total":7
}