get

[POST] …/RetailPaymentReport/get

Возвращает отчет о розничных платежах

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

Название Тип данных Обязательность Описание параметра
operating_cash_ids Array of Int64 Необязательный Массив id касс по которым выбираются данные
period_interval enum Необязательный Тип периода: 1 (Month - месяц), 2 (Week - неделя), 3 (Day - день)
start_date Int64 Необязательный Дата начала периода в формате unixtime в секундах
end_date Int64 Необязательный Дата окончания периода в формате unixtime в секундах

Ограничения, требования и проверки

  1. Если выбран период месяц, то данные возвращаются следующим образом:
    • Первый период: с указанной даты начала до конца месяца.
    • Последний период: с начала месяца до указанной даты окончания.
    • Остальные периоды включают в себя полный месяц

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

{
   "start_date":"2021-05-01",
   "end_date":"2021-08-01",
   "period_interval":1,
   "operating_cash_ids ":[1, 2]
}

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

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

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

{
   "ok":true,
   "result":[
      {
         "payment_type":{
            "id":1,
            "name":"Наличные",
            "account":{
               "id":2,
               "code":"00002",
               "name":"Наличная касса",
               "currency":{
                  "id":1,
                  "code_num":860,
                  "code_chr":"UZS",
                  "name":"Узбекский сум",
                  "exchange_rate":1.000,
                  "is_base":true,
                  "deleted":false,
                  "last_update":1629283329
               },
               "last_update":1629283330
            },
            "shortkey":0,
            "is_cash":true,
            "kkm_code":-1,
            "last_update":1629283330,
            "enabled":"True"
         },
         "data":[
            {
               "value":0.00,
               "date":"01.05.2021 - 31.05.2021"
            },
            {
               "value":0.00,
               "date":"01.06.2021 - 30.06.2021"
            },
            {
               "value":0.00,
               "date":"01.07.2021 - 31.07.2021"
            },
            {
               "value":0.00,
               "date":"01.08.2021 - 01.08.2021"
            }
         ],
         "payment_amount":0.00
      },
      {
         "payment_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":1629283329
               },
               "last_update":1629283330
            },
            "shortkey":0,
            "is_cash":false,
            "kkm_code":-1,
            "last_update":1629283330,
            "enabled":"True"
         },
         "data":[
            {
               "value":0.00,
               "date":"01.05.2021 - 31.05.2021"
            },
            {
               "value":0.00,
               "date":"01.06.2021 - 30.06.2021"
            },
            {
               "value":0.00,
               "date":"01.07.2021 - 31.07.2021"
            },
            {
               "value":0.00,
               "date":"01.08.2021 - 01.08.2021"
            }
         ],
         "payment_amount":0.00
      },
      {
         "payment_type":{
            "id":3,
            "name":"Бонусы",
            "account":{
               "id":3,
               "code":"00003",
               "name":"Баллы и бонусы",
               "currency":{
                  "id":1,
                  "code_num":860,
                  "code_chr":"UZS",
                  "name":"Узбекский сум",
                  "exchange_rate":1.000,
                  "is_base":true,
                  "deleted":false,
                  "last_update":1629283329
               },
               "last_update":1629283330
            },
            "shortkey":0,
            "is_cash":false,
            "kkm_code":-1,
            "last_update":1629283330,
            "enabled":"Frontoffice"
         },
         "data":[
            {
               "value":0.00,
               "date":"01.05.2021 - 31.05.2021"
            },
            {
               "value":0.00,
               "date":"01.06.2021 - 30.06.2021"
            },
            {
               "value":0.00,
               "date":"01.07.2021 - 31.07.2021"
            },
            {
               "value":0.00,
               "date":"01.08.2021 - 01.08.2021"
            }
         ],
         "payment_amount":0.00
      }
   ]
}