---
title: "Звіти"
description: "Отримуйте звіти про дохід, бронювання, завантаженість, клієнтів, баланси, прострочення та майбутні бронювання."
canonical_url: "https://requiply.com/docs/uk/developers/typescript-sdk/reports"
---
# Звіти

> Отримуйте звіти про дохід, бронювання, завантаженість, клієнтів, баланси, прострочення та майбутні бронювання.

Усі ресурси звітів потребують секретного ключа в довіреному серверному коді. Обʼєкти параметрів звітів необовʼязкові, а кожен метод також приймає параметри запиту останнім аргументом.

## `reports.revenue()`

```ts
reports.revenue(
  params?: RevenueReportParams,
  options?: RequiplyRequestOptions,
): Promise<RevenueReportResponse>
```

Параметри: `dateFrom`, `dateTo`, `dateField` (`startDate`, `createdAt` або `endDate`), `groupBy` (`day`, `week`, `month`, `category` або `status`), `excludeCancelled`.

```ts
const report = await requiply.reports.revenue({
  dateFrom: '2026-07-01',
  dateTo: '2026-07-31',
  groupBy: 'week',
  excludeCancelled: true,
});
```

Повертає валюту, застосовані фільтри, підсумки, рядки розбивки та необовʼязкові `notes`.

## `reports.bookingsSummary()`

```ts
reports.bookingsSummary(
  params?: BookingsSummaryParams,
  options?: RequiplyRequestOptions,
): Promise<BookingsSummaryResponse>
```

Параметри: `dateFrom`, `dateTo`, `dateField`. Повертає підсумки бронювань і доходу, частку скасувань і завершень, показники часу та розбивку за статусами. Середній час до початку оренди й середня тривалість можуть бути `null`; ідентифікатори статусів можуть бути `null`.

```ts
const summary = await requiply.reports.bookingsSummary({
  dateFrom: '2026-07-01',
  dateTo: '2026-07-31',
});
```

## `reports.utilization()`

```ts
reports.utilization(
  params?: UtilizationReportParams,
  options?: RequiplyRequestOptions,
): Promise<UtilizationReportResponse>
```

Параметри: `dateFrom`, `dateTo`, `groupBy` (`overall`, `itemGroup` або `category`), `sort` (`highest` або `lowest`), `limit`. Докладна `breakdown` необовʼязкова.

```ts
const utilization = await requiply.reports.utilization({
  groupBy: 'itemGroup',
  sort: 'highest',
  limit: 10,
});
```

## `reports.topItems()`

```ts
reports.topItems(
  params?: TopItemsReportParams,
  options?: RequiplyRequestOptions,
): Promise<TopItemsReportResponse>
```

Параметри: `dateFrom`, `dateTo`, `rankBy` (`revenue`, `bookings`, `rentedDays` або `unitsRented`), `limit`. Ідентифікатори та назви категорій у записах можуть бути `null`.

```ts
const topItems = await requiply.reports.topItems({ rankBy: 'revenue', limit: 10 });
```

## `reports.topClients()`

```ts
reports.topClients(
  params?: TopClientsReportParams,
  options?: RequiplyRequestOptions,
): Promise<TopClientsReportResponse>
```

Параметри: `dateFrom`, `dateTo`, `rankBy` (`spend` або `bookings`), `excludeCancelled`, `limit`. Контактні дані та імена клієнтів можуть бути `null`.

```ts
const topClients = await requiply.reports.topClients({ rankBy: 'spend', limit: 10 });
```

## `reports.outstanding()`

```ts
reports.outstanding(
  params?: OutstandingReportParams,
  options?: RequiplyRequestOptions,
): Promise<OutstandingReportResponse>
```

Параметри: `dateFrom`, `dateTo`, `minBalance`, `limit`. Повертає підсумки виставленого, сплаченого й заборгованого, а також бронювання, упорядковані за балансом. Поля номера бронювання в організації, статусу та клієнта можуть бути `null`.

```ts
const outstanding = await requiply.reports.outstanding({ minBalance: 1, limit: 25 });
```

## `reports.overdue()`

```ts
reports.overdue(
  params?: OverdueReportParams,
  options?: RequiplyRequestOptions,
): Promise<OverdueReportResponse>
```

Параметри: `limit` і `minDaysOverdue`. Повертає мітку часу `asOf`, підсумки за рівнем серйозності та записи, у яких `severity` дорівнює `info`, `warning` або `critical`. Поля бронювання, статусу, клієнта та загальної вартості можуть бути `null`.

Кожен запис також містить `stillOutUnits`: список `{ itemId, sku }` одиниць, які після підтвердженого [часткового повернення](https://requiply.com/docs/uk/guides/bookings/checklists/returns#%D1%87%D0%B0%D1%81%D1%82%D0%BA%D0%BE%D0%B2%D1%96-%D0%BF%D0%BE%D0%B2%D0%B5%D1%80%D0%BD%D0%B5%D0%BD%D0%BD%D1%8F-%D0%BE%D0%B4%D0%B8%D0%BD%D0%B8%D1%86%D1%96-%D1%8F%D0%BA%D1%96-%D0%BD%D0%B5-%D0%BF%D0%BE%D0%B2%D0%B5%D1%80%D0%BD%D1%83%D0%BB%D0%B8%D1%81%D1%8F) залишилися в клієнта й досі не повернулися. Список порожній, коли жодного повернення не підтверджено.

```ts
const overdue = await requiply.reports.overdue({ minDaysOverdue: 2, limit: 25 });
```

## `reports.pipeline()`

```ts
reports.pipeline(
  params?: PipelineReportParams,
  options?: RequiplyRequestOptions,
): Promise<PipelineReportResponse>
```

Параметри: `horizonDays` і `groupBy` (`day`, `week` або `month`). Повертає застосоване вікно звіту, підсумки майбутніх бронювань і доходу, а також часові проміжки.

```ts
const pipeline = await requiply.reports.pipeline({
  horizonDays: 90,
  groupBy: 'month',
});
```


## Sitemap

See the full [sitemap](https://requiply.com/docs/sitemap.md) for all pages.