@munchi_oy/core 2.0.2 → 2.0.4
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 +1591 -9
- 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 +1841 -9
- package/package.json +1 -1
- package/src/version.ts +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -2275,6 +2275,50 @@ export interface ChangePaymentMethodOptionDto {
|
|
|
2275
2275
|
*/
|
|
2276
2276
|
'enable'?: boolean;
|
|
2277
2277
|
}
|
|
2278
|
+
/**
|
|
2279
|
+
*
|
|
2280
|
+
* @export
|
|
2281
|
+
* @interface ChangePosOrdersStatusInBulkDto
|
|
2282
|
+
*/
|
|
2283
|
+
export interface ChangePosOrdersStatusInBulkDto {
|
|
2284
|
+
/**
|
|
2285
|
+
* The venue whose tickets and orders the till moves, by its venue id
|
|
2286
|
+
* @type {number}
|
|
2287
|
+
* @memberof ChangePosOrdersStatusInBulkDto
|
|
2288
|
+
*/
|
|
2289
|
+
'orderingBusinessId': number;
|
|
2290
|
+
/**
|
|
2291
|
+
* The ids in Firestore of the till\'s tickets and orders to move, each once, 1 to 100 of them
|
|
2292
|
+
* @type {Array<string>}
|
|
2293
|
+
* @memberof ChangePosOrdersStatusInBulkDto
|
|
2294
|
+
*/
|
|
2295
|
+
'orderIds': Array<string>;
|
|
2296
|
+
/**
|
|
2297
|
+
*
|
|
2298
|
+
* @type {PosBulkOrderStatus}
|
|
2299
|
+
* @memberof ChangePosOrdersStatusInBulkDto
|
|
2300
|
+
*/
|
|
2301
|
+
'status': PosBulkOrderStatus;
|
|
2302
|
+
}
|
|
2303
|
+
/**
|
|
2304
|
+
*
|
|
2305
|
+
* @export
|
|
2306
|
+
* @interface ChangePosOrdersStatusInBulkResponseDto
|
|
2307
|
+
*/
|
|
2308
|
+
export interface ChangePosOrdersStatusInBulkResponseDto {
|
|
2309
|
+
/**
|
|
2310
|
+
* The ids of the tickets and orders moved to the status, in the order the till sent them; empty when none could be
|
|
2311
|
+
* @type {Array<string>}
|
|
2312
|
+
* @memberof ChangePosOrdersStatusInBulkResponseDto
|
|
2313
|
+
*/
|
|
2314
|
+
'moved': Array<string>;
|
|
2315
|
+
/**
|
|
2316
|
+
* The ids left as they are, each with the reason, in the order the till sent them; empty when every one moved
|
|
2317
|
+
* @type {Array<PosOrderLeftAsItIsDto>}
|
|
2318
|
+
* @memberof ChangePosOrdersStatusInBulkResponseDto
|
|
2319
|
+
*/
|
|
2320
|
+
'skipped': Array<PosOrderLeftAsItIsDto>;
|
|
2321
|
+
}
|
|
2278
2322
|
/**
|
|
2279
2323
|
*
|
|
2280
2324
|
* @export
|
|
@@ -6397,9 +6441,10 @@ export interface ExtendedProductDto {
|
|
|
6397
6441
|
*/
|
|
6398
6442
|
'images': string;
|
|
6399
6443
|
/**
|
|
6400
|
-
* SKU of the product
|
|
6444
|
+
* SKU of the product: its first one. Read skus instead
|
|
6401
6445
|
* @type {string}
|
|
6402
6446
|
* @memberof ExtendedProductDto
|
|
6447
|
+
* @deprecated
|
|
6403
6448
|
*/
|
|
6404
6449
|
'sku'?: string | null;
|
|
6405
6450
|
/**
|
|
@@ -6564,6 +6609,12 @@ export interface ExtendedProductDto {
|
|
|
6564
6609
|
* @memberof ExtendedProductDto
|
|
6565
6610
|
*/
|
|
6566
6611
|
'channel_configs': Array<ChannelConfig>;
|
|
6612
|
+
/**
|
|
6613
|
+
* Every SKU of the product, in order, the first being sku; absent where the product\'s SKUs are not read, such as on an order line
|
|
6614
|
+
* @type {Array<string>}
|
|
6615
|
+
* @memberof ExtendedProductDto
|
|
6616
|
+
*/
|
|
6617
|
+
'skus'?: Array<string>;
|
|
6567
6618
|
/**
|
|
6568
6619
|
* Default course ID assigned to this product
|
|
6569
6620
|
* @type {string}
|
|
@@ -8275,6 +8326,17 @@ export declare const KDSEVENTNAME: {
|
|
|
8275
8326
|
readonly PrintingOrder: "printing.order";
|
|
8276
8327
|
};
|
|
8277
8328
|
export type KDSEVENTNAME = typeof KDSEVENTNAME[keyof typeof KDSEVENTNAME];
|
|
8329
|
+
/**
|
|
8330
|
+
*
|
|
8331
|
+
* @export
|
|
8332
|
+
* @enum {string}
|
|
8333
|
+
*/
|
|
8334
|
+
export declare const KdsBulkReadySkipReason: {
|
|
8335
|
+
readonly Found: "NOT_FOUND";
|
|
8336
|
+
readonly Pos: "NOT_POS";
|
|
8337
|
+
readonly InProgress: "NOT_IN_PROGRESS";
|
|
8338
|
+
};
|
|
8339
|
+
export type KdsBulkReadySkipReason = typeof KdsBulkReadySkipReason[keyof typeof KdsBulkReadySkipReason];
|
|
8278
8340
|
/**
|
|
8279
8341
|
*
|
|
8280
8342
|
* @export
|
|
@@ -8479,6 +8541,31 @@ export interface KdsLocationDtoCoordinates {
|
|
|
8479
8541
|
*/
|
|
8480
8542
|
'lon': number | null;
|
|
8481
8543
|
}
|
|
8544
|
+
/**
|
|
8545
|
+
*
|
|
8546
|
+
* @export
|
|
8547
|
+
* @interface KdsMarkOrdersReadyDto
|
|
8548
|
+
*/
|
|
8549
|
+
export interface KdsMarkOrdersReadyDto {
|
|
8550
|
+
/**
|
|
8551
|
+
* The venue\'s orderingBusinessId
|
|
8552
|
+
* @type {number}
|
|
8553
|
+
* @memberof KdsMarkOrdersReadyDto
|
|
8554
|
+
*/
|
|
8555
|
+
'businessId': number;
|
|
8556
|
+
/**
|
|
8557
|
+
* The id of the station (KDS profile) whose orders are marked ready
|
|
8558
|
+
* @type {string}
|
|
8559
|
+
* @memberof KdsMarkOrdersReadyDto
|
|
8560
|
+
*/
|
|
8561
|
+
'profileId': string;
|
|
8562
|
+
/**
|
|
8563
|
+
* The KDS orders\' ids in kds-service, each once, 1 to 100 of them
|
|
8564
|
+
* @type {Array<string>}
|
|
8565
|
+
* @memberof KdsMarkOrdersReadyDto
|
|
8566
|
+
*/
|
|
8567
|
+
'orderIds': Array<string>;
|
|
8568
|
+
}
|
|
8482
8569
|
/**
|
|
8483
8570
|
*
|
|
8484
8571
|
* @export
|
|
@@ -8851,6 +8938,25 @@ export interface KdsOrderItemDto {
|
|
|
8851
8938
|
*/
|
|
8852
8939
|
'options': Array<KdsOrderOptionDto>;
|
|
8853
8940
|
}
|
|
8941
|
+
/**
|
|
8942
|
+
*
|
|
8943
|
+
* @export
|
|
8944
|
+
* @interface KdsOrderLeftAsItIsDto
|
|
8945
|
+
*/
|
|
8946
|
+
export interface KdsOrderLeftAsItIsDto {
|
|
8947
|
+
/**
|
|
8948
|
+
* The id of a KDS order kds-service did not mark ready
|
|
8949
|
+
* @type {string}
|
|
8950
|
+
* @memberof KdsOrderLeftAsItIsDto
|
|
8951
|
+
*/
|
|
8952
|
+
'orderId': string;
|
|
8953
|
+
/**
|
|
8954
|
+
*
|
|
8955
|
+
* @type {KdsBulkReadySkipReason}
|
|
8956
|
+
* @memberof KdsOrderLeftAsItIsDto
|
|
8957
|
+
*/
|
|
8958
|
+
'reason': KdsBulkReadySkipReason;
|
|
8959
|
+
}
|
|
8854
8960
|
/**
|
|
8855
8961
|
*
|
|
8856
8962
|
* @export
|
|
@@ -9601,6 +9707,43 @@ export interface KdsReadyOrderResponseDtoOrder {
|
|
|
9601
9707
|
*/
|
|
9602
9708
|
'items': Array<KdsOrderItemDto>;
|
|
9603
9709
|
}
|
|
9710
|
+
/**
|
|
9711
|
+
*
|
|
9712
|
+
* @export
|
|
9713
|
+
* @interface KdsReadyOrdersResponseDto
|
|
9714
|
+
*/
|
|
9715
|
+
export interface KdsReadyOrdersResponseDto {
|
|
9716
|
+
/**
|
|
9717
|
+
* The ids of the KDS orders marked ready; empty when none were
|
|
9718
|
+
* @type {Array<string>}
|
|
9719
|
+
* @memberof KdsReadyOrdersResponseDto
|
|
9720
|
+
*/
|
|
9721
|
+
'ready': Array<string>;
|
|
9722
|
+
/**
|
|
9723
|
+
* The ids kds-service left as they are, each with its reason; empty when none were
|
|
9724
|
+
* @type {Array<KdsOrderLeftAsItIsDto>}
|
|
9725
|
+
* @memberof KdsReadyOrdersResponseDto
|
|
9726
|
+
*/
|
|
9727
|
+
'skipped': Array<KdsOrderLeftAsItIsDto>;
|
|
9728
|
+
/**
|
|
9729
|
+
* The ids of tickets kds-service marked ready whose status it could not pass on to this server, so the till may not show them ready yet; absent when every one was passed on
|
|
9730
|
+
* @type {Array<string>}
|
|
9731
|
+
* @memberof KdsReadyOrdersResponseDto
|
|
9732
|
+
*/
|
|
9733
|
+
'notAnnounced'?: Array<string>;
|
|
9734
|
+
/**
|
|
9735
|
+
* true when kds-service answered; false when it refused or could not be reached, and then nothing is listed
|
|
9736
|
+
* @type {boolean}
|
|
9737
|
+
* @memberof KdsReadyOrdersResponseDto
|
|
9738
|
+
*/
|
|
9739
|
+
'status': boolean;
|
|
9740
|
+
/**
|
|
9741
|
+
* Human-readable status message
|
|
9742
|
+
* @type {string}
|
|
9743
|
+
* @memberof KdsReadyOrdersResponseDto
|
|
9744
|
+
*/
|
|
9745
|
+
'message': string;
|
|
9746
|
+
}
|
|
9604
9747
|
/**
|
|
9605
9748
|
*
|
|
9606
9749
|
* @export
|
|
@@ -17405,6 +17548,28 @@ export interface PosActionPasscodeDto {
|
|
|
17405
17548
|
*/
|
|
17406
17549
|
'pinHash': string;
|
|
17407
17550
|
}
|
|
17551
|
+
/**
|
|
17552
|
+
*
|
|
17553
|
+
* @export
|
|
17554
|
+
* @enum {string}
|
|
17555
|
+
*/
|
|
17556
|
+
export declare const PosBulkOrderStatus: {
|
|
17557
|
+
readonly Ready: "ready";
|
|
17558
|
+
readonly Delivered: "delivered";
|
|
17559
|
+
};
|
|
17560
|
+
export type PosBulkOrderStatus = typeof PosBulkOrderStatus[keyof typeof PosBulkOrderStatus];
|
|
17561
|
+
/**
|
|
17562
|
+
*
|
|
17563
|
+
* @export
|
|
17564
|
+
* @enum {string}
|
|
17565
|
+
*/
|
|
17566
|
+
export declare const PosBulkStatusSkipReason: {
|
|
17567
|
+
readonly NotFound: "NOT_FOUND";
|
|
17568
|
+
readonly NotInProgress: "NOT_IN_PROGRESS";
|
|
17569
|
+
readonly KitchenControlled: "KITCHEN_CONTROLLED";
|
|
17570
|
+
readonly NotReady: "NOT_READY";
|
|
17571
|
+
};
|
|
17572
|
+
export type PosBulkStatusSkipReason = typeof PosBulkStatusSkipReason[keyof typeof PosBulkStatusSkipReason];
|
|
17408
17573
|
/**
|
|
17409
17574
|
*
|
|
17410
17575
|
* @export
|
|
@@ -17746,9 +17911,10 @@ export interface PosItemDto {
|
|
|
17746
17911
|
*/
|
|
17747
17912
|
'images': string;
|
|
17748
17913
|
/**
|
|
17749
|
-
* SKU of the product
|
|
17914
|
+
* SKU of the product: its first one. Read skus instead
|
|
17750
17915
|
* @type {string}
|
|
17751
17916
|
* @memberof PosItemDto
|
|
17917
|
+
* @deprecated
|
|
17752
17918
|
*/
|
|
17753
17919
|
'sku'?: string | null;
|
|
17754
17920
|
/**
|
|
@@ -17913,6 +18079,12 @@ export interface PosItemDto {
|
|
|
17913
18079
|
* @memberof PosItemDto
|
|
17914
18080
|
*/
|
|
17915
18081
|
'channel_configs': Array<ChannelConfig>;
|
|
18082
|
+
/**
|
|
18083
|
+
* Every SKU of the product, in order, the first being sku; absent where the product\'s SKUs are not read, such as on an order line
|
|
18084
|
+
* @type {Array<string>}
|
|
18085
|
+
* @memberof PosItemDto
|
|
18086
|
+
*/
|
|
18087
|
+
'skus'?: Array<string>;
|
|
17916
18088
|
/**
|
|
17917
18089
|
* Default course ID assigned to this product
|
|
17918
18090
|
* @type {string}
|
|
@@ -18256,11 +18428,18 @@ export interface PosMenuProductDto {
|
|
|
18256
18428
|
*/
|
|
18257
18429
|
'images': string;
|
|
18258
18430
|
/**
|
|
18259
|
-
* The product\'s stock-keeping code, or null when it has none
|
|
18431
|
+
* The product\'s first stock-keeping code, or null when it has none. Read skus instead
|
|
18260
18432
|
* @type {string}
|
|
18261
18433
|
* @memberof PosMenuProductDto
|
|
18434
|
+
* @deprecated
|
|
18262
18435
|
*/
|
|
18263
18436
|
'sku': string | null;
|
|
18437
|
+
/**
|
|
18438
|
+
* Every stock-keeping code of the product, in order, the first being sku; empty when it has none. Absent from an answer cached before the field existed: read sku then
|
|
18439
|
+
* @type {Array<string>}
|
|
18440
|
+
* @memberof PosMenuProductDto
|
|
18441
|
+
*/
|
|
18442
|
+
'skus'?: Array<string>;
|
|
18264
18443
|
/**
|
|
18265
18444
|
* The product\'s barcode, or null when it has none
|
|
18266
18445
|
* @type {string}
|
|
@@ -19607,6 +19786,25 @@ export interface PosOrderItemSplitSeatDto {
|
|
|
19607
19786
|
*/
|
|
19608
19787
|
'assignments': Array<PosOrderItemSplitSeatAssignmentDto>;
|
|
19609
19788
|
}
|
|
19789
|
+
/**
|
|
19790
|
+
*
|
|
19791
|
+
* @export
|
|
19792
|
+
* @interface PosOrderLeftAsItIsDto
|
|
19793
|
+
*/
|
|
19794
|
+
export interface PosOrderLeftAsItIsDto {
|
|
19795
|
+
/**
|
|
19796
|
+
* The id the till sent of a ticket or an order that was not moved
|
|
19797
|
+
* @type {string}
|
|
19798
|
+
* @memberof PosOrderLeftAsItIsDto
|
|
19799
|
+
*/
|
|
19800
|
+
'orderId': string;
|
|
19801
|
+
/**
|
|
19802
|
+
*
|
|
19803
|
+
* @type {PosBulkStatusSkipReason}
|
|
19804
|
+
* @memberof PosOrderLeftAsItIsDto
|
|
19805
|
+
*/
|
|
19806
|
+
'reason': PosBulkStatusSkipReason;
|
|
19807
|
+
}
|
|
19610
19808
|
/**
|
|
19611
19809
|
*
|
|
19612
19810
|
* @export
|
|
@@ -20799,6 +20997,26 @@ export interface ProductSkuResponseDto {
|
|
|
20799
20997
|
*/
|
|
20800
20998
|
'sku': string;
|
|
20801
20999
|
}
|
|
21000
|
+
/**
|
|
21001
|
+
*
|
|
21002
|
+
* @export
|
|
21003
|
+
* @interface ProductSkusResponseDto
|
|
21004
|
+
*/
|
|
21005
|
+
export interface ProductSkusResponseDto {
|
|
21006
|
+
/**
|
|
21007
|
+
* The first SKU Vendure saved, or null when the product has none. Read skus instead
|
|
21008
|
+
* @type {string}
|
|
21009
|
+
* @memberof ProductSkusResponseDto
|
|
21010
|
+
* @deprecated
|
|
21011
|
+
*/
|
|
21012
|
+
'sku': string | null;
|
|
21013
|
+
/**
|
|
21014
|
+
* Every SKU Vendure saved, trimmed, in order; empty when the product has none
|
|
21015
|
+
* @type {Array<string>}
|
|
21016
|
+
* @memberof ProductSkusResponseDto
|
|
21017
|
+
*/
|
|
21018
|
+
'skus': Array<string>;
|
|
21019
|
+
}
|
|
20802
21020
|
/**
|
|
20803
21021
|
*
|
|
20804
21022
|
* @export
|
|
@@ -22793,6 +23011,71 @@ export interface RejectOrderDto {
|
|
|
22793
23011
|
*/
|
|
22794
23012
|
'reason': string;
|
|
22795
23013
|
}
|
|
23014
|
+
/**
|
|
23015
|
+
*
|
|
23016
|
+
* @export
|
|
23017
|
+
* @enum {string}
|
|
23018
|
+
*/
|
|
23019
|
+
export declare const ReportApp: {
|
|
23020
|
+
readonly Pos: "pos";
|
|
23021
|
+
readonly Kiosk: "kiosk";
|
|
23022
|
+
readonly Storefront: "storefront";
|
|
23023
|
+
readonly Mobile: "mobile";
|
|
23024
|
+
};
|
|
23025
|
+
export type ReportApp = typeof ReportApp[keyof typeof ReportApp];
|
|
23026
|
+
/**
|
|
23027
|
+
*
|
|
23028
|
+
* @export
|
|
23029
|
+
* @enum {string}
|
|
23030
|
+
*/
|
|
23031
|
+
export declare const ReportBaselineLeftOut: {
|
|
23032
|
+
readonly IsTheBaseline: "is_the_baseline";
|
|
23033
|
+
readonly OtherCurrency: "other_currency";
|
|
23034
|
+
};
|
|
23035
|
+
export type ReportBaselineLeftOut = typeof ReportBaselineLeftOut[keyof typeof ReportBaselineLeftOut];
|
|
23036
|
+
/**
|
|
23037
|
+
*
|
|
23038
|
+
* @export
|
|
23039
|
+
* @enum {string}
|
|
23040
|
+
*/
|
|
23041
|
+
export declare const ReportBreakdown: {
|
|
23042
|
+
readonly None: "none";
|
|
23043
|
+
readonly Venue: "venue";
|
|
23044
|
+
readonly App: "app";
|
|
23045
|
+
readonly VenueApp: "venue_app";
|
|
23046
|
+
};
|
|
23047
|
+
export type ReportBreakdown = typeof ReportBreakdown[keyof typeof ReportBreakdown];
|
|
23048
|
+
/**
|
|
23049
|
+
*
|
|
23050
|
+
* @export
|
|
23051
|
+
* @enum {string}
|
|
23052
|
+
*/
|
|
23053
|
+
export declare const ReportChangeField: {
|
|
23054
|
+
readonly SalesReportTotalQuantity: "salesReport.totalQuantity";
|
|
23055
|
+
readonly SalesReportTotalWithTax: "salesReport.totalWithTax";
|
|
23056
|
+
readonly SalesReportTotalTaxAmount: "salesReport.totalTaxAmount";
|
|
23057
|
+
readonly SalesReportTotalWithoutTax: "salesReport.totalWithoutTax";
|
|
23058
|
+
readonly SalesReportDeliveryFee: "salesReport.deliveryFee";
|
|
23059
|
+
readonly SalesReportDeliveryTax: "salesReport.deliveryTax";
|
|
23060
|
+
readonly PaymentReportSummarySalesAndRevenue: "paymentReport.summary.salesAndRevenue";
|
|
23061
|
+
readonly PaymentReportSummaryGrossAmount: "paymentReport.summary.grossAmount";
|
|
23062
|
+
readonly PaymentReportSummaryTotalCount: "paymentReport.summary.totalCount";
|
|
23063
|
+
readonly PaymentReportSummaryTotalAmount: "paymentReport.summary.totalAmount";
|
|
23064
|
+
readonly PaymentReportSummaryCardsCount: "paymentReport.summary.cardsCount";
|
|
23065
|
+
readonly PaymentReportSummaryCardsAmount: "paymentReport.summary.cardsAmount";
|
|
23066
|
+
readonly PaymentReportSummaryEdenredVoucherCount: "paymentReport.summary.edenredVoucherCount";
|
|
23067
|
+
readonly PaymentReportSummaryEdenredVoucherAmount: "paymentReport.summary.edenredVoucherAmount";
|
|
23068
|
+
readonly PaymentReportSummarySmartumVoucherCount: "paymentReport.summary.smartumVoucherCount";
|
|
23069
|
+
readonly PaymentReportSummarySmartumVoucherAmount: "paymentReport.summary.smartumVoucherAmount";
|
|
23070
|
+
readonly PaymentReportSummaryTotalCoupons: "paymentReport.summary.totalCoupons";
|
|
23071
|
+
readonly PaymentReportSummaryTotalVoucherForfeited: "paymentReport.summary.totalVoucherForfeited";
|
|
23072
|
+
readonly PaymentReportSummaryTotalTipAmount: "paymentReport.summary.totalTipAmount";
|
|
23073
|
+
readonly PaymentReportSummaryTotalSurchargeAmount: "paymentReport.summary.totalSurchargeAmount";
|
|
23074
|
+
readonly PaymentReportSummaryTotalRefunds: "paymentReport.summary.totalRefunds";
|
|
23075
|
+
readonly PaymentReportSummaryRefundCount: "paymentReport.summary.refundCount";
|
|
23076
|
+
readonly PaymentReportTotalDiscounts: "paymentReport.totalDiscounts";
|
|
23077
|
+
};
|
|
23078
|
+
export type ReportChangeField = typeof ReportChangeField[keyof typeof ReportChangeField];
|
|
22796
23079
|
/**
|
|
22797
23080
|
*
|
|
22798
23081
|
* @export
|
|
@@ -22803,6 +23086,19 @@ export declare const ReportLanguage: {
|
|
|
22803
23086
|
readonly En: "en";
|
|
22804
23087
|
};
|
|
22805
23088
|
export type ReportLanguage = typeof ReportLanguage[keyof typeof ReportLanguage];
|
|
23089
|
+
/**
|
|
23090
|
+
*
|
|
23091
|
+
* @export
|
|
23092
|
+
* @enum {string}
|
|
23093
|
+
*/
|
|
23094
|
+
export declare const ReportPart: {
|
|
23095
|
+
readonly Summary: "summary";
|
|
23096
|
+
readonly Items: "items";
|
|
23097
|
+
readonly Vat: "vat";
|
|
23098
|
+
readonly Payments: "payments";
|
|
23099
|
+
readonly Discounts: "discounts";
|
|
23100
|
+
};
|
|
23101
|
+
export type ReportPart = typeof ReportPart[keyof typeof ReportPart];
|
|
22806
23102
|
/**
|
|
22807
23103
|
*
|
|
22808
23104
|
* @export
|
|
@@ -23308,6 +23604,1016 @@ export declare const SYNCKEY: {
|
|
|
23308
23604
|
readonly ReceiptFooter: "RECEIPT_FOOTER";
|
|
23309
23605
|
};
|
|
23310
23606
|
export type SYNCKEY = typeof SYNCKEY[keyof typeof SYNCKEY];
|
|
23607
|
+
/**
|
|
23608
|
+
*
|
|
23609
|
+
* @export
|
|
23610
|
+
* @interface SalesReportCategoryDto
|
|
23611
|
+
*/
|
|
23612
|
+
export interface SalesReportCategoryDto {
|
|
23613
|
+
/**
|
|
23614
|
+
* The category\'s name
|
|
23615
|
+
* @type {string}
|
|
23616
|
+
* @memberof SalesReportCategoryDto
|
|
23617
|
+
*/
|
|
23618
|
+
'categoryName': string;
|
|
23619
|
+
/**
|
|
23620
|
+
* How many of its items were sold
|
|
23621
|
+
* @type {number}
|
|
23622
|
+
* @memberof SalesReportCategoryDto
|
|
23623
|
+
*/
|
|
23624
|
+
'totalQuantity': number;
|
|
23625
|
+
/**
|
|
23626
|
+
* Sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
23627
|
+
* @type {number}
|
|
23628
|
+
* @memberof SalesReportCategoryDto
|
|
23629
|
+
*/
|
|
23630
|
+
'totalWithTax': number;
|
|
23631
|
+
/**
|
|
23632
|
+
* The VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
23633
|
+
* @type {number}
|
|
23634
|
+
* @memberof SalesReportCategoryDto
|
|
23635
|
+
*/
|
|
23636
|
+
'taxAmount': number;
|
|
23637
|
+
/**
|
|
23638
|
+
* Sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
23639
|
+
* @type {number}
|
|
23640
|
+
* @memberof SalesReportCategoryDto
|
|
23641
|
+
*/
|
|
23642
|
+
'totalWithoutTax': number;
|
|
23643
|
+
/**
|
|
23644
|
+
* Its items
|
|
23645
|
+
* @type {Array<SalesReportItemDto>}
|
|
23646
|
+
* @memberof SalesReportCategoryDto
|
|
23647
|
+
*/
|
|
23648
|
+
'items': Array<SalesReportItemDto>;
|
|
23649
|
+
}
|
|
23650
|
+
/**
|
|
23651
|
+
*
|
|
23652
|
+
* @export
|
|
23653
|
+
* @interface SalesReportChangeDto
|
|
23654
|
+
*/
|
|
23655
|
+
export interface SalesReportChangeDto {
|
|
23656
|
+
/**
|
|
23657
|
+
*
|
|
23658
|
+
* @type {ReportChangeField}
|
|
23659
|
+
* @memberof SalesReportChangeDto
|
|
23660
|
+
*/
|
|
23661
|
+
'field': ReportChangeField;
|
|
23662
|
+
/**
|
|
23663
|
+
* The total of the asked period, as the group answers it; 0 when only the compared period has it. Money in the major unit of the group\'s currency (euros for EUR)
|
|
23664
|
+
* @type {number}
|
|
23665
|
+
* @memberof SalesReportChangeDto
|
|
23666
|
+
*/
|
|
23667
|
+
'current': number;
|
|
23668
|
+
/**
|
|
23669
|
+
* The total of the compared period, as comparison answers it; 0 when only the asked period has it. Money in the major unit of the group\'s currency (euros for EUR)
|
|
23670
|
+
* @type {number}
|
|
23671
|
+
* @memberof SalesReportChangeDto
|
|
23672
|
+
*/
|
|
23673
|
+
'previous': number;
|
|
23674
|
+
/**
|
|
23675
|
+
* current less previous, worked out in exact decimals, so it carries the digits both totals carry and no float error: to the minor unit for POS, every digit of v2\'s exact sums
|
|
23676
|
+
* @type {number}
|
|
23677
|
+
* @memberof SalesReportChangeDto
|
|
23678
|
+
*/
|
|
23679
|
+
'difference': number;
|
|
23680
|
+
/**
|
|
23681
|
+
* difference as a percent of previous, rounded half away from zero to 2 decimals; negative when the total fell. Null when previous is 0
|
|
23682
|
+
* @type {object}
|
|
23683
|
+
* @memberof SalesReportChangeDto
|
|
23684
|
+
*/
|
|
23685
|
+
'percent': object | null;
|
|
23686
|
+
}
|
|
23687
|
+
/**
|
|
23688
|
+
*
|
|
23689
|
+
* @export
|
|
23690
|
+
* @interface SalesReportComparisonDto
|
|
23691
|
+
*/
|
|
23692
|
+
export interface SalesReportComparisonDto {
|
|
23693
|
+
/**
|
|
23694
|
+
* The first instant of the compared period, ISO 8601 in UTC
|
|
23695
|
+
* @type {string}
|
|
23696
|
+
* @memberof SalesReportComparisonDto
|
|
23697
|
+
*/
|
|
23698
|
+
'reportDateStart': string;
|
|
23699
|
+
/**
|
|
23700
|
+
* The last instant of the compared period, ISO 8601 in UTC; now, when the period ends later
|
|
23701
|
+
* @type {string}
|
|
23702
|
+
* @memberof SalesReportComparisonDto
|
|
23703
|
+
*/
|
|
23704
|
+
'reportDateEnd': string;
|
|
23705
|
+
/**
|
|
23706
|
+
* The first business day compared, YYYY-MM-DD, in the report\'s time zone
|
|
23707
|
+
* @type {string}
|
|
23708
|
+
* @memberof SalesReportComparisonDto
|
|
23709
|
+
*/
|
|
23710
|
+
'firstBusinessDay': string;
|
|
23711
|
+
/**
|
|
23712
|
+
* The last business day compared, YYYY-MM-DD, inclusive
|
|
23713
|
+
* @type {string}
|
|
23714
|
+
* @memberof SalesReportComparisonDto
|
|
23715
|
+
*/
|
|
23716
|
+
'lastBusinessDay': string;
|
|
23717
|
+
/**
|
|
23718
|
+
*
|
|
23719
|
+
* @type {SalesReportComparisonDtoSalesReport}
|
|
23720
|
+
* @memberof SalesReportComparisonDto
|
|
23721
|
+
*/
|
|
23722
|
+
'salesReport'?: SalesReportComparisonDtoSalesReport;
|
|
23723
|
+
/**
|
|
23724
|
+
*
|
|
23725
|
+
* @type {SalesReportComparisonDtoPaymentReport}
|
|
23726
|
+
* @memberof SalesReportComparisonDto
|
|
23727
|
+
*/
|
|
23728
|
+
'paymentReport'?: SalesReportComparisonDtoPaymentReport;
|
|
23729
|
+
/**
|
|
23730
|
+
* The compared period\'s days that sold, oldest first, as the group\'s own dailyBreakdown: present when it is
|
|
23731
|
+
* @type {Array<SalesReportDayDto>}
|
|
23732
|
+
* @memberof SalesReportComparisonDto
|
|
23733
|
+
*/
|
|
23734
|
+
'dailyBreakdown'?: Array<SalesReportDayDto>;
|
|
23735
|
+
/**
|
|
23736
|
+
* The change of each total either period answers, in ReportChangeField\'s order; empty when part summary was not asked
|
|
23737
|
+
* @type {Array<SalesReportChangeDto>}
|
|
23738
|
+
* @memberof SalesReportComparisonDto
|
|
23739
|
+
*/
|
|
23740
|
+
'changes': Array<SalesReportChangeDto>;
|
|
23741
|
+
}
|
|
23742
|
+
/**
|
|
23743
|
+
* The compared period\'s paymentReport, as the group\'s own: present when it is
|
|
23744
|
+
* @export
|
|
23745
|
+
* @interface SalesReportComparisonDtoPaymentReport
|
|
23746
|
+
*/
|
|
23747
|
+
export interface SalesReportComparisonDtoPaymentReport {
|
|
23748
|
+
/**
|
|
23749
|
+
* Part payments: one row per payment method
|
|
23750
|
+
* @type {Array<SalesReportPaymentMethodDto>}
|
|
23751
|
+
* @memberof SalesReportComparisonDtoPaymentReport
|
|
23752
|
+
*/
|
|
23753
|
+
'paymentMethods'?: Array<SalesReportPaymentMethodDto>;
|
|
23754
|
+
/**
|
|
23755
|
+
*
|
|
23756
|
+
* @type {SalesReportPaymentsDtoSummary}
|
|
23757
|
+
* @memberof SalesReportComparisonDtoPaymentReport
|
|
23758
|
+
*/
|
|
23759
|
+
'summary'?: SalesReportPaymentsDtoSummary;
|
|
23760
|
+
/**
|
|
23761
|
+
* Part discounts: one row per discount
|
|
23762
|
+
* @type {Array<SalesReportDiscountDto>}
|
|
23763
|
+
* @memberof SalesReportComparisonDtoPaymentReport
|
|
23764
|
+
*/
|
|
23765
|
+
'discounts'?: Array<SalesReportDiscountDto>;
|
|
23766
|
+
/**
|
|
23767
|
+
* Part summary: every discount given, in the major unit of the group\'s currency (euros for EUR)
|
|
23768
|
+
* @type {number}
|
|
23769
|
+
* @memberof SalesReportComparisonDtoPaymentReport
|
|
23770
|
+
*/
|
|
23771
|
+
'totalDiscounts'?: number;
|
|
23772
|
+
}
|
|
23773
|
+
/**
|
|
23774
|
+
* The compared period\'s salesReport, as the group\'s own: present when it is
|
|
23775
|
+
* @export
|
|
23776
|
+
* @interface SalesReportComparisonDtoSalesReport
|
|
23777
|
+
*/
|
|
23778
|
+
export interface SalesReportComparisonDtoSalesReport {
|
|
23779
|
+
/**
|
|
23780
|
+
* Part items: the categories with their items
|
|
23781
|
+
* @type {Array<SalesReportCategoryDto>}
|
|
23782
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
23783
|
+
*/
|
|
23784
|
+
'categories'?: Array<SalesReportCategoryDto>;
|
|
23785
|
+
/**
|
|
23786
|
+
* Part vat: one row per VAT rate, lowest first
|
|
23787
|
+
* @type {Array<SalesReportVatRateDto>}
|
|
23788
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
23789
|
+
*/
|
|
23790
|
+
'taxSummary'?: Array<SalesReportVatRateDto>;
|
|
23791
|
+
/**
|
|
23792
|
+
* Part summary: how many items were sold
|
|
23793
|
+
* @type {number}
|
|
23794
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
23795
|
+
*/
|
|
23796
|
+
'totalQuantity'?: number;
|
|
23797
|
+
/**
|
|
23798
|
+
* Part summary: sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
23799
|
+
* @type {number}
|
|
23800
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
23801
|
+
*/
|
|
23802
|
+
'totalWithTax'?: number;
|
|
23803
|
+
/**
|
|
23804
|
+
* Part summary: the VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
23805
|
+
* @type {number}
|
|
23806
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
23807
|
+
*/
|
|
23808
|
+
'totalTaxAmount'?: number;
|
|
23809
|
+
/**
|
|
23810
|
+
* Part summary: sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
23811
|
+
* @type {number}
|
|
23812
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
23813
|
+
*/
|
|
23814
|
+
'totalWithoutTax'?: number;
|
|
23815
|
+
/**
|
|
23816
|
+
* 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
|
|
23817
|
+
* @type {number}
|
|
23818
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
23819
|
+
*/
|
|
23820
|
+
'deliveryFee'?: number;
|
|
23821
|
+
/**
|
|
23822
|
+
* Part summary, with deliveryFee: the VAT of the delivery fees, in the major unit of the group\'s currency (euros for EUR)
|
|
23823
|
+
* @type {number}
|
|
23824
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
23825
|
+
*/
|
|
23826
|
+
'deliveryTax'?: number;
|
|
23827
|
+
}
|
|
23828
|
+
/**
|
|
23829
|
+
*
|
|
23830
|
+
* @export
|
|
23831
|
+
* @interface SalesReportDayDto
|
|
23832
|
+
*/
|
|
23833
|
+
export interface SalesReportDayDto {
|
|
23834
|
+
/**
|
|
23835
|
+
* The business day, YYYY-MM-DD, in the venue\'s own time zone
|
|
23836
|
+
* @type {string}
|
|
23837
|
+
* @memberof SalesReportDayDto
|
|
23838
|
+
*/
|
|
23839
|
+
'date': string;
|
|
23840
|
+
/**
|
|
23841
|
+
* How many orders were sold that day
|
|
23842
|
+
* @type {number}
|
|
23843
|
+
* @memberof SalesReportDayDto
|
|
23844
|
+
*/
|
|
23845
|
+
'orders': number;
|
|
23846
|
+
/**
|
|
23847
|
+
* How many items were sold that day
|
|
23848
|
+
* @type {number}
|
|
23849
|
+
* @memberof SalesReportDayDto
|
|
23850
|
+
*/
|
|
23851
|
+
'quantity': number;
|
|
23852
|
+
/**
|
|
23853
|
+
* What was paid, before refunds, in the major unit of the group\'s currency (euros for EUR)
|
|
23854
|
+
* @type {number}
|
|
23855
|
+
* @memberof SalesReportDayDto
|
|
23856
|
+
*/
|
|
23857
|
+
'sales': number;
|
|
23858
|
+
/**
|
|
23859
|
+
* Refunds of that day\'s orders, in the major unit of the group\'s currency (euros for EUR)
|
|
23860
|
+
* @type {number}
|
|
23861
|
+
* @memberof SalesReportDayDto
|
|
23862
|
+
*/
|
|
23863
|
+
'refunds': number;
|
|
23864
|
+
/**
|
|
23865
|
+
* What was paid, refunds taken off, in the major unit of the group\'s currency (euros for EUR)
|
|
23866
|
+
* @type {number}
|
|
23867
|
+
* @memberof SalesReportDayDto
|
|
23868
|
+
*/
|
|
23869
|
+
'net': number;
|
|
23870
|
+
/**
|
|
23871
|
+
* Discounts given that day, in the major unit of the group\'s currency (euros for EUR)
|
|
23872
|
+
* @type {number}
|
|
23873
|
+
* @memberof SalesReportDayDto
|
|
23874
|
+
*/
|
|
23875
|
+
'discounts': number;
|
|
23876
|
+
/**
|
|
23877
|
+
* The VAT of the items sold that day, in the major unit of the group\'s currency (euros for EUR)
|
|
23878
|
+
* @type {number}
|
|
23879
|
+
* @memberof SalesReportDayDto
|
|
23880
|
+
*/
|
|
23881
|
+
'taxAmount': number;
|
|
23882
|
+
}
|
|
23883
|
+
/**
|
|
23884
|
+
*
|
|
23885
|
+
* @export
|
|
23886
|
+
* @interface SalesReportDiscountDto
|
|
23887
|
+
*/
|
|
23888
|
+
export interface SalesReportDiscountDto {
|
|
23889
|
+
/**
|
|
23890
|
+
* The discount\'s name
|
|
23891
|
+
* @type {string}
|
|
23892
|
+
* @memberof SalesReportDiscountDto
|
|
23893
|
+
*/
|
|
23894
|
+
'discountName': string;
|
|
23895
|
+
/**
|
|
23896
|
+
* How many times it was given
|
|
23897
|
+
* @type {number}
|
|
23898
|
+
* @memberof SalesReportDiscountDto
|
|
23899
|
+
*/
|
|
23900
|
+
'count': number;
|
|
23901
|
+
/**
|
|
23902
|
+
* What it took off, in the major unit of the group\'s currency (euros for EUR)
|
|
23903
|
+
* @type {number}
|
|
23904
|
+
* @memberof SalesReportDiscountDto
|
|
23905
|
+
*/
|
|
23906
|
+
'amount': number;
|
|
23907
|
+
}
|
|
23908
|
+
/**
|
|
23909
|
+
*
|
|
23910
|
+
* @export
|
|
23911
|
+
* @interface SalesReportGroupDto
|
|
23912
|
+
*/
|
|
23913
|
+
export interface SalesReportGroupDto {
|
|
23914
|
+
/**
|
|
23915
|
+
* The venue\'s business id; null when the breakdown adds venues together (none, app)
|
|
23916
|
+
* @type {object}
|
|
23917
|
+
* @memberof SalesReportGroupDto
|
|
23918
|
+
*/
|
|
23919
|
+
'businessId': object | null;
|
|
23920
|
+
/**
|
|
23921
|
+
*
|
|
23922
|
+
* @type {ReportApp}
|
|
23923
|
+
* @memberof SalesReportGroupDto
|
|
23924
|
+
*/
|
|
23925
|
+
'app': ReportApp | null;
|
|
23926
|
+
/**
|
|
23927
|
+
*
|
|
23928
|
+
* @type {CurrencyCode}
|
|
23929
|
+
* @memberof SalesReportGroupDto
|
|
23930
|
+
*/
|
|
23931
|
+
'currency': CurrencyCode;
|
|
23932
|
+
/**
|
|
23933
|
+
* The currency\'s ISO 4217 minor digits: EUR 2, ISK 0, BHD 3
|
|
23934
|
+
* @type {number}
|
|
23935
|
+
* @memberof SalesReportGroupDto
|
|
23936
|
+
*/
|
|
23937
|
+
'minorDigits': number;
|
|
23938
|
+
/**
|
|
23939
|
+
*
|
|
23940
|
+
* @type {SalesReportGroupDtoSalesReport}
|
|
23941
|
+
* @memberof SalesReportGroupDto
|
|
23942
|
+
*/
|
|
23943
|
+
'salesReport'?: SalesReportGroupDtoSalesReport;
|
|
23944
|
+
/**
|
|
23945
|
+
*
|
|
23946
|
+
* @type {SalesReportGroupDtoPaymentReport}
|
|
23947
|
+
* @memberof SalesReportGroupDto
|
|
23948
|
+
*/
|
|
23949
|
+
'paymentReport'?: SalesReportGroupDtoPaymentReport;
|
|
23950
|
+
/**
|
|
23951
|
+
* Part summary: one row per business day that sold, oldest first. POS leaves it out when no day sold
|
|
23952
|
+
* @type {Array<SalesReportDayDto>}
|
|
23953
|
+
* @memberof SalesReportGroupDto
|
|
23954
|
+
*/
|
|
23955
|
+
'dailyBreakdown'?: Array<SalesReportDayDto>;
|
|
23956
|
+
/**
|
|
23957
|
+
*
|
|
23958
|
+
* @type {SalesReportGroupDtoComparison}
|
|
23959
|
+
* @memberof SalesReportGroupDto
|
|
23960
|
+
*/
|
|
23961
|
+
'comparison'?: SalesReportGroupDtoComparison;
|
|
23962
|
+
/**
|
|
23963
|
+
* 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
|
|
23964
|
+
* @type {Array<SalesReportChangeDto>}
|
|
23965
|
+
* @memberof SalesReportGroupDto
|
|
23966
|
+
*/
|
|
23967
|
+
'changesFromBaseline'?: Array<SalesReportChangeDto>;
|
|
23968
|
+
/**
|
|
23969
|
+
*
|
|
23970
|
+
* @type {ReportBaselineLeftOut}
|
|
23971
|
+
* @memberof SalesReportGroupDto
|
|
23972
|
+
*/
|
|
23973
|
+
'changesFromBaselineLeftOut'?: ReportBaselineLeftOut;
|
|
23974
|
+
}
|
|
23975
|
+
/**
|
|
23976
|
+
* With compareStart and compareEnd: the same group\'s report of those days and the change of each total. Left out without them
|
|
23977
|
+
* @export
|
|
23978
|
+
* @interface SalesReportGroupDtoComparison
|
|
23979
|
+
*/
|
|
23980
|
+
export interface SalesReportGroupDtoComparison {
|
|
23981
|
+
/**
|
|
23982
|
+
* The first instant of the compared period, ISO 8601 in UTC
|
|
23983
|
+
* @type {string}
|
|
23984
|
+
* @memberof SalesReportGroupDtoComparison
|
|
23985
|
+
*/
|
|
23986
|
+
'reportDateStart': string;
|
|
23987
|
+
/**
|
|
23988
|
+
* The last instant of the compared period, ISO 8601 in UTC; now, when the period ends later
|
|
23989
|
+
* @type {string}
|
|
23990
|
+
* @memberof SalesReportGroupDtoComparison
|
|
23991
|
+
*/
|
|
23992
|
+
'reportDateEnd': string;
|
|
23993
|
+
/**
|
|
23994
|
+
* The first business day compared, YYYY-MM-DD, in the report\'s time zone
|
|
23995
|
+
* @type {string}
|
|
23996
|
+
* @memberof SalesReportGroupDtoComparison
|
|
23997
|
+
*/
|
|
23998
|
+
'firstBusinessDay': string;
|
|
23999
|
+
/**
|
|
24000
|
+
* The last business day compared, YYYY-MM-DD, inclusive
|
|
24001
|
+
* @type {string}
|
|
24002
|
+
* @memberof SalesReportGroupDtoComparison
|
|
24003
|
+
*/
|
|
24004
|
+
'lastBusinessDay': string;
|
|
24005
|
+
/**
|
|
24006
|
+
*
|
|
24007
|
+
* @type {SalesReportComparisonDtoSalesReport}
|
|
24008
|
+
* @memberof SalesReportGroupDtoComparison
|
|
24009
|
+
*/
|
|
24010
|
+
'salesReport'?: SalesReportComparisonDtoSalesReport;
|
|
24011
|
+
/**
|
|
24012
|
+
*
|
|
24013
|
+
* @type {SalesReportComparisonDtoPaymentReport}
|
|
24014
|
+
* @memberof SalesReportGroupDtoComparison
|
|
24015
|
+
*/
|
|
24016
|
+
'paymentReport'?: SalesReportComparisonDtoPaymentReport;
|
|
24017
|
+
/**
|
|
24018
|
+
* The compared period\'s days that sold, oldest first, as the group\'s own dailyBreakdown: present when it is
|
|
24019
|
+
* @type {Array<SalesReportDayDto>}
|
|
24020
|
+
* @memberof SalesReportGroupDtoComparison
|
|
24021
|
+
*/
|
|
24022
|
+
'dailyBreakdown'?: Array<SalesReportDayDto>;
|
|
24023
|
+
/**
|
|
24024
|
+
* The change of each total either period answers, in ReportChangeField\'s order; empty when part summary was not asked
|
|
24025
|
+
* @type {Array<SalesReportChangeDto>}
|
|
24026
|
+
* @memberof SalesReportGroupDtoComparison
|
|
24027
|
+
*/
|
|
24028
|
+
'changes': Array<SalesReportChangeDto>;
|
|
24029
|
+
}
|
|
24030
|
+
/**
|
|
24031
|
+
* The portal\'s paymentReport for the group: present when part summary, payments or discounts was asked
|
|
24032
|
+
* @export
|
|
24033
|
+
* @interface SalesReportGroupDtoPaymentReport
|
|
24034
|
+
*/
|
|
24035
|
+
export interface SalesReportGroupDtoPaymentReport {
|
|
24036
|
+
/**
|
|
24037
|
+
* Part payments: one row per payment method
|
|
24038
|
+
* @type {Array<SalesReportPaymentMethodDto>}
|
|
24039
|
+
* @memberof SalesReportGroupDtoPaymentReport
|
|
24040
|
+
*/
|
|
24041
|
+
'paymentMethods'?: Array<SalesReportPaymentMethodDto>;
|
|
24042
|
+
/**
|
|
24043
|
+
*
|
|
24044
|
+
* @type {SalesReportPaymentsDtoSummary}
|
|
24045
|
+
* @memberof SalesReportGroupDtoPaymentReport
|
|
24046
|
+
*/
|
|
24047
|
+
'summary'?: SalesReportPaymentsDtoSummary;
|
|
24048
|
+
/**
|
|
24049
|
+
* Part discounts: one row per discount
|
|
24050
|
+
* @type {Array<SalesReportDiscountDto>}
|
|
24051
|
+
* @memberof SalesReportGroupDtoPaymentReport
|
|
24052
|
+
*/
|
|
24053
|
+
'discounts'?: Array<SalesReportDiscountDto>;
|
|
24054
|
+
/**
|
|
24055
|
+
* Part summary: every discount given, in the major unit of the group\'s currency (euros for EUR)
|
|
24056
|
+
* @type {number}
|
|
24057
|
+
* @memberof SalesReportGroupDtoPaymentReport
|
|
24058
|
+
*/
|
|
24059
|
+
'totalDiscounts'?: number;
|
|
24060
|
+
}
|
|
24061
|
+
/**
|
|
24062
|
+
* The portal\'s salesReport for the group: present when part summary, items or vat was asked. One app answers as its portal report does (POS as report-service, kiosk, storefront and mobile as dashboard v2); several apps added together answer as v2
|
|
24063
|
+
* @export
|
|
24064
|
+
* @interface SalesReportGroupDtoSalesReport
|
|
24065
|
+
*/
|
|
24066
|
+
export interface SalesReportGroupDtoSalesReport {
|
|
24067
|
+
/**
|
|
24068
|
+
* Part items: the categories with their items
|
|
24069
|
+
* @type {Array<SalesReportCategoryDto>}
|
|
24070
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24071
|
+
*/
|
|
24072
|
+
'categories'?: Array<SalesReportCategoryDto>;
|
|
24073
|
+
/**
|
|
24074
|
+
* Part vat: one row per VAT rate, lowest first
|
|
24075
|
+
* @type {Array<SalesReportVatRateDto>}
|
|
24076
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24077
|
+
*/
|
|
24078
|
+
'taxSummary'?: Array<SalesReportVatRateDto>;
|
|
24079
|
+
/**
|
|
24080
|
+
* Part summary: how many items were sold
|
|
24081
|
+
* @type {number}
|
|
24082
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24083
|
+
*/
|
|
24084
|
+
'totalQuantity'?: number;
|
|
24085
|
+
/**
|
|
24086
|
+
* Part summary: sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24087
|
+
* @type {number}
|
|
24088
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24089
|
+
*/
|
|
24090
|
+
'totalWithTax'?: number;
|
|
24091
|
+
/**
|
|
24092
|
+
* Part summary: the VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24093
|
+
* @type {number}
|
|
24094
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24095
|
+
*/
|
|
24096
|
+
'totalTaxAmount'?: number;
|
|
24097
|
+
/**
|
|
24098
|
+
* Part summary: sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24099
|
+
* @type {number}
|
|
24100
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24101
|
+
*/
|
|
24102
|
+
'totalWithoutTax'?: number;
|
|
24103
|
+
/**
|
|
24104
|
+
* 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
|
|
24105
|
+
* @type {number}
|
|
24106
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24107
|
+
*/
|
|
24108
|
+
'deliveryFee'?: number;
|
|
24109
|
+
/**
|
|
24110
|
+
* Part summary, with deliveryFee: the VAT of the delivery fees, in the major unit of the group\'s currency (euros for EUR)
|
|
24111
|
+
* @type {number}
|
|
24112
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24113
|
+
*/
|
|
24114
|
+
'deliveryTax'?: number;
|
|
24115
|
+
}
|
|
24116
|
+
/**
|
|
24117
|
+
*
|
|
24118
|
+
* @export
|
|
24119
|
+
* @interface SalesReportItemDto
|
|
24120
|
+
*/
|
|
24121
|
+
export interface SalesReportItemDto {
|
|
24122
|
+
/**
|
|
24123
|
+
* The item\'s name. POS: its first sale\'s name and VAT rate, as the portal shows it
|
|
24124
|
+
* @type {object}
|
|
24125
|
+
* @memberof SalesReportItemDto
|
|
24126
|
+
*/
|
|
24127
|
+
'name': object | null;
|
|
24128
|
+
/**
|
|
24129
|
+
* The product\'s id; null when the sale carried none
|
|
24130
|
+
* @type {object}
|
|
24131
|
+
* @memberof SalesReportItemDto
|
|
24132
|
+
*/
|
|
24133
|
+
'productId': object | null;
|
|
24134
|
+
/**
|
|
24135
|
+
* How many were sold
|
|
24136
|
+
* @type {number}
|
|
24137
|
+
* @memberof SalesReportItemDto
|
|
24138
|
+
*/
|
|
24139
|
+
'quantity': number;
|
|
24140
|
+
/**
|
|
24141
|
+
* Sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24142
|
+
* @type {number}
|
|
24143
|
+
* @memberof SalesReportItemDto
|
|
24144
|
+
*/
|
|
24145
|
+
'totalWithTax': number;
|
|
24146
|
+
/**
|
|
24147
|
+
* The VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24148
|
+
* @type {number}
|
|
24149
|
+
* @memberof SalesReportItemDto
|
|
24150
|
+
*/
|
|
24151
|
+
'taxAmount': number;
|
|
24152
|
+
/**
|
|
24153
|
+
* Sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24154
|
+
* @type {number}
|
|
24155
|
+
* @memberof SalesReportItemDto
|
|
24156
|
+
*/
|
|
24157
|
+
'totalWithoutTax': number;
|
|
24158
|
+
/**
|
|
24159
|
+
* The VAT rate in percent; null when none was recorded
|
|
24160
|
+
* @type {object}
|
|
24161
|
+
* @memberof SalesReportItemDto
|
|
24162
|
+
*/
|
|
24163
|
+
'taxRate': object | null;
|
|
24164
|
+
/**
|
|
24165
|
+
* The options sold with the item; left out when none was
|
|
24166
|
+
* @type {Array<SalesReportOptionDto>}
|
|
24167
|
+
* @memberof SalesReportItemDto
|
|
24168
|
+
*/
|
|
24169
|
+
'subOptions'?: Array<SalesReportOptionDto>;
|
|
24170
|
+
}
|
|
24171
|
+
/**
|
|
24172
|
+
*
|
|
24173
|
+
* @export
|
|
24174
|
+
* @interface SalesReportOptionDto
|
|
24175
|
+
*/
|
|
24176
|
+
export interface SalesReportOptionDto {
|
|
24177
|
+
/**
|
|
24178
|
+
* The option\'s name
|
|
24179
|
+
* @type {string}
|
|
24180
|
+
* @memberof SalesReportOptionDto
|
|
24181
|
+
*/
|
|
24182
|
+
'name': string;
|
|
24183
|
+
/**
|
|
24184
|
+
* How many were sold
|
|
24185
|
+
* @type {number}
|
|
24186
|
+
* @memberof SalesReportOptionDto
|
|
24187
|
+
*/
|
|
24188
|
+
'quantity': number;
|
|
24189
|
+
/**
|
|
24190
|
+
* Sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24191
|
+
* @type {number}
|
|
24192
|
+
* @memberof SalesReportOptionDto
|
|
24193
|
+
*/
|
|
24194
|
+
'totalWithTax': number;
|
|
24195
|
+
/**
|
|
24196
|
+
* The VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24197
|
+
* @type {number}
|
|
24198
|
+
* @memberof SalesReportOptionDto
|
|
24199
|
+
*/
|
|
24200
|
+
'taxAmount': number;
|
|
24201
|
+
/**
|
|
24202
|
+
* Sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24203
|
+
* @type {number}
|
|
24204
|
+
* @memberof SalesReportOptionDto
|
|
24205
|
+
*/
|
|
24206
|
+
'totalWithoutTax': number;
|
|
24207
|
+
/**
|
|
24208
|
+
* The VAT rate in percent; null when none was recorded
|
|
24209
|
+
* @type {object}
|
|
24210
|
+
* @memberof SalesReportOptionDto
|
|
24211
|
+
*/
|
|
24212
|
+
'taxRate': object | null;
|
|
24213
|
+
}
|
|
24214
|
+
/**
|
|
24215
|
+
*
|
|
24216
|
+
* @export
|
|
24217
|
+
* @interface SalesReportPaymentMethodDto
|
|
24218
|
+
*/
|
|
24219
|
+
export interface SalesReportPaymentMethodDto {
|
|
24220
|
+
/**
|
|
24221
|
+
* The payment method, as the app records it
|
|
24222
|
+
* @type {string}
|
|
24223
|
+
* @memberof SalesReportPaymentMethodDto
|
|
24224
|
+
*/
|
|
24225
|
+
'paymentMethod': string;
|
|
24226
|
+
/**
|
|
24227
|
+
* How many payments were made with it
|
|
24228
|
+
* @type {number}
|
|
24229
|
+
* @memberof SalesReportPaymentMethodDto
|
|
24230
|
+
*/
|
|
24231
|
+
'count': number;
|
|
24232
|
+
/**
|
|
24233
|
+
* What was paid with it, in the major unit of the group\'s currency (euros for EUR)
|
|
24234
|
+
* @type {number}
|
|
24235
|
+
* @memberof SalesReportPaymentMethodDto
|
|
24236
|
+
*/
|
|
24237
|
+
'amount': number;
|
|
24238
|
+
}
|
|
24239
|
+
/**
|
|
24240
|
+
*
|
|
24241
|
+
* @export
|
|
24242
|
+
* @interface SalesReportPaymentSummaryDto
|
|
24243
|
+
*/
|
|
24244
|
+
export interface SalesReportPaymentSummaryDto {
|
|
24245
|
+
/**
|
|
24246
|
+
* Tips, in the major unit of the group\'s currency (euros for EUR)
|
|
24247
|
+
* @type {number}
|
|
24248
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24249
|
+
*/
|
|
24250
|
+
'totalTipAmount': number;
|
|
24251
|
+
/**
|
|
24252
|
+
* Surcharges, in the major unit of the group\'s currency (euros for EUR)
|
|
24253
|
+
* @type {number}
|
|
24254
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24255
|
+
*/
|
|
24256
|
+
'totalSurchargeAmount': number;
|
|
24257
|
+
/**
|
|
24258
|
+
* What was paid, refunds taken off, in the major unit of the group\'s currency (euros for EUR)
|
|
24259
|
+
* @type {number}
|
|
24260
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24261
|
+
*/
|
|
24262
|
+
'salesAndRevenue': number;
|
|
24263
|
+
/**
|
|
24264
|
+
* How many card payments were made
|
|
24265
|
+
* @type {number}
|
|
24266
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24267
|
+
*/
|
|
24268
|
+
'cardsCount': number;
|
|
24269
|
+
/**
|
|
24270
|
+
* What was paid by card, in the major unit of the group\'s currency (euros for EUR)
|
|
24271
|
+
* @type {number}
|
|
24272
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24273
|
+
*/
|
|
24274
|
+
'cardsAmount': number;
|
|
24275
|
+
/**
|
|
24276
|
+
* How many Edenred vouchers were paid with
|
|
24277
|
+
* @type {number}
|
|
24278
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24279
|
+
*/
|
|
24280
|
+
'edenredVoucherCount': number;
|
|
24281
|
+
/**
|
|
24282
|
+
* What was paid with Edenred vouchers, in the major unit of the group\'s currency (euros for EUR)
|
|
24283
|
+
* @type {number}
|
|
24284
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24285
|
+
*/
|
|
24286
|
+
'edenredVoucherAmount': number;
|
|
24287
|
+
/**
|
|
24288
|
+
* How many Smartum vouchers were paid with
|
|
24289
|
+
* @type {number}
|
|
24290
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24291
|
+
*/
|
|
24292
|
+
'smartumVoucherCount': number;
|
|
24293
|
+
/**
|
|
24294
|
+
* What was paid with Smartum vouchers, in the major unit of the group\'s currency (euros for EUR)
|
|
24295
|
+
* @type {number}
|
|
24296
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24297
|
+
*/
|
|
24298
|
+
'smartumVoucherAmount': number;
|
|
24299
|
+
/**
|
|
24300
|
+
* How many payments were made
|
|
24301
|
+
* @type {number}
|
|
24302
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24303
|
+
*/
|
|
24304
|
+
'totalCount': number;
|
|
24305
|
+
/**
|
|
24306
|
+
* The same as salesAndRevenue, in the major unit of the group\'s currency (euros for EUR)
|
|
24307
|
+
* @type {number}
|
|
24308
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24309
|
+
*/
|
|
24310
|
+
'totalAmount': number;
|
|
24311
|
+
/**
|
|
24312
|
+
* Always 0: no app records coupons here
|
|
24313
|
+
* @type {number}
|
|
24314
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24315
|
+
*/
|
|
24316
|
+
'totalCoupons': number;
|
|
24317
|
+
/**
|
|
24318
|
+
* Vouchers\' leftover that was not given back, in the major unit of the group\'s currency (euros for EUR)
|
|
24319
|
+
* @type {number}
|
|
24320
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24321
|
+
*/
|
|
24322
|
+
'totalVoucherForfeited': number;
|
|
24323
|
+
/**
|
|
24324
|
+
* POS only: what was paid before refunds, in the major unit of the group\'s currency (euros for EUR)
|
|
24325
|
+
* @type {number}
|
|
24326
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24327
|
+
*/
|
|
24328
|
+
'grossAmount'?: number;
|
|
24329
|
+
/**
|
|
24330
|
+
* Refunds, in the major unit of the group\'s currency (euros for EUR), on the day of the order they refund
|
|
24331
|
+
* @type {number}
|
|
24332
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24333
|
+
*/
|
|
24334
|
+
'totalRefunds': number;
|
|
24335
|
+
/**
|
|
24336
|
+
* How many refunds were made
|
|
24337
|
+
* @type {number}
|
|
24338
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24339
|
+
*/
|
|
24340
|
+
'refundCount': number;
|
|
24341
|
+
}
|
|
24342
|
+
/**
|
|
24343
|
+
*
|
|
24344
|
+
* @export
|
|
24345
|
+
* @interface SalesReportPaymentsDto
|
|
24346
|
+
*/
|
|
24347
|
+
export interface SalesReportPaymentsDto {
|
|
24348
|
+
/**
|
|
24349
|
+
* Part payments: one row per payment method
|
|
24350
|
+
* @type {Array<SalesReportPaymentMethodDto>}
|
|
24351
|
+
* @memberof SalesReportPaymentsDto
|
|
24352
|
+
*/
|
|
24353
|
+
'paymentMethods'?: Array<SalesReportPaymentMethodDto>;
|
|
24354
|
+
/**
|
|
24355
|
+
*
|
|
24356
|
+
* @type {SalesReportPaymentsDtoSummary}
|
|
24357
|
+
* @memberof SalesReportPaymentsDto
|
|
24358
|
+
*/
|
|
24359
|
+
'summary'?: SalesReportPaymentsDtoSummary;
|
|
24360
|
+
/**
|
|
24361
|
+
* Part discounts: one row per discount
|
|
24362
|
+
* @type {Array<SalesReportDiscountDto>}
|
|
24363
|
+
* @memberof SalesReportPaymentsDto
|
|
24364
|
+
*/
|
|
24365
|
+
'discounts'?: Array<SalesReportDiscountDto>;
|
|
24366
|
+
/**
|
|
24367
|
+
* Part summary: every discount given, in the major unit of the group\'s currency (euros for EUR)
|
|
24368
|
+
* @type {number}
|
|
24369
|
+
* @memberof SalesReportPaymentsDto
|
|
24370
|
+
*/
|
|
24371
|
+
'totalDiscounts'?: number;
|
|
24372
|
+
}
|
|
24373
|
+
/**
|
|
24374
|
+
* Part summary: the payment totals
|
|
24375
|
+
* @export
|
|
24376
|
+
* @interface SalesReportPaymentsDtoSummary
|
|
24377
|
+
*/
|
|
24378
|
+
export interface SalesReportPaymentsDtoSummary {
|
|
24379
|
+
/**
|
|
24380
|
+
* Tips, in the major unit of the group\'s currency (euros for EUR)
|
|
24381
|
+
* @type {number}
|
|
24382
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24383
|
+
*/
|
|
24384
|
+
'totalTipAmount': number;
|
|
24385
|
+
/**
|
|
24386
|
+
* Surcharges, in the major unit of the group\'s currency (euros for EUR)
|
|
24387
|
+
* @type {number}
|
|
24388
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24389
|
+
*/
|
|
24390
|
+
'totalSurchargeAmount': number;
|
|
24391
|
+
/**
|
|
24392
|
+
* What was paid, refunds taken off, in the major unit of the group\'s currency (euros for EUR)
|
|
24393
|
+
* @type {number}
|
|
24394
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24395
|
+
*/
|
|
24396
|
+
'salesAndRevenue': number;
|
|
24397
|
+
/**
|
|
24398
|
+
* How many card payments were made
|
|
24399
|
+
* @type {number}
|
|
24400
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24401
|
+
*/
|
|
24402
|
+
'cardsCount': number;
|
|
24403
|
+
/**
|
|
24404
|
+
* What was paid by card, in the major unit of the group\'s currency (euros for EUR)
|
|
24405
|
+
* @type {number}
|
|
24406
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24407
|
+
*/
|
|
24408
|
+
'cardsAmount': number;
|
|
24409
|
+
/**
|
|
24410
|
+
* How many Edenred vouchers were paid with
|
|
24411
|
+
* @type {number}
|
|
24412
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24413
|
+
*/
|
|
24414
|
+
'edenredVoucherCount': number;
|
|
24415
|
+
/**
|
|
24416
|
+
* What was paid with Edenred vouchers, in the major unit of the group\'s currency (euros for EUR)
|
|
24417
|
+
* @type {number}
|
|
24418
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24419
|
+
*/
|
|
24420
|
+
'edenredVoucherAmount': number;
|
|
24421
|
+
/**
|
|
24422
|
+
* How many Smartum vouchers were paid with
|
|
24423
|
+
* @type {number}
|
|
24424
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24425
|
+
*/
|
|
24426
|
+
'smartumVoucherCount': number;
|
|
24427
|
+
/**
|
|
24428
|
+
* What was paid with Smartum vouchers, in the major unit of the group\'s currency (euros for EUR)
|
|
24429
|
+
* @type {number}
|
|
24430
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24431
|
+
*/
|
|
24432
|
+
'smartumVoucherAmount': number;
|
|
24433
|
+
/**
|
|
24434
|
+
* How many payments were made
|
|
24435
|
+
* @type {number}
|
|
24436
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24437
|
+
*/
|
|
24438
|
+
'totalCount': number;
|
|
24439
|
+
/**
|
|
24440
|
+
* The same as salesAndRevenue, in the major unit of the group\'s currency (euros for EUR)
|
|
24441
|
+
* @type {number}
|
|
24442
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24443
|
+
*/
|
|
24444
|
+
'totalAmount': number;
|
|
24445
|
+
/**
|
|
24446
|
+
* Always 0: no app records coupons here
|
|
24447
|
+
* @type {number}
|
|
24448
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24449
|
+
*/
|
|
24450
|
+
'totalCoupons': number;
|
|
24451
|
+
/**
|
|
24452
|
+
* Vouchers\' leftover that was not given back, in the major unit of the group\'s currency (euros for EUR)
|
|
24453
|
+
* @type {number}
|
|
24454
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24455
|
+
*/
|
|
24456
|
+
'totalVoucherForfeited': number;
|
|
24457
|
+
/**
|
|
24458
|
+
* POS only: what was paid before refunds, in the major unit of the group\'s currency (euros for EUR)
|
|
24459
|
+
* @type {number}
|
|
24460
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24461
|
+
*/
|
|
24462
|
+
'grossAmount'?: number;
|
|
24463
|
+
/**
|
|
24464
|
+
* Refunds, in the major unit of the group\'s currency (euros for EUR), on the day of the order they refund
|
|
24465
|
+
* @type {number}
|
|
24466
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24467
|
+
*/
|
|
24468
|
+
'totalRefunds': number;
|
|
24469
|
+
/**
|
|
24470
|
+
* How many refunds were made
|
|
24471
|
+
* @type {number}
|
|
24472
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24473
|
+
*/
|
|
24474
|
+
'refundCount': number;
|
|
24475
|
+
}
|
|
24476
|
+
/**
|
|
24477
|
+
*
|
|
24478
|
+
* @export
|
|
24479
|
+
* @interface SalesReportResponseDto
|
|
24480
|
+
*/
|
|
24481
|
+
export interface SalesReportResponseDto {
|
|
24482
|
+
/**
|
|
24483
|
+
* The first instant of the period, ISO 8601 in UTC
|
|
24484
|
+
* @type {string}
|
|
24485
|
+
* @memberof SalesReportResponseDto
|
|
24486
|
+
*/
|
|
24487
|
+
'reportDateStart': string;
|
|
24488
|
+
/**
|
|
24489
|
+
* The last instant of the period, ISO 8601 in UTC; now, when the period ends later
|
|
24490
|
+
* @type {string}
|
|
24491
|
+
* @memberof SalesReportResponseDto
|
|
24492
|
+
*/
|
|
24493
|
+
'reportDateEnd': string;
|
|
24494
|
+
/**
|
|
24495
|
+
* When the report was answered, ISO 8601 in UTC
|
|
24496
|
+
* @type {string}
|
|
24497
|
+
* @memberof SalesReportResponseDto
|
|
24498
|
+
*/
|
|
24499
|
+
'reportGeneratedAt': string;
|
|
24500
|
+
/**
|
|
24501
|
+
* The time zone the period was read in: the request\'s, or else the first venue\'s
|
|
24502
|
+
* @type {string}
|
|
24503
|
+
* @memberof SalesReportResponseDto
|
|
24504
|
+
*/
|
|
24505
|
+
'timezone': string;
|
|
24506
|
+
/**
|
|
24507
|
+
* The first business day added up, YYYY-MM-DD; each venue\'s rows of that date in its own zone
|
|
24508
|
+
* @type {string}
|
|
24509
|
+
* @memberof SalesReportResponseDto
|
|
24510
|
+
*/
|
|
24511
|
+
'firstBusinessDay': string;
|
|
24512
|
+
/**
|
|
24513
|
+
* The last business day added up, YYYY-MM-DD, inclusive
|
|
24514
|
+
* @type {string}
|
|
24515
|
+
* @memberof SalesReportResponseDto
|
|
24516
|
+
*/
|
|
24517
|
+
'lastBusinessDay': string;
|
|
24518
|
+
/**
|
|
24519
|
+
* 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
|
|
24520
|
+
* @type {object}
|
|
24521
|
+
* @memberof SalesReportResponseDto
|
|
24522
|
+
*/
|
|
24523
|
+
'dataUntil': object | null;
|
|
24524
|
+
/**
|
|
24525
|
+
* One group per venue, app and currency the breakdown keeps; an asked venue that sold nothing answers zeros
|
|
24526
|
+
* @type {Array<SalesReportGroupDto>}
|
|
24527
|
+
* @memberof SalesReportResponseDto
|
|
24528
|
+
*/
|
|
24529
|
+
'reports': Array<SalesReportGroupDto>;
|
|
24530
|
+
}
|
|
24531
|
+
/**
|
|
24532
|
+
*
|
|
24533
|
+
* @export
|
|
24534
|
+
* @interface SalesReportSalesDto
|
|
24535
|
+
*/
|
|
24536
|
+
export interface SalesReportSalesDto {
|
|
24537
|
+
/**
|
|
24538
|
+
* Part items: the categories with their items
|
|
24539
|
+
* @type {Array<SalesReportCategoryDto>}
|
|
24540
|
+
* @memberof SalesReportSalesDto
|
|
24541
|
+
*/
|
|
24542
|
+
'categories'?: Array<SalesReportCategoryDto>;
|
|
24543
|
+
/**
|
|
24544
|
+
* Part vat: one row per VAT rate, lowest first
|
|
24545
|
+
* @type {Array<SalesReportVatRateDto>}
|
|
24546
|
+
* @memberof SalesReportSalesDto
|
|
24547
|
+
*/
|
|
24548
|
+
'taxSummary'?: Array<SalesReportVatRateDto>;
|
|
24549
|
+
/**
|
|
24550
|
+
* Part summary: how many items were sold
|
|
24551
|
+
* @type {number}
|
|
24552
|
+
* @memberof SalesReportSalesDto
|
|
24553
|
+
*/
|
|
24554
|
+
'totalQuantity'?: number;
|
|
24555
|
+
/**
|
|
24556
|
+
* Part summary: sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24557
|
+
* @type {number}
|
|
24558
|
+
* @memberof SalesReportSalesDto
|
|
24559
|
+
*/
|
|
24560
|
+
'totalWithTax'?: number;
|
|
24561
|
+
/**
|
|
24562
|
+
* Part summary: the VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24563
|
+
* @type {number}
|
|
24564
|
+
* @memberof SalesReportSalesDto
|
|
24565
|
+
*/
|
|
24566
|
+
'totalTaxAmount'?: number;
|
|
24567
|
+
/**
|
|
24568
|
+
* Part summary: sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24569
|
+
* @type {number}
|
|
24570
|
+
* @memberof SalesReportSalesDto
|
|
24571
|
+
*/
|
|
24572
|
+
'totalWithoutTax'?: number;
|
|
24573
|
+
/**
|
|
24574
|
+
* 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
|
|
24575
|
+
* @type {number}
|
|
24576
|
+
* @memberof SalesReportSalesDto
|
|
24577
|
+
*/
|
|
24578
|
+
'deliveryFee'?: number;
|
|
24579
|
+
/**
|
|
24580
|
+
* Part summary, with deliveryFee: the VAT of the delivery fees, in the major unit of the group\'s currency (euros for EUR)
|
|
24581
|
+
* @type {number}
|
|
24582
|
+
* @memberof SalesReportSalesDto
|
|
24583
|
+
*/
|
|
24584
|
+
'deliveryTax'?: number;
|
|
24585
|
+
}
|
|
24586
|
+
/**
|
|
24587
|
+
*
|
|
24588
|
+
* @export
|
|
24589
|
+
* @interface SalesReportVatRateDto
|
|
24590
|
+
*/
|
|
24591
|
+
export interface SalesReportVatRateDto {
|
|
24592
|
+
/**
|
|
24593
|
+
* The VAT rate in percent
|
|
24594
|
+
* @type {number}
|
|
24595
|
+
* @memberof SalesReportVatRateDto
|
|
24596
|
+
*/
|
|
24597
|
+
'taxRate': number;
|
|
24598
|
+
/**
|
|
24599
|
+
* Sales with VAT at this rate, in the major unit of the group\'s currency (euros for EUR)
|
|
24600
|
+
* @type {number}
|
|
24601
|
+
* @memberof SalesReportVatRateDto
|
|
24602
|
+
*/
|
|
24603
|
+
'totalWithTax': number;
|
|
24604
|
+
/**
|
|
24605
|
+
* The VAT at this rate, in the major unit of the group\'s currency (euros for EUR)
|
|
24606
|
+
* @type {number}
|
|
24607
|
+
* @memberof SalesReportVatRateDto
|
|
24608
|
+
*/
|
|
24609
|
+
'taxAmount': number;
|
|
24610
|
+
/**
|
|
24611
|
+
* Sales without VAT at this rate, in the major unit of the group\'s currency (euros for EUR)
|
|
24612
|
+
* @type {number}
|
|
24613
|
+
* @memberof SalesReportVatRateDto
|
|
24614
|
+
*/
|
|
24615
|
+
'totalWithoutTax': number;
|
|
24616
|
+
}
|
|
23311
24617
|
/**
|
|
23312
24618
|
*
|
|
23313
24619
|
* @export
|
|
@@ -28479,6 +29785,19 @@ export interface UpdateProductSkuDto {
|
|
|
28479
29785
|
*/
|
|
28480
29786
|
'sku': string;
|
|
28481
29787
|
}
|
|
29788
|
+
/**
|
|
29789
|
+
*
|
|
29790
|
+
* @export
|
|
29791
|
+
* @interface UpdateProductSkusDto
|
|
29792
|
+
*/
|
|
29793
|
+
export interface UpdateProductSkusDto {
|
|
29794
|
+
/**
|
|
29795
|
+
* Every SKU (label code) of the product, in order; they replace the ones it has. Each is trimmed, must keep one character and holds at most 255 characters. An empty list removes every SKU. A SKU is unique within the venue, compared without case
|
|
29796
|
+
* @type {Array<string>}
|
|
29797
|
+
* @memberof UpdateProductSkusDto
|
|
29798
|
+
*/
|
|
29799
|
+
'skus': Array<string>;
|
|
29800
|
+
}
|
|
28482
29801
|
/**
|
|
28483
29802
|
*
|
|
28484
29803
|
* @export
|
|
@@ -28601,6 +29920,32 @@ export interface UpdateReservationPolicyDto {
|
|
|
28601
29920
|
* @memberof UpdateReservationPolicyDto
|
|
28602
29921
|
*/
|
|
28603
29922
|
'maxOnlinePartySize'?: number;
|
|
29923
|
+
/**
|
|
29924
|
+
* The smallest party offered slots online; 1 on create when absent
|
|
29925
|
+
* @type {number}
|
|
29926
|
+
* @memberof UpdateReservationPolicyDto
|
|
29927
|
+
*/
|
|
29928
|
+
'minPartySize'?: number;
|
|
29929
|
+
/**
|
|
29930
|
+
* How many days after today a guest may book: a later day offers no slots; 60 on create when absent
|
|
29931
|
+
* @type {number}
|
|
29932
|
+
* @memberof UpdateReservationPolicyDto
|
|
29933
|
+
*/
|
|
29934
|
+
'maxHorizonDays'?: number;
|
|
29935
|
+
/**
|
|
29936
|
+
* The last seating: no slot starts later than this many minutes before each opening closes; 0 (only the turn must fit) on create when absent
|
|
29937
|
+
* @type {number}
|
|
29938
|
+
* @memberof UpdateReservationPolicyDto
|
|
29939
|
+
*/
|
|
29940
|
+
'cutoffMins'?: number;
|
|
29941
|
+
/**
|
|
29942
|
+
* Minutes a table is held, by party size; a party size missing here takes defaultTurnTimeMins. Replaces the whole table when sent, {} clears it; {} on create when absent
|
|
29943
|
+
* @type {{ [key: string]: number; }}
|
|
29944
|
+
* @memberof UpdateReservationPolicyDto
|
|
29945
|
+
*/
|
|
29946
|
+
'turnTimeByPartySize'?: {
|
|
29947
|
+
[key: string]: number;
|
|
29948
|
+
};
|
|
28604
29949
|
}
|
|
28605
29950
|
/**
|
|
28606
29951
|
*
|
|
@@ -29656,12 +31001,6 @@ export interface VendureSellerUpsertDto {
|
|
|
29656
31001
|
* @memberof VendureSellerUpsertDto
|
|
29657
31002
|
*/
|
|
29658
31003
|
'currency'?: string | null;
|
|
29659
|
-
/**
|
|
29660
|
-
* The time the venue\'s business day ends, \"HH:mm\" 24-hour, in the venue\'s time zone: a sale before it counts on the day before in the day\'s report. Kept on the venue\'s MunchiPos config. Null, absent, or text that is not \"HH:mm\" keeps the stored one; a venue with none ends its day at 05:00
|
|
29661
|
-
* @type {string}
|
|
29662
|
-
* @memberof VendureSellerUpsertDto
|
|
29663
|
-
*/
|
|
29664
|
-
'report_time'?: string | null;
|
|
29665
31004
|
/**
|
|
29666
31005
|
* Whether the venue is in use. Vendure sends false when the seller is deleted
|
|
29667
31006
|
* @type {boolean}
|
|
@@ -37442,6 +38781,14 @@ export declare const KDSApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
37442
38781
|
* @throws {RequiredError}
|
|
37443
38782
|
*/
|
|
37444
38783
|
kdsMarkOrderReady: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
38784
|
+
/**
|
|
38785
|
+
* Written in kds-service, in one call for every order; kds-service decides each order and leaves untouched any it cannot mark ready. It admits a signed-in ticket, whose venue must be on its account, or the Munchi-internal Clerk API key; never the shared service key. A failure there is answered with 200 and status false; when the call fails after kds-service has written (a dropped connection or a timeout), status is false although some tickets were marked ready, and the station\'s next list shows them.
|
|
38786
|
+
* @summary Mark several of a station\'s kitchen orders ready
|
|
38787
|
+
* @param {KdsMarkOrdersReadyDto} kdsMarkOrdersReadyDto The venue, the station, and the ids of its KDS orders to mark ready
|
|
38788
|
+
* @param {*} [options] Override http request option.
|
|
38789
|
+
* @throws {RequiredError}
|
|
38790
|
+
*/
|
|
38791
|
+
kdsMarkOrdersReady: (kdsMarkOrdersReadyDto: KdsMarkOrdersReadyDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37445
38792
|
/**
|
|
37446
38793
|
* Written in kds-service. A failure there is answered with 200 and status false.
|
|
37447
38794
|
* @summary Revert a station\'s kitchen order back to in progress
|
|
@@ -37490,6 +38837,14 @@ export declare const KDSApiFp: (configuration?: Configuration) => {
|
|
|
37490
38837
|
* @throws {RequiredError}
|
|
37491
38838
|
*/
|
|
37492
38839
|
kdsMarkOrderReady(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<KdsReadyOrderResponseDto>>;
|
|
38840
|
+
/**
|
|
38841
|
+
* Written in kds-service, in one call for every order; kds-service decides each order and leaves untouched any it cannot mark ready. It admits a signed-in ticket, whose venue must be on its account, or the Munchi-internal Clerk API key; never the shared service key. A failure there is answered with 200 and status false; when the call fails after kds-service has written (a dropped connection or a timeout), status is false although some tickets were marked ready, and the station\'s next list shows them.
|
|
38842
|
+
* @summary Mark several of a station\'s kitchen orders ready
|
|
38843
|
+
* @param {KdsMarkOrdersReadyDto} kdsMarkOrdersReadyDto The venue, the station, and the ids of its KDS orders to mark ready
|
|
38844
|
+
* @param {*} [options] Override http request option.
|
|
38845
|
+
* @throws {RequiredError}
|
|
38846
|
+
*/
|
|
38847
|
+
kdsMarkOrdersReady(kdsMarkOrdersReadyDto: KdsMarkOrdersReadyDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<KdsReadyOrdersResponseDto>>;
|
|
37493
38848
|
/**
|
|
37494
38849
|
* Written in kds-service. A failure there is answered with 200 and status false.
|
|
37495
38850
|
* @summary Revert a station\'s kitchen order back to in progress
|
|
@@ -37538,6 +38893,14 @@ export declare const KDSApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
37538
38893
|
* @throws {RequiredError}
|
|
37539
38894
|
*/
|
|
37540
38895
|
kdsMarkOrderReady(id: string, options?: any): AxiosPromise<KdsReadyOrderResponseDto>;
|
|
38896
|
+
/**
|
|
38897
|
+
* Written in kds-service, in one call for every order; kds-service decides each order and leaves untouched any it cannot mark ready. It admits a signed-in ticket, whose venue must be on its account, or the Munchi-internal Clerk API key; never the shared service key. A failure there is answered with 200 and status false; when the call fails after kds-service has written (a dropped connection or a timeout), status is false although some tickets were marked ready, and the station\'s next list shows them.
|
|
38898
|
+
* @summary Mark several of a station\'s kitchen orders ready
|
|
38899
|
+
* @param {KdsMarkOrdersReadyDto} kdsMarkOrdersReadyDto The venue, the station, and the ids of its KDS orders to mark ready
|
|
38900
|
+
* @param {*} [options] Override http request option.
|
|
38901
|
+
* @throws {RequiredError}
|
|
38902
|
+
*/
|
|
38903
|
+
kdsMarkOrdersReady(kdsMarkOrdersReadyDto: KdsMarkOrdersReadyDto, options?: any): AxiosPromise<KdsReadyOrdersResponseDto>;
|
|
37541
38904
|
/**
|
|
37542
38905
|
* Written in kds-service. A failure there is answered with 200 and status false.
|
|
37543
38906
|
* @summary Revert a station\'s kitchen order back to in progress
|
|
@@ -37590,6 +38953,15 @@ export interface KDSApiInterface {
|
|
|
37590
38953
|
* @memberof KDSApiInterface
|
|
37591
38954
|
*/
|
|
37592
38955
|
kdsMarkOrderReady(id: string, options?: AxiosRequestConfig): AxiosPromise<KdsReadyOrderResponseDto>;
|
|
38956
|
+
/**
|
|
38957
|
+
* Written in kds-service, in one call for every order; kds-service decides each order and leaves untouched any it cannot mark ready. It admits a signed-in ticket, whose venue must be on its account, or the Munchi-internal Clerk API key; never the shared service key. A failure there is answered with 200 and status false; when the call fails after kds-service has written (a dropped connection or a timeout), status is false although some tickets were marked ready, and the station\'s next list shows them.
|
|
38958
|
+
* @summary Mark several of a station\'s kitchen orders ready
|
|
38959
|
+
* @param {KdsMarkOrdersReadyDto} kdsMarkOrdersReadyDto The venue, the station, and the ids of its KDS orders to mark ready
|
|
38960
|
+
* @param {*} [options] Override http request option.
|
|
38961
|
+
* @throws {RequiredError}
|
|
38962
|
+
* @memberof KDSApiInterface
|
|
38963
|
+
*/
|
|
38964
|
+
kdsMarkOrdersReady(kdsMarkOrdersReadyDto: KdsMarkOrdersReadyDto, options?: AxiosRequestConfig): AxiosPromise<KdsReadyOrdersResponseDto>;
|
|
37593
38965
|
/**
|
|
37594
38966
|
* Written in kds-service. A failure there is answered with 200 and status false.
|
|
37595
38967
|
* @summary Revert a station\'s kitchen order back to in progress
|
|
@@ -37644,6 +39016,15 @@ export declare class KDSApi extends BaseAPI implements KDSApiInterface {
|
|
|
37644
39016
|
* @memberof KDSApi
|
|
37645
39017
|
*/
|
|
37646
39018
|
kdsMarkOrderReady(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<KdsReadyOrderResponseDto, any, {}>>;
|
|
39019
|
+
/**
|
|
39020
|
+
* Written in kds-service, in one call for every order; kds-service decides each order and leaves untouched any it cannot mark ready. It admits a signed-in ticket, whose venue must be on its account, or the Munchi-internal Clerk API key; never the shared service key. A failure there is answered with 200 and status false; when the call fails after kds-service has written (a dropped connection or a timeout), status is false although some tickets were marked ready, and the station\'s next list shows them.
|
|
39021
|
+
* @summary Mark several of a station\'s kitchen orders ready
|
|
39022
|
+
* @param {KdsMarkOrdersReadyDto} kdsMarkOrdersReadyDto The venue, the station, and the ids of its KDS orders to mark ready
|
|
39023
|
+
* @param {*} [options] Override http request option.
|
|
39024
|
+
* @throws {RequiredError}
|
|
39025
|
+
* @memberof KDSApi
|
|
39026
|
+
*/
|
|
39027
|
+
kdsMarkOrdersReady(kdsMarkOrdersReadyDto: KdsMarkOrdersReadyDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<KdsReadyOrdersResponseDto, any, {}>>;
|
|
37647
39028
|
/**
|
|
37648
39029
|
* Written in kds-service. A failure there is answered with 200 and status false.
|
|
37649
39030
|
* @summary Revert a station\'s kitchen order back to in progress
|
|
@@ -39285,6 +40666,14 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
39285
40666
|
* @throws {RequiredError}
|
|
39286
40667
|
*/
|
|
39287
40668
|
acceptOrder: (acceptOrderDto: AcceptOrderDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
40669
|
+
/**
|
|
40670
|
+
* One tap on a column of the till: Mark all ready (in progress → ready) or Deliver all (ready → delivered). Each id is looked for among the venue\'s tickets, then its orders, all in one Firestore read, and every one that may move is written in the same transaction; the rest are left as they are, each with its reason. Only the till\'s own tickets and orders move, never a channel\'s (Wolt, Foodora, Storefront): their ids are not found. A ticket the kitchen screen owns is never marked ready here, and nothing goes from in progress to delivered. The tills hear the request once: one kitchen_order_sync and one pos_order_change naming every moved id; the integrations hear every moved document in one announcement. Delivered orders earn their members\' loyalty points before the answer, a few at a time; a credit that fails is logged and does not change the answer.
|
|
40671
|
+
* @summary Move the till\'s tickets and orders of one column to the next status
|
|
40672
|
+
* @param {ChangePosOrdersStatusInBulkDto} changePosOrdersStatusInBulkDto The venue, the ids of its tickets and orders, and the status to move them to
|
|
40673
|
+
* @param {*} [options] Override http request option.
|
|
40674
|
+
* @throws {RequiredError}
|
|
40675
|
+
*/
|
|
40676
|
+
changePosOrdersStatusInBulk: (changePosOrdersStatusInBulkDto: ChangePosOrdersStatusInBulkDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
39288
40677
|
/**
|
|
39289
40678
|
* The till\'s Order Manager confirms a platform preorder with its preparation time. Its pickup time is stored, and a Foodora preorder also moves into preparation. Then the preorder is marked confirmed and the answer leaves; after it, the platform is told, and a courier or a reminder is booked where the channel needs one. A failure in those steps is logged and does not change the answer.
|
|
39290
40679
|
* @summary Confirm a pre-order
|
|
@@ -39417,6 +40806,14 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
39417
40806
|
* @throws {RequiredError}
|
|
39418
40807
|
*/
|
|
39419
40808
|
acceptOrder(acceptOrderDto: AcceptOrderDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderStatusResponseDto>>;
|
|
40809
|
+
/**
|
|
40810
|
+
* One tap on a column of the till: Mark all ready (in progress → ready) or Deliver all (ready → delivered). Each id is looked for among the venue\'s tickets, then its orders, all in one Firestore read, and every one that may move is written in the same transaction; the rest are left as they are, each with its reason. Only the till\'s own tickets and orders move, never a channel\'s (Wolt, Foodora, Storefront): their ids are not found. A ticket the kitchen screen owns is never marked ready here, and nothing goes from in progress to delivered. The tills hear the request once: one kitchen_order_sync and one pos_order_change naming every moved id; the integrations hear every moved document in one announcement. Delivered orders earn their members\' loyalty points before the answer, a few at a time; a credit that fails is logged and does not change the answer.
|
|
40811
|
+
* @summary Move the till\'s tickets and orders of one column to the next status
|
|
40812
|
+
* @param {ChangePosOrdersStatusInBulkDto} changePosOrdersStatusInBulkDto The venue, the ids of its tickets and orders, and the status to move them to
|
|
40813
|
+
* @param {*} [options] Override http request option.
|
|
40814
|
+
* @throws {RequiredError}
|
|
40815
|
+
*/
|
|
40816
|
+
changePosOrdersStatusInBulk(changePosOrdersStatusInBulkDto: ChangePosOrdersStatusInBulkDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChangePosOrdersStatusInBulkResponseDto>>;
|
|
39420
40817
|
/**
|
|
39421
40818
|
* The till\'s Order Manager confirms a platform preorder with its preparation time. Its pickup time is stored, and a Foodora preorder also moves into preparation. Then the preorder is marked confirmed and the answer leaves; after it, the platform is told, and a courier or a reminder is booked where the channel needs one. A failure in those steps is logged and does not change the answer.
|
|
39422
40819
|
* @summary Confirm a pre-order
|
|
@@ -39549,6 +40946,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
39549
40946
|
* @throws {RequiredError}
|
|
39550
40947
|
*/
|
|
39551
40948
|
acceptOrder(acceptOrderDto: AcceptOrderDto, options?: any): AxiosPromise<OrderStatusResponseDto>;
|
|
40949
|
+
/**
|
|
40950
|
+
* One tap on a column of the till: Mark all ready (in progress → ready) or Deliver all (ready → delivered). Each id is looked for among the venue\'s tickets, then its orders, all in one Firestore read, and every one that may move is written in the same transaction; the rest are left as they are, each with its reason. Only the till\'s own tickets and orders move, never a channel\'s (Wolt, Foodora, Storefront): their ids are not found. A ticket the kitchen screen owns is never marked ready here, and nothing goes from in progress to delivered. The tills hear the request once: one kitchen_order_sync and one pos_order_change naming every moved id; the integrations hear every moved document in one announcement. Delivered orders earn their members\' loyalty points before the answer, a few at a time; a credit that fails is logged and does not change the answer.
|
|
40951
|
+
* @summary Move the till\'s tickets and orders of one column to the next status
|
|
40952
|
+
* @param {ChangePosOrdersStatusInBulkDto} changePosOrdersStatusInBulkDto The venue, the ids of its tickets and orders, and the status to move them to
|
|
40953
|
+
* @param {*} [options] Override http request option.
|
|
40954
|
+
* @throws {RequiredError}
|
|
40955
|
+
*/
|
|
40956
|
+
changePosOrdersStatusInBulk(changePosOrdersStatusInBulkDto: ChangePosOrdersStatusInBulkDto, options?: any): AxiosPromise<ChangePosOrdersStatusInBulkResponseDto>;
|
|
39552
40957
|
/**
|
|
39553
40958
|
* The till\'s Order Manager confirms a platform preorder with its preparation time. Its pickup time is stored, and a Foodora preorder also moves into preparation. Then the preorder is marked confirmed and the answer leaves; after it, the platform is told, and a courier or a reminder is booked where the channel needs one. A failure in those steps is logged and does not change the answer.
|
|
39554
40959
|
* @summary Confirm a pre-order
|
|
@@ -39683,6 +41088,15 @@ export interface OrdersApiInterface {
|
|
|
39683
41088
|
* @memberof OrdersApiInterface
|
|
39684
41089
|
*/
|
|
39685
41090
|
acceptOrder(acceptOrderDto: AcceptOrderDto, options?: AxiosRequestConfig): AxiosPromise<OrderStatusResponseDto>;
|
|
41091
|
+
/**
|
|
41092
|
+
* One tap on a column of the till: Mark all ready (in progress → ready) or Deliver all (ready → delivered). Each id is looked for among the venue\'s tickets, then its orders, all in one Firestore read, and every one that may move is written in the same transaction; the rest are left as they are, each with its reason. Only the till\'s own tickets and orders move, never a channel\'s (Wolt, Foodora, Storefront): their ids are not found. A ticket the kitchen screen owns is never marked ready here, and nothing goes from in progress to delivered. The tills hear the request once: one kitchen_order_sync and one pos_order_change naming every moved id; the integrations hear every moved document in one announcement. Delivered orders earn their members\' loyalty points before the answer, a few at a time; a credit that fails is logged and does not change the answer.
|
|
41093
|
+
* @summary Move the till\'s tickets and orders of one column to the next status
|
|
41094
|
+
* @param {ChangePosOrdersStatusInBulkDto} changePosOrdersStatusInBulkDto The venue, the ids of its tickets and orders, and the status to move them to
|
|
41095
|
+
* @param {*} [options] Override http request option.
|
|
41096
|
+
* @throws {RequiredError}
|
|
41097
|
+
* @memberof OrdersApiInterface
|
|
41098
|
+
*/
|
|
41099
|
+
changePosOrdersStatusInBulk(changePosOrdersStatusInBulkDto: ChangePosOrdersStatusInBulkDto, options?: AxiosRequestConfig): AxiosPromise<ChangePosOrdersStatusInBulkResponseDto>;
|
|
39686
41100
|
/**
|
|
39687
41101
|
* The till\'s Order Manager confirms a platform preorder with its preparation time. Its pickup time is stored, and a Foodora preorder also moves into preparation. Then the preorder is marked confirmed and the answer leaves; after it, the platform is told, and a courier or a reminder is booked where the channel needs one. A failure in those steps is logged and does not change the answer.
|
|
39688
41102
|
* @summary Confirm a pre-order
|
|
@@ -39832,6 +41246,15 @@ export declare class OrdersApi extends BaseAPI implements OrdersApiInterface {
|
|
|
39832
41246
|
* @memberof OrdersApi
|
|
39833
41247
|
*/
|
|
39834
41248
|
acceptOrder(acceptOrderDto: AcceptOrderDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderStatusResponseDto, any, {}>>;
|
|
41249
|
+
/**
|
|
41250
|
+
* One tap on a column of the till: Mark all ready (in progress → ready) or Deliver all (ready → delivered). Each id is looked for among the venue\'s tickets, then its orders, all in one Firestore read, and every one that may move is written in the same transaction; the rest are left as they are, each with its reason. Only the till\'s own tickets and orders move, never a channel\'s (Wolt, Foodora, Storefront): their ids are not found. A ticket the kitchen screen owns is never marked ready here, and nothing goes from in progress to delivered. The tills hear the request once: one kitchen_order_sync and one pos_order_change naming every moved id; the integrations hear every moved document in one announcement. Delivered orders earn their members\' loyalty points before the answer, a few at a time; a credit that fails is logged and does not change the answer.
|
|
41251
|
+
* @summary Move the till\'s tickets and orders of one column to the next status
|
|
41252
|
+
* @param {ChangePosOrdersStatusInBulkDto} changePosOrdersStatusInBulkDto The venue, the ids of its tickets and orders, and the status to move them to
|
|
41253
|
+
* @param {*} [options] Override http request option.
|
|
41254
|
+
* @throws {RequiredError}
|
|
41255
|
+
* @memberof OrdersApi
|
|
41256
|
+
*/
|
|
41257
|
+
changePosOrdersStatusInBulk(changePosOrdersStatusInBulkDto: ChangePosOrdersStatusInBulkDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ChangePosOrdersStatusInBulkResponseDto, any, {}>>;
|
|
39835
41258
|
/**
|
|
39836
41259
|
* The till\'s Order Manager confirms a platform preorder with its preparation time. Its pickup time is stored, and a Foodora preorder also moves into preparation. Then the preorder is marked confirmed and the answer leaves; after it, the platform is told, and a courier or a reminder is booked where the channel needs one. A failure in those steps is logged and does not change the answer.
|
|
39837
41260
|
* @summary Confirm a pre-order
|
|
@@ -42653,9 +44076,21 @@ export declare const ProductApiAxiosParamCreator: (configuration?: Configuration
|
|
|
42653
44076
|
* @param {string} productId The product\'s id in Vendure: a whole number from 1, with no leading zero; anything else is refused with 400 before Vendure is asked
|
|
42654
44077
|
* @param {UpdateProductSkuDto} updateProductSkuDto The SKU to save
|
|
42655
44078
|
* @param {*} [options] Override http request option.
|
|
44079
|
+
* @deprecated
|
|
42656
44080
|
* @throws {RequiredError}
|
|
42657
44081
|
*/
|
|
42658
44082
|
updateProductSkuV2: (businessId: string, categoryId: string, productId: string, updateProductSkuDto: UpdateProductSkuDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44083
|
+
/**
|
|
44084
|
+
* Saved in Vendure, each trimmed, in the order sent; the first is the product\'s sku. A SKU is unique within the venue; Vendure compares it without case.
|
|
44085
|
+
* @summary Replace every SKU (label code) of a product
|
|
44086
|
+
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
44087
|
+
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
44088
|
+
* @param {string} productId The product\'s id in Vendure: a whole number from 1, with no leading zero; anything else is refused with 400 before Vendure is asked
|
|
44089
|
+
* @param {UpdateProductSkusDto} updateProductSkusDto Every SKU the product keeps, in order
|
|
44090
|
+
* @param {*} [options] Override http request option.
|
|
44091
|
+
* @throws {RequiredError}
|
|
44092
|
+
*/
|
|
44093
|
+
updateProductSkusV2: (businessId: string, categoryId: string, productId: string, updateProductSkusDto: UpdateProductSkusDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42659
44094
|
};
|
|
42660
44095
|
/**
|
|
42661
44096
|
* ProductApi - functional programming interface
|
|
@@ -42691,9 +44126,21 @@ export declare const ProductApiFp: (configuration?: Configuration) => {
|
|
|
42691
44126
|
* @param {string} productId The product\'s id in Vendure: a whole number from 1, with no leading zero; anything else is refused with 400 before Vendure is asked
|
|
42692
44127
|
* @param {UpdateProductSkuDto} updateProductSkuDto The SKU to save
|
|
42693
44128
|
* @param {*} [options] Override http request option.
|
|
44129
|
+
* @deprecated
|
|
42694
44130
|
* @throws {RequiredError}
|
|
42695
44131
|
*/
|
|
42696
44132
|
updateProductSkuV2(businessId: string, categoryId: string, productId: string, updateProductSkuDto: UpdateProductSkuDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSkuResponseDto>>;
|
|
44133
|
+
/**
|
|
44134
|
+
* Saved in Vendure, each trimmed, in the order sent; the first is the product\'s sku. A SKU is unique within the venue; Vendure compares it without case.
|
|
44135
|
+
* @summary Replace every SKU (label code) of a product
|
|
44136
|
+
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
44137
|
+
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
44138
|
+
* @param {string} productId The product\'s id in Vendure: a whole number from 1, with no leading zero; anything else is refused with 400 before Vendure is asked
|
|
44139
|
+
* @param {UpdateProductSkusDto} updateProductSkusDto Every SKU the product keeps, in order
|
|
44140
|
+
* @param {*} [options] Override http request option.
|
|
44141
|
+
* @throws {RequiredError}
|
|
44142
|
+
*/
|
|
44143
|
+
updateProductSkusV2(businessId: string, categoryId: string, productId: string, updateProductSkusDto: UpdateProductSkusDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSkusResponseDto>>;
|
|
42697
44144
|
};
|
|
42698
44145
|
/**
|
|
42699
44146
|
* ProductApi - factory interface
|
|
@@ -42729,9 +44176,21 @@ export declare const ProductApiFactory: (configuration?: Configuration, basePath
|
|
|
42729
44176
|
* @param {string} productId The product\'s id in Vendure: a whole number from 1, with no leading zero; anything else is refused with 400 before Vendure is asked
|
|
42730
44177
|
* @param {UpdateProductSkuDto} updateProductSkuDto The SKU to save
|
|
42731
44178
|
* @param {*} [options] Override http request option.
|
|
44179
|
+
* @deprecated
|
|
42732
44180
|
* @throws {RequiredError}
|
|
42733
44181
|
*/
|
|
42734
44182
|
updateProductSkuV2(businessId: string, categoryId: string, productId: string, updateProductSkuDto: UpdateProductSkuDto, options?: any): AxiosPromise<ProductSkuResponseDto>;
|
|
44183
|
+
/**
|
|
44184
|
+
* Saved in Vendure, each trimmed, in the order sent; the first is the product\'s sku. A SKU is unique within the venue; Vendure compares it without case.
|
|
44185
|
+
* @summary Replace every SKU (label code) of a product
|
|
44186
|
+
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
44187
|
+
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
44188
|
+
* @param {string} productId The product\'s id in Vendure: a whole number from 1, with no leading zero; anything else is refused with 400 before Vendure is asked
|
|
44189
|
+
* @param {UpdateProductSkusDto} updateProductSkusDto Every SKU the product keeps, in order
|
|
44190
|
+
* @param {*} [options] Override http request option.
|
|
44191
|
+
* @throws {RequiredError}
|
|
44192
|
+
*/
|
|
44193
|
+
updateProductSkusV2(businessId: string, categoryId: string, productId: string, updateProductSkusDto: UpdateProductSkusDto, options?: any): AxiosPromise<ProductSkusResponseDto>;
|
|
42735
44194
|
};
|
|
42736
44195
|
/**
|
|
42737
44196
|
* ProductApi - interface
|
|
@@ -42770,10 +44229,23 @@ export interface ProductApiInterface {
|
|
|
42770
44229
|
* @param {string} productId The product\'s id in Vendure: a whole number from 1, with no leading zero; anything else is refused with 400 before Vendure is asked
|
|
42771
44230
|
* @param {UpdateProductSkuDto} updateProductSkuDto The SKU to save
|
|
42772
44231
|
* @param {*} [options] Override http request option.
|
|
44232
|
+
* @deprecated
|
|
42773
44233
|
* @throws {RequiredError}
|
|
42774
44234
|
* @memberof ProductApiInterface
|
|
42775
44235
|
*/
|
|
42776
44236
|
updateProductSkuV2(businessId: string, categoryId: string, productId: string, updateProductSkuDto: UpdateProductSkuDto, options?: AxiosRequestConfig): AxiosPromise<ProductSkuResponseDto>;
|
|
44237
|
+
/**
|
|
44238
|
+
* Saved in Vendure, each trimmed, in the order sent; the first is the product\'s sku. A SKU is unique within the venue; Vendure compares it without case.
|
|
44239
|
+
* @summary Replace every SKU (label code) of a product
|
|
44240
|
+
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
44241
|
+
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
44242
|
+
* @param {string} productId The product\'s id in Vendure: a whole number from 1, with no leading zero; anything else is refused with 400 before Vendure is asked
|
|
44243
|
+
* @param {UpdateProductSkusDto} updateProductSkusDto Every SKU the product keeps, in order
|
|
44244
|
+
* @param {*} [options] Override http request option.
|
|
44245
|
+
* @throws {RequiredError}
|
|
44246
|
+
* @memberof ProductApiInterface
|
|
44247
|
+
*/
|
|
44248
|
+
updateProductSkusV2(businessId: string, categoryId: string, productId: string, updateProductSkusDto: UpdateProductSkusDto, options?: AxiosRequestConfig): AxiosPromise<ProductSkusResponseDto>;
|
|
42777
44249
|
}
|
|
42778
44250
|
/**
|
|
42779
44251
|
* ProductApi - object-oriented interface
|
|
@@ -42813,10 +44285,23 @@ export declare class ProductApi extends BaseAPI implements ProductApiInterface {
|
|
|
42813
44285
|
* @param {string} productId The product\'s id in Vendure: a whole number from 1, with no leading zero; anything else is refused with 400 before Vendure is asked
|
|
42814
44286
|
* @param {UpdateProductSkuDto} updateProductSkuDto The SKU to save
|
|
42815
44287
|
* @param {*} [options] Override http request option.
|
|
44288
|
+
* @deprecated
|
|
42816
44289
|
* @throws {RequiredError}
|
|
42817
44290
|
* @memberof ProductApi
|
|
42818
44291
|
*/
|
|
42819
44292
|
updateProductSkuV2(businessId: string, categoryId: string, productId: string, updateProductSkuDto: UpdateProductSkuDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductSkuResponseDto, any, {}>>;
|
|
44293
|
+
/**
|
|
44294
|
+
* Saved in Vendure, each trimmed, in the order sent; the first is the product\'s sku. A SKU is unique within the venue; Vendure compares it without case.
|
|
44295
|
+
* @summary Replace every SKU (label code) of a product
|
|
44296
|
+
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
44297
|
+
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
44298
|
+
* @param {string} productId The product\'s id in Vendure: a whole number from 1, with no leading zero; anything else is refused with 400 before Vendure is asked
|
|
44299
|
+
* @param {UpdateProductSkusDto} updateProductSkusDto Every SKU the product keeps, in order
|
|
44300
|
+
* @param {*} [options] Override http request option.
|
|
44301
|
+
* @throws {RequiredError}
|
|
44302
|
+
* @memberof ProductApi
|
|
44303
|
+
*/
|
|
44304
|
+
updateProductSkusV2(businessId: string, categoryId: string, productId: string, updateProductSkusDto: UpdateProductSkusDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductSkusResponseDto, any, {}>>;
|
|
42820
44305
|
}
|
|
42821
44306
|
/**
|
|
42822
44307
|
* ProviderApi - axios parameter creator
|
|
@@ -43737,6 +45222,25 @@ export declare const ReportApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
43737
45222
|
* @throws {RequiredError}
|
|
43738
45223
|
*/
|
|
43739
45224
|
getEndOfDayReportV5: (businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45225
|
+
/**
|
|
45226
|
+
* Adds up each venue\'s finished business days (the calendar date in the venue\'s own time zone) of the apps and parts asked, in one database statement. Each group answers in its app\'s portal shape: POS as report-service, kiosk, storefront and mobile as dashboard v2; several apps added together answer as v2. Amounts of two currencies are never added together: a venue whose sales are in a currency other than its current Business.currency answers a group in each. A person\'s signed-in ticket reads the venues on its account; a Clerk API key of the Munchi-internal organisation (the MCP\'s, D134, D137) reads any venue; the shared key and any other organisation\'s key are refused. A period must cover whole days; today is answered up to dataUntil. With compareStart and compareEnd, each group also answers comparison: the same group over those days, read in the same statement, and the change of each total worked out exactly; a currency only the compared period sold in adds a group of zeros after the others. With baseline, every other group answers changesFromBaseline, its change from the baseline group of its currency.
|
|
45227
|
+
* @summary Sales report of the venues and apps, whole business days, from the daily rows
|
|
45228
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45229
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
45230
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
45231
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
45232
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
45233
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
45234
|
+
* @param {Array<ReportPart>} [parts] The parts to answer, the parameter repeated or a JSON list; only their daily tables are read. Absent: all five
|
|
45235
|
+
* @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
|
|
45236
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
45237
|
+
* @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
|
|
45238
|
+
* @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
|
|
45239
|
+
* @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
|
|
45240
|
+
* @param {*} [options] Override http request option.
|
|
45241
|
+
* @throws {RequiredError}
|
|
45242
|
+
*/
|
|
45243
|
+
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<RequestArgs>;
|
|
43740
45244
|
/**
|
|
43741
45245
|
*
|
|
43742
45246
|
* @summary Send end-of-day report via email (V5)
|
|
@@ -43770,6 +45274,25 @@ export declare const ReportApiFp: (configuration?: Configuration) => {
|
|
|
43770
45274
|
* @throws {RequiredError}
|
|
43771
45275
|
*/
|
|
43772
45276
|
getEndOfDayReportV5(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EndOfDayReportDtoV4>>;
|
|
45277
|
+
/**
|
|
45278
|
+
* Adds up each venue\'s finished business days (the calendar date in the venue\'s own time zone) of the apps and parts asked, in one database statement. Each group answers in its app\'s portal shape: POS as report-service, kiosk, storefront and mobile as dashboard v2; several apps added together answer as v2. Amounts of two currencies are never added together: a venue whose sales are in a currency other than its current Business.currency answers a group in each. A person\'s signed-in ticket reads the venues on its account; a Clerk API key of the Munchi-internal organisation (the MCP\'s, D134, D137) reads any venue; the shared key and any other organisation\'s key are refused. A period must cover whole days; today is answered up to dataUntil. With compareStart and compareEnd, each group also answers comparison: the same group over those days, read in the same statement, and the change of each total worked out exactly; a currency only the compared period sold in adds a group of zeros after the others. With baseline, every other group answers changesFromBaseline, its change from the baseline group of its currency.
|
|
45279
|
+
* @summary Sales report of the venues and apps, whole business days, from the daily rows
|
|
45280
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45281
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
45282
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
45283
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
45284
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
45285
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
45286
|
+
* @param {Array<ReportPart>} [parts] The parts to answer, the parameter repeated or a JSON list; only their daily tables are read. Absent: all five
|
|
45287
|
+
* @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
|
|
45288
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
45289
|
+
* @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
|
|
45290
|
+
* @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
|
|
45291
|
+
* @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
|
|
45292
|
+
* @param {*} [options] Override http request option.
|
|
45293
|
+
* @throws {RequiredError}
|
|
45294
|
+
*/
|
|
45295
|
+
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>>;
|
|
43773
45296
|
/**
|
|
43774
45297
|
*
|
|
43775
45298
|
* @summary Send end-of-day report via email (V5)
|
|
@@ -43803,6 +45326,25 @@ export declare const ReportApiFactory: (configuration?: Configuration, basePath?
|
|
|
43803
45326
|
* @throws {RequiredError}
|
|
43804
45327
|
*/
|
|
43805
45328
|
getEndOfDayReportV5(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, options?: any): AxiosPromise<EndOfDayReportDtoV4>;
|
|
45329
|
+
/**
|
|
45330
|
+
* Adds up each venue\'s finished business days (the calendar date in the venue\'s own time zone) of the apps and parts asked, in one database statement. Each group answers in its app\'s portal shape: POS as report-service, kiosk, storefront and mobile as dashboard v2; several apps added together answer as v2. Amounts of two currencies are never added together: a venue whose sales are in a currency other than its current Business.currency answers a group in each. A person\'s signed-in ticket reads the venues on its account; a Clerk API key of the Munchi-internal organisation (the MCP\'s, D134, D137) reads any venue; the shared key and any other organisation\'s key are refused. A period must cover whole days; today is answered up to dataUntil. With compareStart and compareEnd, each group also answers comparison: the same group over those days, read in the same statement, and the change of each total worked out exactly; a currency only the compared period sold in adds a group of zeros after the others. With baseline, every other group answers changesFromBaseline, its change from the baseline group of its currency.
|
|
45331
|
+
* @summary Sales report of the venues and apps, whole business days, from the daily rows
|
|
45332
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45333
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
45334
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
45335
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
45336
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
45337
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
45338
|
+
* @param {Array<ReportPart>} [parts] The parts to answer, the parameter repeated or a JSON list; only their daily tables are read. Absent: all five
|
|
45339
|
+
* @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
|
|
45340
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
45341
|
+
* @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
|
|
45342
|
+
* @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
|
|
45343
|
+
* @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
|
|
45344
|
+
* @param {*} [options] Override http request option.
|
|
45345
|
+
* @throws {RequiredError}
|
|
45346
|
+
*/
|
|
45347
|
+
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?: any): AxiosPromise<SalesReportResponseDto>;
|
|
43806
45348
|
/**
|
|
43807
45349
|
*
|
|
43808
45350
|
* @summary Send end-of-day report via email (V5)
|
|
@@ -43838,6 +45380,26 @@ export interface ReportApiInterface {
|
|
|
43838
45380
|
* @memberof ReportApiInterface
|
|
43839
45381
|
*/
|
|
43840
45382
|
getEndOfDayReportV5(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, options?: AxiosRequestConfig): AxiosPromise<EndOfDayReportDtoV4>;
|
|
45383
|
+
/**
|
|
45384
|
+
* Adds up each venue\'s finished business days (the calendar date in the venue\'s own time zone) of the apps and parts asked, in one database statement. Each group answers in its app\'s portal shape: POS as report-service, kiosk, storefront and mobile as dashboard v2; several apps added together answer as v2. Amounts of two currencies are never added together: a venue whose sales are in a currency other than its current Business.currency answers a group in each. A person\'s signed-in ticket reads the venues on its account; a Clerk API key of the Munchi-internal organisation (the MCP\'s, D134, D137) reads any venue; the shared key and any other organisation\'s key are refused. A period must cover whole days; today is answered up to dataUntil. With compareStart and compareEnd, each group also answers comparison: the same group over those days, read in the same statement, and the change of each total worked out exactly; a currency only the compared period sold in adds a group of zeros after the others. With baseline, every other group answers changesFromBaseline, its change from the baseline group of its currency.
|
|
45385
|
+
* @summary Sales report of the venues and apps, whole business days, from the daily rows
|
|
45386
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45387
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
45388
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
45389
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
45390
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
45391
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
45392
|
+
* @param {Array<ReportPart>} [parts] The parts to answer, the parameter repeated or a JSON list; only their daily tables are read. Absent: all five
|
|
45393
|
+
* @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
|
|
45394
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
45395
|
+
* @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
|
|
45396
|
+
* @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
|
|
45397
|
+
* @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
|
|
45398
|
+
* @param {*} [options] Override http request option.
|
|
45399
|
+
* @throws {RequiredError}
|
|
45400
|
+
* @memberof ReportApiInterface
|
|
45401
|
+
*/
|
|
45402
|
+
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>;
|
|
43841
45403
|
/**
|
|
43842
45404
|
*
|
|
43843
45405
|
* @summary Send end-of-day report via email (V5)
|
|
@@ -43875,6 +45437,26 @@ export declare class ReportApi extends BaseAPI implements ReportApiInterface {
|
|
|
43875
45437
|
* @memberof ReportApi
|
|
43876
45438
|
*/
|
|
43877
45439
|
getEndOfDayReportV5(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EndOfDayReportDtoV4, any, {}>>;
|
|
45440
|
+
/**
|
|
45441
|
+
* Adds up each venue\'s finished business days (the calendar date in the venue\'s own time zone) of the apps and parts asked, in one database statement. Each group answers in its app\'s portal shape: POS as report-service, kiosk, storefront and mobile as dashboard v2; several apps added together answer as v2. Amounts of two currencies are never added together: a venue whose sales are in a currency other than its current Business.currency answers a group in each. A person\'s signed-in ticket reads the venues on its account; a Clerk API key of the Munchi-internal organisation (the MCP\'s, D134, D137) reads any venue; the shared key and any other organisation\'s key are refused. A period must cover whole days; today is answered up to dataUntil. With compareStart and compareEnd, each group also answers comparison: the same group over those days, read in the same statement, and the change of each total worked out exactly; a currency only the compared period sold in adds a group of zeros after the others. With baseline, every other group answers changesFromBaseline, its change from the baseline group of its currency.
|
|
45442
|
+
* @summary Sales report of the venues and apps, whole business days, from the daily rows
|
|
45443
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45444
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
45445
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
45446
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
45447
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
45448
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
45449
|
+
* @param {Array<ReportPart>} [parts] The parts to answer, the parameter repeated or a JSON list; only their daily tables are read. Absent: all five
|
|
45450
|
+
* @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
|
|
45451
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
45452
|
+
* @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
|
|
45453
|
+
* @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
|
|
45454
|
+
* @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
|
|
45455
|
+
* @param {*} [options] Override http request option.
|
|
45456
|
+
* @throws {RequiredError}
|
|
45457
|
+
* @memberof ReportApi
|
|
45458
|
+
*/
|
|
45459
|
+
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<import("axios").AxiosResponse<SalesReportResponseDto, any, {}>>;
|
|
43878
45460
|
/**
|
|
43879
45461
|
*
|
|
43880
45462
|
* @summary Send end-of-day report via email (V5)
|