Заявяване на генериране на справка

POST /api/v1/integrations/{integrationId}/reports/{report}

Заявете справка от вашия Hype Reports клиент, след което проверявайте върнатия pollUrl за статуса и резултата ѝ. HES управлява генерирането асинхронно.

Поддържани справки: operator-revenue с user_ids и максимум 31 дни; revenue-by-menu с menu_ids и максимум 31 дни; revenue-by-fiscal-device с fiscal_device_ids и максимум 31 дни; revenue-by-main-category с main_category_ids и максимум 31 дни; revenue-by-category с category_ids и максимум 31 дни; orders-summary с user_ids, saloon_ids, table_ids и максимум 1 ден. Периодите се сравняват в цели дни, като остатъкът се пренебрегва. Име на справка, което липсва в каталога на HES, връща 404. Филтрите трябва да съдържат Hype Reports идентификатори, съпоставени чрез задачи. HES пропуска несъпоставените; ако не останат стойности, не се прилага филтър за този тип обект.

Заявка

POST https://es.dev.hype-software.com/api/v1/integrations/{integrationId}/reports/{report}
Authorization: Bearer YOUR_API_TOKEN
Accept: application/json
Content-Type: application/json

Тяло на заявката

{
  "date_from": "2026-07-08T00:00:00.000Z",
  "date_to": "2026-07-08T23:59:59.000Z",
  "user_ids": ["hr-user-7"],
  "saloon_ids": ["hr-saloon-10"],
  "table_ids": ["hr-table-20"]
}

Параметри в пътя

Параметър	Пример
integrationId	Вашият integrationId
report	Вашият report

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

202 · Заявяване на генериране на справка

{
  "jobId": "a0ffc461-33b6-4dcc-b916-1932f339b1f4",
  "pollUrl": "https://es.dev.hype-software.com/api/v1/report-data/a0ffc461-33b6-4dcc-b916-1932f339b1f4",
  "message": "Report request accepted and queued for processing"
}