@harbortouch/skytab-analytics-report-utils 0.7.2 → 0.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1,21 +1,1338 @@
1
- export type { FieldType, ColumnAlignment, FooterCalculationType, FooterCalculation, ColumnPresentationConfig, ColumnGroupConfig, ReportConfig, } from './types';
2
- export { type ReportType, Report, getReportConfig } from './report';
3
- export { type ReportColumnKey, type ColumnMetadata, COLUMN_REGISTRY, getColumnMetadata, getColumnExportHeaderLabel, } from './columns';
4
- export { getColumnAlignment, isNumericType } from './utils/alignment';
5
- export { calculateReportTotals } from './totals';
6
- export type { CalculateReportTotalsOptions } from './totals';
7
- export { salesSummaryConfig, SALES_SUMMARY_AVAILABLE_COLUMNS, SALES_SUMMARY_DEFAULT_VISIBLE_COLUMNS, } from './reports/salesSummary';
8
- export { ticketSummaryConfig, TICKET_SUMMARY_AVAILABLE_COLUMNS, TICKET_SUMMARY_DEFAULT_VISIBLE_COLUMNS, } from './reports/ticketSummary';
9
- export { ticketLiveConfig, TICKET_LIVE_AVAILABLE_COLUMNS, TICKET_LIVE_DEFAULT_VISIBLE_COLUMNS, } from './reports/ticketLive';
10
- export { productMixConfig, PRODUCT_MIX_AVAILABLE_COLUMNS, PRODUCT_MIX_DEFAULT_VISIBLE_COLUMNS, PRODUCT_MIX_CHART_FIELDS, } from './reports/productMix';
11
- export { modifierMixConfig, MODIFIER_MIX_AVAILABLE_COLUMNS, MODIFIER_MIX_DEFAULT_VISIBLE_COLUMNS, } from './reports/modifierMix';
12
- export { itemTaxConfig, ITEM_TAX_AVAILABLE_COLUMNS, ITEM_TAX_DEFAULT_VISIBLE_COLUMNS } from './reports/itemTax';
13
- export { dailySalesConfig, dailySalesTrendsConfig, DAILY_SALES_AVAILABLE_COLUMNS, DAILY_SALES_DEFAULT_VISIBLE_COLUMNS, DAILY_SALES_BY_GROUP_AVAILABLE_COLUMNS, DAILY_SALES_TRENDS_AVAILABLE_COLUMNS, } from './reports/dailySales';
14
- export { dailySalesPaymentsConfig, DAILY_SALES_PAYMENTS_AVAILABLE_COLUMNS, DAILY_SALES_PAYMENTS_DEFAULT_VISIBLE_COLUMNS, } from './reports/dailySalesPayments';
15
- export { dailySalesDiscountsConfig, DAILY_SALES_DISCOUNTS_AVAILABLE_COLUMNS, DAILY_SALES_DISCOUNTS_DEFAULT_VISIBLE_COLUMNS, } from './reports/dailySalesDiscounts';
16
- export { dailySalesRefundsVoidsConfig, DAILY_SALES_REFUNDS_VOIDS_AVAILABLE_COLUMNS, DAILY_SALES_REFUNDS_VOIDS_DEFAULT_VISIBLE_COLUMNS, } from './reports/dailySalesRefundsVoids';
17
- export { dailySalesTaxesConfig, DAILY_SALES_TAXES_AVAILABLE_COLUMNS, DAILY_SALES_TAXES_DEFAULT_VISIBLE_COLUMNS, } from './reports/dailySalesTaxes';
18
- export { employeeTimecardConfig, EMPLOYEE_TIMECARD_AVAILABLE_COLUMNS, EMPLOYEE_TIMECARD_DEFAULT_VISIBLE_COLUMNS, } from './reports/employeeTimecard';
19
- export { salesByItemDetailConfig, SALES_BY_ITEM_DETAIL_AVAILABLE_COLUMNS, SALES_BY_ITEM_DETAIL_DEFAULT_VISIBLE_COLUMNS, } from './reports/salesByItemDetail';
20
- export type { FormatDateOptions, FormatTimeOptions, FormatMoneyOptions, LocaleOption, TimeFormat } from './formatting';
21
- export { formatDate, formatTime, formatMoney, formatPercent, formatInteger, formatFixedNumber, formatString, getNumberToFormat, getDateToFormat, getReportFormattingLocaleOptions, formatMoneyWithoutSymbol, formatFieldValue, } from './formatting';
1
+ type ReportColumnKey = 'fifteenMinInterval' | 'adjustedTips' | 'advantageProgram' | 'amex' | 'amexReturns' | 'attachRate' | 'autoGratuity' | 'averageGrossPrice' | 'bankFees' | 'batchAmount' | 'batchDate' | 'batchNumber' | 'clockInTime' | 'clockOutTime' | 'country' | 'customerName' | 'date' | 'dateClose' | 'daypart' | 'debit' | 'debitReturns' | 'declaredTips' | 'department' | 'depositCurrency' | 'depositDate' | 'discountAmount' | 'discountCount' | 'discover' | 'discoverReturns' | 'ebt' | 'ebtReturns' | 'employeeId' | 'employeeJob' | 'employeeName' | 'exemptTaxes' | 'grandTotal' | 'grossCashSales' | 'grossCashTips' | 'grossCreditCardTips' | 'grossCreditSales' | 'grossSales' | 'grossTips' | 'guestCount' | 'guestsVarLw' | 'guestsVarLwPct' | 'guestsVarLy' | 'guestsVarLyPct' | 'hour' | 'hoursWorked' | 'inclusiveTax' | 'itemName' | 'itemPrice' | 'locationCity' | 'locationId' | 'locationMid' | 'locationName' | 'locationState' | 'mastercard' | 'mcReturns' | 'modifierName' | 'modifierPrice' | 'modifierQuantity' | 'netSales' | 'netTaxCollected' | 'netTips' | 'numberOfGuests' | 'orderType' | 'paymentType' | 'payrollId' | 'quantity' | 'referenceNumber' | 'refundAmount' | 'refundedTaxAmount' | 'revenueCenter' | 'revenueClass' | 'salesVarLw' | 'salesVarLwPct' | 'salesVarLy' | 'salesVarLyPct' | 'salesMixByPct' | 'salesPerGuest' | 'salesPerGuestLw' | 'salesPerGuestLy' | 'scheduledShiftEnd' | 'scheduledShiftStart' | 'settlementBatchDate' | 'shiftDurationHrs' | 'subtotal' | 'taxCollected' | 'taxName' | 'taxRate' | 'taxableSales' | 'ticketClosed' | 'ticketFee' | 'ticketNumber' | 'ticketOpen' | 'ticketTotal' | 'timeOpenMins' | 'tipPct' | 'tipReduction' | 'tipShare' | 'tips' | 'tipsPerHour' | 'totalCollected' | 'totalItemSales' | 'totalModifierSales' | 'totalReturns' | 'totalSales' | 'totalTips' | 'transactionDate' | 'transactionType' | 'untaxedSales' | 'visa' | 'visaReturns' | 'paymentsCount' | 'paymentsAmount' | 'paymentsTotal' | 'refundVoidDescription' | 'refundVoidCount' | 'refundVoidAmount' | 'refundVoidPctSales' | 'discountName' | 'tickets' | 'guests' | 'ticketAverage' | 'guestAverage' | 'net' | 'salePaymentType' | 'status';
2
+ interface ColumnMetadata {
3
+ titleKey: string;
4
+ shortTitleKey: string;
5
+ infoTextKey: string;
6
+ }
7
+ declare const COLUMN_REGISTRY: {
8
+ readonly fifteenMinInterval: {
9
+ readonly titleKey: "common.report-col.fifteen-min-interval";
10
+ readonly shortTitleKey: "common.report-col.fifteen-min-interval.short";
11
+ readonly infoTextKey: "common.report-col.fifteen-min-interval.info";
12
+ };
13
+ readonly adjustedTips: {
14
+ readonly titleKey: "common.report-col.adjusted-tips";
15
+ readonly shortTitleKey: "common.report-col.adjusted-tips.short";
16
+ readonly infoTextKey: "common.report-col.adjusted-tips.info";
17
+ };
18
+ readonly advantageProgram: {
19
+ readonly titleKey: "common.report-col.advantage-program";
20
+ readonly shortTitleKey: "common.report-col.advantage-program.short";
21
+ readonly infoTextKey: "common.report-col.advantage-program.info";
22
+ };
23
+ readonly amex: {
24
+ readonly titleKey: "common.report-col.amex";
25
+ readonly shortTitleKey: "common.report-col.amex.short";
26
+ readonly infoTextKey: "common.report-col.amex.info";
27
+ };
28
+ readonly amexReturns: {
29
+ readonly titleKey: "common.report-col.amex-returns";
30
+ readonly shortTitleKey: "common.report-col.amex-returns.short";
31
+ readonly infoTextKey: "common.report-col.amex-returns.info";
32
+ };
33
+ readonly attachRate: {
34
+ readonly titleKey: "common.report-col.attach-rate";
35
+ readonly shortTitleKey: "common.report-col.attach-rate.short";
36
+ readonly infoTextKey: "common.report-col.attach-rate.info";
37
+ };
38
+ readonly autoGratuity: {
39
+ readonly titleKey: "common.report-col.auto-gratuity";
40
+ readonly shortTitleKey: "common.report-col.auto-gratuity.short";
41
+ readonly infoTextKey: "common.report-col.auto-gratuity.info";
42
+ };
43
+ readonly averageGrossPrice: {
44
+ readonly titleKey: "common.report-col.average-gross-price";
45
+ readonly shortTitleKey: "common.report-col.average-gross-price.short";
46
+ readonly infoTextKey: "common.report-col.average-gross-price.info";
47
+ };
48
+ readonly bankFees: {
49
+ readonly titleKey: "common.report-col.bank-fees";
50
+ readonly shortTitleKey: "common.report-col.bank-fees.short";
51
+ readonly infoTextKey: "common.report-col.bank-fees.info";
52
+ };
53
+ readonly batchAmount: {
54
+ readonly titleKey: "common.report-col.batch-amount";
55
+ readonly shortTitleKey: "common.report-col.batch-amount.short";
56
+ readonly infoTextKey: "common.report-col.batch-amount.info";
57
+ };
58
+ readonly batchDate: {
59
+ readonly titleKey: "common.report-col.batch-date";
60
+ readonly shortTitleKey: "common.report-col.batch-date.short";
61
+ readonly infoTextKey: "common.report-col.batch-date.info";
62
+ };
63
+ readonly batchNumber: {
64
+ readonly titleKey: "common.report-col.batch-number";
65
+ readonly shortTitleKey: "common.report-col.batch-number.short";
66
+ readonly infoTextKey: "common.report-col.batch-number.info";
67
+ };
68
+ readonly clockInTime: {
69
+ readonly titleKey: "common.report-col.clock-in-time";
70
+ readonly shortTitleKey: "common.report-col.clock-in-time.short";
71
+ readonly infoTextKey: "common.report-col.clock-in-time.info";
72
+ };
73
+ readonly clockOutTime: {
74
+ readonly titleKey: "common.report-col.clock-out-time";
75
+ readonly shortTitleKey: "common.report-col.clock-out-time.short";
76
+ readonly infoTextKey: "common.report-col.clock-out-time.info";
77
+ };
78
+ readonly country: {
79
+ readonly titleKey: "common.report-col.country";
80
+ readonly shortTitleKey: "common.report-col.country.short";
81
+ readonly infoTextKey: "common.report-col.country.info";
82
+ };
83
+ readonly customerName: {
84
+ readonly titleKey: "common.report-col.customer-name";
85
+ readonly shortTitleKey: "common.report-col.customer-name.short";
86
+ readonly infoTextKey: "common.report-col.customer-name.info";
87
+ };
88
+ readonly date: {
89
+ readonly titleKey: "common.report-col.date";
90
+ readonly shortTitleKey: "common.report-col.date.short";
91
+ readonly infoTextKey: "common.report-col.date.info";
92
+ };
93
+ readonly dateClose: {
94
+ readonly titleKey: "common.report-col.date-close";
95
+ readonly shortTitleKey: "common.report-col.date-close.short";
96
+ readonly infoTextKey: "common.report-col.date-close.info";
97
+ };
98
+ readonly daypart: {
99
+ readonly titleKey: "common.report-col.daypart";
100
+ readonly shortTitleKey: "common.report-col.daypart.short";
101
+ readonly infoTextKey: "common.report-col.daypart.info";
102
+ };
103
+ readonly debit: {
104
+ readonly titleKey: "common.report-col.debit";
105
+ readonly shortTitleKey: "common.report-col.debit.short";
106
+ readonly infoTextKey: "common.report-col.debit.info";
107
+ };
108
+ readonly debitReturns: {
109
+ readonly titleKey: "common.report-col.debit-returns";
110
+ readonly shortTitleKey: "common.report-col.debit-returns.short";
111
+ readonly infoTextKey: "common.report-col.debit-returns.info";
112
+ };
113
+ readonly declaredTips: {
114
+ readonly titleKey: "common.report-col.declared-tips";
115
+ readonly shortTitleKey: "common.report-col.declared-tips.short";
116
+ readonly infoTextKey: "common.report-col.declared-tips.info";
117
+ };
118
+ readonly department: {
119
+ readonly titleKey: "common.report-col.department";
120
+ readonly shortTitleKey: "common.report-col.department.short";
121
+ readonly infoTextKey: "common.report-col.department.info";
122
+ };
123
+ readonly depositCurrency: {
124
+ readonly titleKey: "common.report-col.deposit-currency";
125
+ readonly shortTitleKey: "common.report-col.deposit-currency.short";
126
+ readonly infoTextKey: "common.report-col.deposit-currency.info";
127
+ };
128
+ readonly depositDate: {
129
+ readonly titleKey: "common.report-col.deposit-date";
130
+ readonly shortTitleKey: "common.report-col.deposit-date.short";
131
+ readonly infoTextKey: "common.report-col.deposit-date.info";
132
+ };
133
+ readonly discountAmount: {
134
+ readonly titleKey: "common.report-col.discount-amount";
135
+ readonly shortTitleKey: "common.report-col.discount-amount.short";
136
+ readonly infoTextKey: "common.report-col.discount-amount.info";
137
+ };
138
+ readonly discountCount: {
139
+ readonly titleKey: "common.report-col.discount-count";
140
+ readonly shortTitleKey: "common.report-col.discount-count.short";
141
+ readonly infoTextKey: "common.report-col.discount-count.info";
142
+ };
143
+ readonly discover: {
144
+ readonly titleKey: "common.report-col.discover";
145
+ readonly shortTitleKey: "common.report-col.discover.short";
146
+ readonly infoTextKey: "common.report-col.discover.info";
147
+ };
148
+ readonly discoverReturns: {
149
+ readonly titleKey: "common.report-col.discover-returns";
150
+ readonly shortTitleKey: "common.report-col.discover-returns.short";
151
+ readonly infoTextKey: "common.report-col.discover-returns.info";
152
+ };
153
+ readonly ebt: {
154
+ readonly titleKey: "common.report-col.ebt";
155
+ readonly shortTitleKey: "common.report-col.ebt.short";
156
+ readonly infoTextKey: "common.report-col.ebt.info";
157
+ };
158
+ readonly ebtReturns: {
159
+ readonly titleKey: "common.report-col.ebt-returns";
160
+ readonly shortTitleKey: "common.report-col.ebt-returns.short";
161
+ readonly infoTextKey: "common.report-col.ebt-returns.info";
162
+ };
163
+ readonly employeeId: {
164
+ readonly titleKey: "common.report-col.employee-id";
165
+ readonly shortTitleKey: "common.report-col.employee-id.short";
166
+ readonly infoTextKey: "common.report-col.employee-id.info";
167
+ };
168
+ readonly employeeJob: {
169
+ readonly titleKey: "common.report-col.employee-job";
170
+ readonly shortTitleKey: "common.report-col.employee-job.short";
171
+ readonly infoTextKey: "common.report-col.employee-job.info";
172
+ };
173
+ readonly employeeName: {
174
+ readonly titleKey: "common.report-col.employee-name";
175
+ readonly shortTitleKey: "common.report-col.employee-name.short";
176
+ readonly infoTextKey: "common.report-col.employee-name.info";
177
+ };
178
+ readonly exemptTaxes: {
179
+ readonly titleKey: "common.report-col.exempt-taxes";
180
+ readonly shortTitleKey: "common.report-col.exempt-taxes.short";
181
+ readonly infoTextKey: "common.report-col.exempt-taxes.info";
182
+ };
183
+ readonly grandTotal: {
184
+ readonly titleKey: "common.report-col.grand-total";
185
+ readonly shortTitleKey: "common.report-col.grand-total.short";
186
+ readonly infoTextKey: "common.report-col.grand-total.info";
187
+ };
188
+ readonly grossCashSales: {
189
+ readonly titleKey: "common.report-col.gross-cash-sales";
190
+ readonly shortTitleKey: "common.report-col.gross-cash-sales.short";
191
+ readonly infoTextKey: "common.report-col.gross-cash-sales.info";
192
+ };
193
+ readonly grossCashTips: {
194
+ readonly titleKey: "common.report-col.gross-cash-tips";
195
+ readonly shortTitleKey: "common.report-col.gross-cash-tips.short";
196
+ readonly infoTextKey: "common.report-col.gross-cash-tips.info";
197
+ };
198
+ readonly grossCreditCardTips: {
199
+ readonly titleKey: "common.report-col.gross-credit-card-tips";
200
+ readonly shortTitleKey: "common.report-col.gross-credit-card-tips.short";
201
+ readonly infoTextKey: "common.report-col.gross-credit-card-tips.info";
202
+ };
203
+ readonly grossCreditSales: {
204
+ readonly titleKey: "common.report-col.gross-credit-sales";
205
+ readonly shortTitleKey: "common.report-col.gross-credit-sales.short";
206
+ readonly infoTextKey: "common.report-col.gross-credit-sales.info";
207
+ };
208
+ readonly grossSales: {
209
+ readonly titleKey: "common.report-col.gross-sales";
210
+ readonly shortTitleKey: "common.report-col.gross-sales.short";
211
+ readonly infoTextKey: "common.report-col.gross-sales.info";
212
+ };
213
+ readonly grossTips: {
214
+ readonly titleKey: "common.report-col.gross-tips";
215
+ readonly shortTitleKey: "common.report-col.gross-tips.short";
216
+ readonly infoTextKey: "common.report-col.gross-tips.info";
217
+ };
218
+ readonly guestCount: {
219
+ readonly titleKey: "common.report-col.guest-count";
220
+ readonly shortTitleKey: "common.report-col.guest-count.short";
221
+ readonly infoTextKey: "common.report-col.guest-count.info";
222
+ };
223
+ readonly guestsVarLw: {
224
+ readonly titleKey: "common.report-col.guests-var-lw";
225
+ readonly shortTitleKey: "common.report-col.guests-var-lw.short";
226
+ readonly infoTextKey: "common.report-col.guests-var-lw.info";
227
+ };
228
+ readonly guestsVarLwPct: {
229
+ readonly titleKey: "common.report-col.guests-var-lw-pct";
230
+ readonly shortTitleKey: "common.report-col.guests-var-lw-pct.short";
231
+ readonly infoTextKey: "common.report-col.guests-var-lw-pct.info";
232
+ };
233
+ readonly guestsVarLy: {
234
+ readonly titleKey: "common.report-col.guests-var-ly";
235
+ readonly shortTitleKey: "common.report-col.guests-var-ly.short";
236
+ readonly infoTextKey: "common.report-col.guests-var-ly.info";
237
+ };
238
+ readonly guestsVarLyPct: {
239
+ readonly titleKey: "common.report-col.guests-var-ly-pct";
240
+ readonly shortTitleKey: "common.report-col.guests-var-ly-pct.short";
241
+ readonly infoTextKey: "common.report-col.guests-var-ly-pct.info";
242
+ };
243
+ readonly hour: {
244
+ readonly titleKey: "common.report-col.hour";
245
+ readonly shortTitleKey: "common.report-col.hour.short";
246
+ readonly infoTextKey: "common.report-col.hour.info";
247
+ };
248
+ readonly hoursWorked: {
249
+ readonly titleKey: "common.report-col.hours-worked";
250
+ readonly shortTitleKey: "common.report-col.hours-worked.short";
251
+ readonly infoTextKey: "common.report-col.hours-worked.info";
252
+ };
253
+ readonly inclusiveTax: {
254
+ readonly titleKey: "common.report-col.inclusive-tax";
255
+ readonly shortTitleKey: "common.report-col.inclusive-tax.short";
256
+ readonly infoTextKey: "common.report-col.inclusive-tax.info";
257
+ };
258
+ readonly itemName: {
259
+ readonly titleKey: "common.report-col.item-name";
260
+ readonly shortTitleKey: "common.report-col.item-name.short";
261
+ readonly infoTextKey: "common.report-col.item-name.info";
262
+ };
263
+ readonly itemPrice: {
264
+ readonly titleKey: "common.report-col.item-price";
265
+ readonly shortTitleKey: "common.report-col.item-price.short";
266
+ readonly infoTextKey: "common.report-col.item-price.info";
267
+ };
268
+ readonly locationCity: {
269
+ readonly titleKey: "common.report-col.location-city";
270
+ readonly shortTitleKey: "common.report-col.location-city.short";
271
+ readonly infoTextKey: "common.report-col.location-city.info";
272
+ };
273
+ readonly locationId: {
274
+ readonly titleKey: "common.report-col.location-id";
275
+ readonly shortTitleKey: "common.report-col.location-id.short";
276
+ readonly infoTextKey: "common.report-col.location-id.info";
277
+ };
278
+ readonly locationMid: {
279
+ readonly titleKey: "common.report-col.location-mid";
280
+ readonly shortTitleKey: "common.report-col.location-mid.short";
281
+ readonly infoTextKey: "common.report-col.location-mid.info";
282
+ };
283
+ readonly locationName: {
284
+ readonly titleKey: "common.report-col.location-name";
285
+ readonly shortTitleKey: "common.report-col.location-name.short";
286
+ readonly infoTextKey: "common.report-col.location-name.info";
287
+ };
288
+ readonly locationState: {
289
+ readonly titleKey: "common.report-col.location-state";
290
+ readonly shortTitleKey: "common.report-col.location-state.short";
291
+ readonly infoTextKey: "common.report-col.location-state.info";
292
+ };
293
+ readonly mastercard: {
294
+ readonly titleKey: "common.report-col.mastercard";
295
+ readonly shortTitleKey: "common.report-col.mastercard.short";
296
+ readonly infoTextKey: "common.report-col.mastercard.info";
297
+ };
298
+ readonly mcReturns: {
299
+ readonly titleKey: "common.report-col.mc-returns";
300
+ readonly shortTitleKey: "common.report-col.mc-returns.short";
301
+ readonly infoTextKey: "common.report-col.mc-returns.info";
302
+ };
303
+ readonly modifierName: {
304
+ readonly titleKey: "common.report-col.modifier-name";
305
+ readonly shortTitleKey: "common.report-col.modifier-name.short";
306
+ readonly infoTextKey: "common.report-col.modifier-name.info";
307
+ };
308
+ readonly modifierPrice: {
309
+ readonly titleKey: "common.report-col.modifier-price";
310
+ readonly shortTitleKey: "common.report-col.modifier-price.short";
311
+ readonly infoTextKey: "common.report-col.modifier-price.info";
312
+ };
313
+ readonly modifierQuantity: {
314
+ readonly titleKey: "common.report-col.modifier-quantity";
315
+ readonly shortTitleKey: "common.report-col.modifier-quantity.short";
316
+ readonly infoTextKey: "common.report-col.modifier-quantity.info";
317
+ };
318
+ readonly netSales: {
319
+ readonly titleKey: "common.report-col.net-sales";
320
+ readonly shortTitleKey: "common.report-col.net-sales.short";
321
+ readonly infoTextKey: "common.report-col.net-sales.info";
322
+ };
323
+ readonly netTaxCollected: {
324
+ readonly titleKey: "common.report-col.net-tax-collected";
325
+ readonly shortTitleKey: "common.report-col.net-tax-collected.short";
326
+ readonly infoTextKey: "common.report-col.net-tax-collected.info";
327
+ };
328
+ readonly netTips: {
329
+ readonly titleKey: "common.report-col.net-tips";
330
+ readonly shortTitleKey: "common.report-col.net-tips.short";
331
+ readonly infoTextKey: "common.report-col.net-tips.info";
332
+ };
333
+ readonly numberOfGuests: {
334
+ readonly titleKey: "common.report-col.number-of-guests";
335
+ readonly shortTitleKey: "common.report-col.number-of-guests.short";
336
+ readonly infoTextKey: "common.report-col.number-of-guests.info";
337
+ };
338
+ readonly orderType: {
339
+ readonly titleKey: "common.report-col.order-type";
340
+ readonly shortTitleKey: "common.report-col.order-type.short";
341
+ readonly infoTextKey: "common.report-col.order-type.info";
342
+ };
343
+ readonly paymentType: {
344
+ readonly titleKey: "common.report-col.payment-type";
345
+ readonly shortTitleKey: "common.report-col.payment-type.short";
346
+ readonly infoTextKey: "common.report-col.payment-type.info";
347
+ };
348
+ readonly payrollId: {
349
+ readonly titleKey: "common.report-col.payroll-id";
350
+ readonly shortTitleKey: "common.report-col.payroll-id.short";
351
+ readonly infoTextKey: "common.report-col.payroll-id.info";
352
+ };
353
+ readonly quantity: {
354
+ readonly titleKey: "common.report-col.quantity";
355
+ readonly shortTitleKey: "common.report-col.quantity.short";
356
+ readonly infoTextKey: "common.report-col.quantity.info";
357
+ };
358
+ readonly referenceNumber: {
359
+ readonly titleKey: "common.report-col.reference-number";
360
+ readonly shortTitleKey: "common.report-col.reference-number.short";
361
+ readonly infoTextKey: "common.report-col.reference-number.info";
362
+ };
363
+ readonly refundAmount: {
364
+ readonly titleKey: "common.report-col.refund-amount";
365
+ readonly shortTitleKey: "common.report-col.refund-amount.short";
366
+ readonly infoTextKey: "common.report-col.refund-amount.info";
367
+ };
368
+ readonly refundedTaxAmount: {
369
+ readonly titleKey: "common.report-col.refunded-tax-amount";
370
+ readonly shortTitleKey: "common.report-col.refunded-tax-amount.short";
371
+ readonly infoTextKey: "common.report-col.refunded-tax-amount.info";
372
+ };
373
+ readonly revenueCenter: {
374
+ readonly titleKey: "common.report-col.revenue-center";
375
+ readonly shortTitleKey: "common.report-col.revenue-center.short";
376
+ readonly infoTextKey: "common.report-col.revenue-center.info";
377
+ };
378
+ readonly revenueClass: {
379
+ readonly titleKey: "common.report-col.revenue-class";
380
+ readonly shortTitleKey: "common.report-col.revenue-class.short";
381
+ readonly infoTextKey: "common.report-col.revenue-class.info";
382
+ };
383
+ readonly salesVarLw: {
384
+ readonly titleKey: "common.report-col.sales-var-lw";
385
+ readonly shortTitleKey: "common.report-col.sales-var-lw.short";
386
+ readonly infoTextKey: "common.report-col.sales-var-lw.info";
387
+ };
388
+ readonly salesVarLwPct: {
389
+ readonly titleKey: "common.report-col.sales-var-lw-pct";
390
+ readonly shortTitleKey: "common.report-col.sales-var-lw-pct.short";
391
+ readonly infoTextKey: "common.report-col.sales-var-lw-pct.info";
392
+ };
393
+ readonly salesVarLy: {
394
+ readonly titleKey: "common.report-col.sales-var-ly";
395
+ readonly shortTitleKey: "common.report-col.sales-var-ly.short";
396
+ readonly infoTextKey: "common.report-col.sales-var-ly.info";
397
+ };
398
+ readonly salesVarLyPct: {
399
+ readonly titleKey: "common.report-col.sales-var-ly-pct";
400
+ readonly shortTitleKey: "common.report-col.sales-var-ly-pct.short";
401
+ readonly infoTextKey: "common.report-col.sales-var-ly-pct.info";
402
+ };
403
+ readonly salesMixByPct: {
404
+ readonly titleKey: "common.report-col.sales-mix-by-pct";
405
+ readonly shortTitleKey: "common.report-col.sales-mix-by-pct.short";
406
+ readonly infoTextKey: "common.report-col.sales-mix-by-pct.info";
407
+ };
408
+ readonly salesPerGuest: {
409
+ readonly titleKey: "common.report-col.sales-per-guest";
410
+ readonly shortTitleKey: "common.report-col.sales-per-guest.short";
411
+ readonly infoTextKey: "common.report-col.sales-per-guest.info";
412
+ };
413
+ readonly salesPerGuestLw: {
414
+ readonly titleKey: "common.report-col.sales-per-guest-lw";
415
+ readonly shortTitleKey: "common.report-col.sales-per-guest-lw.short";
416
+ readonly infoTextKey: "common.report-col.sales-per-guest-lw.info";
417
+ };
418
+ readonly salesPerGuestLy: {
419
+ readonly titleKey: "common.report-col.sales-per-guest-ly";
420
+ readonly shortTitleKey: "common.report-col.sales-per-guest-ly.short";
421
+ readonly infoTextKey: "common.report-col.sales-per-guest-ly.info";
422
+ };
423
+ readonly scheduledShiftEnd: {
424
+ readonly titleKey: "common.report-col.scheduled-shift-end";
425
+ readonly shortTitleKey: "common.report-col.scheduled-shift-end.short";
426
+ readonly infoTextKey: "common.report-col.scheduled-shift-end.info";
427
+ };
428
+ readonly scheduledShiftStart: {
429
+ readonly titleKey: "common.report-col.scheduled-shift-start";
430
+ readonly shortTitleKey: "common.report-col.scheduled-shift-start.short";
431
+ readonly infoTextKey: "common.report-col.scheduled-shift-start.info";
432
+ };
433
+ readonly settlementBatchDate: {
434
+ readonly titleKey: "common.report-col.settlement-batch-date";
435
+ readonly shortTitleKey: "common.report-col.settlement-batch-date.short";
436
+ readonly infoTextKey: "common.report-col.settlement-batch-date.info";
437
+ };
438
+ readonly shiftDurationHrs: {
439
+ readonly titleKey: "common.report-col.shift-duration-hrs";
440
+ readonly shortTitleKey: "common.report-col.shift-duration-hrs.short";
441
+ readonly infoTextKey: "common.report-col.shift-duration-hrs.info";
442
+ };
443
+ readonly salePaymentType: {
444
+ readonly titleKey: "common.report-col.sale-payment-type";
445
+ readonly shortTitleKey: "common.report-col.sale-payment-type.short";
446
+ readonly infoTextKey: "common.report-col.sale-payment-type.info";
447
+ };
448
+ readonly status: {
449
+ readonly titleKey: "common.report-col.status";
450
+ readonly shortTitleKey: "common.report-col.status.short";
451
+ readonly infoTextKey: "common.report-col.status.info";
452
+ };
453
+ readonly subtotal: {
454
+ readonly titleKey: "common.report-col.subtotal";
455
+ readonly shortTitleKey: "common.report-col.subtotal.short";
456
+ readonly infoTextKey: "common.report-col.subtotal.info";
457
+ };
458
+ readonly taxCollected: {
459
+ readonly titleKey: "common.report-col.tax-collected";
460
+ readonly shortTitleKey: "common.report-col.tax-collected.short";
461
+ readonly infoTextKey: "common.report-col.tax-collected.info";
462
+ };
463
+ readonly taxName: {
464
+ readonly titleKey: "common.report-col.tax-name";
465
+ readonly shortTitleKey: "common.report-col.tax-name.short";
466
+ readonly infoTextKey: "common.report-col.tax-name.info";
467
+ };
468
+ readonly taxRate: {
469
+ readonly titleKey: "common.report-col.tax-rate";
470
+ readonly shortTitleKey: "common.report-col.tax-rate.short";
471
+ readonly infoTextKey: "common.report-col.tax-rate.info";
472
+ };
473
+ readonly taxableSales: {
474
+ readonly titleKey: "common.report-col.taxable-sales";
475
+ readonly shortTitleKey: "common.report-col.taxable-sales.short";
476
+ readonly infoTextKey: "common.report-col.taxable-sales.info";
477
+ };
478
+ readonly ticketClosed: {
479
+ readonly titleKey: "common.report-col.ticket-closed";
480
+ readonly shortTitleKey: "common.report-col.ticket-closed.short";
481
+ readonly infoTextKey: "common.report-col.ticket-closed.info";
482
+ };
483
+ readonly ticketFee: {
484
+ readonly titleKey: "common.report-col.ticket-fee";
485
+ readonly shortTitleKey: "common.report-col.ticket-fee.short";
486
+ readonly infoTextKey: "common.report-col.ticket-fee.info";
487
+ };
488
+ readonly ticketNumber: {
489
+ readonly titleKey: "common.report-col.ticket-number";
490
+ readonly shortTitleKey: "common.report-col.ticket-number.short";
491
+ readonly infoTextKey: "common.report-col.ticket-number.info";
492
+ };
493
+ readonly ticketOpen: {
494
+ readonly titleKey: "common.report-col.ticket-open";
495
+ readonly shortTitleKey: "common.report-col.ticket-open.short";
496
+ readonly infoTextKey: "common.report-col.ticket-open.info";
497
+ };
498
+ readonly ticketTotal: {
499
+ readonly titleKey: "common.report-col.ticket-total";
500
+ readonly shortTitleKey: "common.report-col.ticket-total.short";
501
+ readonly infoTextKey: "common.report-col.ticket-total.info";
502
+ };
503
+ readonly timeOpenMins: {
504
+ readonly titleKey: "common.report-col.time-open-mins";
505
+ readonly shortTitleKey: "common.report-col.time-open-mins.short";
506
+ readonly infoTextKey: "common.report-col.time-open-mins.info";
507
+ };
508
+ readonly tipPct: {
509
+ readonly titleKey: "common.report-col.tip-pct";
510
+ readonly shortTitleKey: "common.report-col.tip-pct.short";
511
+ readonly infoTextKey: "common.report-col.tip-pct.info";
512
+ };
513
+ readonly tipReduction: {
514
+ readonly titleKey: "common.report-col.tip-reduction";
515
+ readonly shortTitleKey: "common.report-col.tip-reduction.short";
516
+ readonly infoTextKey: "common.report-col.tip-reduction.info";
517
+ };
518
+ readonly tipShare: {
519
+ readonly titleKey: "common.report-col.tip-share";
520
+ readonly shortTitleKey: "common.report-col.tip-share.short";
521
+ readonly infoTextKey: "common.report-col.tip-share.info";
522
+ };
523
+ readonly tips: {
524
+ readonly titleKey: "common.report-col.tips";
525
+ readonly shortTitleKey: "common.report-col.tips.short";
526
+ readonly infoTextKey: "common.report-col.tips.info";
527
+ };
528
+ readonly tipsPerHour: {
529
+ readonly titleKey: "common.report-col.tips-per-hour";
530
+ readonly shortTitleKey: "common.report-col.tips-per-hour.short";
531
+ readonly infoTextKey: "common.report-col.tips-per-hour.info";
532
+ };
533
+ readonly totalCollected: {
534
+ readonly titleKey: "common.report-col.total-collected";
535
+ readonly shortTitleKey: "common.report-col.total-collected.short";
536
+ readonly infoTextKey: "common.report-col.total-collected.info";
537
+ };
538
+ readonly totalItemSales: {
539
+ readonly titleKey: "common.report-col.total-item-sales";
540
+ readonly shortTitleKey: "common.report-col.total-item-sales.short";
541
+ readonly infoTextKey: "common.report-col.total-item-sales.info";
542
+ };
543
+ readonly totalModifierSales: {
544
+ readonly titleKey: "common.report-col.total-modifier-sales";
545
+ readonly shortTitleKey: "common.report-col.total-modifier-sales.short";
546
+ readonly infoTextKey: "common.report-col.total-modifier-sales.info";
547
+ };
548
+ readonly totalReturns: {
549
+ readonly titleKey: "common.report-col.total-returns";
550
+ readonly shortTitleKey: "common.report-col.total-returns.short";
551
+ readonly infoTextKey: "common.report-col.total-returns.info";
552
+ };
553
+ readonly totalSales: {
554
+ readonly titleKey: "common.report-col.total-sales";
555
+ readonly shortTitleKey: "common.report-col.total-sales.short";
556
+ readonly infoTextKey: "common.report-col.total-sales.info";
557
+ };
558
+ readonly totalTips: {
559
+ readonly titleKey: "common.report-col.total-tips";
560
+ readonly shortTitleKey: "common.report-col.total-tips.short";
561
+ readonly infoTextKey: "common.report-col.total-tips.info";
562
+ };
563
+ readonly transactionDate: {
564
+ readonly titleKey: "common.report-col.transaction-date";
565
+ readonly shortTitleKey: "common.report-col.transaction-date.short";
566
+ readonly infoTextKey: "common.report-col.transaction-date.info";
567
+ };
568
+ readonly transactionType: {
569
+ readonly titleKey: "common.report-col.transaction-type";
570
+ readonly shortTitleKey: "common.report-col.transaction-type.short";
571
+ readonly infoTextKey: "common.report-col.transaction-type.info";
572
+ };
573
+ readonly untaxedSales: {
574
+ readonly titleKey: "common.report-col.untaxed-sales";
575
+ readonly shortTitleKey: "common.report-col.untaxed-sales.short";
576
+ readonly infoTextKey: "common.report-col.untaxed-sales.info";
577
+ };
578
+ readonly visa: {
579
+ readonly titleKey: "common.report-col.visa";
580
+ readonly shortTitleKey: "common.report-col.visa.short";
581
+ readonly infoTextKey: "common.report-col.visa.info";
582
+ };
583
+ readonly visaReturns: {
584
+ readonly titleKey: "common.report-col.visa-returns";
585
+ readonly shortTitleKey: "common.report-col.visa-returns.short";
586
+ readonly infoTextKey: "common.report-col.visa-returns.info";
587
+ };
588
+ readonly paymentsCount: {
589
+ readonly titleKey: "common.report-col.payments-count";
590
+ readonly shortTitleKey: "common.report-col.payments-count.short";
591
+ readonly infoTextKey: "common.report-col.payments-count.info";
592
+ };
593
+ readonly paymentsAmount: {
594
+ readonly titleKey: "common.report-col.payments-amount";
595
+ readonly shortTitleKey: "common.report-col.payments-amount.short";
596
+ readonly infoTextKey: "common.report-col.payments-amount.info";
597
+ };
598
+ readonly paymentsTotal: {
599
+ readonly titleKey: "common.report-col.payments-total";
600
+ readonly shortTitleKey: "common.report-col.payments-total.short";
601
+ readonly infoTextKey: "common.report-col.payments-total.info";
602
+ };
603
+ readonly refundVoidDescription: {
604
+ readonly titleKey: "common.report-col.refund-void-description";
605
+ readonly shortTitleKey: "common.report-col.refund-void-description.short";
606
+ readonly infoTextKey: "common.report-col.refund-void-description.info";
607
+ };
608
+ readonly refundVoidCount: {
609
+ readonly titleKey: "common.report-col.refund-void-count";
610
+ readonly shortTitleKey: "common.report-col.refund-void-count.short";
611
+ readonly infoTextKey: "common.report-col.refund-void-count.info";
612
+ };
613
+ readonly refundVoidAmount: {
614
+ readonly titleKey: "common.report-col.refund-void-amount";
615
+ readonly shortTitleKey: "common.report-col.refund-void-amount.short";
616
+ readonly infoTextKey: "common.report-col.refund-void-amount.info";
617
+ };
618
+ readonly refundVoidPctSales: {
619
+ readonly titleKey: "common.report-col.refund-void-pct-sales";
620
+ readonly shortTitleKey: "common.report-col.refund-void-pct-sales.short";
621
+ readonly infoTextKey: "common.report-col.refund-void-pct-sales.info";
622
+ };
623
+ readonly discountName: {
624
+ readonly titleKey: "common.report-col.discount-name";
625
+ readonly shortTitleKey: "common.report-col.discount-name.short";
626
+ readonly infoTextKey: "common.report-col.discount-name.info";
627
+ };
628
+ readonly tickets: {
629
+ readonly titleKey: "common.report-col.tickets";
630
+ readonly shortTitleKey: "common.report-col.tickets.short";
631
+ readonly infoTextKey: "common.report-col.tickets.info";
632
+ };
633
+ readonly guests: {
634
+ readonly titleKey: "common.report-col.guests";
635
+ readonly shortTitleKey: "common.report-col.guests.short";
636
+ readonly infoTextKey: "common.report-col.guests.info";
637
+ };
638
+ readonly ticketAverage: {
639
+ readonly titleKey: "common.report-col.ticket-average";
640
+ readonly shortTitleKey: "common.report-col.ticket-average.short";
641
+ readonly infoTextKey: "common.report-col.ticket-average.info";
642
+ };
643
+ readonly guestAverage: {
644
+ readonly titleKey: "common.report-col.guest-average";
645
+ readonly shortTitleKey: "common.report-col.guest-average.short";
646
+ readonly infoTextKey: "common.report-col.guest-average.info";
647
+ };
648
+ readonly net: {
649
+ readonly titleKey: "common.report-col.net";
650
+ readonly shortTitleKey: "common.report-col.net.short";
651
+ readonly infoTextKey: "common.report-col.net.info";
652
+ };
653
+ };
654
+ declare function getColumnMetadata(key: ReportColumnKey): {
655
+ readonly titleKey: "common.report-col.fifteen-min-interval";
656
+ readonly shortTitleKey: "common.report-col.fifteen-min-interval.short";
657
+ readonly infoTextKey: "common.report-col.fifteen-min-interval.info";
658
+ } | {
659
+ readonly titleKey: "common.report-col.adjusted-tips";
660
+ readonly shortTitleKey: "common.report-col.adjusted-tips.short";
661
+ readonly infoTextKey: "common.report-col.adjusted-tips.info";
662
+ } | {
663
+ readonly titleKey: "common.report-col.advantage-program";
664
+ readonly shortTitleKey: "common.report-col.advantage-program.short";
665
+ readonly infoTextKey: "common.report-col.advantage-program.info";
666
+ } | {
667
+ readonly titleKey: "common.report-col.amex";
668
+ readonly shortTitleKey: "common.report-col.amex.short";
669
+ readonly infoTextKey: "common.report-col.amex.info";
670
+ } | {
671
+ readonly titleKey: "common.report-col.amex-returns";
672
+ readonly shortTitleKey: "common.report-col.amex-returns.short";
673
+ readonly infoTextKey: "common.report-col.amex-returns.info";
674
+ } | {
675
+ readonly titleKey: "common.report-col.attach-rate";
676
+ readonly shortTitleKey: "common.report-col.attach-rate.short";
677
+ readonly infoTextKey: "common.report-col.attach-rate.info";
678
+ } | {
679
+ readonly titleKey: "common.report-col.auto-gratuity";
680
+ readonly shortTitleKey: "common.report-col.auto-gratuity.short";
681
+ readonly infoTextKey: "common.report-col.auto-gratuity.info";
682
+ } | {
683
+ readonly titleKey: "common.report-col.average-gross-price";
684
+ readonly shortTitleKey: "common.report-col.average-gross-price.short";
685
+ readonly infoTextKey: "common.report-col.average-gross-price.info";
686
+ } | {
687
+ readonly titleKey: "common.report-col.bank-fees";
688
+ readonly shortTitleKey: "common.report-col.bank-fees.short";
689
+ readonly infoTextKey: "common.report-col.bank-fees.info";
690
+ } | {
691
+ readonly titleKey: "common.report-col.batch-amount";
692
+ readonly shortTitleKey: "common.report-col.batch-amount.short";
693
+ readonly infoTextKey: "common.report-col.batch-amount.info";
694
+ } | {
695
+ readonly titleKey: "common.report-col.batch-date";
696
+ readonly shortTitleKey: "common.report-col.batch-date.short";
697
+ readonly infoTextKey: "common.report-col.batch-date.info";
698
+ } | {
699
+ readonly titleKey: "common.report-col.batch-number";
700
+ readonly shortTitleKey: "common.report-col.batch-number.short";
701
+ readonly infoTextKey: "common.report-col.batch-number.info";
702
+ } | {
703
+ readonly titleKey: "common.report-col.clock-in-time";
704
+ readonly shortTitleKey: "common.report-col.clock-in-time.short";
705
+ readonly infoTextKey: "common.report-col.clock-in-time.info";
706
+ } | {
707
+ readonly titleKey: "common.report-col.clock-out-time";
708
+ readonly shortTitleKey: "common.report-col.clock-out-time.short";
709
+ readonly infoTextKey: "common.report-col.clock-out-time.info";
710
+ } | {
711
+ readonly titleKey: "common.report-col.country";
712
+ readonly shortTitleKey: "common.report-col.country.short";
713
+ readonly infoTextKey: "common.report-col.country.info";
714
+ } | {
715
+ readonly titleKey: "common.report-col.customer-name";
716
+ readonly shortTitleKey: "common.report-col.customer-name.short";
717
+ readonly infoTextKey: "common.report-col.customer-name.info";
718
+ } | {
719
+ readonly titleKey: "common.report-col.date";
720
+ readonly shortTitleKey: "common.report-col.date.short";
721
+ readonly infoTextKey: "common.report-col.date.info";
722
+ } | {
723
+ readonly titleKey: "common.report-col.date-close";
724
+ readonly shortTitleKey: "common.report-col.date-close.short";
725
+ readonly infoTextKey: "common.report-col.date-close.info";
726
+ } | {
727
+ readonly titleKey: "common.report-col.daypart";
728
+ readonly shortTitleKey: "common.report-col.daypart.short";
729
+ readonly infoTextKey: "common.report-col.daypart.info";
730
+ } | {
731
+ readonly titleKey: "common.report-col.debit";
732
+ readonly shortTitleKey: "common.report-col.debit.short";
733
+ readonly infoTextKey: "common.report-col.debit.info";
734
+ } | {
735
+ readonly titleKey: "common.report-col.debit-returns";
736
+ readonly shortTitleKey: "common.report-col.debit-returns.short";
737
+ readonly infoTextKey: "common.report-col.debit-returns.info";
738
+ } | {
739
+ readonly titleKey: "common.report-col.declared-tips";
740
+ readonly shortTitleKey: "common.report-col.declared-tips.short";
741
+ readonly infoTextKey: "common.report-col.declared-tips.info";
742
+ } | {
743
+ readonly titleKey: "common.report-col.department";
744
+ readonly shortTitleKey: "common.report-col.department.short";
745
+ readonly infoTextKey: "common.report-col.department.info";
746
+ } | {
747
+ readonly titleKey: "common.report-col.deposit-currency";
748
+ readonly shortTitleKey: "common.report-col.deposit-currency.short";
749
+ readonly infoTextKey: "common.report-col.deposit-currency.info";
750
+ } | {
751
+ readonly titleKey: "common.report-col.deposit-date";
752
+ readonly shortTitleKey: "common.report-col.deposit-date.short";
753
+ readonly infoTextKey: "common.report-col.deposit-date.info";
754
+ } | {
755
+ readonly titleKey: "common.report-col.discount-amount";
756
+ readonly shortTitleKey: "common.report-col.discount-amount.short";
757
+ readonly infoTextKey: "common.report-col.discount-amount.info";
758
+ } | {
759
+ readonly titleKey: "common.report-col.discount-count";
760
+ readonly shortTitleKey: "common.report-col.discount-count.short";
761
+ readonly infoTextKey: "common.report-col.discount-count.info";
762
+ } | {
763
+ readonly titleKey: "common.report-col.discover";
764
+ readonly shortTitleKey: "common.report-col.discover.short";
765
+ readonly infoTextKey: "common.report-col.discover.info";
766
+ } | {
767
+ readonly titleKey: "common.report-col.discover-returns";
768
+ readonly shortTitleKey: "common.report-col.discover-returns.short";
769
+ readonly infoTextKey: "common.report-col.discover-returns.info";
770
+ } | {
771
+ readonly titleKey: "common.report-col.ebt";
772
+ readonly shortTitleKey: "common.report-col.ebt.short";
773
+ readonly infoTextKey: "common.report-col.ebt.info";
774
+ } | {
775
+ readonly titleKey: "common.report-col.ebt-returns";
776
+ readonly shortTitleKey: "common.report-col.ebt-returns.short";
777
+ readonly infoTextKey: "common.report-col.ebt-returns.info";
778
+ } | {
779
+ readonly titleKey: "common.report-col.employee-id";
780
+ readonly shortTitleKey: "common.report-col.employee-id.short";
781
+ readonly infoTextKey: "common.report-col.employee-id.info";
782
+ } | {
783
+ readonly titleKey: "common.report-col.employee-job";
784
+ readonly shortTitleKey: "common.report-col.employee-job.short";
785
+ readonly infoTextKey: "common.report-col.employee-job.info";
786
+ } | {
787
+ readonly titleKey: "common.report-col.employee-name";
788
+ readonly shortTitleKey: "common.report-col.employee-name.short";
789
+ readonly infoTextKey: "common.report-col.employee-name.info";
790
+ } | {
791
+ readonly titleKey: "common.report-col.exempt-taxes";
792
+ readonly shortTitleKey: "common.report-col.exempt-taxes.short";
793
+ readonly infoTextKey: "common.report-col.exempt-taxes.info";
794
+ } | {
795
+ readonly titleKey: "common.report-col.grand-total";
796
+ readonly shortTitleKey: "common.report-col.grand-total.short";
797
+ readonly infoTextKey: "common.report-col.grand-total.info";
798
+ } | {
799
+ readonly titleKey: "common.report-col.gross-cash-sales";
800
+ readonly shortTitleKey: "common.report-col.gross-cash-sales.short";
801
+ readonly infoTextKey: "common.report-col.gross-cash-sales.info";
802
+ } | {
803
+ readonly titleKey: "common.report-col.gross-cash-tips";
804
+ readonly shortTitleKey: "common.report-col.gross-cash-tips.short";
805
+ readonly infoTextKey: "common.report-col.gross-cash-tips.info";
806
+ } | {
807
+ readonly titleKey: "common.report-col.gross-credit-card-tips";
808
+ readonly shortTitleKey: "common.report-col.gross-credit-card-tips.short";
809
+ readonly infoTextKey: "common.report-col.gross-credit-card-tips.info";
810
+ } | {
811
+ readonly titleKey: "common.report-col.gross-credit-sales";
812
+ readonly shortTitleKey: "common.report-col.gross-credit-sales.short";
813
+ readonly infoTextKey: "common.report-col.gross-credit-sales.info";
814
+ } | {
815
+ readonly titleKey: "common.report-col.gross-sales";
816
+ readonly shortTitleKey: "common.report-col.gross-sales.short";
817
+ readonly infoTextKey: "common.report-col.gross-sales.info";
818
+ } | {
819
+ readonly titleKey: "common.report-col.gross-tips";
820
+ readonly shortTitleKey: "common.report-col.gross-tips.short";
821
+ readonly infoTextKey: "common.report-col.gross-tips.info";
822
+ } | {
823
+ readonly titleKey: "common.report-col.guest-count";
824
+ readonly shortTitleKey: "common.report-col.guest-count.short";
825
+ readonly infoTextKey: "common.report-col.guest-count.info";
826
+ } | {
827
+ readonly titleKey: "common.report-col.guests-var-lw";
828
+ readonly shortTitleKey: "common.report-col.guests-var-lw.short";
829
+ readonly infoTextKey: "common.report-col.guests-var-lw.info";
830
+ } | {
831
+ readonly titleKey: "common.report-col.guests-var-lw-pct";
832
+ readonly shortTitleKey: "common.report-col.guests-var-lw-pct.short";
833
+ readonly infoTextKey: "common.report-col.guests-var-lw-pct.info";
834
+ } | {
835
+ readonly titleKey: "common.report-col.guests-var-ly";
836
+ readonly shortTitleKey: "common.report-col.guests-var-ly.short";
837
+ readonly infoTextKey: "common.report-col.guests-var-ly.info";
838
+ } | {
839
+ readonly titleKey: "common.report-col.guests-var-ly-pct";
840
+ readonly shortTitleKey: "common.report-col.guests-var-ly-pct.short";
841
+ readonly infoTextKey: "common.report-col.guests-var-ly-pct.info";
842
+ } | {
843
+ readonly titleKey: "common.report-col.hour";
844
+ readonly shortTitleKey: "common.report-col.hour.short";
845
+ readonly infoTextKey: "common.report-col.hour.info";
846
+ } | {
847
+ readonly titleKey: "common.report-col.hours-worked";
848
+ readonly shortTitleKey: "common.report-col.hours-worked.short";
849
+ readonly infoTextKey: "common.report-col.hours-worked.info";
850
+ } | {
851
+ readonly titleKey: "common.report-col.inclusive-tax";
852
+ readonly shortTitleKey: "common.report-col.inclusive-tax.short";
853
+ readonly infoTextKey: "common.report-col.inclusive-tax.info";
854
+ } | {
855
+ readonly titleKey: "common.report-col.item-name";
856
+ readonly shortTitleKey: "common.report-col.item-name.short";
857
+ readonly infoTextKey: "common.report-col.item-name.info";
858
+ } | {
859
+ readonly titleKey: "common.report-col.item-price";
860
+ readonly shortTitleKey: "common.report-col.item-price.short";
861
+ readonly infoTextKey: "common.report-col.item-price.info";
862
+ } | {
863
+ readonly titleKey: "common.report-col.location-city";
864
+ readonly shortTitleKey: "common.report-col.location-city.short";
865
+ readonly infoTextKey: "common.report-col.location-city.info";
866
+ } | {
867
+ readonly titleKey: "common.report-col.location-id";
868
+ readonly shortTitleKey: "common.report-col.location-id.short";
869
+ readonly infoTextKey: "common.report-col.location-id.info";
870
+ } | {
871
+ readonly titleKey: "common.report-col.location-mid";
872
+ readonly shortTitleKey: "common.report-col.location-mid.short";
873
+ readonly infoTextKey: "common.report-col.location-mid.info";
874
+ } | {
875
+ readonly titleKey: "common.report-col.location-name";
876
+ readonly shortTitleKey: "common.report-col.location-name.short";
877
+ readonly infoTextKey: "common.report-col.location-name.info";
878
+ } | {
879
+ readonly titleKey: "common.report-col.location-state";
880
+ readonly shortTitleKey: "common.report-col.location-state.short";
881
+ readonly infoTextKey: "common.report-col.location-state.info";
882
+ } | {
883
+ readonly titleKey: "common.report-col.mastercard";
884
+ readonly shortTitleKey: "common.report-col.mastercard.short";
885
+ readonly infoTextKey: "common.report-col.mastercard.info";
886
+ } | {
887
+ readonly titleKey: "common.report-col.mc-returns";
888
+ readonly shortTitleKey: "common.report-col.mc-returns.short";
889
+ readonly infoTextKey: "common.report-col.mc-returns.info";
890
+ } | {
891
+ readonly titleKey: "common.report-col.modifier-name";
892
+ readonly shortTitleKey: "common.report-col.modifier-name.short";
893
+ readonly infoTextKey: "common.report-col.modifier-name.info";
894
+ } | {
895
+ readonly titleKey: "common.report-col.modifier-price";
896
+ readonly shortTitleKey: "common.report-col.modifier-price.short";
897
+ readonly infoTextKey: "common.report-col.modifier-price.info";
898
+ } | {
899
+ readonly titleKey: "common.report-col.modifier-quantity";
900
+ readonly shortTitleKey: "common.report-col.modifier-quantity.short";
901
+ readonly infoTextKey: "common.report-col.modifier-quantity.info";
902
+ } | {
903
+ readonly titleKey: "common.report-col.net-sales";
904
+ readonly shortTitleKey: "common.report-col.net-sales.short";
905
+ readonly infoTextKey: "common.report-col.net-sales.info";
906
+ } | {
907
+ readonly titleKey: "common.report-col.net-tax-collected";
908
+ readonly shortTitleKey: "common.report-col.net-tax-collected.short";
909
+ readonly infoTextKey: "common.report-col.net-tax-collected.info";
910
+ } | {
911
+ readonly titleKey: "common.report-col.net-tips";
912
+ readonly shortTitleKey: "common.report-col.net-tips.short";
913
+ readonly infoTextKey: "common.report-col.net-tips.info";
914
+ } | {
915
+ readonly titleKey: "common.report-col.number-of-guests";
916
+ readonly shortTitleKey: "common.report-col.number-of-guests.short";
917
+ readonly infoTextKey: "common.report-col.number-of-guests.info";
918
+ } | {
919
+ readonly titleKey: "common.report-col.order-type";
920
+ readonly shortTitleKey: "common.report-col.order-type.short";
921
+ readonly infoTextKey: "common.report-col.order-type.info";
922
+ } | {
923
+ readonly titleKey: "common.report-col.payment-type";
924
+ readonly shortTitleKey: "common.report-col.payment-type.short";
925
+ readonly infoTextKey: "common.report-col.payment-type.info";
926
+ } | {
927
+ readonly titleKey: "common.report-col.payroll-id";
928
+ readonly shortTitleKey: "common.report-col.payroll-id.short";
929
+ readonly infoTextKey: "common.report-col.payroll-id.info";
930
+ } | {
931
+ readonly titleKey: "common.report-col.quantity";
932
+ readonly shortTitleKey: "common.report-col.quantity.short";
933
+ readonly infoTextKey: "common.report-col.quantity.info";
934
+ } | {
935
+ readonly titleKey: "common.report-col.reference-number";
936
+ readonly shortTitleKey: "common.report-col.reference-number.short";
937
+ readonly infoTextKey: "common.report-col.reference-number.info";
938
+ } | {
939
+ readonly titleKey: "common.report-col.refund-amount";
940
+ readonly shortTitleKey: "common.report-col.refund-amount.short";
941
+ readonly infoTextKey: "common.report-col.refund-amount.info";
942
+ } | {
943
+ readonly titleKey: "common.report-col.refunded-tax-amount";
944
+ readonly shortTitleKey: "common.report-col.refunded-tax-amount.short";
945
+ readonly infoTextKey: "common.report-col.refunded-tax-amount.info";
946
+ } | {
947
+ readonly titleKey: "common.report-col.revenue-center";
948
+ readonly shortTitleKey: "common.report-col.revenue-center.short";
949
+ readonly infoTextKey: "common.report-col.revenue-center.info";
950
+ } | {
951
+ readonly titleKey: "common.report-col.revenue-class";
952
+ readonly shortTitleKey: "common.report-col.revenue-class.short";
953
+ readonly infoTextKey: "common.report-col.revenue-class.info";
954
+ } | {
955
+ readonly titleKey: "common.report-col.sales-var-lw";
956
+ readonly shortTitleKey: "common.report-col.sales-var-lw.short";
957
+ readonly infoTextKey: "common.report-col.sales-var-lw.info";
958
+ } | {
959
+ readonly titleKey: "common.report-col.sales-var-lw-pct";
960
+ readonly shortTitleKey: "common.report-col.sales-var-lw-pct.short";
961
+ readonly infoTextKey: "common.report-col.sales-var-lw-pct.info";
962
+ } | {
963
+ readonly titleKey: "common.report-col.sales-var-ly";
964
+ readonly shortTitleKey: "common.report-col.sales-var-ly.short";
965
+ readonly infoTextKey: "common.report-col.sales-var-ly.info";
966
+ } | {
967
+ readonly titleKey: "common.report-col.sales-var-ly-pct";
968
+ readonly shortTitleKey: "common.report-col.sales-var-ly-pct.short";
969
+ readonly infoTextKey: "common.report-col.sales-var-ly-pct.info";
970
+ } | {
971
+ readonly titleKey: "common.report-col.sales-mix-by-pct";
972
+ readonly shortTitleKey: "common.report-col.sales-mix-by-pct.short";
973
+ readonly infoTextKey: "common.report-col.sales-mix-by-pct.info";
974
+ } | {
975
+ readonly titleKey: "common.report-col.sales-per-guest";
976
+ readonly shortTitleKey: "common.report-col.sales-per-guest.short";
977
+ readonly infoTextKey: "common.report-col.sales-per-guest.info";
978
+ } | {
979
+ readonly titleKey: "common.report-col.sales-per-guest-lw";
980
+ readonly shortTitleKey: "common.report-col.sales-per-guest-lw.short";
981
+ readonly infoTextKey: "common.report-col.sales-per-guest-lw.info";
982
+ } | {
983
+ readonly titleKey: "common.report-col.sales-per-guest-ly";
984
+ readonly shortTitleKey: "common.report-col.sales-per-guest-ly.short";
985
+ readonly infoTextKey: "common.report-col.sales-per-guest-ly.info";
986
+ } | {
987
+ readonly titleKey: "common.report-col.scheduled-shift-end";
988
+ readonly shortTitleKey: "common.report-col.scheduled-shift-end.short";
989
+ readonly infoTextKey: "common.report-col.scheduled-shift-end.info";
990
+ } | {
991
+ readonly titleKey: "common.report-col.scheduled-shift-start";
992
+ readonly shortTitleKey: "common.report-col.scheduled-shift-start.short";
993
+ readonly infoTextKey: "common.report-col.scheduled-shift-start.info";
994
+ } | {
995
+ readonly titleKey: "common.report-col.settlement-batch-date";
996
+ readonly shortTitleKey: "common.report-col.settlement-batch-date.short";
997
+ readonly infoTextKey: "common.report-col.settlement-batch-date.info";
998
+ } | {
999
+ readonly titleKey: "common.report-col.shift-duration-hrs";
1000
+ readonly shortTitleKey: "common.report-col.shift-duration-hrs.short";
1001
+ readonly infoTextKey: "common.report-col.shift-duration-hrs.info";
1002
+ } | {
1003
+ readonly titleKey: "common.report-col.sale-payment-type";
1004
+ readonly shortTitleKey: "common.report-col.sale-payment-type.short";
1005
+ readonly infoTextKey: "common.report-col.sale-payment-type.info";
1006
+ } | {
1007
+ readonly titleKey: "common.report-col.status";
1008
+ readonly shortTitleKey: "common.report-col.status.short";
1009
+ readonly infoTextKey: "common.report-col.status.info";
1010
+ } | {
1011
+ readonly titleKey: "common.report-col.subtotal";
1012
+ readonly shortTitleKey: "common.report-col.subtotal.short";
1013
+ readonly infoTextKey: "common.report-col.subtotal.info";
1014
+ } | {
1015
+ readonly titleKey: "common.report-col.tax-collected";
1016
+ readonly shortTitleKey: "common.report-col.tax-collected.short";
1017
+ readonly infoTextKey: "common.report-col.tax-collected.info";
1018
+ } | {
1019
+ readonly titleKey: "common.report-col.tax-name";
1020
+ readonly shortTitleKey: "common.report-col.tax-name.short";
1021
+ readonly infoTextKey: "common.report-col.tax-name.info";
1022
+ } | {
1023
+ readonly titleKey: "common.report-col.tax-rate";
1024
+ readonly shortTitleKey: "common.report-col.tax-rate.short";
1025
+ readonly infoTextKey: "common.report-col.tax-rate.info";
1026
+ } | {
1027
+ readonly titleKey: "common.report-col.taxable-sales";
1028
+ readonly shortTitleKey: "common.report-col.taxable-sales.short";
1029
+ readonly infoTextKey: "common.report-col.taxable-sales.info";
1030
+ } | {
1031
+ readonly titleKey: "common.report-col.ticket-closed";
1032
+ readonly shortTitleKey: "common.report-col.ticket-closed.short";
1033
+ readonly infoTextKey: "common.report-col.ticket-closed.info";
1034
+ } | {
1035
+ readonly titleKey: "common.report-col.ticket-fee";
1036
+ readonly shortTitleKey: "common.report-col.ticket-fee.short";
1037
+ readonly infoTextKey: "common.report-col.ticket-fee.info";
1038
+ } | {
1039
+ readonly titleKey: "common.report-col.ticket-number";
1040
+ readonly shortTitleKey: "common.report-col.ticket-number.short";
1041
+ readonly infoTextKey: "common.report-col.ticket-number.info";
1042
+ } | {
1043
+ readonly titleKey: "common.report-col.ticket-open";
1044
+ readonly shortTitleKey: "common.report-col.ticket-open.short";
1045
+ readonly infoTextKey: "common.report-col.ticket-open.info";
1046
+ } | {
1047
+ readonly titleKey: "common.report-col.ticket-total";
1048
+ readonly shortTitleKey: "common.report-col.ticket-total.short";
1049
+ readonly infoTextKey: "common.report-col.ticket-total.info";
1050
+ } | {
1051
+ readonly titleKey: "common.report-col.time-open-mins";
1052
+ readonly shortTitleKey: "common.report-col.time-open-mins.short";
1053
+ readonly infoTextKey: "common.report-col.time-open-mins.info";
1054
+ } | {
1055
+ readonly titleKey: "common.report-col.tip-pct";
1056
+ readonly shortTitleKey: "common.report-col.tip-pct.short";
1057
+ readonly infoTextKey: "common.report-col.tip-pct.info";
1058
+ } | {
1059
+ readonly titleKey: "common.report-col.tip-reduction";
1060
+ readonly shortTitleKey: "common.report-col.tip-reduction.short";
1061
+ readonly infoTextKey: "common.report-col.tip-reduction.info";
1062
+ } | {
1063
+ readonly titleKey: "common.report-col.tip-share";
1064
+ readonly shortTitleKey: "common.report-col.tip-share.short";
1065
+ readonly infoTextKey: "common.report-col.tip-share.info";
1066
+ } | {
1067
+ readonly titleKey: "common.report-col.tips";
1068
+ readonly shortTitleKey: "common.report-col.tips.short";
1069
+ readonly infoTextKey: "common.report-col.tips.info";
1070
+ } | {
1071
+ readonly titleKey: "common.report-col.tips-per-hour";
1072
+ readonly shortTitleKey: "common.report-col.tips-per-hour.short";
1073
+ readonly infoTextKey: "common.report-col.tips-per-hour.info";
1074
+ } | {
1075
+ readonly titleKey: "common.report-col.total-collected";
1076
+ readonly shortTitleKey: "common.report-col.total-collected.short";
1077
+ readonly infoTextKey: "common.report-col.total-collected.info";
1078
+ } | {
1079
+ readonly titleKey: "common.report-col.total-item-sales";
1080
+ readonly shortTitleKey: "common.report-col.total-item-sales.short";
1081
+ readonly infoTextKey: "common.report-col.total-item-sales.info";
1082
+ } | {
1083
+ readonly titleKey: "common.report-col.total-modifier-sales";
1084
+ readonly shortTitleKey: "common.report-col.total-modifier-sales.short";
1085
+ readonly infoTextKey: "common.report-col.total-modifier-sales.info";
1086
+ } | {
1087
+ readonly titleKey: "common.report-col.total-returns";
1088
+ readonly shortTitleKey: "common.report-col.total-returns.short";
1089
+ readonly infoTextKey: "common.report-col.total-returns.info";
1090
+ } | {
1091
+ readonly titleKey: "common.report-col.total-sales";
1092
+ readonly shortTitleKey: "common.report-col.total-sales.short";
1093
+ readonly infoTextKey: "common.report-col.total-sales.info";
1094
+ } | {
1095
+ readonly titleKey: "common.report-col.total-tips";
1096
+ readonly shortTitleKey: "common.report-col.total-tips.short";
1097
+ readonly infoTextKey: "common.report-col.total-tips.info";
1098
+ } | {
1099
+ readonly titleKey: "common.report-col.transaction-date";
1100
+ readonly shortTitleKey: "common.report-col.transaction-date.short";
1101
+ readonly infoTextKey: "common.report-col.transaction-date.info";
1102
+ } | {
1103
+ readonly titleKey: "common.report-col.transaction-type";
1104
+ readonly shortTitleKey: "common.report-col.transaction-type.short";
1105
+ readonly infoTextKey: "common.report-col.transaction-type.info";
1106
+ } | {
1107
+ readonly titleKey: "common.report-col.untaxed-sales";
1108
+ readonly shortTitleKey: "common.report-col.untaxed-sales.short";
1109
+ readonly infoTextKey: "common.report-col.untaxed-sales.info";
1110
+ } | {
1111
+ readonly titleKey: "common.report-col.visa";
1112
+ readonly shortTitleKey: "common.report-col.visa.short";
1113
+ readonly infoTextKey: "common.report-col.visa.info";
1114
+ } | {
1115
+ readonly titleKey: "common.report-col.visa-returns";
1116
+ readonly shortTitleKey: "common.report-col.visa-returns.short";
1117
+ readonly infoTextKey: "common.report-col.visa-returns.info";
1118
+ } | {
1119
+ readonly titleKey: "common.report-col.payments-count";
1120
+ readonly shortTitleKey: "common.report-col.payments-count.short";
1121
+ readonly infoTextKey: "common.report-col.payments-count.info";
1122
+ } | {
1123
+ readonly titleKey: "common.report-col.payments-amount";
1124
+ readonly shortTitleKey: "common.report-col.payments-amount.short";
1125
+ readonly infoTextKey: "common.report-col.payments-amount.info";
1126
+ } | {
1127
+ readonly titleKey: "common.report-col.payments-total";
1128
+ readonly shortTitleKey: "common.report-col.payments-total.short";
1129
+ readonly infoTextKey: "common.report-col.payments-total.info";
1130
+ } | {
1131
+ readonly titleKey: "common.report-col.refund-void-description";
1132
+ readonly shortTitleKey: "common.report-col.refund-void-description.short";
1133
+ readonly infoTextKey: "common.report-col.refund-void-description.info";
1134
+ } | {
1135
+ readonly titleKey: "common.report-col.refund-void-count";
1136
+ readonly shortTitleKey: "common.report-col.refund-void-count.short";
1137
+ readonly infoTextKey: "common.report-col.refund-void-count.info";
1138
+ } | {
1139
+ readonly titleKey: "common.report-col.refund-void-amount";
1140
+ readonly shortTitleKey: "common.report-col.refund-void-amount.short";
1141
+ readonly infoTextKey: "common.report-col.refund-void-amount.info";
1142
+ } | {
1143
+ readonly titleKey: "common.report-col.refund-void-pct-sales";
1144
+ readonly shortTitleKey: "common.report-col.refund-void-pct-sales.short";
1145
+ readonly infoTextKey: "common.report-col.refund-void-pct-sales.info";
1146
+ } | {
1147
+ readonly titleKey: "common.report-col.discount-name";
1148
+ readonly shortTitleKey: "common.report-col.discount-name.short";
1149
+ readonly infoTextKey: "common.report-col.discount-name.info";
1150
+ } | {
1151
+ readonly titleKey: "common.report-col.tickets";
1152
+ readonly shortTitleKey: "common.report-col.tickets.short";
1153
+ readonly infoTextKey: "common.report-col.tickets.info";
1154
+ } | {
1155
+ readonly titleKey: "common.report-col.guests";
1156
+ readonly shortTitleKey: "common.report-col.guests.short";
1157
+ readonly infoTextKey: "common.report-col.guests.info";
1158
+ } | {
1159
+ readonly titleKey: "common.report-col.ticket-average";
1160
+ readonly shortTitleKey: "common.report-col.ticket-average.short";
1161
+ readonly infoTextKey: "common.report-col.ticket-average.info";
1162
+ } | {
1163
+ readonly titleKey: "common.report-col.guest-average";
1164
+ readonly shortTitleKey: "common.report-col.guest-average.short";
1165
+ readonly infoTextKey: "common.report-col.guest-average.info";
1166
+ } | {
1167
+ readonly titleKey: "common.report-col.net";
1168
+ readonly shortTitleKey: "common.report-col.net.short";
1169
+ readonly infoTextKey: "common.report-col.net.info";
1170
+ };
1171
+ declare function getColumnExportHeaderLabel(colTitle: string, groupTitle: string | null): string;
1172
+
1173
+ type FieldType = 'string' | 'money' | 'percent' | 'number' | 'fixedNumber' | 'date' | 'time' | 'boolean';
1174
+ type ColumnAlignment = 'left' | 'right';
1175
+ type FooterCalculationType = 'sum' | 'percentChange' | 'average' | 'none';
1176
+ interface FooterCalculation<TField = string> {
1177
+ type: FooterCalculationType;
1178
+ numeratorField?: TField;
1179
+ denominatorField?: TField;
1180
+ }
1181
+ interface ColumnPresentationConfig<TField = string> {
1182
+ columnKey?: ReportColumnKey;
1183
+ type: FieldType;
1184
+ size?: number;
1185
+ enableSorting?: boolean;
1186
+ filteringAvailable?: boolean;
1187
+ footerCalculation?: FooterCalculation<TField>;
1188
+ }
1189
+ interface ColumnGroupConfig {
1190
+ id: string;
1191
+ headerTranslationKey: string;
1192
+ baseFields: string[];
1193
+ lastWeekFields?: string[];
1194
+ lastYearFields?: string[];
1195
+ }
1196
+ interface ReportConfig<TField extends string = string> {
1197
+ fields: Record<TField, ColumnPresentationConfig<TField>>;
1198
+ availableColumns: TField[];
1199
+ defaultVisibleColumns: TField[];
1200
+ columnGroups?: ColumnGroupConfig[];
1201
+ }
1202
+
1203
+ declare const Report: {
1204
+ readonly TICKET_LIVE: "ticket-live";
1205
+ readonly TICKET_ANALYTICS: "ticket-analytics";
1206
+ readonly SALES_SUMMARY: "sales-summary";
1207
+ readonly PRODUCT_MIX: "product-mix";
1208
+ readonly MODIFIER_MIX: "modifier-mix";
1209
+ readonly ITEM_TAX: "item-tax";
1210
+ readonly EMPLOYEE_TIMECARD: "employee-timecard";
1211
+ readonly EMPLOYEE_TIP: "employee-tip";
1212
+ readonly SALES_BY_ITEM: "sales-by-item";
1213
+ readonly DAILY_SALES: "daily-sales";
1214
+ readonly DAILY_SALES_LIVE: "daily-sales-live";
1215
+ };
1216
+ type ReportType = (typeof Report)[keyof typeof Report];
1217
+ declare const getReportConfig: (reportType: ReportType) => ReportConfig<string> | null;
1218
+
1219
+ declare function getColumnAlignment(type?: FieldType): ColumnAlignment;
1220
+ declare function isNumericType(type?: FieldType): boolean;
1221
+
1222
+ interface CalculateReportTotalsOptions {
1223
+ labelField: string;
1224
+ label: string;
1225
+ }
1226
+ declare function calculateReportTotals<T>(data: T[], fieldConfig: Record<string, ColumnPresentationConfig>, opts: CalculateReportTotalsOptions): T;
1227
+
1228
+ type SalesSummaryField = 'groupById' | 'groupByName' | 'salesAmountNet' | 'salesVarLW' | 'salesVarLY' | 'salesVarLWPct' | 'salesVarLYPct' | 'salesAmountNetLastWeek' | 'salesAmountNetLastYear' | 'salesAmountGross' | 'salesAmountGrossLastWeek' | 'salesAmountGrossLastYear' | 'ticketsCount' | 'ticketsCountLastWeek' | 'ticketsCountLastYear' | 'guestsCount' | 'guestsVarLW' | 'guestsVarLY' | 'guestsVarLWPct' | 'guestsVarLYPct' | 'guestsCountLastWeek' | 'guestsCountLastYear' | 'salesPerGuestTY' | 'salesPerGuestLW' | 'salesPerGuestLY';
1229
+ declare const SALES_SUMMARY_AVAILABLE_COLUMNS: SalesSummaryField[];
1230
+ declare const SALES_SUMMARY_DEFAULT_VISIBLE_COLUMNS: SalesSummaryField[];
1231
+ declare const salesSummaryConfig: ReportConfig<SalesSummaryField>;
1232
+
1233
+ type TicketSummaryField = 'ticketId' | 'locationId' | 'orderName' | 'revenueCenterName' | 'daypartName' | 'inclusiveTaxesAmount' | 'locationName' | 'orderNumber' | 'businessDate' | 'ticketOpenedAt' | 'ticketClosedAt' | 'ticketTime' | 'ticketSubtotal' | 'discountsAmount' | 'surchargesAmount' | 'taxesAmount' | 'ticketGrandTotal' | 'gratuitiesAmount' | 'tipAmount' | 'paymentsAmount' | 'paymentTypeName' | 'guestsCount' | 'employeeName' | 'orderTypeName';
1234
+ declare const TICKET_SUMMARY_AVAILABLE_COLUMNS: TicketSummaryField[];
1235
+ declare const TICKET_SUMMARY_DEFAULT_VISIBLE_COLUMNS: TicketSummaryField[];
1236
+ declare const ticketSummaryConfig: ReportConfig<TicketSummaryField>;
1237
+
1238
+ type TicketLiveField = 'locationName' | 'orderNumber' | 'dateOpen' | 'timeOpen' | 'dateClose' | 'timeClose' | 'durationMinutes' | 'subtotal' | 'discountTotal' | 'surchargeTotal' | 'taxTotal' | 'grandTotal' | 'gratuityTotal' | 'totalTips' | 'paymentsReceived' | 'paymentTypeName' | 'guestCount' | 'customerName' | 'employeeName' | 'orderType';
1239
+ declare const TICKET_LIVE_AVAILABLE_COLUMNS: TicketLiveField[];
1240
+ declare const TICKET_LIVE_DEFAULT_VISIBLE_COLUMNS: TicketLiveField[];
1241
+ declare const ticketLiveConfig: ReportConfig<TicketLiveField>;
1242
+
1243
+ type ProductMixField = 'groupById' | 'groupByName' | 'salesAmountGross' | 'discountsAmount' | 'inclusiveTaxesAmount' | 'salesAmountNet' | 'itemsQuantity' | 'avgPrice' | 'salesMixPct';
1244
+ declare const PRODUCT_MIX_AVAILABLE_COLUMNS: ProductMixField[];
1245
+ declare const PRODUCT_MIX_DEFAULT_VISIBLE_COLUMNS: ProductMixField[];
1246
+ declare const PRODUCT_MIX_CHART_FIELDS: ProductMixField[];
1247
+ declare const productMixConfig: ReportConfig<ProductMixField>;
1248
+
1249
+ type ModifierMixField = 'groupById' | 'groupByName' | 'groupById2' | 'groupByName2' | 'modifiersSales' | 'modifiersQuantity' | 'itemsQuantity' | 'avgGross' | 'attachRate' | 'modifiersSalesComp' | 'modifiersQuantityComp' | 'itemsQuantityComp' | 'attachRateComp' | 'modifiersSalesVar' | 'modifiersSalesVarPct' | 'modifiersQuantityVar' | 'modifiersQuantityVarPct' | 'attachRateVar' | 'attachRateVarPct';
1250
+ declare const MODIFIER_MIX_AVAILABLE_COLUMNS: ModifierMixField[];
1251
+ declare const MODIFIER_MIX_DEFAULT_VISIBLE_COLUMNS: ModifierMixField[];
1252
+ declare const modifierMixConfig: ReportConfig<ModifierMixField>;
1253
+
1254
+ type ItemTaxField = 'locationId' | 'taxIsFlat' | 'merchantId' | 'locationName' | 'locationCity' | 'locationState' | 'itemName' | 'itemPrice' | 'departmentName' | 'revenueClassName' | 'orderTypeName' | 'taxName' | 'taxValue' | 'taxRate' | 'recordsCount' | 'taxableSales' | 'totalCollected' | 'itemTax' | 'taxCollected';
1255
+ declare const ITEM_TAX_AVAILABLE_COLUMNS: ItemTaxField[];
1256
+ declare const ITEM_TAX_DEFAULT_VISIBLE_COLUMNS: ItemTaxField[];
1257
+ declare const itemTaxConfig: ReportConfig<ItemTaxField>;
1258
+
1259
+ type DailySalesField = 'groupById' | 'groupByName' | 'itemsQuantity' | 'salesAmountGross' | 'discountsAmount' | 'inclusiveTaxesAmount' | 'salesAmountNet' | 'salesMixPct' | 'avgPrice' | 'ticketsCount' | 'guestsCount' | 'ticketAverage' | 'guestAverage' | 'ticketAvg' | 'guestAvg';
1260
+ declare const DAILY_SALES_AVAILABLE_COLUMNS: DailySalesField[];
1261
+ declare const DAILY_SALES_BY_GROUP_AVAILABLE_COLUMNS: DailySalesField[];
1262
+ declare const DAILY_SALES_DEFAULT_VISIBLE_COLUMNS: DailySalesField[];
1263
+ declare const dailySalesConfig: ReportConfig<DailySalesField>;
1264
+ declare const DAILY_SALES_TRENDS_AVAILABLE_COLUMNS: DailySalesField[];
1265
+ declare const dailySalesTrendsConfig: ReportConfig<DailySalesField>;
1266
+
1267
+ type DailySalesPaymentsField = 'paymentTypeName' | 'paymentsCount' | 'paymentsAmount' | 'tipsAmount' | 'totalSales';
1268
+ declare const DAILY_SALES_PAYMENTS_AVAILABLE_COLUMNS: DailySalesPaymentsField[];
1269
+ declare const DAILY_SALES_PAYMENTS_DEFAULT_VISIBLE_COLUMNS: DailySalesPaymentsField[];
1270
+ declare const dailySalesPaymentsConfig: ReportConfig<DailySalesPaymentsField>;
1271
+
1272
+ type DailySalesDiscountsField = 'discountName' | 'discountsCount' | 'discountsAmount';
1273
+ declare const DAILY_SALES_DISCOUNTS_AVAILABLE_COLUMNS: DailySalesDiscountsField[];
1274
+ declare const DAILY_SALES_DISCOUNTS_DEFAULT_VISIBLE_COLUMNS: DailySalesDiscountsField[];
1275
+ declare const dailySalesDiscountsConfig: ReportConfig<DailySalesDiscountsField>;
1276
+
1277
+ type DailySalesRefundsVoidsField = 'description' | 'count' | 'amount' | 'pctSales';
1278
+ declare const DAILY_SALES_REFUNDS_VOIDS_AVAILABLE_COLUMNS: DailySalesRefundsVoidsField[];
1279
+ declare const DAILY_SALES_REFUNDS_VOIDS_DEFAULT_VISIBLE_COLUMNS: DailySalesRefundsVoidsField[];
1280
+ declare const dailySalesRefundsVoidsConfig: ReportConfig<DailySalesRefundsVoidsField>;
1281
+
1282
+ type DailySalesTaxesField = 'taxName' | 'taxableSales' | 'taxesAmount' | 'exemptSales';
1283
+ declare const DAILY_SALES_TAXES_AVAILABLE_COLUMNS: DailySalesTaxesField[];
1284
+ declare const DAILY_SALES_TAXES_DEFAULT_VISIBLE_COLUMNS: DailySalesTaxesField[];
1285
+ declare const dailySalesTaxesConfig: ReportConfig<DailySalesTaxesField>;
1286
+
1287
+ type EmployeeTimecardField = 'locationId' | 'locationName' | 'businessDate' | 'employeeName' | 'isActive' | 'lookup' | 'payrollCode' | 'jobName' | 'isBreak' | 'startTime' | 'endTime' | 'shiftHours';
1288
+ declare const EMPLOYEE_TIMECARD_AVAILABLE_COLUMNS: EmployeeTimecardField[];
1289
+ declare const EMPLOYEE_TIMECARD_DEFAULT_VISIBLE_COLUMNS: EmployeeTimecardField[];
1290
+ declare const employeeTimecardConfig: ReportConfig<EmployeeTimecardField>;
1291
+
1292
+ type SalesByItemDetailField = 'businessDate' | 'ticketClosedAt' | 'hourId' | 'daypartName' | 'locationId' | 'locationName' | 'departmentName' | 'itemName' | 'revenueCenterName' | 'revenueClassName' | 'salesAmountGross' | 'itemsQuantity' | 'transactionId' | 'guestsCount' | 'employeeName' | 'orderTypeName' | 'salesType' | 'itemPrice';
1293
+ declare const SALES_BY_ITEM_DETAIL_AVAILABLE_COLUMNS: SalesByItemDetailField[];
1294
+ declare const SALES_BY_ITEM_DETAIL_DEFAULT_VISIBLE_COLUMNS: SalesByItemDetailField[];
1295
+ declare const salesByItemDetailConfig: ReportConfig<SalesByItemDetailField>;
1296
+
1297
+ type TimeFormat = '00:00' | '00:00:00' | '00:00-24H';
1298
+ interface LocaleOption {
1299
+ currency: string;
1300
+ locale: string;
1301
+ }
1302
+ interface FormatDateOptions {
1303
+ locale?: string;
1304
+ timeZone?: string;
1305
+ format?: TimeFormat;
1306
+ }
1307
+ interface FormatTimeOptions {
1308
+ locale?: string;
1309
+ timeZone?: string;
1310
+ format: TimeFormat;
1311
+ }
1312
+ interface FormatMoneyOptions {
1313
+ locale?: string;
1314
+ currency?: string;
1315
+ decimals?: number;
1316
+ }
1317
+ interface FormatNumberOptions {
1318
+ locale?: string;
1319
+ decimals?: number;
1320
+ }
1321
+ declare const formatDate: (date: Date, options?: FormatDateOptions) => string;
1322
+ declare const formatTime: (date: Date | string | number, options: FormatTimeOptions) => string;
1323
+ declare const formatMoney: (amount: number, options?: FormatMoneyOptions) => string;
1324
+ declare const formatPercent: (value: number, decimals?: number) => string;
1325
+ declare const formatInteger: (value: number) => string;
1326
+ declare const formatFixedNumber: (value: number, decimals?: number) => string;
1327
+ declare const formatString: (value: unknown) => string;
1328
+ declare const getNumberToFormat: (value: unknown) => number;
1329
+ declare const getDateToFormat: (value?: unknown) => Date | null;
1330
+ declare const formatMoneyWithoutSymbol: (amount: number, options?: FormatNumberOptions) => string;
1331
+ declare const getReportFormattingLocaleOptions: (locations: {
1332
+ currency: string;
1333
+ countryCode: string;
1334
+ language: string;
1335
+ }[]) => LocaleOption[];
1336
+ declare const formatFieldValue: (value: unknown, type: FieldType, localeOptions: LocaleOption) => string;
1337
+
1338
+ export { COLUMN_REGISTRY, type CalculateReportTotalsOptions, type ColumnAlignment, type ColumnGroupConfig, type ColumnMetadata, type ColumnPresentationConfig, DAILY_SALES_AVAILABLE_COLUMNS, DAILY_SALES_BY_GROUP_AVAILABLE_COLUMNS, DAILY_SALES_DEFAULT_VISIBLE_COLUMNS, DAILY_SALES_DISCOUNTS_AVAILABLE_COLUMNS, DAILY_SALES_DISCOUNTS_DEFAULT_VISIBLE_COLUMNS, DAILY_SALES_PAYMENTS_AVAILABLE_COLUMNS, DAILY_SALES_PAYMENTS_DEFAULT_VISIBLE_COLUMNS, DAILY_SALES_REFUNDS_VOIDS_AVAILABLE_COLUMNS, DAILY_SALES_REFUNDS_VOIDS_DEFAULT_VISIBLE_COLUMNS, DAILY_SALES_TAXES_AVAILABLE_COLUMNS, DAILY_SALES_TAXES_DEFAULT_VISIBLE_COLUMNS, DAILY_SALES_TRENDS_AVAILABLE_COLUMNS, EMPLOYEE_TIMECARD_AVAILABLE_COLUMNS, EMPLOYEE_TIMECARD_DEFAULT_VISIBLE_COLUMNS, type FieldType, type FooterCalculation, type FooterCalculationType, type FormatDateOptions, type FormatMoneyOptions, type FormatNumberOptions, type FormatTimeOptions, ITEM_TAX_AVAILABLE_COLUMNS, ITEM_TAX_DEFAULT_VISIBLE_COLUMNS, type LocaleOption, MODIFIER_MIX_AVAILABLE_COLUMNS, MODIFIER_MIX_DEFAULT_VISIBLE_COLUMNS, PRODUCT_MIX_AVAILABLE_COLUMNS, PRODUCT_MIX_CHART_FIELDS, PRODUCT_MIX_DEFAULT_VISIBLE_COLUMNS, Report, type ReportColumnKey, type ReportConfig, type ReportType, SALES_BY_ITEM_DETAIL_AVAILABLE_COLUMNS, SALES_BY_ITEM_DETAIL_DEFAULT_VISIBLE_COLUMNS, SALES_SUMMARY_AVAILABLE_COLUMNS, SALES_SUMMARY_DEFAULT_VISIBLE_COLUMNS, TICKET_LIVE_AVAILABLE_COLUMNS, TICKET_LIVE_DEFAULT_VISIBLE_COLUMNS, TICKET_SUMMARY_AVAILABLE_COLUMNS, TICKET_SUMMARY_DEFAULT_VISIBLE_COLUMNS, type TimeFormat, calculateReportTotals, dailySalesConfig, dailySalesDiscountsConfig, dailySalesPaymentsConfig, dailySalesRefundsVoidsConfig, dailySalesTaxesConfig, dailySalesTrendsConfig, employeeTimecardConfig, formatDate, formatFieldValue, formatFixedNumber, formatInteger, formatMoney, formatMoneyWithoutSymbol, formatPercent, formatString, formatTime, getColumnAlignment, getColumnExportHeaderLabel, getColumnMetadata, getDateToFormat, getNumberToFormat, getReportConfig, getReportFormattingLocaleOptions, isNumericType, itemTaxConfig, modifierMixConfig, productMixConfig, salesByItemDetailConfig, salesSummaryConfig, ticketLiveConfig, ticketSummaryConfig };