Raporty

Wszystkie zasoby raportów wymagają klucza tajnego w zaufanym kodzie na serwerze. Obiekty parametrów raportów są opcjonalne, a każda metoda przyjmuje też opcje żądania jako ostatni argument.

reports.revenue()

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

Parametry: dateFrom, dateTo, dateField (startDate, createdAt lub endDate), groupBy (day, week, month, category lub status) i excludeCancelled.

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

Zwraca walutę, zastosowane filtry, sumy, wiersze zestawienia i opcjonalne notes.

reports.bookingsSummary()

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

Parametry: dateFrom, dateTo i dateField. Zwraca sumy rezerwacji i przychodu, odsetek anulowań i zakończeń, wskaźniki czasowe i podział według statusów. Średni czas od rezerwacji do rozpoczęcia i średni czas trwania mogą mieć wartość null. Identyfikatory statusów mogą mieć wartość null.

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

reports.utilization()

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

Parametry: dateFrom, dateTo, groupBy (overall, itemGroup lub category), sort (highest lub lowest) i limit. Szczegółowe zestawienie breakdown jest opcjonalne.

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

reports.topItems()

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

Parametry: dateFrom, dateTo, rankBy (revenue, bookings, rentedDays lub unitsRented) i limit. Identyfikatory i nazwy kategorii we wpisach mogą mieć wartość null.

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

reports.topClients()

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

Parametry: dateFrom, dateTo, rankBy (spend lub bookings), excludeCancelled i limit. Pola kontaktowe i imię i nazwisko klienta mogą mieć wartość null.

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

reports.outstanding()

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

Parametry: dateFrom, dateTo, minBalance i limit. Zwraca sumy zafakturowane, zapłacone i należne oraz rezerwacje uszeregowane według salda. Pola numeru rezerwacji w organizacji, statusu i klienta mogą mieć wartość null.

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

reports.overdue()

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

Parametry: limit i minDaysOverdue. Zwraca znacznik czasu asOf, sumy według stopnia pilności i wpisy, których severity to info, warning lub critical. Pola rezerwacji, statusu, klienta i kosztu całkowitego mogą mieć wartość null.

Każdy wpis zawiera też stillOutUnits, listę { itemId, sku } egzemplarzy, które po potwierdzonym częściowym zwrocie zostały u klienta i od tego czasu nie wróciły. Lista jest pusta, gdy nie potwierdzono żadnego zwrotu.

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

reports.pipeline()

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

Parametry: horizonDays i groupBy (day, week lub month). Zwraca zastosowany przedział raportu, sumy nadchodzących rezerwacji i przychodu oraz przedziały czasowe.

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