@munchi_oy/core 2.1.0 → 2.2.0
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/generated/api.d.ts +2065 -5
- package/dist/generated/api.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/src/version.d.ts +1 -1
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/generated/api.ts +4503 -1790
- package/package.json +1 -1
- package/src/version.ts +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -421,6 +421,94 @@ export interface AmountDto {
|
|
|
421
421
|
*/
|
|
422
422
|
'currency': string;
|
|
423
423
|
}
|
|
424
|
+
/**
|
|
425
|
+
*
|
|
426
|
+
* @export
|
|
427
|
+
* @interface AnalyticsDashboardCardDto
|
|
428
|
+
*/
|
|
429
|
+
export interface AnalyticsDashboardCardDto {
|
|
430
|
+
/**
|
|
431
|
+
* Which card this is, in dashboard-one\'s own words. The server keeps it as sent and never checks it against a list.
|
|
432
|
+
* @type {string}
|
|
433
|
+
* @memberof AnalyticsDashboardCardDto
|
|
434
|
+
*/
|
|
435
|
+
'id': string;
|
|
436
|
+
}
|
|
437
|
+
/**
|
|
438
|
+
*
|
|
439
|
+
* @export
|
|
440
|
+
* @interface AnalyticsDashboardGoalsDto
|
|
441
|
+
*/
|
|
442
|
+
export interface AnalyticsDashboardGoalsDto {
|
|
443
|
+
/**
|
|
444
|
+
* The day\'s sales goal, a whole number in the minor unit of the store\'s currency (cents for EUR). Absent: no day goal.
|
|
445
|
+
* @type {number}
|
|
446
|
+
* @memberof AnalyticsDashboardGoalsDto
|
|
447
|
+
*/
|
|
448
|
+
'daySales'?: number;
|
|
449
|
+
/**
|
|
450
|
+
* The month\'s sales goal, a whole number in the minor unit of the store\'s currency (cents for EUR). Absent: no month goal.
|
|
451
|
+
* @type {number}
|
|
452
|
+
* @memberof AnalyticsDashboardGoalsDto
|
|
453
|
+
*/
|
|
454
|
+
'monthSales'?: number;
|
|
455
|
+
}
|
|
456
|
+
/**
|
|
457
|
+
*
|
|
458
|
+
* @export
|
|
459
|
+
* @interface AnalyticsDashboardResponseDto
|
|
460
|
+
*/
|
|
461
|
+
export interface AnalyticsDashboardResponseDto {
|
|
462
|
+
/**
|
|
463
|
+
* The cards in the order they are shown, first card first
|
|
464
|
+
* @type {Array<AnalyticsDashboardCardDto>}
|
|
465
|
+
* @memberof AnalyticsDashboardResponseDto
|
|
466
|
+
*/
|
|
467
|
+
'cards': Array<AnalyticsDashboardCardDto>;
|
|
468
|
+
/**
|
|
469
|
+
*
|
|
470
|
+
* @type {AnalyticsDashboardResponseDtoGoals}
|
|
471
|
+
* @memberof AnalyticsDashboardResponseDto
|
|
472
|
+
*/
|
|
473
|
+
'goals': AnalyticsDashboardResponseDtoGoals;
|
|
474
|
+
/**
|
|
475
|
+
* When the dashboard was last saved, ISO 8601 in UTC
|
|
476
|
+
* @type {string}
|
|
477
|
+
* @memberof AnalyticsDashboardResponseDto
|
|
478
|
+
*/
|
|
479
|
+
'updatedAt': string;
|
|
480
|
+
/**
|
|
481
|
+
* The dashboard\'s version: 1 when first saved, one more on each save. Send it back as expectedVersion to save.
|
|
482
|
+
* @type {number}
|
|
483
|
+
* @memberof AnalyticsDashboardResponseDto
|
|
484
|
+
*/
|
|
485
|
+
'version': number;
|
|
486
|
+
/**
|
|
487
|
+
* The Clerk user id of the person who last saved it
|
|
488
|
+
* @type {string}
|
|
489
|
+
* @memberof AnalyticsDashboardResponseDto
|
|
490
|
+
*/
|
|
491
|
+
'updatedBy': string;
|
|
492
|
+
}
|
|
493
|
+
/**
|
|
494
|
+
* The sales goals, in the minor unit of the store\'s currency; a goal not set is absent
|
|
495
|
+
* @export
|
|
496
|
+
* @interface AnalyticsDashboardResponseDtoGoals
|
|
497
|
+
*/
|
|
498
|
+
export interface AnalyticsDashboardResponseDtoGoals {
|
|
499
|
+
/**
|
|
500
|
+
* The day\'s sales goal, a whole number in the minor unit of the store\'s currency (cents for EUR). Absent: no day goal.
|
|
501
|
+
* @type {number}
|
|
502
|
+
* @memberof AnalyticsDashboardResponseDtoGoals
|
|
503
|
+
*/
|
|
504
|
+
'daySales'?: number;
|
|
505
|
+
/**
|
|
506
|
+
* The month\'s sales goal, a whole number in the minor unit of the store\'s currency (cents for EUR). Absent: no month goal.
|
|
507
|
+
* @type {number}
|
|
508
|
+
* @memberof AnalyticsDashboardResponseDtoGoals
|
|
509
|
+
*/
|
|
510
|
+
'monthSales'?: number;
|
|
511
|
+
}
|
|
424
512
|
/**
|
|
425
513
|
*
|
|
426
514
|
* @export
|
|
@@ -7743,6 +7831,16 @@ export interface FeesDto {
|
|
|
7743
7831
|
*/
|
|
7744
7832
|
'parts': Array<FeePartDto>;
|
|
7745
7833
|
}
|
|
7834
|
+
/**
|
|
7835
|
+
*
|
|
7836
|
+
* @export
|
|
7837
|
+
* @enum {string}
|
|
7838
|
+
*/
|
|
7839
|
+
export declare const FileFormat: {
|
|
7840
|
+
readonly Pdf: "pdf";
|
|
7841
|
+
readonly Xlsx: "xlsx";
|
|
7842
|
+
};
|
|
7843
|
+
export type FileFormat = typeof FileFormat[keyof typeof FileFormat];
|
|
7746
7844
|
/**
|
|
7747
7845
|
*
|
|
7748
7846
|
* @export
|
|
@@ -8319,6 +8417,15 @@ export interface InboundReservationWebhookDto {
|
|
|
8319
8417
|
*/
|
|
8320
8418
|
'payload': object;
|
|
8321
8419
|
}
|
|
8420
|
+
/**
|
|
8421
|
+
*
|
|
8422
|
+
* @export
|
|
8423
|
+
* @enum {string}
|
|
8424
|
+
*/
|
|
8425
|
+
export declare const IngredientSectionHeadingCode: {
|
|
8426
|
+
readonly IngredientsDefaultHeading: "INGREDIENTS_DEFAULT_HEADING";
|
|
8427
|
+
};
|
|
8428
|
+
export type IngredientSectionHeadingCode = typeof IngredientSectionHeadingCode[keyof typeof IngredientSectionHeadingCode];
|
|
8322
8429
|
/**
|
|
8323
8430
|
*
|
|
8324
8431
|
* @export
|
|
@@ -9693,6 +9800,12 @@ export interface KdsOrderItemDto {
|
|
|
9693
9800
|
* @memberof KdsOrderItemDto
|
|
9694
9801
|
*/
|
|
9695
9802
|
'options': Array<KdsOrderOptionDto>;
|
|
9803
|
+
/**
|
|
9804
|
+
* Every ingredient shown on the guest\'s card for the item, kept (removed false) and removed, in the card\'s order, as kds-service keeps it. Absent only when no card was shown.
|
|
9805
|
+
* @type {Array<OrderIngredientDto>}
|
|
9806
|
+
* @memberof KdsOrderItemDto
|
|
9807
|
+
*/
|
|
9808
|
+
'ingredients'?: Array<OrderIngredientDto>;
|
|
9696
9809
|
}
|
|
9697
9810
|
/**
|
|
9698
9811
|
*
|
|
@@ -14184,6 +14297,31 @@ export interface OrderHistoryResponseDtoSummary {
|
|
|
14184
14297
|
*/
|
|
14185
14298
|
'totalTipAmount'?: number;
|
|
14186
14299
|
}
|
|
14300
|
+
/**
|
|
14301
|
+
*
|
|
14302
|
+
* @export
|
|
14303
|
+
* @interface OrderIngredientDto
|
|
14304
|
+
*/
|
|
14305
|
+
export interface OrderIngredientDto {
|
|
14306
|
+
/**
|
|
14307
|
+
* Id of the inventory item behind the ingredient, in Vendure
|
|
14308
|
+
* @type {number}
|
|
14309
|
+
* @memberof OrderIngredientDto
|
|
14310
|
+
*/
|
|
14311
|
+
'itemId': number;
|
|
14312
|
+
/**
|
|
14313
|
+
* The ingredient\'s name as the guest saw it
|
|
14314
|
+
* @type {string}
|
|
14315
|
+
* @memberof OrderIngredientDto
|
|
14316
|
+
*/
|
|
14317
|
+
'name': string;
|
|
14318
|
+
/**
|
|
14319
|
+
* true when the guest removed the ingredient from the product
|
|
14320
|
+
* @type {boolean}
|
|
14321
|
+
* @memberof OrderIngredientDto
|
|
14322
|
+
*/
|
|
14323
|
+
'removed': boolean;
|
|
14324
|
+
}
|
|
14187
14325
|
/**
|
|
14188
14326
|
*
|
|
14189
14327
|
* @export
|
|
@@ -19171,6 +19309,56 @@ export interface PosMenuExtraDto {
|
|
|
19171
19309
|
*/
|
|
19172
19310
|
'options': Array<PosMenuOptionDto>;
|
|
19173
19311
|
}
|
|
19312
|
+
/**
|
|
19313
|
+
*
|
|
19314
|
+
* @export
|
|
19315
|
+
* @interface PosMenuIngredientDto
|
|
19316
|
+
*/
|
|
19317
|
+
export interface PosMenuIngredientDto {
|
|
19318
|
+
/**
|
|
19319
|
+
* The ingredient\'s inventory item id
|
|
19320
|
+
* @type {number}
|
|
19321
|
+
* @memberof PosMenuIngredientDto
|
|
19322
|
+
*/
|
|
19323
|
+
'id': number;
|
|
19324
|
+
/**
|
|
19325
|
+
* The name customers see: the venue\'s customer name, else the ingredient\'s own name. Never translated
|
|
19326
|
+
* @type {string}
|
|
19327
|
+
* @memberof PosMenuIngredientDto
|
|
19328
|
+
*/
|
|
19329
|
+
'name': string;
|
|
19330
|
+
/**
|
|
19331
|
+
* Its place in the section, from 1. The list is already in this order
|
|
19332
|
+
* @type {number}
|
|
19333
|
+
* @memberof PosMenuIngredientDto
|
|
19334
|
+
*/
|
|
19335
|
+
'rank': number;
|
|
19336
|
+
}
|
|
19337
|
+
/**
|
|
19338
|
+
*
|
|
19339
|
+
* @export
|
|
19340
|
+
* @interface PosMenuIngredientSectionDto
|
|
19341
|
+
*/
|
|
19342
|
+
export interface PosMenuIngredientSectionDto {
|
|
19343
|
+
/**
|
|
19344
|
+
*
|
|
19345
|
+
* @type {IngredientSectionHeadingCode}
|
|
19346
|
+
* @memberof PosMenuIngredientSectionDto
|
|
19347
|
+
*/
|
|
19348
|
+
'heading_code'?: IngredientSectionHeadingCode;
|
|
19349
|
+
/**
|
|
19350
|
+
* The venue\'s own heading, or null when the app shows its own translation of heading_code
|
|
19351
|
+
* @type {string}
|
|
19352
|
+
* @memberof PosMenuIngredientSectionDto
|
|
19353
|
+
*/
|
|
19354
|
+
'heading': string | null;
|
|
19355
|
+
/**
|
|
19356
|
+
* The ingredients the customer may remove, all ticked to start with. Never empty; hidden ones are not sent
|
|
19357
|
+
* @type {Array<PosMenuIngredientDto>}
|
|
19358
|
+
* @memberof PosMenuIngredientSectionDto
|
|
19359
|
+
*/
|
|
19360
|
+
'ingredients': Array<PosMenuIngredientDto>;
|
|
19361
|
+
}
|
|
19174
19362
|
/**
|
|
19175
19363
|
*
|
|
19176
19364
|
* @export
|
|
@@ -19395,6 +19583,37 @@ export interface PosMenuProductDto {
|
|
|
19395
19583
|
* @memberof PosMenuProductDto
|
|
19396
19584
|
*/
|
|
19397
19585
|
'extras': Array<PosMenuExtraDto>;
|
|
19586
|
+
/**
|
|
19587
|
+
*
|
|
19588
|
+
* @type {PosMenuProductDtoIngredientSection}
|
|
19589
|
+
* @memberof PosMenuProductDto
|
|
19590
|
+
*/
|
|
19591
|
+
'ingredient_section'?: PosMenuProductDtoIngredientSection;
|
|
19592
|
+
}
|
|
19593
|
+
/**
|
|
19594
|
+
* What the customer may remove. Sent only when inventory is on, the venue shows ingredients on the till, and the product has a recipe with an ingredient not hidden; otherwise absent, never null
|
|
19595
|
+
* @export
|
|
19596
|
+
* @interface PosMenuProductDtoIngredientSection
|
|
19597
|
+
*/
|
|
19598
|
+
export interface PosMenuProductDtoIngredientSection {
|
|
19599
|
+
/**
|
|
19600
|
+
*
|
|
19601
|
+
* @type {IngredientSectionHeadingCode}
|
|
19602
|
+
* @memberof PosMenuProductDtoIngredientSection
|
|
19603
|
+
*/
|
|
19604
|
+
'heading_code'?: IngredientSectionHeadingCode;
|
|
19605
|
+
/**
|
|
19606
|
+
* The venue\'s own heading, or null when the app shows its own translation of heading_code
|
|
19607
|
+
* @type {string}
|
|
19608
|
+
* @memberof PosMenuProductDtoIngredientSection
|
|
19609
|
+
*/
|
|
19610
|
+
'heading': string | null;
|
|
19611
|
+
/**
|
|
19612
|
+
* The ingredients the customer may remove, all ticked to start with. Never empty; hidden ones are not sent
|
|
19613
|
+
* @type {Array<PosMenuIngredientDto>}
|
|
19614
|
+
* @memberof PosMenuProductDtoIngredientSection
|
|
19615
|
+
*/
|
|
19616
|
+
'ingredients': Array<PosMenuIngredientDto>;
|
|
19398
19617
|
}
|
|
19399
19618
|
/**
|
|
19400
19619
|
* The reporting category the product\'s sales are counted under, or null when it has none
|
|
@@ -20358,6 +20577,12 @@ export interface PosOrderItemDto {
|
|
|
20358
20577
|
* @memberof PosOrderItemDto
|
|
20359
20578
|
*/
|
|
20360
20579
|
'options': Array<PosOrderOptionDto>;
|
|
20580
|
+
/**
|
|
20581
|
+
* Every ingredient shown on the guest\'s card for the line, kept (removed false) and removed, in the card\'s order: the only record of a removal. Sent whenever the card was shown, even when nothing was removed; absent only when no card was shown.
|
|
20582
|
+
* @type {Array<OrderIngredientDto>}
|
|
20583
|
+
* @memberof PosOrderItemDto
|
|
20584
|
+
*/
|
|
20585
|
+
'ingredients'?: Array<OrderIngredientDto>;
|
|
20361
20586
|
/**
|
|
20362
20587
|
* Whether the product has a display label
|
|
20363
20588
|
* @type {boolean}
|
|
@@ -22003,6 +22228,12 @@ export interface ProductDto {
|
|
|
22003
22228
|
* @memberof ProductDto
|
|
22004
22229
|
*/
|
|
22005
22230
|
'customField': object | null;
|
|
22231
|
+
/**
|
|
22232
|
+
* Every ingredient shown on the guest\'s card for the product, kept (removed false) and removed, in the card\'s order. Absent only when no card was shown.
|
|
22233
|
+
* @type {Array<OrderIngredientDto>}
|
|
22234
|
+
* @memberof ProductDto
|
|
22235
|
+
*/
|
|
22236
|
+
'ingredients'?: Array<OrderIngredientDto>;
|
|
22006
22237
|
/**
|
|
22007
22238
|
* Kitchen status of the product
|
|
22008
22239
|
* @type {string}
|
|
@@ -24121,6 +24352,18 @@ export declare const ReportLanguage: {
|
|
|
24121
24352
|
readonly En: "en";
|
|
24122
24353
|
};
|
|
24123
24354
|
export type ReportLanguage = typeof ReportLanguage[keyof typeof ReportLanguage];
|
|
24355
|
+
/**
|
|
24356
|
+
*
|
|
24357
|
+
* @export
|
|
24358
|
+
* @enum {string}
|
|
24359
|
+
*/
|
|
24360
|
+
export declare const ReportOrderType: {
|
|
24361
|
+
readonly EatIn: "eat_in";
|
|
24362
|
+
readonly Takeaway: "takeaway";
|
|
24363
|
+
readonly Delivery: "delivery";
|
|
24364
|
+
readonly Unknown: "unknown";
|
|
24365
|
+
};
|
|
24366
|
+
export type ReportOrderType = typeof ReportOrderType[keyof typeof ReportOrderType];
|
|
24124
24367
|
/**
|
|
24125
24368
|
*
|
|
24126
24369
|
* @export
|
|
@@ -24889,6 +25132,92 @@ export declare const SYNCKEY: {
|
|
|
24889
25132
|
readonly ReceiptFooter: "RECEIPT_FOOTER";
|
|
24890
25133
|
};
|
|
24891
25134
|
export type SYNCKEY = typeof SYNCKEY[keyof typeof SYNCKEY];
|
|
25135
|
+
/**
|
|
25136
|
+
*
|
|
25137
|
+
* @export
|
|
25138
|
+
* @interface SalesReportBoughtTogetherGroupDto
|
|
25139
|
+
*/
|
|
25140
|
+
export interface SalesReportBoughtTogetherGroupDto {
|
|
25141
|
+
/**
|
|
25142
|
+
* The venue\'s orderingBusinessId, or null when the breakdown adds venues together
|
|
25143
|
+
* @type {number}
|
|
25144
|
+
* @memberof SalesReportBoughtTogetherGroupDto
|
|
25145
|
+
*/
|
|
25146
|
+
'businessId': number | null;
|
|
25147
|
+
/**
|
|
25148
|
+
*
|
|
25149
|
+
* @type {ReportApp}
|
|
25150
|
+
* @memberof SalesReportBoughtTogetherGroupDto
|
|
25151
|
+
*/
|
|
25152
|
+
'app': ReportApp | null;
|
|
25153
|
+
/**
|
|
25154
|
+
*
|
|
25155
|
+
* @type {CurrencyCode}
|
|
25156
|
+
* @memberof SalesReportBoughtTogetherGroupDto
|
|
25157
|
+
*/
|
|
25158
|
+
'currency': CurrencyCode;
|
|
25159
|
+
/**
|
|
25160
|
+
* Venue-app days of the period that sold more than 25 pairs: each kept only its top 25, so a pair\'s orders are exact when this is 0 and a lower bound otherwise
|
|
25161
|
+
* @type {number}
|
|
25162
|
+
* @memberof SalesReportBoughtTogetherGroupDto
|
|
25163
|
+
*/
|
|
25164
|
+
'daysWithPairsCut': number;
|
|
25165
|
+
/**
|
|
25166
|
+
* The pairs bought in the most orders, most first, ties by the items\' keys
|
|
25167
|
+
* @type {Array<SalesReportPairDto>}
|
|
25168
|
+
* @memberof SalesReportBoughtTogetherGroupDto
|
|
25169
|
+
*/
|
|
25170
|
+
'pairs': Array<SalesReportPairDto>;
|
|
25171
|
+
}
|
|
25172
|
+
/**
|
|
25173
|
+
*
|
|
25174
|
+
* @export
|
|
25175
|
+
* @interface SalesReportBoughtTogetherResponseDto
|
|
25176
|
+
*/
|
|
25177
|
+
export interface SalesReportBoughtTogetherResponseDto {
|
|
25178
|
+
/**
|
|
25179
|
+
* The first instant of the period, ISO 8601 in UTC
|
|
25180
|
+
* @type {string}
|
|
25181
|
+
* @memberof SalesReportBoughtTogetherResponseDto
|
|
25182
|
+
*/
|
|
25183
|
+
'reportDateStart': string;
|
|
25184
|
+
/**
|
|
25185
|
+
* The last instant of the period, ISO 8601 in UTC; now, when the period ends later
|
|
25186
|
+
* @type {string}
|
|
25187
|
+
* @memberof SalesReportBoughtTogetherResponseDto
|
|
25188
|
+
*/
|
|
25189
|
+
'reportDateEnd': string;
|
|
25190
|
+
/**
|
|
25191
|
+
* The IANA time zone the period\'s days are read in
|
|
25192
|
+
* @type {string}
|
|
25193
|
+
* @memberof SalesReportBoughtTogetherResponseDto
|
|
25194
|
+
*/
|
|
25195
|
+
'timezone': string;
|
|
25196
|
+
/**
|
|
25197
|
+
* The first business day, YYYY-MM-DD
|
|
25198
|
+
* @type {string}
|
|
25199
|
+
* @memberof SalesReportBoughtTogetherResponseDto
|
|
25200
|
+
*/
|
|
25201
|
+
'firstBusinessDay': string;
|
|
25202
|
+
/**
|
|
25203
|
+
* The last business day, YYYY-MM-DD, inclusive
|
|
25204
|
+
* @type {string}
|
|
25205
|
+
* @memberof SalesReportBoughtTogetherResponseDto
|
|
25206
|
+
*/
|
|
25207
|
+
'lastBusinessDay': string;
|
|
25208
|
+
/**
|
|
25209
|
+
* The newest BigQuery rebuild the rows read, ISO 8601 in UTC; null when none
|
|
25210
|
+
* @type {string}
|
|
25211
|
+
* @memberof SalesReportBoughtTogetherResponseDto
|
|
25212
|
+
*/
|
|
25213
|
+
'dataUntil': string | null;
|
|
25214
|
+
/**
|
|
25215
|
+
* One group per venue, app and currency the breakdown keeps
|
|
25216
|
+
* @type {Array<SalesReportBoughtTogetherGroupDto>}
|
|
25217
|
+
* @memberof SalesReportBoughtTogetherResponseDto
|
|
25218
|
+
*/
|
|
25219
|
+
'groups': Array<SalesReportBoughtTogetherGroupDto>;
|
|
25220
|
+
}
|
|
24892
25221
|
/**
|
|
24893
25222
|
*
|
|
24894
25223
|
* @export
|
|
@@ -24999,6 +25328,12 @@ export interface SalesReportComparisonDto {
|
|
|
24999
25328
|
* @memberof SalesReportComparisonDto
|
|
25000
25329
|
*/
|
|
25001
25330
|
'lastBusinessDay': string;
|
|
25331
|
+
/**
|
|
25332
|
+
* compareSameTime only: the instant the compared last day was added up to, ISO 8601 in UTC: that day at the last full hour, on the report\'s clock, that both the daily rows and the hours have reached on the report\'s last day (a client says \"until 14:00\"). The report\'s own last day is cut at the same hour of its day, so both sides cover the same hours: the group\'s totals and dailyBreakdown of that day stop there too. Present when no venue and app of the group was compared whole that day (one that sold nothing that day counts as cut); absent when compareSameTime was not sent, the report\'s last day is over, or a venue\'s day had no hours yet and was compared whole. In a group of venues in several time zones each venue is cut at its own clock\'s hour of the same instant, which this names in the report\'s time zone
|
|
25333
|
+
* @type {string}
|
|
25334
|
+
* @memberof SalesReportComparisonDto
|
|
25335
|
+
*/
|
|
25336
|
+
'comparedUntil'?: string;
|
|
25002
25337
|
/**
|
|
25003
25338
|
*
|
|
25004
25339
|
* @type {SalesReportComparisonDtoSalesReport}
|
|
@@ -25311,6 +25646,12 @@ export interface SalesReportGroupDtoComparison {
|
|
|
25311
25646
|
* @memberof SalesReportGroupDtoComparison
|
|
25312
25647
|
*/
|
|
25313
25648
|
'lastBusinessDay': string;
|
|
25649
|
+
/**
|
|
25650
|
+
* compareSameTime only: the instant the compared last day was added up to, ISO 8601 in UTC: that day at the last full hour, on the report\'s clock, that both the daily rows and the hours have reached on the report\'s last day (a client says \"until 14:00\"). The report\'s own last day is cut at the same hour of its day, so both sides cover the same hours: the group\'s totals and dailyBreakdown of that day stop there too. Present when no venue and app of the group was compared whole that day (one that sold nothing that day counts as cut); absent when compareSameTime was not sent, the report\'s last day is over, or a venue\'s day had no hours yet and was compared whole. In a group of venues in several time zones each venue is cut at its own clock\'s hour of the same instant, which this names in the report\'s time zone
|
|
25651
|
+
* @type {string}
|
|
25652
|
+
* @memberof SalesReportGroupDtoComparison
|
|
25653
|
+
*/
|
|
25654
|
+
'comparedUntil'?: string;
|
|
25314
25655
|
/**
|
|
25315
25656
|
*
|
|
25316
25657
|
* @type {SalesReportComparisonDtoSalesReport}
|
|
@@ -25434,6 +25775,165 @@ export interface SalesReportGroupDtoSalesReport {
|
|
|
25434
25775
|
*/
|
|
25435
25776
|
'deliveryTax'?: number;
|
|
25436
25777
|
}
|
|
25778
|
+
/**
|
|
25779
|
+
*
|
|
25780
|
+
* @export
|
|
25781
|
+
* @interface SalesReportHourDto
|
|
25782
|
+
*/
|
|
25783
|
+
export interface SalesReportHourDto {
|
|
25784
|
+
/**
|
|
25785
|
+
* The hour of the venue\'s clock, 0 to 23: its orders from hour:00 to hour:59. On the day the clocks go back, the hour that repeats holds both; on the day they go forward, the hour skipped holds nothing
|
|
25786
|
+
* @type {number}
|
|
25787
|
+
* @memberof SalesReportHourDto
|
|
25788
|
+
*/
|
|
25789
|
+
'hour': number;
|
|
25790
|
+
/**
|
|
25791
|
+
* The period\'s orders counted in this hour, as orderCount counts them
|
|
25792
|
+
* @type {number}
|
|
25793
|
+
* @memberof SalesReportHourDto
|
|
25794
|
+
*/
|
|
25795
|
+
'orderCount': number;
|
|
25796
|
+
/**
|
|
25797
|
+
* The period\'s sales of this hour, as the report\'s salesReport.totalWithTax adds them up, in the major unit: the 24 hours add up to the period\'s totalWithTax within each hour\'s own rounding to the minor unit
|
|
25798
|
+
* @type {number}
|
|
25799
|
+
* @memberof SalesReportHourDto
|
|
25800
|
+
*/
|
|
25801
|
+
'totalWithTax': number;
|
|
25802
|
+
/**
|
|
25803
|
+
* The hour\'s orders on an average finished day: orderCount less today\'s, divided by the group\'s daysAveraged, 2 decimals, rounded half up
|
|
25804
|
+
* @type {number}
|
|
25805
|
+
* @memberof SalesReportHourDto
|
|
25806
|
+
*/
|
|
25807
|
+
'averageOrderCount': number;
|
|
25808
|
+
/**
|
|
25809
|
+
* The hour\'s sales on an average finished day: totalWithTax less today\'s, divided by the group\'s daysAveraged, in the major unit, rounded half up to the currency\'s minor digits
|
|
25810
|
+
* @type {number}
|
|
25811
|
+
* @memberof SalesReportHourDto
|
|
25812
|
+
*/
|
|
25813
|
+
'averageTotalWithTax': number;
|
|
25814
|
+
/**
|
|
25815
|
+
* The period\'s sales of this hour without VAT, as the report\'s salesReport.totalWithoutTax adds them up (the POS\'s item lines without VAT, kiosk and online the tax summary\'s; with the forfeited vouchers where the app\'s report adds them), in the major unit; with totalWithTax less this, the hour\'s VAT
|
|
25816
|
+
* @type {number}
|
|
25817
|
+
* @memberof SalesReportHourDto
|
|
25818
|
+
*/
|
|
25819
|
+
'totalWithoutTax': number;
|
|
25820
|
+
/**
|
|
25821
|
+
* The hour\'s sales without VAT on an average finished day: totalWithoutTax less today\'s, divided by the group\'s daysAveraged, in the major unit, rounded half up to the currency\'s minor digits
|
|
25822
|
+
* @type {number}
|
|
25823
|
+
* @memberof SalesReportHourDto
|
|
25824
|
+
*/
|
|
25825
|
+
'averageTotalWithoutTax': number;
|
|
25826
|
+
}
|
|
25827
|
+
/**
|
|
25828
|
+
*
|
|
25829
|
+
* @export
|
|
25830
|
+
* @interface SalesReportHoursGroupDto
|
|
25831
|
+
*/
|
|
25832
|
+
export interface SalesReportHoursGroupDto {
|
|
25833
|
+
/**
|
|
25834
|
+
* The venue\'s orderingBusinessId, or null when the breakdown adds venues together
|
|
25835
|
+
* @type {number}
|
|
25836
|
+
* @memberof SalesReportHoursGroupDto
|
|
25837
|
+
*/
|
|
25838
|
+
'businessId': number | null;
|
|
25839
|
+
/**
|
|
25840
|
+
*
|
|
25841
|
+
* @type {ReportApp}
|
|
25842
|
+
* @memberof SalesReportHoursGroupDto
|
|
25843
|
+
*/
|
|
25844
|
+
'app': ReportApp | null;
|
|
25845
|
+
/**
|
|
25846
|
+
*
|
|
25847
|
+
* @type {CurrencyCode}
|
|
25848
|
+
* @memberof SalesReportHoursGroupDto
|
|
25849
|
+
*/
|
|
25850
|
+
'currency': CurrencyCode;
|
|
25851
|
+
/**
|
|
25852
|
+
* Decimals of the currency\'s minor unit (2 for EUR)
|
|
25853
|
+
* @type {number}
|
|
25854
|
+
* @memberof SalesReportHoursGroupDto
|
|
25855
|
+
*/
|
|
25856
|
+
'minorDigits': number;
|
|
25857
|
+
/**
|
|
25858
|
+
* The finished days of the period (of isoWeekday, when sent) on which a venue or app of the group sold but has no hours yet (built before hours were kept, until their backfill): their sales are in no hour, and the averages leave them out. 0 when every day has them
|
|
25859
|
+
* @type {number}
|
|
25860
|
+
* @memberof SalesReportHoursGroupDto
|
|
25861
|
+
*/
|
|
25862
|
+
'daysWithoutHours': number;
|
|
25863
|
+
/**
|
|
25864
|
+
* What the group\'s averages divide by: daysCounted less daysWithoutHours
|
|
25865
|
+
* @type {number}
|
|
25866
|
+
* @memberof SalesReportHoursGroupDto
|
|
25867
|
+
*/
|
|
25868
|
+
'daysAveraged': number;
|
|
25869
|
+
/**
|
|
25870
|
+
* Every hour of the day, 0 to 23, in order
|
|
25871
|
+
* @type {Array<SalesReportHourDto>}
|
|
25872
|
+
* @memberof SalesReportHoursGroupDto
|
|
25873
|
+
*/
|
|
25874
|
+
'hours': Array<SalesReportHourDto>;
|
|
25875
|
+
}
|
|
25876
|
+
/**
|
|
25877
|
+
*
|
|
25878
|
+
* @export
|
|
25879
|
+
* @interface SalesReportHoursResponseDto
|
|
25880
|
+
*/
|
|
25881
|
+
export interface SalesReportHoursResponseDto {
|
|
25882
|
+
/**
|
|
25883
|
+
* The first instant of the period, ISO 8601 in UTC
|
|
25884
|
+
* @type {string}
|
|
25885
|
+
* @memberof SalesReportHoursResponseDto
|
|
25886
|
+
*/
|
|
25887
|
+
'reportDateStart': string;
|
|
25888
|
+
/**
|
|
25889
|
+
* The last instant of the period, ISO 8601 in UTC; now, when the period ends later
|
|
25890
|
+
* @type {string}
|
|
25891
|
+
* @memberof SalesReportHoursResponseDto
|
|
25892
|
+
*/
|
|
25893
|
+
'reportDateEnd': string;
|
|
25894
|
+
/**
|
|
25895
|
+
* The IANA time zone the period\'s days are read in
|
|
25896
|
+
* @type {string}
|
|
25897
|
+
* @memberof SalesReportHoursResponseDto
|
|
25898
|
+
*/
|
|
25899
|
+
'timezone': string;
|
|
25900
|
+
/**
|
|
25901
|
+
* The first business day, YYYY-MM-DD
|
|
25902
|
+
* @type {string}
|
|
25903
|
+
* @memberof SalesReportHoursResponseDto
|
|
25904
|
+
*/
|
|
25905
|
+
'firstBusinessDay': string;
|
|
25906
|
+
/**
|
|
25907
|
+
* The last business day, YYYY-MM-DD, inclusive
|
|
25908
|
+
* @type {string}
|
|
25909
|
+
* @memberof SalesReportHoursResponseDto
|
|
25910
|
+
*/
|
|
25911
|
+
'lastBusinessDay': string;
|
|
25912
|
+
/**
|
|
25913
|
+
* The ISO weekday counted, 1 Monday to 7 Sunday, or null for every day
|
|
25914
|
+
* @type {number}
|
|
25915
|
+
* @memberof SalesReportHoursResponseDto
|
|
25916
|
+
*/
|
|
25917
|
+
'isoWeekday': number | null;
|
|
25918
|
+
/**
|
|
25919
|
+
* The finished calendar days of the period (of isoWeekday, when sent), sold on or not; today, still running, is not one of them. Each group\'s averages divide by its daysAveraged
|
|
25920
|
+
* @type {number}
|
|
25921
|
+
* @memberof SalesReportHoursResponseDto
|
|
25922
|
+
*/
|
|
25923
|
+
'daysCounted': number;
|
|
25924
|
+
/**
|
|
25925
|
+
* The newest BigQuery rebuild the rows read, ISO 8601 in UTC; null when none
|
|
25926
|
+
* @type {string}
|
|
25927
|
+
* @memberof SalesReportHoursResponseDto
|
|
25928
|
+
*/
|
|
25929
|
+
'dataUntil': string | null;
|
|
25930
|
+
/**
|
|
25931
|
+
* One group per venue, app and currency the breakdown keeps
|
|
25932
|
+
* @type {Array<SalesReportHoursGroupDto>}
|
|
25933
|
+
* @memberof SalesReportHoursResponseDto
|
|
25934
|
+
*/
|
|
25935
|
+
'groups': Array<SalesReportHoursGroupDto>;
|
|
25936
|
+
}
|
|
25437
25937
|
/**
|
|
25438
25938
|
*
|
|
25439
25939
|
* @export
|
|
@@ -25532,6 +26032,247 @@ export interface SalesReportOptionDto {
|
|
|
25532
26032
|
*/
|
|
25533
26033
|
'taxRate': object | null;
|
|
25534
26034
|
}
|
|
26035
|
+
/**
|
|
26036
|
+
*
|
|
26037
|
+
* @export
|
|
26038
|
+
* @interface SalesReportOrderTypeDto
|
|
26039
|
+
*/
|
|
26040
|
+
export interface SalesReportOrderTypeDto {
|
|
26041
|
+
/**
|
|
26042
|
+
*
|
|
26043
|
+
* @type {ReportOrderType}
|
|
26044
|
+
* @memberof SalesReportOrderTypeDto
|
|
26045
|
+
*/
|
|
26046
|
+
'orderType': ReportOrderType;
|
|
26047
|
+
/**
|
|
26048
|
+
* The period\'s orders of this type, as orderCount counts them
|
|
26049
|
+
* @type {number}
|
|
26050
|
+
* @memberof SalesReportOrderTypeDto
|
|
26051
|
+
*/
|
|
26052
|
+
'orderCount': number;
|
|
26053
|
+
/**
|
|
26054
|
+
* The period\'s sales of this type, as the report\'s salesReport.totalWithTax adds them up, in the major unit: the types add up to the period\'s totalWithTax within each type\'s own rounding to the minor unit
|
|
26055
|
+
* @type {number}
|
|
26056
|
+
* @memberof SalesReportOrderTypeDto
|
|
26057
|
+
*/
|
|
26058
|
+
'totalWithTax': number;
|
|
26059
|
+
/**
|
|
26060
|
+
* Their VAT, as salesReport.totalTaxAmount, in the major unit
|
|
26061
|
+
* @type {number}
|
|
26062
|
+
* @memberof SalesReportOrderTypeDto
|
|
26063
|
+
*/
|
|
26064
|
+
'totalTaxAmount': number;
|
|
26065
|
+
/**
|
|
26066
|
+
* Their sales without VAT, as salesReport.totalWithoutTax, in the major unit
|
|
26067
|
+
* @type {number}
|
|
26068
|
+
* @memberof SalesReportOrderTypeDto
|
|
26069
|
+
*/
|
|
26070
|
+
'totalWithoutTax': number;
|
|
26071
|
+
}
|
|
26072
|
+
/**
|
|
26073
|
+
*
|
|
26074
|
+
* @export
|
|
26075
|
+
* @interface SalesReportOrderTypesGroupDto
|
|
26076
|
+
*/
|
|
26077
|
+
export interface SalesReportOrderTypesGroupDto {
|
|
26078
|
+
/**
|
|
26079
|
+
* The venue\'s orderingBusinessId, or null when the breakdown adds venues together
|
|
26080
|
+
* @type {number}
|
|
26081
|
+
* @memberof SalesReportOrderTypesGroupDto
|
|
26082
|
+
*/
|
|
26083
|
+
'businessId': number | null;
|
|
26084
|
+
/**
|
|
26085
|
+
*
|
|
26086
|
+
* @type {ReportApp}
|
|
26087
|
+
* @memberof SalesReportOrderTypesGroupDto
|
|
26088
|
+
*/
|
|
26089
|
+
'app': ReportApp | null;
|
|
26090
|
+
/**
|
|
26091
|
+
*
|
|
26092
|
+
* @type {CurrencyCode}
|
|
26093
|
+
* @memberof SalesReportOrderTypesGroupDto
|
|
26094
|
+
*/
|
|
26095
|
+
'currency': CurrencyCode;
|
|
26096
|
+
/**
|
|
26097
|
+
* Decimals of the currency\'s minor unit (2 for EUR)
|
|
26098
|
+
* @type {number}
|
|
26099
|
+
* @memberof SalesReportOrderTypesGroupDto
|
|
26100
|
+
*/
|
|
26101
|
+
'minorDigits': number;
|
|
26102
|
+
/**
|
|
26103
|
+
* Venue-app days of the period with sales but no order types yet (built before they were kept, until their backfill): their sales are in no type. 0 when every day has them
|
|
26104
|
+
* @type {number}
|
|
26105
|
+
* @memberof SalesReportOrderTypesGroupDto
|
|
26106
|
+
*/
|
|
26107
|
+
'daysWithoutOrderTypes': number;
|
|
26108
|
+
/**
|
|
26109
|
+
* Every order type, in the order eat_in, takeaway, delivery, unknown; a type nobody ordered answers zeros
|
|
26110
|
+
* @type {Array<SalesReportOrderTypeDto>}
|
|
26111
|
+
* @memberof SalesReportOrderTypesGroupDto
|
|
26112
|
+
*/
|
|
26113
|
+
'orderTypes': Array<SalesReportOrderTypeDto>;
|
|
26114
|
+
}
|
|
26115
|
+
/**
|
|
26116
|
+
*
|
|
26117
|
+
* @export
|
|
26118
|
+
* @interface SalesReportOrderTypesResponseDto
|
|
26119
|
+
*/
|
|
26120
|
+
export interface SalesReportOrderTypesResponseDto {
|
|
26121
|
+
/**
|
|
26122
|
+
* The first instant of the period, ISO 8601 in UTC
|
|
26123
|
+
* @type {string}
|
|
26124
|
+
* @memberof SalesReportOrderTypesResponseDto
|
|
26125
|
+
*/
|
|
26126
|
+
'reportDateStart': string;
|
|
26127
|
+
/**
|
|
26128
|
+
* The last instant of the period, ISO 8601 in UTC; now, when the period ends later
|
|
26129
|
+
* @type {string}
|
|
26130
|
+
* @memberof SalesReportOrderTypesResponseDto
|
|
26131
|
+
*/
|
|
26132
|
+
'reportDateEnd': string;
|
|
26133
|
+
/**
|
|
26134
|
+
* The IANA time zone the period\'s days are read in
|
|
26135
|
+
* @type {string}
|
|
26136
|
+
* @memberof SalesReportOrderTypesResponseDto
|
|
26137
|
+
*/
|
|
26138
|
+
'timezone': string;
|
|
26139
|
+
/**
|
|
26140
|
+
* The first business day, YYYY-MM-DD
|
|
26141
|
+
* @type {string}
|
|
26142
|
+
* @memberof SalesReportOrderTypesResponseDto
|
|
26143
|
+
*/
|
|
26144
|
+
'firstBusinessDay': string;
|
|
26145
|
+
/**
|
|
26146
|
+
* The last business day, YYYY-MM-DD, inclusive
|
|
26147
|
+
* @type {string}
|
|
26148
|
+
* @memberof SalesReportOrderTypesResponseDto
|
|
26149
|
+
*/
|
|
26150
|
+
'lastBusinessDay': string;
|
|
26151
|
+
/**
|
|
26152
|
+
* The newest BigQuery rebuild the rows read, ISO 8601 in UTC; null when none
|
|
26153
|
+
* @type {string}
|
|
26154
|
+
* @memberof SalesReportOrderTypesResponseDto
|
|
26155
|
+
*/
|
|
26156
|
+
'dataUntil': string | null;
|
|
26157
|
+
/**
|
|
26158
|
+
* One group per venue, app and currency the breakdown keeps
|
|
26159
|
+
* @type {Array<SalesReportOrderTypesGroupDto>}
|
|
26160
|
+
* @memberof SalesReportOrderTypesResponseDto
|
|
26161
|
+
*/
|
|
26162
|
+
'groups': Array<SalesReportOrderTypesGroupDto>;
|
|
26163
|
+
}
|
|
26164
|
+
/**
|
|
26165
|
+
*
|
|
26166
|
+
* @export
|
|
26167
|
+
* @interface SalesReportPairDto
|
|
26168
|
+
*/
|
|
26169
|
+
export interface SalesReportPairDto {
|
|
26170
|
+
/**
|
|
26171
|
+
*
|
|
26172
|
+
* @type {SalesReportPairDtoItemA}
|
|
26173
|
+
* @memberof SalesReportPairDto
|
|
26174
|
+
*/
|
|
26175
|
+
'itemA': SalesReportPairDtoItemA;
|
|
26176
|
+
/**
|
|
26177
|
+
*
|
|
26178
|
+
* @type {SalesReportPairDtoItemB}
|
|
26179
|
+
* @memberof SalesReportPairDto
|
|
26180
|
+
*/
|
|
26181
|
+
'itemB': SalesReportPairDtoItemB;
|
|
26182
|
+
/**
|
|
26183
|
+
* The period\'s orders with both items, each order once whatever the quantities. A lower bound when the group has daysWithPairsCut: a cut day kept only its top 25 pairs
|
|
26184
|
+
* @type {number}
|
|
26185
|
+
* @memberof SalesReportPairDto
|
|
26186
|
+
*/
|
|
26187
|
+
'orders': number;
|
|
26188
|
+
/**
|
|
26189
|
+
* Of the orders with itemA, the percent that also had itemB: orders / itemA.orders × 100, 2 decimals, half up
|
|
26190
|
+
* @type {number}
|
|
26191
|
+
* @memberof SalesReportPairDto
|
|
26192
|
+
*/
|
|
26193
|
+
'percentOfItemA': number;
|
|
26194
|
+
/**
|
|
26195
|
+
* Of the orders with itemB, the percent that also had itemA: orders / itemB.orders × 100, 2 decimals, half up
|
|
26196
|
+
* @type {number}
|
|
26197
|
+
* @memberof SalesReportPairDto
|
|
26198
|
+
*/
|
|
26199
|
+
'percentOfItemB': number;
|
|
26200
|
+
}
|
|
26201
|
+
/**
|
|
26202
|
+
* One item of the pair: the one whose key sorts first
|
|
26203
|
+
* @export
|
|
26204
|
+
* @interface SalesReportPairDtoItemA
|
|
26205
|
+
*/
|
|
26206
|
+
export interface SalesReportPairDtoItemA {
|
|
26207
|
+
/**
|
|
26208
|
+
* The item\'s key: the POS posId, the online product id
|
|
26209
|
+
* @type {string}
|
|
26210
|
+
* @memberof SalesReportPairDtoItemA
|
|
26211
|
+
*/
|
|
26212
|
+
'itemKey': string;
|
|
26213
|
+
/**
|
|
26214
|
+
* The item\'s least name over the period, as the sales report names it; null when none was recorded
|
|
26215
|
+
* @type {string}
|
|
26216
|
+
* @memberof SalesReportPairDtoItemA
|
|
26217
|
+
*/
|
|
26218
|
+
'name': string | null;
|
|
26219
|
+
/**
|
|
26220
|
+
* The period\'s orders with the item (as its own line, never as an option)
|
|
26221
|
+
* @type {number}
|
|
26222
|
+
* @memberof SalesReportPairDtoItemA
|
|
26223
|
+
*/
|
|
26224
|
+
'orders': number;
|
|
26225
|
+
}
|
|
26226
|
+
/**
|
|
26227
|
+
* The other item of the pair
|
|
26228
|
+
* @export
|
|
26229
|
+
* @interface SalesReportPairDtoItemB
|
|
26230
|
+
*/
|
|
26231
|
+
export interface SalesReportPairDtoItemB {
|
|
26232
|
+
/**
|
|
26233
|
+
* The item\'s key: the POS posId, the online product id
|
|
26234
|
+
* @type {string}
|
|
26235
|
+
* @memberof SalesReportPairDtoItemB
|
|
26236
|
+
*/
|
|
26237
|
+
'itemKey': string;
|
|
26238
|
+
/**
|
|
26239
|
+
* The item\'s least name over the period, as the sales report names it; null when none was recorded
|
|
26240
|
+
* @type {string}
|
|
26241
|
+
* @memberof SalesReportPairDtoItemB
|
|
26242
|
+
*/
|
|
26243
|
+
'name': string | null;
|
|
26244
|
+
/**
|
|
26245
|
+
* The period\'s orders with the item (as its own line, never as an option)
|
|
26246
|
+
* @type {number}
|
|
26247
|
+
* @memberof SalesReportPairDtoItemB
|
|
26248
|
+
*/
|
|
26249
|
+
'orders': number;
|
|
26250
|
+
}
|
|
26251
|
+
/**
|
|
26252
|
+
*
|
|
26253
|
+
* @export
|
|
26254
|
+
* @interface SalesReportPairItemDto
|
|
26255
|
+
*/
|
|
26256
|
+
export interface SalesReportPairItemDto {
|
|
26257
|
+
/**
|
|
26258
|
+
* The item\'s key: the POS posId, the online product id
|
|
26259
|
+
* @type {string}
|
|
26260
|
+
* @memberof SalesReportPairItemDto
|
|
26261
|
+
*/
|
|
26262
|
+
'itemKey': string;
|
|
26263
|
+
/**
|
|
26264
|
+
* The item\'s least name over the period, as the sales report names it; null when none was recorded
|
|
26265
|
+
* @type {string}
|
|
26266
|
+
* @memberof SalesReportPairItemDto
|
|
26267
|
+
*/
|
|
26268
|
+
'name': string | null;
|
|
26269
|
+
/**
|
|
26270
|
+
* The period\'s orders with the item (as its own line, never as an option)
|
|
26271
|
+
* @type {number}
|
|
26272
|
+
* @memberof SalesReportPairItemDto
|
|
26273
|
+
*/
|
|
26274
|
+
'orders': number;
|
|
26275
|
+
}
|
|
25535
26276
|
/**
|
|
25536
26277
|
*
|
|
25537
26278
|
* @export
|
|
@@ -25848,6 +26589,12 @@ export interface SalesReportResponseDto {
|
|
|
25848
26589
|
* @memberof SalesReportResponseDto
|
|
25849
26590
|
*/
|
|
25850
26591
|
'reports': Array<SalesReportGroupDto>;
|
|
26592
|
+
/**
|
|
26593
|
+
* The short report (GET /api/v6/report/sales/short), when the breakdown splits several venues or apps: their groups added together, one per currency, as breakdown none answers them (comparison and changes too), so the parts and their total come in one answer
|
|
26594
|
+
* @type {Array<SalesReportGroupDto>}
|
|
26595
|
+
* @memberof SalesReportResponseDto
|
|
26596
|
+
*/
|
|
26597
|
+
'totals'?: Array<SalesReportGroupDto>;
|
|
25851
26598
|
}
|
|
25852
26599
|
/**
|
|
25853
26600
|
*
|
|
@@ -25904,6 +26651,561 @@ export interface SalesReportSalesDto {
|
|
|
25904
26651
|
*/
|
|
25905
26652
|
'deliveryTax'?: number;
|
|
25906
26653
|
}
|
|
26654
|
+
/**
|
|
26655
|
+
*
|
|
26656
|
+
* @export
|
|
26657
|
+
* @interface SalesReportShortCategoryDto
|
|
26658
|
+
*/
|
|
26659
|
+
export interface SalesReportShortCategoryDto {
|
|
26660
|
+
/**
|
|
26661
|
+
* The category\'s name
|
|
26662
|
+
* @type {string}
|
|
26663
|
+
* @memberof SalesReportShortCategoryDto
|
|
26664
|
+
*/
|
|
26665
|
+
'categoryName': string;
|
|
26666
|
+
/**
|
|
26667
|
+
* How many of its items were sold
|
|
26668
|
+
* @type {number}
|
|
26669
|
+
* @memberof SalesReportShortCategoryDto
|
|
26670
|
+
*/
|
|
26671
|
+
'totalQuantity': number;
|
|
26672
|
+
/**
|
|
26673
|
+
* Sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
26674
|
+
* @type {number}
|
|
26675
|
+
* @memberof SalesReportShortCategoryDto
|
|
26676
|
+
*/
|
|
26677
|
+
'totalWithTax': number;
|
|
26678
|
+
/**
|
|
26679
|
+
* The VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
26680
|
+
* @type {number}
|
|
26681
|
+
* @memberof SalesReportShortCategoryDto
|
|
26682
|
+
*/
|
|
26683
|
+
'taxAmount': number;
|
|
26684
|
+
/**
|
|
26685
|
+
* Sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
26686
|
+
* @type {number}
|
|
26687
|
+
* @memberof SalesReportShortCategoryDto
|
|
26688
|
+
*/
|
|
26689
|
+
'totalWithoutTax': number;
|
|
26690
|
+
}
|
|
26691
|
+
/**
|
|
26692
|
+
*
|
|
26693
|
+
* @export
|
|
26694
|
+
* @interface SalesReportShortComparisonDto
|
|
26695
|
+
*/
|
|
26696
|
+
export interface SalesReportShortComparisonDto {
|
|
26697
|
+
/**
|
|
26698
|
+
* The first instant of the compared period, ISO 8601 in UTC
|
|
26699
|
+
* @type {string}
|
|
26700
|
+
* @memberof SalesReportShortComparisonDto
|
|
26701
|
+
*/
|
|
26702
|
+
'reportDateStart': string;
|
|
26703
|
+
/**
|
|
26704
|
+
* The last instant of the compared period, ISO 8601 in UTC; now, when the period ends later
|
|
26705
|
+
* @type {string}
|
|
26706
|
+
* @memberof SalesReportShortComparisonDto
|
|
26707
|
+
*/
|
|
26708
|
+
'reportDateEnd': string;
|
|
26709
|
+
/**
|
|
26710
|
+
* The first business day compared, YYYY-MM-DD, in the report\'s time zone
|
|
26711
|
+
* @type {string}
|
|
26712
|
+
* @memberof SalesReportShortComparisonDto
|
|
26713
|
+
*/
|
|
26714
|
+
'firstBusinessDay': string;
|
|
26715
|
+
/**
|
|
26716
|
+
* The last business day compared, YYYY-MM-DD, inclusive
|
|
26717
|
+
* @type {string}
|
|
26718
|
+
* @memberof SalesReportShortComparisonDto
|
|
26719
|
+
*/
|
|
26720
|
+
'lastBusinessDay': string;
|
|
26721
|
+
/**
|
|
26722
|
+
* compareSameTime only: the instant the compared last day was added up to, ISO 8601 in UTC: that day at the last full hour, on the report\'s clock, that both the daily rows and the hours have reached on the report\'s last day (a client says \"until 14:00\"). The report\'s own last day is cut at the same hour of its day, so both sides cover the same hours: the group\'s totals and dailyBreakdown of that day stop there too. Present when no venue and app of the group was compared whole that day (one that sold nothing that day counts as cut); absent when compareSameTime was not sent, the report\'s last day is over, or a venue\'s day had no hours yet and was compared whole. In a group of venues in several time zones each venue is cut at its own clock\'s hour of the same instant, which this names in the report\'s time zone
|
|
26723
|
+
* @type {string}
|
|
26724
|
+
* @memberof SalesReportShortComparisonDto
|
|
26725
|
+
*/
|
|
26726
|
+
'comparedUntil'?: string;
|
|
26727
|
+
/**
|
|
26728
|
+
*
|
|
26729
|
+
* @type {SalesReportComparisonDtoPaymentReport}
|
|
26730
|
+
* @memberof SalesReportShortComparisonDto
|
|
26731
|
+
*/
|
|
26732
|
+
'paymentReport'?: SalesReportComparisonDtoPaymentReport;
|
|
26733
|
+
/**
|
|
26734
|
+
* The compared period\'s days that sold, oldest first, as the group\'s own dailyBreakdown: present when it is
|
|
26735
|
+
* @type {Array<SalesReportDayDto>}
|
|
26736
|
+
* @memberof SalesReportShortComparisonDto
|
|
26737
|
+
*/
|
|
26738
|
+
'dailyBreakdown'?: Array<SalesReportDayDto>;
|
|
26739
|
+
/**
|
|
26740
|
+
* Part summary: how many orders were sold, the sum of dailyBreakdown[].orders. POS counts orders as the till does, so a split bill counts once; kiosk, storefront and mobile count each of their orders once. A group that adds apps together (breakdown none or venue) adds POS\'s count to the other apps\' counts. Wolt, Foodora and other platform orders are not included. Count orders with this, never with paymentReport.summary.totalCount, which counts payments. Left out without part summary
|
|
26741
|
+
* @type {number}
|
|
26742
|
+
* @memberof SalesReportShortComparisonDto
|
|
26743
|
+
*/
|
|
26744
|
+
'orderCount'?: number;
|
|
26745
|
+
/**
|
|
26746
|
+
* Part summary: what was paid, refunds taken off (paymentReport.summary.salesAndRevenue), divided by orderCount, rounded half up to the currency\'s minor digits, in the major unit of the group\'s currency (euros for EUR). Null when no order was sold, and then its change is left out of changes and changesFromBaseline. Left out without part summary
|
|
26747
|
+
* @type {number}
|
|
26748
|
+
* @memberof SalesReportShortComparisonDto
|
|
26749
|
+
*/
|
|
26750
|
+
'averageOrderValue'?: number | null;
|
|
26751
|
+
/**
|
|
26752
|
+
* The change of each total either period answers, in ReportChangeField\'s order; empty when part summary was not asked
|
|
26753
|
+
* @type {Array<SalesReportChangeDto>}
|
|
26754
|
+
* @memberof SalesReportShortComparisonDto
|
|
26755
|
+
*/
|
|
26756
|
+
'changes': Array<SalesReportChangeDto>;
|
|
26757
|
+
/**
|
|
26758
|
+
*
|
|
26759
|
+
* @type {SalesReportShortComparisonDtoSalesReport}
|
|
26760
|
+
* @memberof SalesReportShortComparisonDto
|
|
26761
|
+
*/
|
|
26762
|
+
'salesReport'?: SalesReportShortComparisonDtoSalesReport;
|
|
26763
|
+
}
|
|
26764
|
+
/**
|
|
26765
|
+
* The compared period\'s salesReport, short as the group\'s own: present when it is
|
|
26766
|
+
* @export
|
|
26767
|
+
* @interface SalesReportShortComparisonDtoSalesReport
|
|
26768
|
+
*/
|
|
26769
|
+
export interface SalesReportShortComparisonDtoSalesReport {
|
|
26770
|
+
/**
|
|
26771
|
+
* Part vat: one row per VAT rate, lowest first
|
|
26772
|
+
* @type {Array<SalesReportVatRateDto>}
|
|
26773
|
+
* @memberof SalesReportShortComparisonDtoSalesReport
|
|
26774
|
+
*/
|
|
26775
|
+
'taxSummary'?: Array<SalesReportVatRateDto>;
|
|
26776
|
+
/**
|
|
26777
|
+
* Part summary: how many items were sold
|
|
26778
|
+
* @type {number}
|
|
26779
|
+
* @memberof SalesReportShortComparisonDtoSalesReport
|
|
26780
|
+
*/
|
|
26781
|
+
'totalQuantity'?: number;
|
|
26782
|
+
/**
|
|
26783
|
+
* Part summary: sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
26784
|
+
* @type {number}
|
|
26785
|
+
* @memberof SalesReportShortComparisonDtoSalesReport
|
|
26786
|
+
*/
|
|
26787
|
+
'totalWithTax'?: number;
|
|
26788
|
+
/**
|
|
26789
|
+
* Part summary: the VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
26790
|
+
* @type {number}
|
|
26791
|
+
* @memberof SalesReportShortComparisonDtoSalesReport
|
|
26792
|
+
*/
|
|
26793
|
+
'totalTaxAmount'?: number;
|
|
26794
|
+
/**
|
|
26795
|
+
* Part summary: sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
26796
|
+
* @type {number}
|
|
26797
|
+
* @memberof SalesReportShortComparisonDtoSalesReport
|
|
26798
|
+
*/
|
|
26799
|
+
'totalWithoutTax'?: number;
|
|
26800
|
+
/**
|
|
26801
|
+
* Part summary, storefront and mobile: the delivery fees charged, in the major unit of the group\'s currency (euros for EUR); left out when none was
|
|
26802
|
+
* @type {number}
|
|
26803
|
+
* @memberof SalesReportShortComparisonDtoSalesReport
|
|
26804
|
+
*/
|
|
26805
|
+
'deliveryFee'?: number;
|
|
26806
|
+
/**
|
|
26807
|
+
* Part summary, with deliveryFee: the VAT of the delivery fees, in the major unit of the group\'s currency (euros for EUR)
|
|
26808
|
+
* @type {number}
|
|
26809
|
+
* @memberof SalesReportShortComparisonDtoSalesReport
|
|
26810
|
+
*/
|
|
26811
|
+
'deliveryTax'?: number;
|
|
26812
|
+
/**
|
|
26813
|
+
* Part items: each category\'s totals, without its items
|
|
26814
|
+
* @type {Array<SalesReportShortCategoryDto>}
|
|
26815
|
+
* @memberof SalesReportShortComparisonDtoSalesReport
|
|
26816
|
+
*/
|
|
26817
|
+
'categories'?: Array<SalesReportShortCategoryDto>;
|
|
26818
|
+
/**
|
|
26819
|
+
* Part items: the 10 items with the most sales with VAT, most first (then the most sold); an item in several categories is added up once
|
|
26820
|
+
* @type {Array<SalesReportTopItemDto>}
|
|
26821
|
+
* @memberof SalesReportShortComparisonDtoSalesReport
|
|
26822
|
+
*/
|
|
26823
|
+
'topItemsBySales'?: Array<SalesReportTopItemDto>;
|
|
26824
|
+
/**
|
|
26825
|
+
* Part items: the 10 items sold most often, most first (then the most sales); an item in several categories is added up once
|
|
26826
|
+
* @type {Array<SalesReportTopItemDto>}
|
|
26827
|
+
* @memberof SalesReportShortComparisonDtoSalesReport
|
|
26828
|
+
*/
|
|
26829
|
+
'topItemsByQuantity'?: Array<SalesReportTopItemDto>;
|
|
26830
|
+
}
|
|
26831
|
+
/**
|
|
26832
|
+
*
|
|
26833
|
+
* @export
|
|
26834
|
+
* @interface SalesReportShortGroupDto
|
|
26835
|
+
*/
|
|
26836
|
+
export interface SalesReportShortGroupDto {
|
|
26837
|
+
/**
|
|
26838
|
+
* The venue\'s business id; null when the breakdown adds venues together (none, app)
|
|
26839
|
+
* @type {object}
|
|
26840
|
+
* @memberof SalesReportShortGroupDto
|
|
26841
|
+
*/
|
|
26842
|
+
'businessId': object | null;
|
|
26843
|
+
/**
|
|
26844
|
+
*
|
|
26845
|
+
* @type {ReportApp}
|
|
26846
|
+
* @memberof SalesReportShortGroupDto
|
|
26847
|
+
*/
|
|
26848
|
+
'app': ReportApp | null;
|
|
26849
|
+
/**
|
|
26850
|
+
*
|
|
26851
|
+
* @type {CurrencyCode}
|
|
26852
|
+
* @memberof SalesReportShortGroupDto
|
|
26853
|
+
*/
|
|
26854
|
+
'currency': CurrencyCode;
|
|
26855
|
+
/**
|
|
26856
|
+
* The currency\'s ISO 4217 minor digits: EUR 2, ISK 0, BHD 3
|
|
26857
|
+
* @type {number}
|
|
26858
|
+
* @memberof SalesReportShortGroupDto
|
|
26859
|
+
*/
|
|
26860
|
+
'minorDigits': number;
|
|
26861
|
+
/**
|
|
26862
|
+
*
|
|
26863
|
+
* @type {SalesReportGroupDtoPaymentReport}
|
|
26864
|
+
* @memberof SalesReportShortGroupDto
|
|
26865
|
+
*/
|
|
26866
|
+
'paymentReport'?: SalesReportGroupDtoPaymentReport;
|
|
26867
|
+
/**
|
|
26868
|
+
* Part summary: one row per business day that sold, oldest first. POS leaves it out when no day sold
|
|
26869
|
+
* @type {Array<SalesReportDayDto>}
|
|
26870
|
+
* @memberof SalesReportShortGroupDto
|
|
26871
|
+
*/
|
|
26872
|
+
'dailyBreakdown'?: Array<SalesReportDayDto>;
|
|
26873
|
+
/**
|
|
26874
|
+
* Part summary: how many orders were sold, the sum of dailyBreakdown[].orders. POS counts orders as the till does, so a split bill counts once; kiosk, storefront and mobile count each of their orders once. A group that adds apps together (breakdown none or venue) adds POS\'s count to the other apps\' counts. Wolt, Foodora and other platform orders are not included. Count orders with this, never with paymentReport.summary.totalCount, which counts payments. Left out without part summary
|
|
26875
|
+
* @type {number}
|
|
26876
|
+
* @memberof SalesReportShortGroupDto
|
|
26877
|
+
*/
|
|
26878
|
+
'orderCount'?: number;
|
|
26879
|
+
/**
|
|
26880
|
+
* Part summary: what was paid, refunds taken off (paymentReport.summary.salesAndRevenue), divided by orderCount, rounded half up to the currency\'s minor digits, in the major unit of the group\'s currency (euros for EUR). Null when no order was sold, and then its change is left out of changes and changesFromBaseline. Left out without part summary
|
|
26881
|
+
* @type {number}
|
|
26882
|
+
* @memberof SalesReportShortGroupDto
|
|
26883
|
+
*/
|
|
26884
|
+
'averageOrderValue'?: number | null;
|
|
26885
|
+
/**
|
|
26886
|
+
* With baseline, every group but the baseline: the change of each total from the baseline group of the same currency (current: this group; previous: the baseline), of the main period only, worked out exactly
|
|
26887
|
+
* @type {Array<SalesReportChangeDto>}
|
|
26888
|
+
* @memberof SalesReportShortGroupDto
|
|
26889
|
+
*/
|
|
26890
|
+
'changesFromBaseline'?: Array<SalesReportChangeDto>;
|
|
26891
|
+
/**
|
|
26892
|
+
*
|
|
26893
|
+
* @type {ReportBaselineLeftOut}
|
|
26894
|
+
* @memberof SalesReportShortGroupDto
|
|
26895
|
+
*/
|
|
26896
|
+
'changesFromBaselineLeftOut'?: ReportBaselineLeftOut;
|
|
26897
|
+
/**
|
|
26898
|
+
*
|
|
26899
|
+
* @type {SalesReportShortGroupDtoSalesReport}
|
|
26900
|
+
* @memberof SalesReportShortGroupDto
|
|
26901
|
+
*/
|
|
26902
|
+
'salesReport'?: SalesReportShortGroupDtoSalesReport;
|
|
26903
|
+
/**
|
|
26904
|
+
*
|
|
26905
|
+
* @type {SalesReportShortGroupDtoComparison}
|
|
26906
|
+
* @memberof SalesReportShortGroupDto
|
|
26907
|
+
*/
|
|
26908
|
+
'comparison'?: SalesReportShortGroupDtoComparison;
|
|
26909
|
+
}
|
|
26910
|
+
/**
|
|
26911
|
+
* With compareStart and compareEnd: the same group\'s short report of those days and the change of each total
|
|
26912
|
+
* @export
|
|
26913
|
+
* @interface SalesReportShortGroupDtoComparison
|
|
26914
|
+
*/
|
|
26915
|
+
export interface SalesReportShortGroupDtoComparison {
|
|
26916
|
+
/**
|
|
26917
|
+
* The first instant of the compared period, ISO 8601 in UTC
|
|
26918
|
+
* @type {string}
|
|
26919
|
+
* @memberof SalesReportShortGroupDtoComparison
|
|
26920
|
+
*/
|
|
26921
|
+
'reportDateStart': string;
|
|
26922
|
+
/**
|
|
26923
|
+
* The last instant of the compared period, ISO 8601 in UTC; now, when the period ends later
|
|
26924
|
+
* @type {string}
|
|
26925
|
+
* @memberof SalesReportShortGroupDtoComparison
|
|
26926
|
+
*/
|
|
26927
|
+
'reportDateEnd': string;
|
|
26928
|
+
/**
|
|
26929
|
+
* The first business day compared, YYYY-MM-DD, in the report\'s time zone
|
|
26930
|
+
* @type {string}
|
|
26931
|
+
* @memberof SalesReportShortGroupDtoComparison
|
|
26932
|
+
*/
|
|
26933
|
+
'firstBusinessDay': string;
|
|
26934
|
+
/**
|
|
26935
|
+
* The last business day compared, YYYY-MM-DD, inclusive
|
|
26936
|
+
* @type {string}
|
|
26937
|
+
* @memberof SalesReportShortGroupDtoComparison
|
|
26938
|
+
*/
|
|
26939
|
+
'lastBusinessDay': string;
|
|
26940
|
+
/**
|
|
26941
|
+
* compareSameTime only: the instant the compared last day was added up to, ISO 8601 in UTC: that day at the last full hour, on the report\'s clock, that both the daily rows and the hours have reached on the report\'s last day (a client says \"until 14:00\"). The report\'s own last day is cut at the same hour of its day, so both sides cover the same hours: the group\'s totals and dailyBreakdown of that day stop there too. Present when no venue and app of the group was compared whole that day (one that sold nothing that day counts as cut); absent when compareSameTime was not sent, the report\'s last day is over, or a venue\'s day had no hours yet and was compared whole. In a group of venues in several time zones each venue is cut at its own clock\'s hour of the same instant, which this names in the report\'s time zone
|
|
26942
|
+
* @type {string}
|
|
26943
|
+
* @memberof SalesReportShortGroupDtoComparison
|
|
26944
|
+
*/
|
|
26945
|
+
'comparedUntil'?: string;
|
|
26946
|
+
/**
|
|
26947
|
+
*
|
|
26948
|
+
* @type {SalesReportComparisonDtoPaymentReport}
|
|
26949
|
+
* @memberof SalesReportShortGroupDtoComparison
|
|
26950
|
+
*/
|
|
26951
|
+
'paymentReport'?: SalesReportComparisonDtoPaymentReport;
|
|
26952
|
+
/**
|
|
26953
|
+
* The compared period\'s days that sold, oldest first, as the group\'s own dailyBreakdown: present when it is
|
|
26954
|
+
* @type {Array<SalesReportDayDto>}
|
|
26955
|
+
* @memberof SalesReportShortGroupDtoComparison
|
|
26956
|
+
*/
|
|
26957
|
+
'dailyBreakdown'?: Array<SalesReportDayDto>;
|
|
26958
|
+
/**
|
|
26959
|
+
* Part summary: how many orders were sold, the sum of dailyBreakdown[].orders. POS counts orders as the till does, so a split bill counts once; kiosk, storefront and mobile count each of their orders once. A group that adds apps together (breakdown none or venue) adds POS\'s count to the other apps\' counts. Wolt, Foodora and other platform orders are not included. Count orders with this, never with paymentReport.summary.totalCount, which counts payments. Left out without part summary
|
|
26960
|
+
* @type {number}
|
|
26961
|
+
* @memberof SalesReportShortGroupDtoComparison
|
|
26962
|
+
*/
|
|
26963
|
+
'orderCount'?: number;
|
|
26964
|
+
/**
|
|
26965
|
+
* Part summary: what was paid, refunds taken off (paymentReport.summary.salesAndRevenue), divided by orderCount, rounded half up to the currency\'s minor digits, in the major unit of the group\'s currency (euros for EUR). Null when no order was sold, and then its change is left out of changes and changesFromBaseline. Left out without part summary
|
|
26966
|
+
* @type {number}
|
|
26967
|
+
* @memberof SalesReportShortGroupDtoComparison
|
|
26968
|
+
*/
|
|
26969
|
+
'averageOrderValue'?: number | null;
|
|
26970
|
+
/**
|
|
26971
|
+
* The change of each total either period answers, in ReportChangeField\'s order; empty when part summary was not asked
|
|
26972
|
+
* @type {Array<SalesReportChangeDto>}
|
|
26973
|
+
* @memberof SalesReportShortGroupDtoComparison
|
|
26974
|
+
*/
|
|
26975
|
+
'changes': Array<SalesReportChangeDto>;
|
|
26976
|
+
/**
|
|
26977
|
+
*
|
|
26978
|
+
* @type {SalesReportShortComparisonDtoSalesReport}
|
|
26979
|
+
* @memberof SalesReportShortGroupDtoComparison
|
|
26980
|
+
*/
|
|
26981
|
+
'salesReport'?: SalesReportShortComparisonDtoSalesReport;
|
|
26982
|
+
}
|
|
26983
|
+
/**
|
|
26984
|
+
* The group\'s salesReport, short: present when part summary, items or vat was asked
|
|
26985
|
+
* @export
|
|
26986
|
+
* @interface SalesReportShortGroupDtoSalesReport
|
|
26987
|
+
*/
|
|
26988
|
+
export interface SalesReportShortGroupDtoSalesReport {
|
|
26989
|
+
/**
|
|
26990
|
+
* Part vat: one row per VAT rate, lowest first
|
|
26991
|
+
* @type {Array<SalesReportVatRateDto>}
|
|
26992
|
+
* @memberof SalesReportShortGroupDtoSalesReport
|
|
26993
|
+
*/
|
|
26994
|
+
'taxSummary'?: Array<SalesReportVatRateDto>;
|
|
26995
|
+
/**
|
|
26996
|
+
* Part summary: how many items were sold
|
|
26997
|
+
* @type {number}
|
|
26998
|
+
* @memberof SalesReportShortGroupDtoSalesReport
|
|
26999
|
+
*/
|
|
27000
|
+
'totalQuantity'?: number;
|
|
27001
|
+
/**
|
|
27002
|
+
* Part summary: sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
27003
|
+
* @type {number}
|
|
27004
|
+
* @memberof SalesReportShortGroupDtoSalesReport
|
|
27005
|
+
*/
|
|
27006
|
+
'totalWithTax'?: number;
|
|
27007
|
+
/**
|
|
27008
|
+
* Part summary: the VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
27009
|
+
* @type {number}
|
|
27010
|
+
* @memberof SalesReportShortGroupDtoSalesReport
|
|
27011
|
+
*/
|
|
27012
|
+
'totalTaxAmount'?: number;
|
|
27013
|
+
/**
|
|
27014
|
+
* Part summary: sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
27015
|
+
* @type {number}
|
|
27016
|
+
* @memberof SalesReportShortGroupDtoSalesReport
|
|
27017
|
+
*/
|
|
27018
|
+
'totalWithoutTax'?: number;
|
|
27019
|
+
/**
|
|
27020
|
+
* Part summary, storefront and mobile: the delivery fees charged, in the major unit of the group\'s currency (euros for EUR); left out when none was
|
|
27021
|
+
* @type {number}
|
|
27022
|
+
* @memberof SalesReportShortGroupDtoSalesReport
|
|
27023
|
+
*/
|
|
27024
|
+
'deliveryFee'?: number;
|
|
27025
|
+
/**
|
|
27026
|
+
* Part summary, with deliveryFee: the VAT of the delivery fees, in the major unit of the group\'s currency (euros for EUR)
|
|
27027
|
+
* @type {number}
|
|
27028
|
+
* @memberof SalesReportShortGroupDtoSalesReport
|
|
27029
|
+
*/
|
|
27030
|
+
'deliveryTax'?: number;
|
|
27031
|
+
/**
|
|
27032
|
+
* Part items: each category\'s totals, without its items
|
|
27033
|
+
* @type {Array<SalesReportShortCategoryDto>}
|
|
27034
|
+
* @memberof SalesReportShortGroupDtoSalesReport
|
|
27035
|
+
*/
|
|
27036
|
+
'categories'?: Array<SalesReportShortCategoryDto>;
|
|
27037
|
+
/**
|
|
27038
|
+
* Part items: the 10 items with the most sales with VAT, most first (then the most sold); an item in several categories is added up once
|
|
27039
|
+
* @type {Array<SalesReportTopItemDto>}
|
|
27040
|
+
* @memberof SalesReportShortGroupDtoSalesReport
|
|
27041
|
+
*/
|
|
27042
|
+
'topItemsBySales'?: Array<SalesReportTopItemDto>;
|
|
27043
|
+
/**
|
|
27044
|
+
* Part items: the 10 items sold most often, most first (then the most sales); an item in several categories is added up once
|
|
27045
|
+
* @type {Array<SalesReportTopItemDto>}
|
|
27046
|
+
* @memberof SalesReportShortGroupDtoSalesReport
|
|
27047
|
+
*/
|
|
27048
|
+
'topItemsByQuantity'?: Array<SalesReportTopItemDto>;
|
|
27049
|
+
}
|
|
27050
|
+
/**
|
|
27051
|
+
*
|
|
27052
|
+
* @export
|
|
27053
|
+
* @interface SalesReportShortResponseDto
|
|
27054
|
+
*/
|
|
27055
|
+
export interface SalesReportShortResponseDto {
|
|
27056
|
+
/**
|
|
27057
|
+
* The first instant of the period, ISO 8601 in UTC
|
|
27058
|
+
* @type {string}
|
|
27059
|
+
* @memberof SalesReportShortResponseDto
|
|
27060
|
+
*/
|
|
27061
|
+
'reportDateStart': string;
|
|
27062
|
+
/**
|
|
27063
|
+
* The last instant of the period, ISO 8601 in UTC; now, when the period ends later
|
|
27064
|
+
* @type {string}
|
|
27065
|
+
* @memberof SalesReportShortResponseDto
|
|
27066
|
+
*/
|
|
27067
|
+
'reportDateEnd': string;
|
|
27068
|
+
/**
|
|
27069
|
+
* When the report was answered, ISO 8601 in UTC
|
|
27070
|
+
* @type {string}
|
|
27071
|
+
* @memberof SalesReportShortResponseDto
|
|
27072
|
+
*/
|
|
27073
|
+
'reportGeneratedAt': string;
|
|
27074
|
+
/**
|
|
27075
|
+
* The time zone the period was read in: the request\'s, or else the first venue\'s
|
|
27076
|
+
* @type {string}
|
|
27077
|
+
* @memberof SalesReportShortResponseDto
|
|
27078
|
+
*/
|
|
27079
|
+
'timezone': string;
|
|
27080
|
+
/**
|
|
27081
|
+
* The first business day added up, YYYY-MM-DD; each venue\'s rows of that date in its own zone
|
|
27082
|
+
* @type {string}
|
|
27083
|
+
* @memberof SalesReportShortResponseDto
|
|
27084
|
+
*/
|
|
27085
|
+
'firstBusinessDay': string;
|
|
27086
|
+
/**
|
|
27087
|
+
* The last business day added up, YYYY-MM-DD, inclusive
|
|
27088
|
+
* @type {string}
|
|
27089
|
+
* @memberof SalesReportShortResponseDto
|
|
27090
|
+
*/
|
|
27091
|
+
'lastBusinessDay': string;
|
|
27092
|
+
/**
|
|
27093
|
+
* When the newest daily rows this report reads were rebuilt; a sale after it may not be counted yet (they are rebuilt every 5 minutes). Null when none were ever loaded
|
|
27094
|
+
* @type {object}
|
|
27095
|
+
* @memberof SalesReportShortResponseDto
|
|
27096
|
+
*/
|
|
27097
|
+
'dataUntil': object | null;
|
|
27098
|
+
/**
|
|
27099
|
+
* One group per venue, app and currency the breakdown keeps, as GET /api/v6/report/sales answers them, short
|
|
27100
|
+
* @type {Array<SalesReportShortGroupDto>}
|
|
27101
|
+
* @memberof SalesReportShortResponseDto
|
|
27102
|
+
*/
|
|
27103
|
+
'reports': Array<SalesReportShortGroupDto>;
|
|
27104
|
+
/**
|
|
27105
|
+
* When the breakdown splits several venues or apps: their groups added together, one per currency, short
|
|
27106
|
+
* @type {Array<SalesReportShortGroupDto>}
|
|
27107
|
+
* @memberof SalesReportShortResponseDto
|
|
27108
|
+
*/
|
|
27109
|
+
'totals'?: Array<SalesReportShortGroupDto>;
|
|
27110
|
+
}
|
|
27111
|
+
/**
|
|
27112
|
+
*
|
|
27113
|
+
* @export
|
|
27114
|
+
* @interface SalesReportShortSalesDto
|
|
27115
|
+
*/
|
|
27116
|
+
export interface SalesReportShortSalesDto {
|
|
27117
|
+
/**
|
|
27118
|
+
* Part vat: one row per VAT rate, lowest first
|
|
27119
|
+
* @type {Array<SalesReportVatRateDto>}
|
|
27120
|
+
* @memberof SalesReportShortSalesDto
|
|
27121
|
+
*/
|
|
27122
|
+
'taxSummary'?: Array<SalesReportVatRateDto>;
|
|
27123
|
+
/**
|
|
27124
|
+
* Part summary: how many items were sold
|
|
27125
|
+
* @type {number}
|
|
27126
|
+
* @memberof SalesReportShortSalesDto
|
|
27127
|
+
*/
|
|
27128
|
+
'totalQuantity'?: number;
|
|
27129
|
+
/**
|
|
27130
|
+
* Part summary: sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
27131
|
+
* @type {number}
|
|
27132
|
+
* @memberof SalesReportShortSalesDto
|
|
27133
|
+
*/
|
|
27134
|
+
'totalWithTax'?: number;
|
|
27135
|
+
/**
|
|
27136
|
+
* Part summary: the VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
27137
|
+
* @type {number}
|
|
27138
|
+
* @memberof SalesReportShortSalesDto
|
|
27139
|
+
*/
|
|
27140
|
+
'totalTaxAmount'?: number;
|
|
27141
|
+
/**
|
|
27142
|
+
* Part summary: sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
27143
|
+
* @type {number}
|
|
27144
|
+
* @memberof SalesReportShortSalesDto
|
|
27145
|
+
*/
|
|
27146
|
+
'totalWithoutTax'?: number;
|
|
27147
|
+
/**
|
|
27148
|
+
* Part summary, storefront and mobile: the delivery fees charged, in the major unit of the group\'s currency (euros for EUR); left out when none was
|
|
27149
|
+
* @type {number}
|
|
27150
|
+
* @memberof SalesReportShortSalesDto
|
|
27151
|
+
*/
|
|
27152
|
+
'deliveryFee'?: number;
|
|
27153
|
+
/**
|
|
27154
|
+
* Part summary, with deliveryFee: the VAT of the delivery fees, in the major unit of the group\'s currency (euros for EUR)
|
|
27155
|
+
* @type {number}
|
|
27156
|
+
* @memberof SalesReportShortSalesDto
|
|
27157
|
+
*/
|
|
27158
|
+
'deliveryTax'?: number;
|
|
27159
|
+
/**
|
|
27160
|
+
* Part items: each category\'s totals, without its items
|
|
27161
|
+
* @type {Array<SalesReportShortCategoryDto>}
|
|
27162
|
+
* @memberof SalesReportShortSalesDto
|
|
27163
|
+
*/
|
|
27164
|
+
'categories'?: Array<SalesReportShortCategoryDto>;
|
|
27165
|
+
/**
|
|
27166
|
+
* Part items: the 10 items with the most sales with VAT, most first (then the most sold); an item in several categories is added up once
|
|
27167
|
+
* @type {Array<SalesReportTopItemDto>}
|
|
27168
|
+
* @memberof SalesReportShortSalesDto
|
|
27169
|
+
*/
|
|
27170
|
+
'topItemsBySales'?: Array<SalesReportTopItemDto>;
|
|
27171
|
+
/**
|
|
27172
|
+
* Part items: the 10 items sold most often, most first (then the most sales); an item in several categories is added up once
|
|
27173
|
+
* @type {Array<SalesReportTopItemDto>}
|
|
27174
|
+
* @memberof SalesReportShortSalesDto
|
|
27175
|
+
*/
|
|
27176
|
+
'topItemsByQuantity'?: Array<SalesReportTopItemDto>;
|
|
27177
|
+
}
|
|
27178
|
+
/**
|
|
27179
|
+
*
|
|
27180
|
+
* @export
|
|
27181
|
+
* @interface SalesReportTopItemDto
|
|
27182
|
+
*/
|
|
27183
|
+
export interface SalesReportTopItemDto {
|
|
27184
|
+
/**
|
|
27185
|
+
* The item\'s name, as the full report names it; items of the same name in several categories are one. Null when the sale carried no name: such an item is its product id, and one with neither is listed alone
|
|
27186
|
+
* @type {object}
|
|
27187
|
+
* @memberof SalesReportTopItemDto
|
|
27188
|
+
*/
|
|
27189
|
+
'name': object | null;
|
|
27190
|
+
/**
|
|
27191
|
+
* The categories it sold in
|
|
27192
|
+
* @type {Array<string>}
|
|
27193
|
+
* @memberof SalesReportTopItemDto
|
|
27194
|
+
*/
|
|
27195
|
+
'categoryNames': Array<string>;
|
|
27196
|
+
/**
|
|
27197
|
+
* How many were sold, in every category
|
|
27198
|
+
* @type {number}
|
|
27199
|
+
* @memberof SalesReportTopItemDto
|
|
27200
|
+
*/
|
|
27201
|
+
'quantity': number;
|
|
27202
|
+
/**
|
|
27203
|
+
* Sales with VAT, in every category, in the major unit of the group\'s currency (euros for EUR), rounded to its minor digits
|
|
27204
|
+
* @type {number}
|
|
27205
|
+
* @memberof SalesReportTopItemDto
|
|
27206
|
+
*/
|
|
27207
|
+
'totalWithTax': number;
|
|
27208
|
+
}
|
|
25907
27209
|
/**
|
|
25908
27210
|
*
|
|
25909
27211
|
* @export
|
|
@@ -26038,6 +27340,50 @@ export interface SalesSummaryDtoV2 {
|
|
|
26038
27340
|
*/
|
|
26039
27341
|
'totalSurchargeAmount': number;
|
|
26040
27342
|
}
|
|
27343
|
+
/**
|
|
27344
|
+
*
|
|
27345
|
+
* @export
|
|
27346
|
+
* @interface SaveAnalyticsDashboardDto
|
|
27347
|
+
*/
|
|
27348
|
+
export interface SaveAnalyticsDashboardDto {
|
|
27349
|
+
/**
|
|
27350
|
+
* The cards in the order they are shown, first card first; at most 60. An empty list saves an empty dashboard.
|
|
27351
|
+
* @type {Array<AnalyticsDashboardCardDto>}
|
|
27352
|
+
* @memberof SaveAnalyticsDashboardDto
|
|
27353
|
+
*/
|
|
27354
|
+
'cards': Array<AnalyticsDashboardCardDto>;
|
|
27355
|
+
/**
|
|
27356
|
+
*
|
|
27357
|
+
* @type {SaveAnalyticsDashboardDtoGoals}
|
|
27358
|
+
* @memberof SaveAnalyticsDashboardDto
|
|
27359
|
+
*/
|
|
27360
|
+
'goals': SaveAnalyticsDashboardDtoGoals;
|
|
27361
|
+
/**
|
|
27362
|
+
* The version the dashboard was read at, from its GET. Absent or null only to create the first dashboard; answered 409 when someone saved since, or when one already exists.
|
|
27363
|
+
* @type {number}
|
|
27364
|
+
* @memberof SaveAnalyticsDashboardDto
|
|
27365
|
+
*/
|
|
27366
|
+
'expectedVersion'?: number | null;
|
|
27367
|
+
}
|
|
27368
|
+
/**
|
|
27369
|
+
* The sales goals the cards measure against; an empty object saves none.
|
|
27370
|
+
* @export
|
|
27371
|
+
* @interface SaveAnalyticsDashboardDtoGoals
|
|
27372
|
+
*/
|
|
27373
|
+
export interface SaveAnalyticsDashboardDtoGoals {
|
|
27374
|
+
/**
|
|
27375
|
+
* The day\'s sales goal, a whole number in the minor unit of the store\'s currency (cents for EUR). Absent: no day goal.
|
|
27376
|
+
* @type {number}
|
|
27377
|
+
* @memberof SaveAnalyticsDashboardDtoGoals
|
|
27378
|
+
*/
|
|
27379
|
+
'daySales'?: number;
|
|
27380
|
+
/**
|
|
27381
|
+
* The month\'s sales goal, a whole number in the minor unit of the store\'s currency (cents for EUR). Absent: no month goal.
|
|
27382
|
+
* @type {number}
|
|
27383
|
+
* @memberof SaveAnalyticsDashboardDtoGoals
|
|
27384
|
+
*/
|
|
27385
|
+
'monthSales'?: number;
|
|
27386
|
+
}
|
|
26041
27387
|
/**
|
|
26042
27388
|
*
|
|
26043
27389
|
* @export
|
|
@@ -30617,6 +31963,12 @@ export interface UnifiedProductDto {
|
|
|
30617
31963
|
* @memberof UnifiedProductDto
|
|
30618
31964
|
*/
|
|
30619
31965
|
'options': Array<UnifiedOptionDto>;
|
|
31966
|
+
/**
|
|
31967
|
+
* Every ingredient shown on the guest\'s card for this product, kept (removed false) and removed, in the card\'s order. Absent only when no card was shown.
|
|
31968
|
+
* @type {Array<OrderIngredientDto>}
|
|
31969
|
+
* @memberof UnifiedProductDto
|
|
31970
|
+
*/
|
|
31971
|
+
'ingredients'?: Array<OrderIngredientDto>;
|
|
30620
31972
|
}
|
|
30621
31973
|
/**
|
|
30622
31974
|
*
|
|
@@ -35671,6 +37023,217 @@ export declare class ActionPasscodesApi extends BaseAPI implements ActionPasscod
|
|
|
35671
37023
|
*/
|
|
35672
37024
|
checkActionPasscode(businessId: number, xPosPin: string, checkActionPasscodeDto: CheckActionPasscodeDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ActionPasscodeCheckResponseDto, any, {}>>;
|
|
35673
37025
|
}
|
|
37026
|
+
/**
|
|
37027
|
+
* AnalyticsDashboardsApi - axios parameter creator
|
|
37028
|
+
* @export
|
|
37029
|
+
*/
|
|
37030
|
+
export declare const AnalyticsDashboardsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
37031
|
+
/**
|
|
37032
|
+
* The organisation\'s saved cards and sales goals for its All stores view, shared by its management and everyone working at one of its stores. 404 when none is saved yet. Asks the licence server who the person is in the organisation on every call.
|
|
37033
|
+
* @summary Read an organisation\'s Analytics dashboard
|
|
37034
|
+
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
37035
|
+
* @param {*} [options] Override http request option.
|
|
37036
|
+
* @throws {RequiredError}
|
|
37037
|
+
*/
|
|
37038
|
+
getOrganisationAnalyticsDashboard: (groupId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37039
|
+
/**
|
|
37040
|
+
* The store\'s saved cards and sales goals, shared by everyone who can see the store. 404 when none is saved yet. Read from the database every time.
|
|
37041
|
+
* @summary Read a store\'s Analytics dashboard
|
|
37042
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
37043
|
+
* @param {*} [options] Override http request option.
|
|
37044
|
+
* @throws {RequiredError}
|
|
37045
|
+
*/
|
|
37046
|
+
getStoreAnalyticsDashboard: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37047
|
+
/**
|
|
37048
|
+
* Saves the cards, in order, and the sales goals of the organisation\'s All stores view, replacing what was saved. The first save, without expectedVersion, creates it; every later one sends the version it read, and loses with 409 when someone saved since. Only the organisation\'s management may save.
|
|
37049
|
+
* @summary Replace an organisation\'s Analytics dashboard
|
|
37050
|
+
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
37051
|
+
* @param {SaveAnalyticsDashboardDto} saveAnalyticsDashboardDto
|
|
37052
|
+
* @param {*} [options] Override http request option.
|
|
37053
|
+
* @throws {RequiredError}
|
|
37054
|
+
*/
|
|
37055
|
+
saveOrganisationAnalyticsDashboard: (groupId: string, saveAnalyticsDashboardDto: SaveAnalyticsDashboardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37056
|
+
/**
|
|
37057
|
+
* Saves the cards, in order, and the sales goals, replacing what was saved. The first save, without expectedVersion, creates it; every later one sends the version it read, and loses with 409 when someone saved since. Only the store\'s managers and its organisation\'s management may save, read from the licence server at each save.
|
|
37058
|
+
* @summary Replace a store\'s Analytics dashboard
|
|
37059
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
37060
|
+
* @param {SaveAnalyticsDashboardDto} saveAnalyticsDashboardDto
|
|
37061
|
+
* @param {*} [options] Override http request option.
|
|
37062
|
+
* @throws {RequiredError}
|
|
37063
|
+
*/
|
|
37064
|
+
saveStoreAnalyticsDashboard: (businessId: number, saveAnalyticsDashboardDto: SaveAnalyticsDashboardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37065
|
+
};
|
|
37066
|
+
/**
|
|
37067
|
+
* AnalyticsDashboardsApi - functional programming interface
|
|
37068
|
+
* @export
|
|
37069
|
+
*/
|
|
37070
|
+
export declare const AnalyticsDashboardsApiFp: (configuration?: Configuration) => {
|
|
37071
|
+
/**
|
|
37072
|
+
* The organisation\'s saved cards and sales goals for its All stores view, shared by its management and everyone working at one of its stores. 404 when none is saved yet. Asks the licence server who the person is in the organisation on every call.
|
|
37073
|
+
* @summary Read an organisation\'s Analytics dashboard
|
|
37074
|
+
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
37075
|
+
* @param {*} [options] Override http request option.
|
|
37076
|
+
* @throws {RequiredError}
|
|
37077
|
+
*/
|
|
37078
|
+
getOrganisationAnalyticsDashboard(groupId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsDashboardResponseDto>>;
|
|
37079
|
+
/**
|
|
37080
|
+
* The store\'s saved cards and sales goals, shared by everyone who can see the store. 404 when none is saved yet. Read from the database every time.
|
|
37081
|
+
* @summary Read a store\'s Analytics dashboard
|
|
37082
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
37083
|
+
* @param {*} [options] Override http request option.
|
|
37084
|
+
* @throws {RequiredError}
|
|
37085
|
+
*/
|
|
37086
|
+
getStoreAnalyticsDashboard(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsDashboardResponseDto>>;
|
|
37087
|
+
/**
|
|
37088
|
+
* Saves the cards, in order, and the sales goals of the organisation\'s All stores view, replacing what was saved. The first save, without expectedVersion, creates it; every later one sends the version it read, and loses with 409 when someone saved since. Only the organisation\'s management may save.
|
|
37089
|
+
* @summary Replace an organisation\'s Analytics dashboard
|
|
37090
|
+
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
37091
|
+
* @param {SaveAnalyticsDashboardDto} saveAnalyticsDashboardDto
|
|
37092
|
+
* @param {*} [options] Override http request option.
|
|
37093
|
+
* @throws {RequiredError}
|
|
37094
|
+
*/
|
|
37095
|
+
saveOrganisationAnalyticsDashboard(groupId: string, saveAnalyticsDashboardDto: SaveAnalyticsDashboardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsDashboardResponseDto>>;
|
|
37096
|
+
/**
|
|
37097
|
+
* Saves the cards, in order, and the sales goals, replacing what was saved. The first save, without expectedVersion, creates it; every later one sends the version it read, and loses with 409 when someone saved since. Only the store\'s managers and its organisation\'s management may save, read from the licence server at each save.
|
|
37098
|
+
* @summary Replace a store\'s Analytics dashboard
|
|
37099
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
37100
|
+
* @param {SaveAnalyticsDashboardDto} saveAnalyticsDashboardDto
|
|
37101
|
+
* @param {*} [options] Override http request option.
|
|
37102
|
+
* @throws {RequiredError}
|
|
37103
|
+
*/
|
|
37104
|
+
saveStoreAnalyticsDashboard(businessId: number, saveAnalyticsDashboardDto: SaveAnalyticsDashboardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsDashboardResponseDto>>;
|
|
37105
|
+
};
|
|
37106
|
+
/**
|
|
37107
|
+
* AnalyticsDashboardsApi - factory interface
|
|
37108
|
+
* @export
|
|
37109
|
+
*/
|
|
37110
|
+
export declare const AnalyticsDashboardsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
37111
|
+
/**
|
|
37112
|
+
* The organisation\'s saved cards and sales goals for its All stores view, shared by its management and everyone working at one of its stores. 404 when none is saved yet. Asks the licence server who the person is in the organisation on every call.
|
|
37113
|
+
* @summary Read an organisation\'s Analytics dashboard
|
|
37114
|
+
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
37115
|
+
* @param {*} [options] Override http request option.
|
|
37116
|
+
* @throws {RequiredError}
|
|
37117
|
+
*/
|
|
37118
|
+
getOrganisationAnalyticsDashboard(groupId: string, options?: any): AxiosPromise<AnalyticsDashboardResponseDto>;
|
|
37119
|
+
/**
|
|
37120
|
+
* The store\'s saved cards and sales goals, shared by everyone who can see the store. 404 when none is saved yet. Read from the database every time.
|
|
37121
|
+
* @summary Read a store\'s Analytics dashboard
|
|
37122
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
37123
|
+
* @param {*} [options] Override http request option.
|
|
37124
|
+
* @throws {RequiredError}
|
|
37125
|
+
*/
|
|
37126
|
+
getStoreAnalyticsDashboard(businessId: number, options?: any): AxiosPromise<AnalyticsDashboardResponseDto>;
|
|
37127
|
+
/**
|
|
37128
|
+
* Saves the cards, in order, and the sales goals of the organisation\'s All stores view, replacing what was saved. The first save, without expectedVersion, creates it; every later one sends the version it read, and loses with 409 when someone saved since. Only the organisation\'s management may save.
|
|
37129
|
+
* @summary Replace an organisation\'s Analytics dashboard
|
|
37130
|
+
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
37131
|
+
* @param {SaveAnalyticsDashboardDto} saveAnalyticsDashboardDto
|
|
37132
|
+
* @param {*} [options] Override http request option.
|
|
37133
|
+
* @throws {RequiredError}
|
|
37134
|
+
*/
|
|
37135
|
+
saveOrganisationAnalyticsDashboard(groupId: string, saveAnalyticsDashboardDto: SaveAnalyticsDashboardDto, options?: any): AxiosPromise<AnalyticsDashboardResponseDto>;
|
|
37136
|
+
/**
|
|
37137
|
+
* Saves the cards, in order, and the sales goals, replacing what was saved. The first save, without expectedVersion, creates it; every later one sends the version it read, and loses with 409 when someone saved since. Only the store\'s managers and its organisation\'s management may save, read from the licence server at each save.
|
|
37138
|
+
* @summary Replace a store\'s Analytics dashboard
|
|
37139
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
37140
|
+
* @param {SaveAnalyticsDashboardDto} saveAnalyticsDashboardDto
|
|
37141
|
+
* @param {*} [options] Override http request option.
|
|
37142
|
+
* @throws {RequiredError}
|
|
37143
|
+
*/
|
|
37144
|
+
saveStoreAnalyticsDashboard(businessId: number, saveAnalyticsDashboardDto: SaveAnalyticsDashboardDto, options?: any): AxiosPromise<AnalyticsDashboardResponseDto>;
|
|
37145
|
+
};
|
|
37146
|
+
/**
|
|
37147
|
+
* AnalyticsDashboardsApi - interface
|
|
37148
|
+
* @export
|
|
37149
|
+
* @interface AnalyticsDashboardsApi
|
|
37150
|
+
*/
|
|
37151
|
+
export interface AnalyticsDashboardsApiInterface {
|
|
37152
|
+
/**
|
|
37153
|
+
* The organisation\'s saved cards and sales goals for its All stores view, shared by its management and everyone working at one of its stores. 404 when none is saved yet. Asks the licence server who the person is in the organisation on every call.
|
|
37154
|
+
* @summary Read an organisation\'s Analytics dashboard
|
|
37155
|
+
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
37156
|
+
* @param {*} [options] Override http request option.
|
|
37157
|
+
* @throws {RequiredError}
|
|
37158
|
+
* @memberof AnalyticsDashboardsApiInterface
|
|
37159
|
+
*/
|
|
37160
|
+
getOrganisationAnalyticsDashboard(groupId: string, options?: AxiosRequestConfig): AxiosPromise<AnalyticsDashboardResponseDto>;
|
|
37161
|
+
/**
|
|
37162
|
+
* The store\'s saved cards and sales goals, shared by everyone who can see the store. 404 when none is saved yet. Read from the database every time.
|
|
37163
|
+
* @summary Read a store\'s Analytics dashboard
|
|
37164
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
37165
|
+
* @param {*} [options] Override http request option.
|
|
37166
|
+
* @throws {RequiredError}
|
|
37167
|
+
* @memberof AnalyticsDashboardsApiInterface
|
|
37168
|
+
*/
|
|
37169
|
+
getStoreAnalyticsDashboard(businessId: number, options?: AxiosRequestConfig): AxiosPromise<AnalyticsDashboardResponseDto>;
|
|
37170
|
+
/**
|
|
37171
|
+
* Saves the cards, in order, and the sales goals of the organisation\'s All stores view, replacing what was saved. The first save, without expectedVersion, creates it; every later one sends the version it read, and loses with 409 when someone saved since. Only the organisation\'s management may save.
|
|
37172
|
+
* @summary Replace an organisation\'s Analytics dashboard
|
|
37173
|
+
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
37174
|
+
* @param {SaveAnalyticsDashboardDto} saveAnalyticsDashboardDto
|
|
37175
|
+
* @param {*} [options] Override http request option.
|
|
37176
|
+
* @throws {RequiredError}
|
|
37177
|
+
* @memberof AnalyticsDashboardsApiInterface
|
|
37178
|
+
*/
|
|
37179
|
+
saveOrganisationAnalyticsDashboard(groupId: string, saveAnalyticsDashboardDto: SaveAnalyticsDashboardDto, options?: AxiosRequestConfig): AxiosPromise<AnalyticsDashboardResponseDto>;
|
|
37180
|
+
/**
|
|
37181
|
+
* Saves the cards, in order, and the sales goals, replacing what was saved. The first save, without expectedVersion, creates it; every later one sends the version it read, and loses with 409 when someone saved since. Only the store\'s managers and its organisation\'s management may save, read from the licence server at each save.
|
|
37182
|
+
* @summary Replace a store\'s Analytics dashboard
|
|
37183
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
37184
|
+
* @param {SaveAnalyticsDashboardDto} saveAnalyticsDashboardDto
|
|
37185
|
+
* @param {*} [options] Override http request option.
|
|
37186
|
+
* @throws {RequiredError}
|
|
37187
|
+
* @memberof AnalyticsDashboardsApiInterface
|
|
37188
|
+
*/
|
|
37189
|
+
saveStoreAnalyticsDashboard(businessId: number, saveAnalyticsDashboardDto: SaveAnalyticsDashboardDto, options?: AxiosRequestConfig): AxiosPromise<AnalyticsDashboardResponseDto>;
|
|
37190
|
+
}
|
|
37191
|
+
/**
|
|
37192
|
+
* AnalyticsDashboardsApi - object-oriented interface
|
|
37193
|
+
* @export
|
|
37194
|
+
* @class AnalyticsDashboardsApi
|
|
37195
|
+
* @extends {BaseAPI}
|
|
37196
|
+
*/
|
|
37197
|
+
export declare class AnalyticsDashboardsApi extends BaseAPI implements AnalyticsDashboardsApiInterface {
|
|
37198
|
+
/**
|
|
37199
|
+
* The organisation\'s saved cards and sales goals for its All stores view, shared by its management and everyone working at one of its stores. 404 when none is saved yet. Asks the licence server who the person is in the organisation on every call.
|
|
37200
|
+
* @summary Read an organisation\'s Analytics dashboard
|
|
37201
|
+
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
37202
|
+
* @param {*} [options] Override http request option.
|
|
37203
|
+
* @throws {RequiredError}
|
|
37204
|
+
* @memberof AnalyticsDashboardsApi
|
|
37205
|
+
*/
|
|
37206
|
+
getOrganisationAnalyticsDashboard(groupId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AnalyticsDashboardResponseDto, any, {}>>;
|
|
37207
|
+
/**
|
|
37208
|
+
* The store\'s saved cards and sales goals, shared by everyone who can see the store. 404 when none is saved yet. Read from the database every time.
|
|
37209
|
+
* @summary Read a store\'s Analytics dashboard
|
|
37210
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
37211
|
+
* @param {*} [options] Override http request option.
|
|
37212
|
+
* @throws {RequiredError}
|
|
37213
|
+
* @memberof AnalyticsDashboardsApi
|
|
37214
|
+
*/
|
|
37215
|
+
getStoreAnalyticsDashboard(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AnalyticsDashboardResponseDto, any, {}>>;
|
|
37216
|
+
/**
|
|
37217
|
+
* Saves the cards, in order, and the sales goals of the organisation\'s All stores view, replacing what was saved. The first save, without expectedVersion, creates it; every later one sends the version it read, and loses with 409 when someone saved since. Only the organisation\'s management may save.
|
|
37218
|
+
* @summary Replace an organisation\'s Analytics dashboard
|
|
37219
|
+
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
37220
|
+
* @param {SaveAnalyticsDashboardDto} saveAnalyticsDashboardDto
|
|
37221
|
+
* @param {*} [options] Override http request option.
|
|
37222
|
+
* @throws {RequiredError}
|
|
37223
|
+
* @memberof AnalyticsDashboardsApi
|
|
37224
|
+
*/
|
|
37225
|
+
saveOrganisationAnalyticsDashboard(groupId: string, saveAnalyticsDashboardDto: SaveAnalyticsDashboardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AnalyticsDashboardResponseDto, any, {}>>;
|
|
37226
|
+
/**
|
|
37227
|
+
* Saves the cards, in order, and the sales goals, replacing what was saved. The first save, without expectedVersion, creates it; every later one sends the version it read, and loses with 409 when someone saved since. Only the store\'s managers and its organisation\'s management may save, read from the licence server at each save.
|
|
37228
|
+
* @summary Replace a store\'s Analytics dashboard
|
|
37229
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
37230
|
+
* @param {SaveAnalyticsDashboardDto} saveAnalyticsDashboardDto
|
|
37231
|
+
* @param {*} [options] Override http request option.
|
|
37232
|
+
* @throws {RequiredError}
|
|
37233
|
+
* @memberof AnalyticsDashboardsApi
|
|
37234
|
+
*/
|
|
37235
|
+
saveStoreAnalyticsDashboard(businessId: number, saveAnalyticsDashboardDto: SaveAnalyticsDashboardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AnalyticsDashboardResponseDto, any, {}>>;
|
|
37236
|
+
}
|
|
35674
37237
|
/**
|
|
35675
37238
|
* AuthApi - axios parameter creator
|
|
35676
37239
|
* @export
|
|
@@ -48053,6 +49616,37 @@ export declare class RefundsApi extends BaseAPI implements RefundsApiInterface {
|
|
|
48053
49616
|
* @export
|
|
48054
49617
|
*/
|
|
48055
49618
|
export declare const ReportApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
49619
|
+
/**
|
|
49620
|
+
* The period GET /api/v6/report/sales would add up, for the same venues, apps, time zone and breakdown, with the same access: each group\'s pairs of base items (an item\'s own line, never an option) sold in the most orders, each order once, with every order of each item, so percentOfItemA is exact: of the orders with A, how many also had B. Each venue-day keeps its top 25 pairs (daily_item_pairs); a group whose daysWithPairsCut is not 0 answers each pair\'s orders as a lower bound. itemKey answers the pairs of one item only.
|
|
49621
|
+
* @summary Items bought together in one order, over the period
|
|
49622
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
49623
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
49624
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49625
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49626
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
49627
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
49628
|
+
* @param {ReportBreakdown} [breakdown] How the venues and apps are split into groups; every currency always splits, and one app asked is never added into several apps. Absent: venue for several venues, none for one
|
|
49629
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
49630
|
+
* @param {string} [itemKey] Only the pairs with this item, by its key (an item\'s itemKey of an earlier answer: the POS posId, the online product id). Absent: every pair
|
|
49631
|
+
* @param {number} [limit] How many pairs each group answers, most orders first: 1 to 100. Absent: 20
|
|
49632
|
+
* @param {*} [options] Override http request option.
|
|
49633
|
+
* @throws {RequiredError}
|
|
49634
|
+
*/
|
|
49635
|
+
getBoughtTogether: (businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, breakdown?: ReportBreakdown, language?: string, itemKey?: string, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49636
|
+
/**
|
|
49637
|
+
* The same report, rendered by the same generator, as the PDF the report e-mail (POST /api/v6/report/email) attaches, answered as the file itself instead of e-mailed. The period is the e-mail\'s: timeSpan DAY (the venue\'s business day), WEEK, MONTH, YEAR, or CUSTOM between start and end. A till\'s ticket gets it narrowed to the person on the till, as the e-mail is. Answers application/pdf with Content-Disposition attachment and the file\'s name.
|
|
49638
|
+
* @summary End-of-day sales report of a venue as a PDF file to download, for a day, week, month, year or custom period
|
|
49639
|
+
* @param {number} businessId The venue the file is of, by business id
|
|
49640
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
49641
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49642
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49643
|
+
* @param {string} [timezone] The IANA time zone the period\'s days are counted in. Absent: the venue\'s own
|
|
49644
|
+
* @param {ProviderEnum} [provider] The order source the report counts. Absent: MunchiPos, as the till\'s report
|
|
49645
|
+
* @param {ReportLanguage} [language] The language the file is printed in. Absent: English
|
|
49646
|
+
* @param {*} [options] Override http request option.
|
|
49647
|
+
* @throws {RequiredError}
|
|
49648
|
+
*/
|
|
49649
|
+
getEndOfDayReportFile: (businessId: number, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, language?: ReportLanguage, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48056
49650
|
/**
|
|
48057
49651
|
*
|
|
48058
49652
|
* @summary Get end-of-day financial report (V5)
|
|
@@ -48080,11 +49674,77 @@ export declare const ReportApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
48080
49674
|
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
48081
49675
|
* @param {string} [compareStart] With compareEnd, compares the report with these whole days: each group then also answers comparison, the same group over them, and the change of every total worked out exactly. The first business day compared, YYYY-MM-DD, in the report\'s time zone; not later than today. Neither sent: no comparison, and the answer is as before. Sent without compareEnd: refused
|
|
48082
49676
|
* @param {string} [compareEnd] With compareStart: the last business day compared, YYYY-MM-DD, inclusive; a day later than today is read up to now. Sent without compareStart: refused
|
|
49677
|
+
* @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\'s last day is still running, both last days, the report\'s and the compared one, are added up only to the last full hour the data has reached, on each venue\'s own clock (today until 14:00 against that day until 14:00), so neither side counts minutes the other does not; earlier days stay whole. Each group whose compared day was cut answers comparison.comparedUntil. Only totals are cut (salesReport\'s and paymentReport.summary\'s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the day\'s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
|
|
49678
|
+
* @param {string} [baseline] One group of the answer every other group is compared with: venue:<id> with breakdown venue, app:<app> with breakdown app, venue:<id>,app:<app> with breakdown venue_app. Every other group then answers changesFromBaseline (current: the group; previous: the baseline), of the main period only; a group in another currency than the baseline\'s answers changesFromBaselineLeftOut instead. Refused when the breakdown does not split on what it names, or it names a venue or app not asked
|
|
49679
|
+
* @param {*} [options] Override http request option.
|
|
49680
|
+
* @throws {RequiredError}
|
|
49681
|
+
*/
|
|
49682
|
+
getSalesReport: (businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, parts?: Array<ReportPart>, breakdown?: ReportBreakdown, language?: string, compareStart?: string, compareEnd?: string, compareSameTime?: boolean, baseline?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49683
|
+
/**
|
|
49684
|
+
* The venue\'s sales report over the channels it has enabled (its active providers: MunchiPos is POS; MunchiKiosk, MunchiKioskV2 and Kiosk are the kiosk; Storefront is the storefront and the mobile app), added together: the same report GET /api/v6/report/sales answers for those apps with breakdown none, so its totals are that route\'s. The PDF prints a summary (channels, orders, average order value, gross sales, refunds), the sales breakdown (categories, items, VAT) and the payments breakdown (payment methods, vouchers, tips, discounts). With format xlsx the same report is an Excel workbook of plain numbers in the venue\'s currency, with the PDF\'s totals: sheets Summary, Items (every item and every option on its own row), Categories, VAT by rate, Payments, Vouchers & extras and Discounts. The period is whole business days, as that route reads them: timeSpan DAY, WEEK, MONTH or YEAR, or CUSTOM between start and end. Answers application/pdf (format pdf, the default) or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (format xlsx) with Content-Disposition attachment, named sales-report-<businessId>-<first day>-<last day>.pdf or .xlsx.
|
|
49685
|
+
* @summary Sales report of a venue, every channel it has enabled (POS, kiosk, storefront and mobile app), as a PDF or Excel (xlsx) file to download
|
|
49686
|
+
* @param {number} businessId The venue the file is of, by business id
|
|
49687
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
49688
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49689
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49690
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the venue\'s own (Business.timeZone)
|
|
49691
|
+
* @param {ReportLanguage} [language] The language the file is printed in. Absent: English
|
|
49692
|
+
* @param {FileFormat} [format] The file\'s format: pdf, or xlsx for an Excel workbook of the same report with every item and option on its own row. Absent: pdf
|
|
49693
|
+
* @param {*} [options] Override http request option.
|
|
49694
|
+
* @throws {RequiredError}
|
|
49695
|
+
*/
|
|
49696
|
+
getSalesReportFile: (businessId: number, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, language?: ReportLanguage, format?: FileFormat, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49697
|
+
/**
|
|
49698
|
+
* The period GET /api/v6/report/sales would add up, for the same venues, apps, time zone and breakdown, with the same access, per hour of each venue\'s own clock (hourly_summary): each hour\'s orders and totalWithTax, added up by the report\'s own rules, and their average over the period\'s calendar days, of isoWeekday only when it is sent. Busy hours: a month, its averageOrderCount. A normal Tuesday beside today: the last 8 weeks with isoWeekday 2, against today\'s own hours. A day sold on before hours were kept answers in no hour and is counted in daysWithoutHours.
|
|
49699
|
+
* @summary Sales of the venues and apps per hour of the day, with each hour\'s average day
|
|
49700
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
49701
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
49702
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49703
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49704
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
49705
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
49706
|
+
* @param {ReportBreakdown} [breakdown] How the venues and apps are split into groups; every currency always splits, and one app asked is never added into several apps. Absent: venue for several venues, none for one
|
|
49707
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
49708
|
+
* @param {number} [isoWeekday] Only the business days of this ISO weekday count, 1 Monday to 7 Sunday, in the report\'s time zone; the average then is over those days. Absent: every day of the period. A normal Tuesday: the last 8 weeks before today with isoWeekday 2
|
|
49709
|
+
* @param {*} [options] Override http request option.
|
|
49710
|
+
* @throws {RequiredError}
|
|
49711
|
+
*/
|
|
49712
|
+
getSalesReportHours: (businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, breakdown?: ReportBreakdown, language?: string, isoWeekday?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49713
|
+
/**
|
|
49714
|
+
* The period GET /api/v6/report/sales would add up, for the same venues, apps, time zone and breakdown, with the same access, per order type (daily_order_types): each type\'s orders and sales, added up by the report\'s own rules. The till and the kiosk write dine_in or pick_up, the online store\'s Vendure dine_in, pickup or delivery; anything else, and an online order counted from its Postgres copy, is unknown, never guessed. A day sold on before order types were kept answers in no type and is counted in daysWithoutOrderTypes.
|
|
49715
|
+
* @summary Sales of the venues and apps per order type: eat in, takeaway, delivery
|
|
49716
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
49717
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
49718
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49719
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49720
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
49721
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
49722
|
+
* @param {ReportBreakdown} [breakdown] How the venues and apps are split into groups; every currency always splits, and one app asked is never added into several apps. Absent: venue for several venues, none for one
|
|
49723
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
49724
|
+
* @param {*} [options] Override http request option.
|
|
49725
|
+
* @throws {RequiredError}
|
|
49726
|
+
*/
|
|
49727
|
+
getSalesReportOrderTypes: (businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, breakdown?: ReportBreakdown, language?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49728
|
+
/**
|
|
49729
|
+
* The report GET /api/v6/report/sales answers for the same query, with the same access, short enough to read whole: the same totals, orderCount, averageOrderValue, days, VAT, payments, discounts, comparison, changes and changesFromBaseline, every amount rounded to the currency\'s minor digits; with part items, each category\'s totals (with and without VAT) without its items, and topItemsBySales and topItemsByQuantity, the 10 best-selling items with an item of the same name in several categories added up once. For every item with its VAT, its net and its options, read GET /api/v6/report/sales.
|
|
49730
|
+
* @summary Sales report of the venues and apps, short: totals, categories and best-selling items
|
|
49731
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
49732
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
49733
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49734
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49735
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
49736
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
49737
|
+
* @param {Array<ReportPart>} [parts] The parts to answer, the parameter repeated or a JSON list; only their daily tables are read. Absent: all five
|
|
49738
|
+
* @param {ReportBreakdown} [breakdown] How the venues and apps are split into groups; every currency always splits, and one app asked is never added into several apps. Absent: venue for several venues, none for one
|
|
49739
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
49740
|
+
* @param {string} [compareStart] With compareEnd, compares the report with these whole days: each group then also answers comparison, the same group over them, and the change of every total worked out exactly. The first business day compared, YYYY-MM-DD, in the report\'s time zone; not later than today. Neither sent: no comparison, and the answer is as before. Sent without compareEnd: refused
|
|
49741
|
+
* @param {string} [compareEnd] With compareStart: the last business day compared, YYYY-MM-DD, inclusive; a day later than today is read up to now. Sent without compareStart: refused
|
|
49742
|
+
* @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\'s last day is still running, both last days, the report\'s and the compared one, are added up only to the last full hour the data has reached, on each venue\'s own clock (today until 14:00 against that day until 14:00), so neither side counts minutes the other does not; earlier days stay whole. Each group whose compared day was cut answers comparison.comparedUntil. Only totals are cut (salesReport\'s and paymentReport.summary\'s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the day\'s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
|
|
48083
49743
|
* @param {string} [baseline] One group of the answer every other group is compared with: venue:<id> with breakdown venue, app:<app> with breakdown app, venue:<id>,app:<app> with breakdown venue_app. Every other group then answers changesFromBaseline (current: the group; previous: the baseline), of the main period only; a group in another currency than the baseline\'s answers changesFromBaselineLeftOut instead. Refused when the breakdown does not split on what it names, or it names a venue or app not asked
|
|
48084
49744
|
* @param {*} [options] Override http request option.
|
|
48085
49745
|
* @throws {RequiredError}
|
|
48086
49746
|
*/
|
|
48087
|
-
|
|
49747
|
+
getShortSalesReport: (businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, parts?: Array<ReportPart>, breakdown?: ReportBreakdown, language?: string, compareStart?: string, compareEnd?: string, compareSameTime?: boolean, baseline?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48088
49748
|
/**
|
|
48089
49749
|
*
|
|
48090
49750
|
* @summary Send end-of-day report via email (V5)
|
|
@@ -48105,6 +49765,37 @@ export declare const ReportApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
48105
49765
|
* @export
|
|
48106
49766
|
*/
|
|
48107
49767
|
export declare const ReportApiFp: (configuration?: Configuration) => {
|
|
49768
|
+
/**
|
|
49769
|
+
* The period GET /api/v6/report/sales would add up, for the same venues, apps, time zone and breakdown, with the same access: each group\'s pairs of base items (an item\'s own line, never an option) sold in the most orders, each order once, with every order of each item, so percentOfItemA is exact: of the orders with A, how many also had B. Each venue-day keeps its top 25 pairs (daily_item_pairs); a group whose daysWithPairsCut is not 0 answers each pair\'s orders as a lower bound. itemKey answers the pairs of one item only.
|
|
49770
|
+
* @summary Items bought together in one order, over the period
|
|
49771
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
49772
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
49773
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49774
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49775
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
49776
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
49777
|
+
* @param {ReportBreakdown} [breakdown] How the venues and apps are split into groups; every currency always splits, and one app asked is never added into several apps. Absent: venue for several venues, none for one
|
|
49778
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
49779
|
+
* @param {string} [itemKey] Only the pairs with this item, by its key (an item\'s itemKey of an earlier answer: the POS posId, the online product id). Absent: every pair
|
|
49780
|
+
* @param {number} [limit] How many pairs each group answers, most orders first: 1 to 100. Absent: 20
|
|
49781
|
+
* @param {*} [options] Override http request option.
|
|
49782
|
+
* @throws {RequiredError}
|
|
49783
|
+
*/
|
|
49784
|
+
getBoughtTogether(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, breakdown?: ReportBreakdown, language?: string, itemKey?: string, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SalesReportBoughtTogetherResponseDto>>;
|
|
49785
|
+
/**
|
|
49786
|
+
* The same report, rendered by the same generator, as the PDF the report e-mail (POST /api/v6/report/email) attaches, answered as the file itself instead of e-mailed. The period is the e-mail\'s: timeSpan DAY (the venue\'s business day), WEEK, MONTH, YEAR, or CUSTOM between start and end. A till\'s ticket gets it narrowed to the person on the till, as the e-mail is. Answers application/pdf with Content-Disposition attachment and the file\'s name.
|
|
49787
|
+
* @summary End-of-day sales report of a venue as a PDF file to download, for a day, week, month, year or custom period
|
|
49788
|
+
* @param {number} businessId The venue the file is of, by business id
|
|
49789
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
49790
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49791
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49792
|
+
* @param {string} [timezone] The IANA time zone the period\'s days are counted in. Absent: the venue\'s own
|
|
49793
|
+
* @param {ProviderEnum} [provider] The order source the report counts. Absent: MunchiPos, as the till\'s report
|
|
49794
|
+
* @param {ReportLanguage} [language] The language the file is printed in. Absent: English
|
|
49795
|
+
* @param {*} [options] Override http request option.
|
|
49796
|
+
* @throws {RequiredError}
|
|
49797
|
+
*/
|
|
49798
|
+
getEndOfDayReportFile(businessId: number, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, language?: ReportLanguage, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
48108
49799
|
/**
|
|
48109
49800
|
*
|
|
48110
49801
|
* @summary Get end-of-day financial report (V5)
|
|
@@ -48132,11 +49823,77 @@ export declare const ReportApiFp: (configuration?: Configuration) => {
|
|
|
48132
49823
|
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
48133
49824
|
* @param {string} [compareStart] With compareEnd, compares the report with these whole days: each group then also answers comparison, the same group over them, and the change of every total worked out exactly. The first business day compared, YYYY-MM-DD, in the report\'s time zone; not later than today. Neither sent: no comparison, and the answer is as before. Sent without compareEnd: refused
|
|
48134
49825
|
* @param {string} [compareEnd] With compareStart: the last business day compared, YYYY-MM-DD, inclusive; a day later than today is read up to now. Sent without compareStart: refused
|
|
49826
|
+
* @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\'s last day is still running, both last days, the report\'s and the compared one, are added up only to the last full hour the data has reached, on each venue\'s own clock (today until 14:00 against that day until 14:00), so neither side counts minutes the other does not; earlier days stay whole. Each group whose compared day was cut answers comparison.comparedUntil. Only totals are cut (salesReport\'s and paymentReport.summary\'s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the day\'s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
|
|
48135
49827
|
* @param {string} [baseline] One group of the answer every other group is compared with: venue:<id> with breakdown venue, app:<app> with breakdown app, venue:<id>,app:<app> with breakdown venue_app. Every other group then answers changesFromBaseline (current: the group; previous: the baseline), of the main period only; a group in another currency than the baseline\'s answers changesFromBaselineLeftOut instead. Refused when the breakdown does not split on what it names, or it names a venue or app not asked
|
|
48136
49828
|
* @param {*} [options] Override http request option.
|
|
48137
49829
|
* @throws {RequiredError}
|
|
48138
49830
|
*/
|
|
48139
|
-
getSalesReport(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, parts?: Array<ReportPart>, breakdown?: ReportBreakdown, language?: string, compareStart?: string, compareEnd?: string, baseline?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SalesReportResponseDto>>;
|
|
49831
|
+
getSalesReport(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, parts?: Array<ReportPart>, breakdown?: ReportBreakdown, language?: string, compareStart?: string, compareEnd?: string, compareSameTime?: boolean, baseline?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SalesReportResponseDto>>;
|
|
49832
|
+
/**
|
|
49833
|
+
* The venue\'s sales report over the channels it has enabled (its active providers: MunchiPos is POS; MunchiKiosk, MunchiKioskV2 and Kiosk are the kiosk; Storefront is the storefront and the mobile app), added together: the same report GET /api/v6/report/sales answers for those apps with breakdown none, so its totals are that route\'s. The PDF prints a summary (channels, orders, average order value, gross sales, refunds), the sales breakdown (categories, items, VAT) and the payments breakdown (payment methods, vouchers, tips, discounts). With format xlsx the same report is an Excel workbook of plain numbers in the venue\'s currency, with the PDF\'s totals: sheets Summary, Items (every item and every option on its own row), Categories, VAT by rate, Payments, Vouchers & extras and Discounts. The period is whole business days, as that route reads them: timeSpan DAY, WEEK, MONTH or YEAR, or CUSTOM between start and end. Answers application/pdf (format pdf, the default) or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (format xlsx) with Content-Disposition attachment, named sales-report-<businessId>-<first day>-<last day>.pdf or .xlsx.
|
|
49834
|
+
* @summary Sales report of a venue, every channel it has enabled (POS, kiosk, storefront and mobile app), as a PDF or Excel (xlsx) file to download
|
|
49835
|
+
* @param {number} businessId The venue the file is of, by business id
|
|
49836
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
49837
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49838
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49839
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the venue\'s own (Business.timeZone)
|
|
49840
|
+
* @param {ReportLanguage} [language] The language the file is printed in. Absent: English
|
|
49841
|
+
* @param {FileFormat} [format] The file\'s format: pdf, or xlsx for an Excel workbook of the same report with every item and option on its own row. Absent: pdf
|
|
49842
|
+
* @param {*} [options] Override http request option.
|
|
49843
|
+
* @throws {RequiredError}
|
|
49844
|
+
*/
|
|
49845
|
+
getSalesReportFile(businessId: number, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, language?: ReportLanguage, format?: FileFormat, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
49846
|
+
/**
|
|
49847
|
+
* The period GET /api/v6/report/sales would add up, for the same venues, apps, time zone and breakdown, with the same access, per hour of each venue\'s own clock (hourly_summary): each hour\'s orders and totalWithTax, added up by the report\'s own rules, and their average over the period\'s calendar days, of isoWeekday only when it is sent. Busy hours: a month, its averageOrderCount. A normal Tuesday beside today: the last 8 weeks with isoWeekday 2, against today\'s own hours. A day sold on before hours were kept answers in no hour and is counted in daysWithoutHours.
|
|
49848
|
+
* @summary Sales of the venues and apps per hour of the day, with each hour\'s average day
|
|
49849
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
49850
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
49851
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49852
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49853
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
49854
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
49855
|
+
* @param {ReportBreakdown} [breakdown] How the venues and apps are split into groups; every currency always splits, and one app asked is never added into several apps. Absent: venue for several venues, none for one
|
|
49856
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
49857
|
+
* @param {number} [isoWeekday] Only the business days of this ISO weekday count, 1 Monday to 7 Sunday, in the report\'s time zone; the average then is over those days. Absent: every day of the period. A normal Tuesday: the last 8 weeks before today with isoWeekday 2
|
|
49858
|
+
* @param {*} [options] Override http request option.
|
|
49859
|
+
* @throws {RequiredError}
|
|
49860
|
+
*/
|
|
49861
|
+
getSalesReportHours(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, breakdown?: ReportBreakdown, language?: string, isoWeekday?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SalesReportHoursResponseDto>>;
|
|
49862
|
+
/**
|
|
49863
|
+
* The period GET /api/v6/report/sales would add up, for the same venues, apps, time zone and breakdown, with the same access, per order type (daily_order_types): each type\'s orders and sales, added up by the report\'s own rules. The till and the kiosk write dine_in or pick_up, the online store\'s Vendure dine_in, pickup or delivery; anything else, and an online order counted from its Postgres copy, is unknown, never guessed. A day sold on before order types were kept answers in no type and is counted in daysWithoutOrderTypes.
|
|
49864
|
+
* @summary Sales of the venues and apps per order type: eat in, takeaway, delivery
|
|
49865
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
49866
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
49867
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49868
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49869
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
49870
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
49871
|
+
* @param {ReportBreakdown} [breakdown] How the venues and apps are split into groups; every currency always splits, and one app asked is never added into several apps. Absent: venue for several venues, none for one
|
|
49872
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
49873
|
+
* @param {*} [options] Override http request option.
|
|
49874
|
+
* @throws {RequiredError}
|
|
49875
|
+
*/
|
|
49876
|
+
getSalesReportOrderTypes(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, breakdown?: ReportBreakdown, language?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SalesReportOrderTypesResponseDto>>;
|
|
49877
|
+
/**
|
|
49878
|
+
* The report GET /api/v6/report/sales answers for the same query, with the same access, short enough to read whole: the same totals, orderCount, averageOrderValue, days, VAT, payments, discounts, comparison, changes and changesFromBaseline, every amount rounded to the currency\'s minor digits; with part items, each category\'s totals (with and without VAT) without its items, and topItemsBySales and topItemsByQuantity, the 10 best-selling items with an item of the same name in several categories added up once. For every item with its VAT, its net and its options, read GET /api/v6/report/sales.
|
|
49879
|
+
* @summary Sales report of the venues and apps, short: totals, categories and best-selling items
|
|
49880
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
49881
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
49882
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49883
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49884
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
49885
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
49886
|
+
* @param {Array<ReportPart>} [parts] The parts to answer, the parameter repeated or a JSON list; only their daily tables are read. Absent: all five
|
|
49887
|
+
* @param {ReportBreakdown} [breakdown] How the venues and apps are split into groups; every currency always splits, and one app asked is never added into several apps. Absent: venue for several venues, none for one
|
|
49888
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
49889
|
+
* @param {string} [compareStart] With compareEnd, compares the report with these whole days: each group then also answers comparison, the same group over them, and the change of every total worked out exactly. The first business day compared, YYYY-MM-DD, in the report\'s time zone; not later than today. Neither sent: no comparison, and the answer is as before. Sent without compareEnd: refused
|
|
49890
|
+
* @param {string} [compareEnd] With compareStart: the last business day compared, YYYY-MM-DD, inclusive; a day later than today is read up to now. Sent without compareStart: refused
|
|
49891
|
+
* @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\'s last day is still running, both last days, the report\'s and the compared one, are added up only to the last full hour the data has reached, on each venue\'s own clock (today until 14:00 against that day until 14:00), so neither side counts minutes the other does not; earlier days stay whole. Each group whose compared day was cut answers comparison.comparedUntil. Only totals are cut (salesReport\'s and paymentReport.summary\'s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the day\'s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
|
|
49892
|
+
* @param {string} [baseline] One group of the answer every other group is compared with: venue:<id> with breakdown venue, app:<app> with breakdown app, venue:<id>,app:<app> with breakdown venue_app. Every other group then answers changesFromBaseline (current: the group; previous: the baseline), of the main period only; a group in another currency than the baseline\'s answers changesFromBaselineLeftOut instead. Refused when the breakdown does not split on what it names, or it names a venue or app not asked
|
|
49893
|
+
* @param {*} [options] Override http request option.
|
|
49894
|
+
* @throws {RequiredError}
|
|
49895
|
+
*/
|
|
49896
|
+
getShortSalesReport(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, parts?: Array<ReportPart>, breakdown?: ReportBreakdown, language?: string, compareStart?: string, compareEnd?: string, compareSameTime?: boolean, baseline?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SalesReportShortResponseDto>>;
|
|
48140
49897
|
/**
|
|
48141
49898
|
*
|
|
48142
49899
|
* @summary Send end-of-day report via email (V5)
|
|
@@ -48157,6 +49914,37 @@ export declare const ReportApiFp: (configuration?: Configuration) => {
|
|
|
48157
49914
|
* @export
|
|
48158
49915
|
*/
|
|
48159
49916
|
export declare const ReportApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
49917
|
+
/**
|
|
49918
|
+
* The period GET /api/v6/report/sales would add up, for the same venues, apps, time zone and breakdown, with the same access: each group\'s pairs of base items (an item\'s own line, never an option) sold in the most orders, each order once, with every order of each item, so percentOfItemA is exact: of the orders with A, how many also had B. Each venue-day keeps its top 25 pairs (daily_item_pairs); a group whose daysWithPairsCut is not 0 answers each pair\'s orders as a lower bound. itemKey answers the pairs of one item only.
|
|
49919
|
+
* @summary Items bought together in one order, over the period
|
|
49920
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
49921
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
49922
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49923
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49924
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
49925
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
49926
|
+
* @param {ReportBreakdown} [breakdown] How the venues and apps are split into groups; every currency always splits, and one app asked is never added into several apps. Absent: venue for several venues, none for one
|
|
49927
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
49928
|
+
* @param {string} [itemKey] Only the pairs with this item, by its key (an item\'s itemKey of an earlier answer: the POS posId, the online product id). Absent: every pair
|
|
49929
|
+
* @param {number} [limit] How many pairs each group answers, most orders first: 1 to 100. Absent: 20
|
|
49930
|
+
* @param {*} [options] Override http request option.
|
|
49931
|
+
* @throws {RequiredError}
|
|
49932
|
+
*/
|
|
49933
|
+
getBoughtTogether(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, breakdown?: ReportBreakdown, language?: string, itemKey?: string, limit?: number, options?: any): AxiosPromise<SalesReportBoughtTogetherResponseDto>;
|
|
49934
|
+
/**
|
|
49935
|
+
* The same report, rendered by the same generator, as the PDF the report e-mail (POST /api/v6/report/email) attaches, answered as the file itself instead of e-mailed. The period is the e-mail\'s: timeSpan DAY (the venue\'s business day), WEEK, MONTH, YEAR, or CUSTOM between start and end. A till\'s ticket gets it narrowed to the person on the till, as the e-mail is. Answers application/pdf with Content-Disposition attachment and the file\'s name.
|
|
49936
|
+
* @summary End-of-day sales report of a venue as a PDF file to download, for a day, week, month, year or custom period
|
|
49937
|
+
* @param {number} businessId The venue the file is of, by business id
|
|
49938
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
49939
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49940
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49941
|
+
* @param {string} [timezone] The IANA time zone the period\'s days are counted in. Absent: the venue\'s own
|
|
49942
|
+
* @param {ProviderEnum} [provider] The order source the report counts. Absent: MunchiPos, as the till\'s report
|
|
49943
|
+
* @param {ReportLanguage} [language] The language the file is printed in. Absent: English
|
|
49944
|
+
* @param {*} [options] Override http request option.
|
|
49945
|
+
* @throws {RequiredError}
|
|
49946
|
+
*/
|
|
49947
|
+
getEndOfDayReportFile(businessId: number, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, language?: ReportLanguage, options?: any): AxiosPromise<File>;
|
|
48160
49948
|
/**
|
|
48161
49949
|
*
|
|
48162
49950
|
* @summary Get end-of-day financial report (V5)
|
|
@@ -48184,11 +49972,77 @@ export declare const ReportApiFactory: (configuration?: Configuration, basePath?
|
|
|
48184
49972
|
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
48185
49973
|
* @param {string} [compareStart] With compareEnd, compares the report with these whole days: each group then also answers comparison, the same group over them, and the change of every total worked out exactly. The first business day compared, YYYY-MM-DD, in the report\'s time zone; not later than today. Neither sent: no comparison, and the answer is as before. Sent without compareEnd: refused
|
|
48186
49974
|
* @param {string} [compareEnd] With compareStart: the last business day compared, YYYY-MM-DD, inclusive; a day later than today is read up to now. Sent without compareStart: refused
|
|
49975
|
+
* @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\'s last day is still running, both last days, the report\'s and the compared one, are added up only to the last full hour the data has reached, on each venue\'s own clock (today until 14:00 against that day until 14:00), so neither side counts minutes the other does not; earlier days stay whole. Each group whose compared day was cut answers comparison.comparedUntil. Only totals are cut (salesReport\'s and paymentReport.summary\'s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the day\'s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
|
|
49976
|
+
* @param {string} [baseline] One group of the answer every other group is compared with: venue:<id> with breakdown venue, app:<app> with breakdown app, venue:<id>,app:<app> with breakdown venue_app. Every other group then answers changesFromBaseline (current: the group; previous: the baseline), of the main period only; a group in another currency than the baseline\'s answers changesFromBaselineLeftOut instead. Refused when the breakdown does not split on what it names, or it names a venue or app not asked
|
|
49977
|
+
* @param {*} [options] Override http request option.
|
|
49978
|
+
* @throws {RequiredError}
|
|
49979
|
+
*/
|
|
49980
|
+
getSalesReport(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, parts?: Array<ReportPart>, breakdown?: ReportBreakdown, language?: string, compareStart?: string, compareEnd?: string, compareSameTime?: boolean, baseline?: string, options?: any): AxiosPromise<SalesReportResponseDto>;
|
|
49981
|
+
/**
|
|
49982
|
+
* The venue\'s sales report over the channels it has enabled (its active providers: MunchiPos is POS; MunchiKiosk, MunchiKioskV2 and Kiosk are the kiosk; Storefront is the storefront and the mobile app), added together: the same report GET /api/v6/report/sales answers for those apps with breakdown none, so its totals are that route\'s. The PDF prints a summary (channels, orders, average order value, gross sales, refunds), the sales breakdown (categories, items, VAT) and the payments breakdown (payment methods, vouchers, tips, discounts). With format xlsx the same report is an Excel workbook of plain numbers in the venue\'s currency, with the PDF\'s totals: sheets Summary, Items (every item and every option on its own row), Categories, VAT by rate, Payments, Vouchers & extras and Discounts. The period is whole business days, as that route reads them: timeSpan DAY, WEEK, MONTH or YEAR, or CUSTOM between start and end. Answers application/pdf (format pdf, the default) or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (format xlsx) with Content-Disposition attachment, named sales-report-<businessId>-<first day>-<last day>.pdf or .xlsx.
|
|
49983
|
+
* @summary Sales report of a venue, every channel it has enabled (POS, kiosk, storefront and mobile app), as a PDF or Excel (xlsx) file to download
|
|
49984
|
+
* @param {number} businessId The venue the file is of, by business id
|
|
49985
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
49986
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49987
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
49988
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the venue\'s own (Business.timeZone)
|
|
49989
|
+
* @param {ReportLanguage} [language] The language the file is printed in. Absent: English
|
|
49990
|
+
* @param {FileFormat} [format] The file\'s format: pdf, or xlsx for an Excel workbook of the same report with every item and option on its own row. Absent: pdf
|
|
49991
|
+
* @param {*} [options] Override http request option.
|
|
49992
|
+
* @throws {RequiredError}
|
|
49993
|
+
*/
|
|
49994
|
+
getSalesReportFile(businessId: number, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, language?: ReportLanguage, format?: FileFormat, options?: any): AxiosPromise<File>;
|
|
49995
|
+
/**
|
|
49996
|
+
* The period GET /api/v6/report/sales would add up, for the same venues, apps, time zone and breakdown, with the same access, per hour of each venue\'s own clock (hourly_summary): each hour\'s orders and totalWithTax, added up by the report\'s own rules, and their average over the period\'s calendar days, of isoWeekday only when it is sent. Busy hours: a month, its averageOrderCount. A normal Tuesday beside today: the last 8 weeks with isoWeekday 2, against today\'s own hours. A day sold on before hours were kept answers in no hour and is counted in daysWithoutHours.
|
|
49997
|
+
* @summary Sales of the venues and apps per hour of the day, with each hour\'s average day
|
|
49998
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
49999
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
50000
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50001
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50002
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
50003
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
50004
|
+
* @param {ReportBreakdown} [breakdown] How the venues and apps are split into groups; every currency always splits, and one app asked is never added into several apps. Absent: venue for several venues, none for one
|
|
50005
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
50006
|
+
* @param {number} [isoWeekday] Only the business days of this ISO weekday count, 1 Monday to 7 Sunday, in the report\'s time zone; the average then is over those days. Absent: every day of the period. A normal Tuesday: the last 8 weeks before today with isoWeekday 2
|
|
50007
|
+
* @param {*} [options] Override http request option.
|
|
50008
|
+
* @throws {RequiredError}
|
|
50009
|
+
*/
|
|
50010
|
+
getSalesReportHours(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, breakdown?: ReportBreakdown, language?: string, isoWeekday?: number, options?: any): AxiosPromise<SalesReportHoursResponseDto>;
|
|
50011
|
+
/**
|
|
50012
|
+
* The period GET /api/v6/report/sales would add up, for the same venues, apps, time zone and breakdown, with the same access, per order type (daily_order_types): each type\'s orders and sales, added up by the report\'s own rules. The till and the kiosk write dine_in or pick_up, the online store\'s Vendure dine_in, pickup or delivery; anything else, and an online order counted from its Postgres copy, is unknown, never guessed. A day sold on before order types were kept answers in no type and is counted in daysWithoutOrderTypes.
|
|
50013
|
+
* @summary Sales of the venues and apps per order type: eat in, takeaway, delivery
|
|
50014
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
50015
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
50016
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50017
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50018
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
50019
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
50020
|
+
* @param {ReportBreakdown} [breakdown] How the venues and apps are split into groups; every currency always splits, and one app asked is never added into several apps. Absent: venue for several venues, none for one
|
|
50021
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
50022
|
+
* @param {*} [options] Override http request option.
|
|
50023
|
+
* @throws {RequiredError}
|
|
50024
|
+
*/
|
|
50025
|
+
getSalesReportOrderTypes(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, breakdown?: ReportBreakdown, language?: string, options?: any): AxiosPromise<SalesReportOrderTypesResponseDto>;
|
|
50026
|
+
/**
|
|
50027
|
+
* The report GET /api/v6/report/sales answers for the same query, with the same access, short enough to read whole: the same totals, orderCount, averageOrderValue, days, VAT, payments, discounts, comparison, changes and changesFromBaseline, every amount rounded to the currency\'s minor digits; with part items, each category\'s totals (with and without VAT) without its items, and topItemsBySales and topItemsByQuantity, the 10 best-selling items with an item of the same name in several categories added up once. For every item with its VAT, its net and its options, read GET /api/v6/report/sales.
|
|
50028
|
+
* @summary Sales report of the venues and apps, short: totals, categories and best-selling items
|
|
50029
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
50030
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
50031
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50032
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50033
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
50034
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
50035
|
+
* @param {Array<ReportPart>} [parts] The parts to answer, the parameter repeated or a JSON list; only their daily tables are read. Absent: all five
|
|
50036
|
+
* @param {ReportBreakdown} [breakdown] How the venues and apps are split into groups; every currency always splits, and one app asked is never added into several apps. Absent: venue for several venues, none for one
|
|
50037
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
50038
|
+
* @param {string} [compareStart] With compareEnd, compares the report with these whole days: each group then also answers comparison, the same group over them, and the change of every total worked out exactly. The first business day compared, YYYY-MM-DD, in the report\'s time zone; not later than today. Neither sent: no comparison, and the answer is as before. Sent without compareEnd: refused
|
|
50039
|
+
* @param {string} [compareEnd] With compareStart: the last business day compared, YYYY-MM-DD, inclusive; a day later than today is read up to now. Sent without compareStart: refused
|
|
50040
|
+
* @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\'s last day is still running, both last days, the report\'s and the compared one, are added up only to the last full hour the data has reached, on each venue\'s own clock (today until 14:00 against that day until 14:00), so neither side counts minutes the other does not; earlier days stay whole. Each group whose compared day was cut answers comparison.comparedUntil. Only totals are cut (salesReport\'s and paymentReport.summary\'s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the day\'s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
|
|
48187
50041
|
* @param {string} [baseline] One group of the answer every other group is compared with: venue:<id> with breakdown venue, app:<app> with breakdown app, venue:<id>,app:<app> with breakdown venue_app. Every other group then answers changesFromBaseline (current: the group; previous: the baseline), of the main period only; a group in another currency than the baseline\'s answers changesFromBaselineLeftOut instead. Refused when the breakdown does not split on what it names, or it names a venue or app not asked
|
|
48188
50042
|
* @param {*} [options] Override http request option.
|
|
48189
50043
|
* @throws {RequiredError}
|
|
48190
50044
|
*/
|
|
48191
|
-
|
|
50045
|
+
getShortSalesReport(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, parts?: Array<ReportPart>, breakdown?: ReportBreakdown, language?: string, compareStart?: string, compareEnd?: string, compareSameTime?: boolean, baseline?: string, options?: any): AxiosPromise<SalesReportShortResponseDto>;
|
|
48192
50046
|
/**
|
|
48193
50047
|
*
|
|
48194
50048
|
* @summary Send end-of-day report via email (V5)
|
|
@@ -48210,6 +50064,39 @@ export declare const ReportApiFactory: (configuration?: Configuration, basePath?
|
|
|
48210
50064
|
* @interface ReportApi
|
|
48211
50065
|
*/
|
|
48212
50066
|
export interface ReportApiInterface {
|
|
50067
|
+
/**
|
|
50068
|
+
* The period GET /api/v6/report/sales would add up, for the same venues, apps, time zone and breakdown, with the same access: each group\'s pairs of base items (an item\'s own line, never an option) sold in the most orders, each order once, with every order of each item, so percentOfItemA is exact: of the orders with A, how many also had B. Each venue-day keeps its top 25 pairs (daily_item_pairs); a group whose daysWithPairsCut is not 0 answers each pair\'s orders as a lower bound. itemKey answers the pairs of one item only.
|
|
50069
|
+
* @summary Items bought together in one order, over the period
|
|
50070
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
50071
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
50072
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50073
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50074
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
50075
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
50076
|
+
* @param {ReportBreakdown} [breakdown] How the venues and apps are split into groups; every currency always splits, and one app asked is never added into several apps. Absent: venue for several venues, none for one
|
|
50077
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
50078
|
+
* @param {string} [itemKey] Only the pairs with this item, by its key (an item\'s itemKey of an earlier answer: the POS posId, the online product id). Absent: every pair
|
|
50079
|
+
* @param {number} [limit] How many pairs each group answers, most orders first: 1 to 100. Absent: 20
|
|
50080
|
+
* @param {*} [options] Override http request option.
|
|
50081
|
+
* @throws {RequiredError}
|
|
50082
|
+
* @memberof ReportApiInterface
|
|
50083
|
+
*/
|
|
50084
|
+
getBoughtTogether(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, breakdown?: ReportBreakdown, language?: string, itemKey?: string, limit?: number, options?: AxiosRequestConfig): AxiosPromise<SalesReportBoughtTogetherResponseDto>;
|
|
50085
|
+
/**
|
|
50086
|
+
* The same report, rendered by the same generator, as the PDF the report e-mail (POST /api/v6/report/email) attaches, answered as the file itself instead of e-mailed. The period is the e-mail\'s: timeSpan DAY (the venue\'s business day), WEEK, MONTH, YEAR, or CUSTOM between start and end. A till\'s ticket gets it narrowed to the person on the till, as the e-mail is. Answers application/pdf with Content-Disposition attachment and the file\'s name.
|
|
50087
|
+
* @summary End-of-day sales report of a venue as a PDF file to download, for a day, week, month, year or custom period
|
|
50088
|
+
* @param {number} businessId The venue the file is of, by business id
|
|
50089
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
50090
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50091
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50092
|
+
* @param {string} [timezone] The IANA time zone the period\'s days are counted in. Absent: the venue\'s own
|
|
50093
|
+
* @param {ProviderEnum} [provider] The order source the report counts. Absent: MunchiPos, as the till\'s report
|
|
50094
|
+
* @param {ReportLanguage} [language] The language the file is printed in. Absent: English
|
|
50095
|
+
* @param {*} [options] Override http request option.
|
|
50096
|
+
* @throws {RequiredError}
|
|
50097
|
+
* @memberof ReportApiInterface
|
|
50098
|
+
*/
|
|
50099
|
+
getEndOfDayReportFile(businessId: number, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, language?: ReportLanguage, options?: AxiosRequestConfig): AxiosPromise<File>;
|
|
48213
50100
|
/**
|
|
48214
50101
|
*
|
|
48215
50102
|
* @summary Get end-of-day financial report (V5)
|
|
@@ -48238,12 +50125,82 @@ export interface ReportApiInterface {
|
|
|
48238
50125
|
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
48239
50126
|
* @param {string} [compareStart] With compareEnd, compares the report with these whole days: each group then also answers comparison, the same group over them, and the change of every total worked out exactly. The first business day compared, YYYY-MM-DD, in the report\'s time zone; not later than today. Neither sent: no comparison, and the answer is as before. Sent without compareEnd: refused
|
|
48240
50127
|
* @param {string} [compareEnd] With compareStart: the last business day compared, YYYY-MM-DD, inclusive; a day later than today is read up to now. Sent without compareStart: refused
|
|
50128
|
+
* @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\'s last day is still running, both last days, the report\'s and the compared one, are added up only to the last full hour the data has reached, on each venue\'s own clock (today until 14:00 against that day until 14:00), so neither side counts minutes the other does not; earlier days stay whole. Each group whose compared day was cut answers comparison.comparedUntil. Only totals are cut (salesReport\'s and paymentReport.summary\'s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the day\'s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
|
|
48241
50129
|
* @param {string} [baseline] One group of the answer every other group is compared with: venue:<id> with breakdown venue, app:<app> with breakdown app, venue:<id>,app:<app> with breakdown venue_app. Every other group then answers changesFromBaseline (current: the group; previous: the baseline), of the main period only; a group in another currency than the baseline\'s answers changesFromBaselineLeftOut instead. Refused when the breakdown does not split on what it names, or it names a venue or app not asked
|
|
48242
50130
|
* @param {*} [options] Override http request option.
|
|
48243
50131
|
* @throws {RequiredError}
|
|
48244
50132
|
* @memberof ReportApiInterface
|
|
48245
50133
|
*/
|
|
48246
|
-
getSalesReport(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, parts?: Array<ReportPart>, breakdown?: ReportBreakdown, language?: string, compareStart?: string, compareEnd?: string, baseline?: string, options?: AxiosRequestConfig): AxiosPromise<SalesReportResponseDto>;
|
|
50134
|
+
getSalesReport(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, parts?: Array<ReportPart>, breakdown?: ReportBreakdown, language?: string, compareStart?: string, compareEnd?: string, compareSameTime?: boolean, baseline?: string, options?: AxiosRequestConfig): AxiosPromise<SalesReportResponseDto>;
|
|
50135
|
+
/**
|
|
50136
|
+
* The venue\'s sales report over the channels it has enabled (its active providers: MunchiPos is POS; MunchiKiosk, MunchiKioskV2 and Kiosk are the kiosk; Storefront is the storefront and the mobile app), added together: the same report GET /api/v6/report/sales answers for those apps with breakdown none, so its totals are that route\'s. The PDF prints a summary (channels, orders, average order value, gross sales, refunds), the sales breakdown (categories, items, VAT) and the payments breakdown (payment methods, vouchers, tips, discounts). With format xlsx the same report is an Excel workbook of plain numbers in the venue\'s currency, with the PDF\'s totals: sheets Summary, Items (every item and every option on its own row), Categories, VAT by rate, Payments, Vouchers & extras and Discounts. The period is whole business days, as that route reads them: timeSpan DAY, WEEK, MONTH or YEAR, or CUSTOM between start and end. Answers application/pdf (format pdf, the default) or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (format xlsx) with Content-Disposition attachment, named sales-report-<businessId>-<first day>-<last day>.pdf or .xlsx.
|
|
50137
|
+
* @summary Sales report of a venue, every channel it has enabled (POS, kiosk, storefront and mobile app), as a PDF or Excel (xlsx) file to download
|
|
50138
|
+
* @param {number} businessId The venue the file is of, by business id
|
|
50139
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
50140
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50141
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50142
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the venue\'s own (Business.timeZone)
|
|
50143
|
+
* @param {ReportLanguage} [language] The language the file is printed in. Absent: English
|
|
50144
|
+
* @param {FileFormat} [format] The file\'s format: pdf, or xlsx for an Excel workbook of the same report with every item and option on its own row. Absent: pdf
|
|
50145
|
+
* @param {*} [options] Override http request option.
|
|
50146
|
+
* @throws {RequiredError}
|
|
50147
|
+
* @memberof ReportApiInterface
|
|
50148
|
+
*/
|
|
50149
|
+
getSalesReportFile(businessId: number, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, language?: ReportLanguage, format?: FileFormat, options?: AxiosRequestConfig): AxiosPromise<File>;
|
|
50150
|
+
/**
|
|
50151
|
+
* The period GET /api/v6/report/sales would add up, for the same venues, apps, time zone and breakdown, with the same access, per hour of each venue\'s own clock (hourly_summary): each hour\'s orders and totalWithTax, added up by the report\'s own rules, and their average over the period\'s calendar days, of isoWeekday only when it is sent. Busy hours: a month, its averageOrderCount. A normal Tuesday beside today: the last 8 weeks with isoWeekday 2, against today\'s own hours. A day sold on before hours were kept answers in no hour and is counted in daysWithoutHours.
|
|
50152
|
+
* @summary Sales of the venues and apps per hour of the day, with each hour\'s average day
|
|
50153
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
50154
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
50155
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50156
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50157
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
50158
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
50159
|
+
* @param {ReportBreakdown} [breakdown] How the venues and apps are split into groups; every currency always splits, and one app asked is never added into several apps. Absent: venue for several venues, none for one
|
|
50160
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
50161
|
+
* @param {number} [isoWeekday] Only the business days of this ISO weekday count, 1 Monday to 7 Sunday, in the report\'s time zone; the average then is over those days. Absent: every day of the period. A normal Tuesday: the last 8 weeks before today with isoWeekday 2
|
|
50162
|
+
* @param {*} [options] Override http request option.
|
|
50163
|
+
* @throws {RequiredError}
|
|
50164
|
+
* @memberof ReportApiInterface
|
|
50165
|
+
*/
|
|
50166
|
+
getSalesReportHours(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, breakdown?: ReportBreakdown, language?: string, isoWeekday?: number, options?: AxiosRequestConfig): AxiosPromise<SalesReportHoursResponseDto>;
|
|
50167
|
+
/**
|
|
50168
|
+
* The period GET /api/v6/report/sales would add up, for the same venues, apps, time zone and breakdown, with the same access, per order type (daily_order_types): each type\'s orders and sales, added up by the report\'s own rules. The till and the kiosk write dine_in or pick_up, the online store\'s Vendure dine_in, pickup or delivery; anything else, and an online order counted from its Postgres copy, is unknown, never guessed. A day sold on before order types were kept answers in no type and is counted in daysWithoutOrderTypes.
|
|
50169
|
+
* @summary Sales of the venues and apps per order type: eat in, takeaway, delivery
|
|
50170
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
50171
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
50172
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50173
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50174
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
50175
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
50176
|
+
* @param {ReportBreakdown} [breakdown] How the venues and apps are split into groups; every currency always splits, and one app asked is never added into several apps. Absent: venue for several venues, none for one
|
|
50177
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
50178
|
+
* @param {*} [options] Override http request option.
|
|
50179
|
+
* @throws {RequiredError}
|
|
50180
|
+
* @memberof ReportApiInterface
|
|
50181
|
+
*/
|
|
50182
|
+
getSalesReportOrderTypes(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, breakdown?: ReportBreakdown, language?: string, options?: AxiosRequestConfig): AxiosPromise<SalesReportOrderTypesResponseDto>;
|
|
50183
|
+
/**
|
|
50184
|
+
* The report GET /api/v6/report/sales answers for the same query, with the same access, short enough to read whole: the same totals, orderCount, averageOrderValue, days, VAT, payments, discounts, comparison, changes and changesFromBaseline, every amount rounded to the currency\'s minor digits; with part items, each category\'s totals (with and without VAT) without its items, and topItemsBySales and topItemsByQuantity, the 10 best-selling items with an item of the same name in several categories added up once. For every item with its VAT, its net and its options, read GET /api/v6/report/sales.
|
|
50185
|
+
* @summary Sales report of the venues and apps, short: totals, categories and best-selling items
|
|
50186
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
50187
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
50188
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50189
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50190
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
50191
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
50192
|
+
* @param {Array<ReportPart>} [parts] The parts to answer, the parameter repeated or a JSON list; only their daily tables are read. Absent: all five
|
|
50193
|
+
* @param {ReportBreakdown} [breakdown] How the venues and apps are split into groups; every currency always splits, and one app asked is never added into several apps. Absent: venue for several venues, none for one
|
|
50194
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
50195
|
+
* @param {string} [compareStart] With compareEnd, compares the report with these whole days: each group then also answers comparison, the same group over them, and the change of every total worked out exactly. The first business day compared, YYYY-MM-DD, in the report\'s time zone; not later than today. Neither sent: no comparison, and the answer is as before. Sent without compareEnd: refused
|
|
50196
|
+
* @param {string} [compareEnd] With compareStart: the last business day compared, YYYY-MM-DD, inclusive; a day later than today is read up to now. Sent without compareStart: refused
|
|
50197
|
+
* @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\'s last day is still running, both last days, the report\'s and the compared one, are added up only to the last full hour the data has reached, on each venue\'s own clock (today until 14:00 against that day until 14:00), so neither side counts minutes the other does not; earlier days stay whole. Each group whose compared day was cut answers comparison.comparedUntil. Only totals are cut (salesReport\'s and paymentReport.summary\'s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the day\'s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
|
|
50198
|
+
* @param {string} [baseline] One group of the answer every other group is compared with: venue:<id> with breakdown venue, app:<app> with breakdown app, venue:<id>,app:<app> with breakdown venue_app. Every other group then answers changesFromBaseline (current: the group; previous: the baseline), of the main period only; a group in another currency than the baseline\'s answers changesFromBaselineLeftOut instead. Refused when the breakdown does not split on what it names, or it names a venue or app not asked
|
|
50199
|
+
* @param {*} [options] Override http request option.
|
|
50200
|
+
* @throws {RequiredError}
|
|
50201
|
+
* @memberof ReportApiInterface
|
|
50202
|
+
*/
|
|
50203
|
+
getShortSalesReport(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, parts?: Array<ReportPart>, breakdown?: ReportBreakdown, language?: string, compareStart?: string, compareEnd?: string, compareSameTime?: boolean, baseline?: string, options?: AxiosRequestConfig): AxiosPromise<SalesReportShortResponseDto>;
|
|
48247
50204
|
/**
|
|
48248
50205
|
*
|
|
48249
50206
|
* @summary Send end-of-day report via email (V5)
|
|
@@ -48267,6 +50224,39 @@ export interface ReportApiInterface {
|
|
|
48267
50224
|
* @extends {BaseAPI}
|
|
48268
50225
|
*/
|
|
48269
50226
|
export declare class ReportApi extends BaseAPI implements ReportApiInterface {
|
|
50227
|
+
/**
|
|
50228
|
+
* The period GET /api/v6/report/sales would add up, for the same venues, apps, time zone and breakdown, with the same access: each group\'s pairs of base items (an item\'s own line, never an option) sold in the most orders, each order once, with every order of each item, so percentOfItemA is exact: of the orders with A, how many also had B. Each venue-day keeps its top 25 pairs (daily_item_pairs); a group whose daysWithPairsCut is not 0 answers each pair\'s orders as a lower bound. itemKey answers the pairs of one item only.
|
|
50229
|
+
* @summary Items bought together in one order, over the period
|
|
50230
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
50231
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
50232
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50233
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50234
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
50235
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
50236
|
+
* @param {ReportBreakdown} [breakdown] How the venues and apps are split into groups; every currency always splits, and one app asked is never added into several apps. Absent: venue for several venues, none for one
|
|
50237
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
50238
|
+
* @param {string} [itemKey] Only the pairs with this item, by its key (an item\'s itemKey of an earlier answer: the POS posId, the online product id). Absent: every pair
|
|
50239
|
+
* @param {number} [limit] How many pairs each group answers, most orders first: 1 to 100. Absent: 20
|
|
50240
|
+
* @param {*} [options] Override http request option.
|
|
50241
|
+
* @throws {RequiredError}
|
|
50242
|
+
* @memberof ReportApi
|
|
50243
|
+
*/
|
|
50244
|
+
getBoughtTogether(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, breakdown?: ReportBreakdown, language?: string, itemKey?: string, limit?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SalesReportBoughtTogetherResponseDto, any, {}>>;
|
|
50245
|
+
/**
|
|
50246
|
+
* The same report, rendered by the same generator, as the PDF the report e-mail (POST /api/v6/report/email) attaches, answered as the file itself instead of e-mailed. The period is the e-mail\'s: timeSpan DAY (the venue\'s business day), WEEK, MONTH, YEAR, or CUSTOM between start and end. A till\'s ticket gets it narrowed to the person on the till, as the e-mail is. Answers application/pdf with Content-Disposition attachment and the file\'s name.
|
|
50247
|
+
* @summary End-of-day sales report of a venue as a PDF file to download, for a day, week, month, year or custom period
|
|
50248
|
+
* @param {number} businessId The venue the file is of, by business id
|
|
50249
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
50250
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50251
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50252
|
+
* @param {string} [timezone] The IANA time zone the period\'s days are counted in. Absent: the venue\'s own
|
|
50253
|
+
* @param {ProviderEnum} [provider] The order source the report counts. Absent: MunchiPos, as the till\'s report
|
|
50254
|
+
* @param {ReportLanguage} [language] The language the file is printed in. Absent: English
|
|
50255
|
+
* @param {*} [options] Override http request option.
|
|
50256
|
+
* @throws {RequiredError}
|
|
50257
|
+
* @memberof ReportApi
|
|
50258
|
+
*/
|
|
50259
|
+
getEndOfDayReportFile(businessId: number, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, language?: ReportLanguage, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
|
|
48270
50260
|
/**
|
|
48271
50261
|
*
|
|
48272
50262
|
* @summary Get end-of-day financial report (V5)
|
|
@@ -48295,12 +50285,82 @@ export declare class ReportApi extends BaseAPI implements ReportApiInterface {
|
|
|
48295
50285
|
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
48296
50286
|
* @param {string} [compareStart] With compareEnd, compares the report with these whole days: each group then also answers comparison, the same group over them, and the change of every total worked out exactly. The first business day compared, YYYY-MM-DD, in the report\'s time zone; not later than today. Neither sent: no comparison, and the answer is as before. Sent without compareEnd: refused
|
|
48297
50287
|
* @param {string} [compareEnd] With compareStart: the last business day compared, YYYY-MM-DD, inclusive; a day later than today is read up to now. Sent without compareStart: refused
|
|
50288
|
+
* @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\'s last day is still running, both last days, the report\'s and the compared one, are added up only to the last full hour the data has reached, on each venue\'s own clock (today until 14:00 against that day until 14:00), so neither side counts minutes the other does not; earlier days stay whole. Each group whose compared day was cut answers comparison.comparedUntil. Only totals are cut (salesReport\'s and paymentReport.summary\'s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the day\'s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
|
|
50289
|
+
* @param {string} [baseline] One group of the answer every other group is compared with: venue:<id> with breakdown venue, app:<app> with breakdown app, venue:<id>,app:<app> with breakdown venue_app. Every other group then answers changesFromBaseline (current: the group; previous: the baseline), of the main period only; a group in another currency than the baseline\'s answers changesFromBaselineLeftOut instead. Refused when the breakdown does not split on what it names, or it names a venue or app not asked
|
|
50290
|
+
* @param {*} [options] Override http request option.
|
|
50291
|
+
* @throws {RequiredError}
|
|
50292
|
+
* @memberof ReportApi
|
|
50293
|
+
*/
|
|
50294
|
+
getSalesReport(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, parts?: Array<ReportPart>, breakdown?: ReportBreakdown, language?: string, compareStart?: string, compareEnd?: string, compareSameTime?: boolean, baseline?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SalesReportResponseDto, any, {}>>;
|
|
50295
|
+
/**
|
|
50296
|
+
* The venue\'s sales report over the channels it has enabled (its active providers: MunchiPos is POS; MunchiKiosk, MunchiKioskV2 and Kiosk are the kiosk; Storefront is the storefront and the mobile app), added together: the same report GET /api/v6/report/sales answers for those apps with breakdown none, so its totals are that route\'s. The PDF prints a summary (channels, orders, average order value, gross sales, refunds), the sales breakdown (categories, items, VAT) and the payments breakdown (payment methods, vouchers, tips, discounts). With format xlsx the same report is an Excel workbook of plain numbers in the venue\'s currency, with the PDF\'s totals: sheets Summary, Items (every item and every option on its own row), Categories, VAT by rate, Payments, Vouchers & extras and Discounts. The period is whole business days, as that route reads them: timeSpan DAY, WEEK, MONTH or YEAR, or CUSTOM between start and end. Answers application/pdf (format pdf, the default) or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (format xlsx) with Content-Disposition attachment, named sales-report-<businessId>-<first day>-<last day>.pdf or .xlsx.
|
|
50297
|
+
* @summary Sales report of a venue, every channel it has enabled (POS, kiosk, storefront and mobile app), as a PDF or Excel (xlsx) file to download
|
|
50298
|
+
* @param {number} businessId The venue the file is of, by business id
|
|
50299
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
50300
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50301
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50302
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the venue\'s own (Business.timeZone)
|
|
50303
|
+
* @param {ReportLanguage} [language] The language the file is printed in. Absent: English
|
|
50304
|
+
* @param {FileFormat} [format] The file\'s format: pdf, or xlsx for an Excel workbook of the same report with every item and option on its own row. Absent: pdf
|
|
50305
|
+
* @param {*} [options] Override http request option.
|
|
50306
|
+
* @throws {RequiredError}
|
|
50307
|
+
* @memberof ReportApi
|
|
50308
|
+
*/
|
|
50309
|
+
getSalesReportFile(businessId: number, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, language?: ReportLanguage, format?: FileFormat, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
|
|
50310
|
+
/**
|
|
50311
|
+
* The period GET /api/v6/report/sales would add up, for the same venues, apps, time zone and breakdown, with the same access, per hour of each venue\'s own clock (hourly_summary): each hour\'s orders and totalWithTax, added up by the report\'s own rules, and their average over the period\'s calendar days, of isoWeekday only when it is sent. Busy hours: a month, its averageOrderCount. A normal Tuesday beside today: the last 8 weeks with isoWeekday 2, against today\'s own hours. A day sold on before hours were kept answers in no hour and is counted in daysWithoutHours.
|
|
50312
|
+
* @summary Sales of the venues and apps per hour of the day, with each hour\'s average day
|
|
50313
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
50314
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
50315
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50316
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50317
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
50318
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
50319
|
+
* @param {ReportBreakdown} [breakdown] How the venues and apps are split into groups; every currency always splits, and one app asked is never added into several apps. Absent: venue for several venues, none for one
|
|
50320
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
50321
|
+
* @param {number} [isoWeekday] Only the business days of this ISO weekday count, 1 Monday to 7 Sunday, in the report\'s time zone; the average then is over those days. Absent: every day of the period. A normal Tuesday: the last 8 weeks before today with isoWeekday 2
|
|
50322
|
+
* @param {*} [options] Override http request option.
|
|
50323
|
+
* @throws {RequiredError}
|
|
50324
|
+
* @memberof ReportApi
|
|
50325
|
+
*/
|
|
50326
|
+
getSalesReportHours(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, breakdown?: ReportBreakdown, language?: string, isoWeekday?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SalesReportHoursResponseDto, any, {}>>;
|
|
50327
|
+
/**
|
|
50328
|
+
* The period GET /api/v6/report/sales would add up, for the same venues, apps, time zone and breakdown, with the same access, per order type (daily_order_types): each type\'s orders and sales, added up by the report\'s own rules. The till and the kiosk write dine_in or pick_up, the online store\'s Vendure dine_in, pickup or delivery; anything else, and an online order counted from its Postgres copy, is unknown, never guessed. A day sold on before order types were kept answers in no type and is counted in daysWithoutOrderTypes.
|
|
50329
|
+
* @summary Sales of the venues and apps per order type: eat in, takeaway, delivery
|
|
50330
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
50331
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
50332
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50333
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50334
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
50335
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
50336
|
+
* @param {ReportBreakdown} [breakdown] How the venues and apps are split into groups; every currency always splits, and one app asked is never added into several apps. Absent: venue for several venues, none for one
|
|
50337
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
50338
|
+
* @param {*} [options] Override http request option.
|
|
50339
|
+
* @throws {RequiredError}
|
|
50340
|
+
* @memberof ReportApi
|
|
50341
|
+
*/
|
|
50342
|
+
getSalesReportOrderTypes(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, breakdown?: ReportBreakdown, language?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SalesReportOrderTypesResponseDto, any, {}>>;
|
|
50343
|
+
/**
|
|
50344
|
+
* The report GET /api/v6/report/sales answers for the same query, with the same access, short enough to read whole: the same totals, orderCount, averageOrderValue, days, VAT, payments, discounts, comparison, changes and changesFromBaseline, every amount rounded to the currency\'s minor digits; with part items, each category\'s totals (with and without VAT) without its items, and topItemsBySales and topItemsByQuantity, the 10 best-selling items with an item of the same name in several categories added up once. For every item with its VAT, its net and its options, read GET /api/v6/report/sales.
|
|
50345
|
+
* @summary Sales report of the venues and apps, short: totals, categories and best-selling items
|
|
50346
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
50347
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
50348
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50349
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
50350
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
50351
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
50352
|
+
* @param {Array<ReportPart>} [parts] The parts to answer, the parameter repeated or a JSON list; only their daily tables are read. Absent: all five
|
|
50353
|
+
* @param {ReportBreakdown} [breakdown] How the venues and apps are split into groups; every currency always splits, and one app asked is never added into several apps. Absent: venue for several venues, none for one
|
|
50354
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
50355
|
+
* @param {string} [compareStart] With compareEnd, compares the report with these whole days: each group then also answers comparison, the same group over them, and the change of every total worked out exactly. The first business day compared, YYYY-MM-DD, in the report\'s time zone; not later than today. Neither sent: no comparison, and the answer is as before. Sent without compareEnd: refused
|
|
50356
|
+
* @param {string} [compareEnd] With compareStart: the last business day compared, YYYY-MM-DD, inclusive; a day later than today is read up to now. Sent without compareStart: refused
|
|
50357
|
+
* @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\'s last day is still running, both last days, the report\'s and the compared one, are added up only to the last full hour the data has reached, on each venue\'s own clock (today until 14:00 against that day until 14:00), so neither side counts minutes the other does not; earlier days stay whole. Each group whose compared day was cut answers comparison.comparedUntil. Only totals are cut (salesReport\'s and paymentReport.summary\'s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the day\'s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
|
|
48298
50358
|
* @param {string} [baseline] One group of the answer every other group is compared with: venue:<id> with breakdown venue, app:<app> with breakdown app, venue:<id>,app:<app> with breakdown venue_app. Every other group then answers changesFromBaseline (current: the group; previous: the baseline), of the main period only; a group in another currency than the baseline\'s answers changesFromBaselineLeftOut instead. Refused when the breakdown does not split on what it names, or it names a venue or app not asked
|
|
48299
50359
|
* @param {*} [options] Override http request option.
|
|
48300
50360
|
* @throws {RequiredError}
|
|
48301
50361
|
* @memberof ReportApi
|
|
48302
50362
|
*/
|
|
48303
|
-
|
|
50363
|
+
getShortSalesReport(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, parts?: Array<ReportPart>, breakdown?: ReportBreakdown, language?: string, compareStart?: string, compareEnd?: string, compareSameTime?: boolean, baseline?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SalesReportShortResponseDto, any, {}>>;
|
|
48304
50364
|
/**
|
|
48305
50365
|
*
|
|
48306
50366
|
* @summary Send end-of-day report via email (V5)
|