@erp-galoper/types 1.0.1254 → 1.0.1256
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/openapi.ts +1100 -50
- package/package.json +1 -1
package/openapi.ts
CHANGED
|
@@ -19368,6 +19368,252 @@ export interface paths {
|
|
|
19368
19368
|
patch?: never;
|
|
19369
19369
|
trace?: never;
|
|
19370
19370
|
};
|
|
19371
|
+
"/api/v1/reports/by-item/": {
|
|
19372
|
+
parameters: {
|
|
19373
|
+
query?: never;
|
|
19374
|
+
header?: never;
|
|
19375
|
+
path?: never;
|
|
19376
|
+
cookie?: never;
|
|
19377
|
+
};
|
|
19378
|
+
/**
|
|
19379
|
+
* Get Sales By Item Report
|
|
19380
|
+
* @description Sales Report by Item - Sales performance at the individual item level.
|
|
19381
|
+
*
|
|
19382
|
+
* **Possible Responses:**
|
|
19383
|
+
* - 200: Report data grouped by item
|
|
19384
|
+
* - 400:
|
|
19385
|
+
* - startDateAndEndDateAreRequiredForCustomPeriodType
|
|
19386
|
+
* - invalidDateFormat
|
|
19387
|
+
* - 403: permissionDenied
|
|
19388
|
+
*
|
|
19389
|
+
* **Permission Keys:**
|
|
19390
|
+
* - salesbyitemreport: ["view"]
|
|
19391
|
+
*/
|
|
19392
|
+
get: operations["reports_salesreport_views_get_sales_by_item_report"];
|
|
19393
|
+
put?: never;
|
|
19394
|
+
post?: never;
|
|
19395
|
+
delete?: never;
|
|
19396
|
+
options?: never;
|
|
19397
|
+
head?: never;
|
|
19398
|
+
patch?: never;
|
|
19399
|
+
trace?: never;
|
|
19400
|
+
};
|
|
19401
|
+
"/api/v1/reports/by-category/": {
|
|
19402
|
+
parameters: {
|
|
19403
|
+
query?: never;
|
|
19404
|
+
header?: never;
|
|
19405
|
+
path?: never;
|
|
19406
|
+
cookie?: never;
|
|
19407
|
+
};
|
|
19408
|
+
/**
|
|
19409
|
+
* Get Sales By Category Report
|
|
19410
|
+
* @description Sales Report by Category - Aggregated sales per item category.
|
|
19411
|
+
*
|
|
19412
|
+
* **Possible Responses:**
|
|
19413
|
+
* - 200: Report data grouped by category
|
|
19414
|
+
* - 400:
|
|
19415
|
+
* - startDateAndEndDateAreRequiredForCustomPeriodType
|
|
19416
|
+
* - invalidDateFormat
|
|
19417
|
+
* - 403: permissionDenied
|
|
19418
|
+
*
|
|
19419
|
+
* **Permission Keys:**
|
|
19420
|
+
* - salesbycategoryreport: ["view"]
|
|
19421
|
+
*/
|
|
19422
|
+
get: operations["reports_salesreport_views_get_sales_by_category_report"];
|
|
19423
|
+
put?: never;
|
|
19424
|
+
post?: never;
|
|
19425
|
+
delete?: never;
|
|
19426
|
+
options?: never;
|
|
19427
|
+
head?: never;
|
|
19428
|
+
patch?: never;
|
|
19429
|
+
trace?: never;
|
|
19430
|
+
};
|
|
19431
|
+
"/api/v1/reports/by-brand/": {
|
|
19432
|
+
parameters: {
|
|
19433
|
+
query?: never;
|
|
19434
|
+
header?: never;
|
|
19435
|
+
path?: never;
|
|
19436
|
+
cookie?: never;
|
|
19437
|
+
};
|
|
19438
|
+
/**
|
|
19439
|
+
* Get Sales By Brand Report
|
|
19440
|
+
* @description Sales Report by Brand - Sales contribution of each brand.
|
|
19441
|
+
*
|
|
19442
|
+
* **Possible Responses:**
|
|
19443
|
+
* - 200: Report data grouped by brand
|
|
19444
|
+
* - 400:
|
|
19445
|
+
* - startDateAndEndDateAreRequiredForCustomPeriodType
|
|
19446
|
+
* - invalidDateFormat
|
|
19447
|
+
* - 403: permissionDenied
|
|
19448
|
+
*
|
|
19449
|
+
* **Permission Keys:**
|
|
19450
|
+
* - salesbybrandreport: ["view"]
|
|
19451
|
+
*/
|
|
19452
|
+
get: operations["reports_salesreport_views_get_sales_by_brand_report"];
|
|
19453
|
+
put?: never;
|
|
19454
|
+
post?: never;
|
|
19455
|
+
delete?: never;
|
|
19456
|
+
options?: never;
|
|
19457
|
+
head?: never;
|
|
19458
|
+
patch?: never;
|
|
19459
|
+
trace?: never;
|
|
19460
|
+
};
|
|
19461
|
+
"/api/v1/reports/by-customer/": {
|
|
19462
|
+
parameters: {
|
|
19463
|
+
query?: never;
|
|
19464
|
+
header?: never;
|
|
19465
|
+
path?: never;
|
|
19466
|
+
cookie?: never;
|
|
19467
|
+
};
|
|
19468
|
+
/**
|
|
19469
|
+
* Get Sales By Customer Report
|
|
19470
|
+
* @description Sales Report by Customer - Sales analysis per customer.
|
|
19471
|
+
*
|
|
19472
|
+
* **Possible Responses:**
|
|
19473
|
+
* - 200: Report data grouped by customer
|
|
19474
|
+
* - 400:
|
|
19475
|
+
* - startDateAndEndDateAreRequiredForCustomPeriodType
|
|
19476
|
+
* - invalidDateFormat
|
|
19477
|
+
* - 403: permissionDenied
|
|
19478
|
+
*
|
|
19479
|
+
* **Permission Keys:**
|
|
19480
|
+
* - salesbycustomerreport: ["view"]
|
|
19481
|
+
*/
|
|
19482
|
+
get: operations["reports_salesreport_views_get_sales_by_customer_report"];
|
|
19483
|
+
put?: never;
|
|
19484
|
+
post?: never;
|
|
19485
|
+
delete?: never;
|
|
19486
|
+
options?: never;
|
|
19487
|
+
head?: never;
|
|
19488
|
+
patch?: never;
|
|
19489
|
+
trace?: never;
|
|
19490
|
+
};
|
|
19491
|
+
"/api/v1/reports/by-salesperson/": {
|
|
19492
|
+
parameters: {
|
|
19493
|
+
query?: never;
|
|
19494
|
+
header?: never;
|
|
19495
|
+
path?: never;
|
|
19496
|
+
cookie?: never;
|
|
19497
|
+
};
|
|
19498
|
+
/**
|
|
19499
|
+
* Get Sales By Salesperson Report
|
|
19500
|
+
* @description Sales Report by Salesperson - Performance tracking of sales staff.
|
|
19501
|
+
* Note: This report only uses Sales Invoices (not POS).
|
|
19502
|
+
*
|
|
19503
|
+
* **Possible Responses:**
|
|
19504
|
+
* - 200: Report data grouped by salesperson
|
|
19505
|
+
* - 400:
|
|
19506
|
+
* - startDateAndEndDateAreRequiredForCustomPeriodType
|
|
19507
|
+
* - invalidDateFormat
|
|
19508
|
+
* - 403: permissionDenied
|
|
19509
|
+
*
|
|
19510
|
+
* **Permission Keys:**
|
|
19511
|
+
* - salesbysalespersonreport: ["view"]
|
|
19512
|
+
*/
|
|
19513
|
+
get: operations["reports_salesreport_views_get_sales_by_salesperson_report"];
|
|
19514
|
+
put?: never;
|
|
19515
|
+
post?: never;
|
|
19516
|
+
delete?: never;
|
|
19517
|
+
options?: never;
|
|
19518
|
+
head?: never;
|
|
19519
|
+
patch?: never;
|
|
19520
|
+
trace?: never;
|
|
19521
|
+
};
|
|
19522
|
+
"/api/v1/reports/by-warehouse/": {
|
|
19523
|
+
parameters: {
|
|
19524
|
+
query?: never;
|
|
19525
|
+
header?: never;
|
|
19526
|
+
path?: never;
|
|
19527
|
+
cookie?: never;
|
|
19528
|
+
};
|
|
19529
|
+
/**
|
|
19530
|
+
* Get Sales By Warehouse Report
|
|
19531
|
+
* @description Sales Report by Warehouse - Branch/warehouse performance comparison.
|
|
19532
|
+
*
|
|
19533
|
+
* **Possible Responses:**
|
|
19534
|
+
* - 200: Report data grouped by warehouse
|
|
19535
|
+
* - 400:
|
|
19536
|
+
* - startDateAndEndDateAreRequiredForCustomPeriodType
|
|
19537
|
+
* - invalidDateFormat
|
|
19538
|
+
* - 403: permissionDenied
|
|
19539
|
+
*
|
|
19540
|
+
* **Permission Keys:**
|
|
19541
|
+
* - salesbywarehousereport: ["view"]
|
|
19542
|
+
*/
|
|
19543
|
+
get: operations["reports_salesreport_views_get_sales_by_warehouse_report"];
|
|
19544
|
+
put?: never;
|
|
19545
|
+
post?: never;
|
|
19546
|
+
delete?: never;
|
|
19547
|
+
options?: never;
|
|
19548
|
+
head?: never;
|
|
19549
|
+
patch?: never;
|
|
19550
|
+
trace?: never;
|
|
19551
|
+
};
|
|
19552
|
+
"/api/v1/reports/summary/": {
|
|
19553
|
+
parameters: {
|
|
19554
|
+
query?: never;
|
|
19555
|
+
header?: never;
|
|
19556
|
+
path?: never;
|
|
19557
|
+
cookie?: never;
|
|
19558
|
+
};
|
|
19559
|
+
/**
|
|
19560
|
+
* Get Sales Summary Report
|
|
19561
|
+
* @description Sales Summary Report - Overall sales summary and profitability.
|
|
19562
|
+
*
|
|
19563
|
+
* **Possible Responses:**
|
|
19564
|
+
* - 200: Summary report data
|
|
19565
|
+
* - 400:
|
|
19566
|
+
* - startDateAndEndDateAreRequiredForCustomPeriodType
|
|
19567
|
+
* - invalidDateFormat
|
|
19568
|
+
* - 403: permissionDenied
|
|
19569
|
+
*
|
|
19570
|
+
* **Permission Keys:**
|
|
19571
|
+
* - salessummaryreport: ["view"]
|
|
19572
|
+
*/
|
|
19573
|
+
get: operations["reports_salesreport_views_get_sales_summary_report"];
|
|
19574
|
+
put?: never;
|
|
19575
|
+
post?: never;
|
|
19576
|
+
delete?: never;
|
|
19577
|
+
options?: never;
|
|
19578
|
+
head?: never;
|
|
19579
|
+
patch?: never;
|
|
19580
|
+
trace?: never;
|
|
19581
|
+
};
|
|
19582
|
+
"/api/v1/reports/trend/": {
|
|
19583
|
+
parameters: {
|
|
19584
|
+
query?: never;
|
|
19585
|
+
header?: never;
|
|
19586
|
+
path?: never;
|
|
19587
|
+
cookie?: never;
|
|
19588
|
+
};
|
|
19589
|
+
/**
|
|
19590
|
+
* Get Sales Trend Report
|
|
19591
|
+
* @description Sales Trend Report - Time-based sales analysis.
|
|
19592
|
+
*
|
|
19593
|
+
* **Granularity Options:**
|
|
19594
|
+
* - `daily`: Day-by-day breakdown (best for short periods like thisWeek, lastWeek, thisMonth)
|
|
19595
|
+
* - `weekly`: Week-by-week breakdown (best for medium periods like thisMonth, thisQuarter)
|
|
19596
|
+
* - `monthly`: Month-by-month breakdown (best for longer periods like thisYear, lastYear)
|
|
19597
|
+
*
|
|
19598
|
+
* **Possible Responses:**
|
|
19599
|
+
* - 200: Trend report data (daily, weekly, or monthly)
|
|
19600
|
+
* - 400:
|
|
19601
|
+
* - startDateAndEndDateAreRequiredForCustomPeriodType
|
|
19602
|
+
* - invalidDateFormat
|
|
19603
|
+
* - 403: permissionDenied
|
|
19604
|
+
*
|
|
19605
|
+
* **Permission Keys:**
|
|
19606
|
+
* - salestrendreport: ["view"]
|
|
19607
|
+
*/
|
|
19608
|
+
get: operations["reports_salesreport_views_get_sales_trend_report"];
|
|
19609
|
+
put?: never;
|
|
19610
|
+
post?: never;
|
|
19611
|
+
delete?: never;
|
|
19612
|
+
options?: never;
|
|
19613
|
+
head?: never;
|
|
19614
|
+
patch?: never;
|
|
19615
|
+
trace?: never;
|
|
19616
|
+
};
|
|
19371
19617
|
"/api/v1/task/status": {
|
|
19372
19618
|
parameters: {
|
|
19373
19619
|
query?: never;
|
|
@@ -20517,16 +20763,10 @@ export interface paths {
|
|
|
20517
20763
|
* Possible Responses:
|
|
20518
20764
|
* - 200:
|
|
20519
20765
|
* - RetrieveNotificationSetting
|
|
20520
|
-
* - 403:
|
|
20521
|
-
* - permissionDenied
|
|
20522
|
-
* - noModuleAccess
|
|
20523
20766
|
* - 404:
|
|
20524
20767
|
* - notificationSettingDoesNotExist
|
|
20525
20768
|
* - 500:
|
|
20526
20769
|
* - internalServerError
|
|
20527
|
-
*
|
|
20528
|
-
* Permission Key:
|
|
20529
|
-
* 'erp_settings.notificationsettings = ['view']'
|
|
20530
20770
|
*/
|
|
20531
20771
|
get: operations["erp_settings_notificationsettings_views_get_notification_setting"];
|
|
20532
20772
|
/**
|
|
@@ -20544,9 +20784,6 @@ export interface paths {
|
|
|
20544
20784
|
* - notificationSettingDoesNotExist
|
|
20545
20785
|
* - 500:
|
|
20546
20786
|
* - internalServerError
|
|
20547
|
-
*
|
|
20548
|
-
* Permsission Key:
|
|
20549
|
-
* 'erp_settings.notificationsettings = ['change']'
|
|
20550
20787
|
*/
|
|
20551
20788
|
put: operations["erp_settings_notificationsettings_views_edit_notification_setting"];
|
|
20552
20789
|
post?: never;
|
|
@@ -20573,14 +20810,8 @@ export interface paths {
|
|
|
20573
20810
|
* - 400:
|
|
20574
20811
|
* - invalidFilterFormat
|
|
20575
20812
|
* - paginationError
|
|
20576
|
-
* - 403:
|
|
20577
|
-
* - permissionDenied
|
|
20578
|
-
* - noModuleAccess
|
|
20579
20813
|
* - 500:
|
|
20580
20814
|
* - internalServerError
|
|
20581
|
-
*
|
|
20582
|
-
* Permission Key:
|
|
20583
|
-
* 'erp_settings.notificationsettings = ["view"]'
|
|
20584
20815
|
*/
|
|
20585
20816
|
get: operations["erp_settings_notificationsettings_views_list_notification_settings"];
|
|
20586
20817
|
put?: never;
|
|
@@ -20590,9 +20821,6 @@ export interface paths {
|
|
|
20590
20821
|
* Possible Responses:
|
|
20591
20822
|
* - 201:
|
|
20592
20823
|
* - RetrieveNotificationSetting
|
|
20593
|
-
* - 403:
|
|
20594
|
-
* - permissionDenied
|
|
20595
|
-
* - noModuleAccess
|
|
20596
20824
|
* - 400:
|
|
20597
20825
|
* - ValidationError
|
|
20598
20826
|
* - contentTypeDoesNotExist
|
|
@@ -20600,9 +20828,6 @@ export interface paths {
|
|
|
20600
20828
|
* - DuplicateNotificationSetting
|
|
20601
20829
|
* - 500:
|
|
20602
20830
|
* - internalServerError
|
|
20603
|
-
*
|
|
20604
|
-
* Permission key:
|
|
20605
|
-
* 'erp_settings.notificationsettings = ['add']'
|
|
20606
20831
|
*/
|
|
20607
20832
|
post: operations["erp_settings_notificationsettings_views_create_notification_setting"];
|
|
20608
20833
|
delete?: never;
|
|
@@ -20629,7 +20854,7 @@ export interface paths {
|
|
|
20629
20854
|
* the client's browser
|
|
20630
20855
|
*
|
|
20631
20856
|
* How SSE works >>>
|
|
20632
|
-
* - Client initiates a GET request;
|
|
20857
|
+
* - Client initiates a GET request;
|
|
20633
20858
|
* - Upon success, a persistent HTTP connection is opened, subscribing to the Redis channel unique for request user
|
|
20634
20859
|
* - An initial `{"type":"connected"}` JSON payload is sent immediately to confirm the stream is active.
|
|
20635
20860
|
* - The server runs an asynchronous loop, yielding any messages published to Redis directly to the client in SSE format.
|
|
@@ -20661,14 +20886,8 @@ export interface paths {
|
|
|
20661
20886
|
* - 400:
|
|
20662
20887
|
* - invalidFilterFormat
|
|
20663
20888
|
* - paginationError
|
|
20664
|
-
* - 403:
|
|
20665
|
-
* - permissionDenied
|
|
20666
|
-
* - noModuleAccess
|
|
20667
20889
|
* - 500:
|
|
20668
20890
|
* - internalServerError
|
|
20669
|
-
*
|
|
20670
|
-
* Permission Key:
|
|
20671
|
-
* 'notificationrecipient = ["view"]'
|
|
20672
20891
|
*/
|
|
20673
20892
|
get: operations["notification_views_list_notification"];
|
|
20674
20893
|
put?: never;
|
|
@@ -20701,22 +20920,15 @@ export interface paths {
|
|
|
20701
20920
|
* - RetrieveNotificationRecipient
|
|
20702
20921
|
* - 400:
|
|
20703
20922
|
* - ValidationError
|
|
20704
|
-
* - 403:
|
|
20705
|
-
* - permissionDenied
|
|
20706
|
-
* - noModuleAccess
|
|
20707
20923
|
* - 404:
|
|
20708
20924
|
* - NotificationDoesNotExist
|
|
20709
20925
|
* - 500:
|
|
20710
20926
|
* - internalServerError
|
|
20711
|
-
*
|
|
20712
|
-
* Permission Key:
|
|
20713
|
-
* 'notificationrecipient = ['mark_read']' Permission key to mark notification as read only
|
|
20714
|
-
* 'notificationrecipient = ['mark_unread']' Permission key to mark notification as unread only
|
|
20715
20927
|
*/
|
|
20716
20928
|
patch: operations["notification_views_update_notification_status"];
|
|
20717
20929
|
trace?: never;
|
|
20718
20930
|
};
|
|
20719
|
-
"/api/v1/notification/
|
|
20931
|
+
"/api/v1/notification/batch-update/": {
|
|
20720
20932
|
parameters: {
|
|
20721
20933
|
query?: never;
|
|
20722
20934
|
header?: never;
|
|
@@ -20733,17 +20945,10 @@ export interface paths {
|
|
|
20733
20945
|
* - MessageResponse
|
|
20734
20946
|
* - 400:
|
|
20735
20947
|
* - ValidationError
|
|
20736
|
-
* - 403:
|
|
20737
|
-
* - permissionDenied
|
|
20738
|
-
* - noModuleAccess
|
|
20739
20948
|
* - 404:
|
|
20740
20949
|
* - NotificationDoesNotExist
|
|
20741
20950
|
* - 500:
|
|
20742
20951
|
* - internalServerError
|
|
20743
|
-
*
|
|
20744
|
-
* Permission Key:
|
|
20745
|
-
* 'notificationrecipient = ['mark_read']' Permission key to mark notification as read only
|
|
20746
|
-
* 'notificationrecipient = ['mark_unread']' Permission key to mark notification as unread only
|
|
20747
20952
|
*/
|
|
20748
20953
|
put: operations["notification_views_batch_update_notification_status"];
|
|
20749
20954
|
post?: never;
|
|
@@ -20767,16 +20972,10 @@ export interface paths {
|
|
|
20767
20972
|
* Possible Responses:
|
|
20768
20973
|
* - 200:
|
|
20769
20974
|
* - RetrieveNotificationRecipient
|
|
20770
|
-
* - 403:
|
|
20771
|
-
* - permissionDenied
|
|
20772
|
-
* - noModuleAccess
|
|
20773
20975
|
* - 404:
|
|
20774
20976
|
* - notificationDoesNotExist
|
|
20775
20977
|
* - 500:
|
|
20776
20978
|
* - internalServerError
|
|
20777
|
-
*
|
|
20778
|
-
* Permission Key:
|
|
20779
|
-
* 'notificationrecipient = ['view']'
|
|
20780
20979
|
*/
|
|
20781
20980
|
get: operations["notification_views_get_notification"];
|
|
20782
20981
|
put?: never;
|
|
@@ -21906,6 +22105,11 @@ export interface components {
|
|
|
21906
22105
|
* @default []
|
|
21907
22106
|
*/
|
|
21908
22107
|
expenses: components["schemas"]["BasePermissionsSchema_Expenses"];
|
|
22108
|
+
/**
|
|
22109
|
+
* @description notification actions
|
|
22110
|
+
* @default []
|
|
22111
|
+
*/
|
|
22112
|
+
notification: components["schemas"]["BasePermissionsSchema_Notification"];
|
|
21909
22113
|
/**
|
|
21910
22114
|
* @description pos actions
|
|
21911
22115
|
* @default []
|
|
@@ -22304,6 +22508,53 @@ export interface components {
|
|
|
22304
22508
|
* @enum {string}
|
|
22305
22509
|
*/
|
|
22306
22510
|
BasePermissionsSchema_Inventory_WarehouseEnum: "add" | "change" | "delete" | "view";
|
|
22511
|
+
/** BasePermissionsSchema_Notification */
|
|
22512
|
+
BasePermissionsSchema_Notification: {
|
|
22513
|
+
/**
|
|
22514
|
+
* Notification
|
|
22515
|
+
* @description notification actions
|
|
22516
|
+
* @default []
|
|
22517
|
+
*/
|
|
22518
|
+
notification: components["schemas"]["BasePermissionsSchema_Notification_NotificationEnum"][];
|
|
22519
|
+
/**
|
|
22520
|
+
* Notificationrecipient
|
|
22521
|
+
* @description notificationrecipient actions
|
|
22522
|
+
* @default []
|
|
22523
|
+
*/
|
|
22524
|
+
notificationrecipient: components["schemas"]["BasePermissionsSchema_Notification_NotificationrecipientEnum"][];
|
|
22525
|
+
/**
|
|
22526
|
+
* Read Notificationrecipient
|
|
22527
|
+
* @description read_notificationrecipient actions
|
|
22528
|
+
* @default []
|
|
22529
|
+
*/
|
|
22530
|
+
read_notificationrecipient: components["schemas"]["BasePermissionsSchema_Notification_Read_notificationrecipientEnum"][];
|
|
22531
|
+
/**
|
|
22532
|
+
* Unread Notificationrecipient
|
|
22533
|
+
* @description unread_notificationrecipient actions
|
|
22534
|
+
* @default []
|
|
22535
|
+
*/
|
|
22536
|
+
unread_notificationrecipient: components["schemas"]["BasePermissionsSchema_Notification_Unread_notificationrecipientEnum"][];
|
|
22537
|
+
};
|
|
22538
|
+
/**
|
|
22539
|
+
* BasePermissionsSchema_Notification_NotificationEnum
|
|
22540
|
+
* @enum {string}
|
|
22541
|
+
*/
|
|
22542
|
+
BasePermissionsSchema_Notification_NotificationEnum: "add" | "change" | "delete" | "view";
|
|
22543
|
+
/**
|
|
22544
|
+
* BasePermissionsSchema_Notification_NotificationrecipientEnum
|
|
22545
|
+
* @enum {string}
|
|
22546
|
+
*/
|
|
22547
|
+
BasePermissionsSchema_Notification_NotificationrecipientEnum: "add" | "change" | "delete" | "view";
|
|
22548
|
+
/**
|
|
22549
|
+
* BasePermissionsSchema_Notification_Read_notificationrecipientEnum
|
|
22550
|
+
* @constant
|
|
22551
|
+
*/
|
|
22552
|
+
BasePermissionsSchema_Notification_Read_notificationrecipientEnum: "mark";
|
|
22553
|
+
/**
|
|
22554
|
+
* BasePermissionsSchema_Notification_Unread_notificationrecipientEnum
|
|
22555
|
+
* @constant
|
|
22556
|
+
*/
|
|
22557
|
+
BasePermissionsSchema_Notification_Unread_notificationrecipientEnum: "mark";
|
|
22307
22558
|
/** BasePermissionsSchema_Pos */
|
|
22308
22559
|
BasePermissionsSchema_Pos: {
|
|
22309
22560
|
/**
|
|
@@ -22972,6 +23223,11 @@ export interface components {
|
|
|
22972
23223
|
* @default []
|
|
22973
23224
|
*/
|
|
22974
23225
|
settings: components["schemas"]["BasePermissionsSchema_Settings_Settings"];
|
|
23226
|
+
/**
|
|
23227
|
+
* @description notification actions
|
|
23228
|
+
* @default []
|
|
23229
|
+
*/
|
|
23230
|
+
notification: components["schemas"]["BasePermissionsSchema_Settings_Notification"];
|
|
22975
23231
|
/**
|
|
22976
23232
|
* @description pos actions
|
|
22977
23233
|
* @default []
|
|
@@ -23575,6 +23831,20 @@ export interface components {
|
|
|
23575
23831
|
* @enum {string}
|
|
23576
23832
|
*/
|
|
23577
23833
|
BasePermissionsSchema_Settings_Miscellaneous_ZoneEnum: "add" | "change" | "delete" | "view";
|
|
23834
|
+
/** BasePermissionsSchema_Settings_Notification */
|
|
23835
|
+
BasePermissionsSchema_Settings_Notification: {
|
|
23836
|
+
/**
|
|
23837
|
+
* Notificationsetting
|
|
23838
|
+
* @description notificationsetting actions
|
|
23839
|
+
* @default []
|
|
23840
|
+
*/
|
|
23841
|
+
notificationsetting: components["schemas"]["BasePermissionsSchema_Settings_Notification_NotificationsettingEnum"][];
|
|
23842
|
+
};
|
|
23843
|
+
/**
|
|
23844
|
+
* BasePermissionsSchema_Settings_Notification_NotificationsettingEnum
|
|
23845
|
+
* @enum {string}
|
|
23846
|
+
*/
|
|
23847
|
+
BasePermissionsSchema_Settings_Notification_NotificationsettingEnum: "add" | "change" | "delete" | "view";
|
|
23578
23848
|
/** BasePermissionsSchema_Settings_Pos */
|
|
23579
23849
|
BasePermissionsSchema_Settings_Pos: {
|
|
23580
23850
|
/**
|
|
@@ -52575,6 +52845,398 @@ export interface components {
|
|
|
52575
52845
|
*/
|
|
52576
52846
|
locations: components["schemas"]["ItemLocationSchema"][];
|
|
52577
52847
|
};
|
|
52848
|
+
/**
|
|
52849
|
+
* SalesReportPeriodType
|
|
52850
|
+
* @enum {string}
|
|
52851
|
+
*/
|
|
52852
|
+
SalesReportPeriodType: "today" | "yesterday" | "thisWeek" | "lastWeek" | "thisMonth" | "lastMonth" | "thisQuarter" | "lastQuarter" | "thisYear" | "lastYear" | "custom";
|
|
52853
|
+
/**
|
|
52854
|
+
* SalesReportSourceType
|
|
52855
|
+
* @enum {string}
|
|
52856
|
+
*/
|
|
52857
|
+
SalesReportSourceType: "salesInvoice" | "posInvoice" | "onlineOrder";
|
|
52858
|
+
/** BrandSummarySchema */
|
|
52859
|
+
BrandSummarySchema: {
|
|
52860
|
+
/** Id */
|
|
52861
|
+
id: number;
|
|
52862
|
+
/** Name */
|
|
52863
|
+
name: string;
|
|
52864
|
+
};
|
|
52865
|
+
/** CategorySummarySchema */
|
|
52866
|
+
CategorySummarySchema: {
|
|
52867
|
+
/** Id */
|
|
52868
|
+
id: number;
|
|
52869
|
+
/** Name */
|
|
52870
|
+
name: string;
|
|
52871
|
+
};
|
|
52872
|
+
/**
|
|
52873
|
+
* CurrencyAmountSchema
|
|
52874
|
+
* @description Amount in both primary and secondary currencies
|
|
52875
|
+
*/
|
|
52876
|
+
CurrencyAmountSchema: {
|
|
52877
|
+
/** Primary */
|
|
52878
|
+
primary: number;
|
|
52879
|
+
/** Secondary */
|
|
52880
|
+
secondary: number;
|
|
52881
|
+
};
|
|
52882
|
+
/** FamilySummarySchema */
|
|
52883
|
+
FamilySummarySchema: {
|
|
52884
|
+
/** Id */
|
|
52885
|
+
id: number;
|
|
52886
|
+
/** Name */
|
|
52887
|
+
name: string;
|
|
52888
|
+
};
|
|
52889
|
+
/** ItemSummarySchema */
|
|
52890
|
+
ItemSummarySchema: {
|
|
52891
|
+
/** Id */
|
|
52892
|
+
id: number;
|
|
52893
|
+
/** Name */
|
|
52894
|
+
name: string;
|
|
52895
|
+
/** Skucode */
|
|
52896
|
+
skuCode?: string | null;
|
|
52897
|
+
};
|
|
52898
|
+
/** SalesByItemListSchema */
|
|
52899
|
+
SalesByItemListSchema: {
|
|
52900
|
+
info: components["schemas"]["PageInfoSchema"];
|
|
52901
|
+
/** Results */
|
|
52902
|
+
results: components["schemas"]["SalesByItemSchema"][];
|
|
52903
|
+
totals?: components["schemas"]["SalesTotalsSchema"] | null;
|
|
52904
|
+
};
|
|
52905
|
+
/**
|
|
52906
|
+
* SalesByItemSchema
|
|
52907
|
+
* @description Sales performance at the individual item level
|
|
52908
|
+
*/
|
|
52909
|
+
SalesByItemSchema: {
|
|
52910
|
+
item: components["schemas"]["ItemSummarySchema"];
|
|
52911
|
+
category?: components["schemas"]["CategorySummarySchema"] | null;
|
|
52912
|
+
brand?: components["schemas"]["BrandSummarySchema"] | null;
|
|
52913
|
+
family?: components["schemas"]["FamilySummarySchema"] | null;
|
|
52914
|
+
/** Quantitysold */
|
|
52915
|
+
quantitySold: number;
|
|
52916
|
+
/** @description Total sales before discounts */
|
|
52917
|
+
grossSalesAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
52918
|
+
discountAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
52919
|
+
/** @description Sales after discounts */
|
|
52920
|
+
netSalesAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
52921
|
+
taxAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
52922
|
+
/** @description Net sales + tax */
|
|
52923
|
+
totalAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
52924
|
+
/** @description Cost of goods sold (COGS) */
|
|
52925
|
+
cost: components["schemas"]["CurrencyAmountSchema"];
|
|
52926
|
+
/** @description Net sales - COGS */
|
|
52927
|
+
grossProfit: components["schemas"]["CurrencyAmountSchema"];
|
|
52928
|
+
/**
|
|
52929
|
+
* Profitmargin
|
|
52930
|
+
* @description Profit margin percentage
|
|
52931
|
+
*/
|
|
52932
|
+
profitMargin: number;
|
|
52933
|
+
};
|
|
52934
|
+
/**
|
|
52935
|
+
* SalesTotalsSchema
|
|
52936
|
+
* @description Summary totals for sales reports
|
|
52937
|
+
*/
|
|
52938
|
+
SalesTotalsSchema: {
|
|
52939
|
+
/** Totalquantitysold */
|
|
52940
|
+
totalQuantitySold: number;
|
|
52941
|
+
grossSalesAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
52942
|
+
totalDiscounts: components["schemas"]["CurrencyAmountSchema"];
|
|
52943
|
+
netSalesAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
52944
|
+
totalTaxAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
52945
|
+
totalAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
52946
|
+
totalCost: components["schemas"]["CurrencyAmountSchema"];
|
|
52947
|
+
grossProfit: components["schemas"]["CurrencyAmountSchema"];
|
|
52948
|
+
/** Profitmargin */
|
|
52949
|
+
profitMargin: number;
|
|
52950
|
+
};
|
|
52951
|
+
/** SalesByCategoryListSchema */
|
|
52952
|
+
SalesByCategoryListSchema: {
|
|
52953
|
+
info: components["schemas"]["PageInfoSchema"];
|
|
52954
|
+
/** Results */
|
|
52955
|
+
results: components["schemas"]["SalesByCategorySchema"][];
|
|
52956
|
+
totals?: components["schemas"]["SalesTotalsSchema"] | null;
|
|
52957
|
+
};
|
|
52958
|
+
/**
|
|
52959
|
+
* SalesByCategorySchema
|
|
52960
|
+
* @description Aggregated sales per item category
|
|
52961
|
+
*/
|
|
52962
|
+
SalesByCategorySchema: {
|
|
52963
|
+
category: components["schemas"]["CategorySummarySchema"];
|
|
52964
|
+
/** Quantitysold */
|
|
52965
|
+
quantitySold: number;
|
|
52966
|
+
grossSalesAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
52967
|
+
discountAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
52968
|
+
netSalesAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
52969
|
+
taxAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
52970
|
+
totalAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
52971
|
+
cost: components["schemas"]["CurrencyAmountSchema"];
|
|
52972
|
+
grossProfit: components["schemas"]["CurrencyAmountSchema"];
|
|
52973
|
+
/** Profitmargin */
|
|
52974
|
+
profitMargin: number;
|
|
52975
|
+
/**
|
|
52976
|
+
* Contributionpercentage
|
|
52977
|
+
* @description Category's contribution to total sales
|
|
52978
|
+
*/
|
|
52979
|
+
contributionPercentage: number;
|
|
52980
|
+
};
|
|
52981
|
+
/** SalesByBrandListSchema */
|
|
52982
|
+
SalesByBrandListSchema: {
|
|
52983
|
+
info: components["schemas"]["PageInfoSchema"];
|
|
52984
|
+
/** Results */
|
|
52985
|
+
results: components["schemas"]["SalesByBrandSchema"][];
|
|
52986
|
+
totals?: components["schemas"]["SalesTotalsSchema"] | null;
|
|
52987
|
+
};
|
|
52988
|
+
/**
|
|
52989
|
+
* SalesByBrandSchema
|
|
52990
|
+
* @description Sales contribution of each brand
|
|
52991
|
+
*/
|
|
52992
|
+
SalesByBrandSchema: {
|
|
52993
|
+
brand: components["schemas"]["BrandSummarySchema"];
|
|
52994
|
+
/** Quantitysold */
|
|
52995
|
+
quantitySold: number;
|
|
52996
|
+
grossSalesAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
52997
|
+
discountAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
52998
|
+
netSalesAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
52999
|
+
taxAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
53000
|
+
totalAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
53001
|
+
cost: components["schemas"]["CurrencyAmountSchema"];
|
|
53002
|
+
grossProfit: components["schemas"]["CurrencyAmountSchema"];
|
|
53003
|
+
/** Profitmargin */
|
|
53004
|
+
profitMargin: number;
|
|
53005
|
+
};
|
|
53006
|
+
/** CustomerSummarySchema */
|
|
53007
|
+
CustomerSummarySchema: {
|
|
53008
|
+
/** Id */
|
|
53009
|
+
id: number;
|
|
53010
|
+
/** Name */
|
|
53011
|
+
name: string;
|
|
53012
|
+
/** Code */
|
|
53013
|
+
code?: string | null;
|
|
53014
|
+
};
|
|
53015
|
+
/** SalesByCustomerListSchema */
|
|
53016
|
+
SalesByCustomerListSchema: {
|
|
53017
|
+
info: components["schemas"]["PageInfoSchema"];
|
|
53018
|
+
/** Results */
|
|
53019
|
+
results: components["schemas"]["SalesByCustomerSchema"][];
|
|
53020
|
+
totals?: components["schemas"]["SalesTotalsSchema"] | null;
|
|
53021
|
+
};
|
|
53022
|
+
/**
|
|
53023
|
+
* SalesByCustomerSchema
|
|
53024
|
+
* @description Sales analysis per customer
|
|
53025
|
+
*/
|
|
53026
|
+
SalesByCustomerSchema: {
|
|
53027
|
+
customer: components["schemas"]["CustomerSummarySchema"];
|
|
53028
|
+
/** Totalinvoices */
|
|
53029
|
+
totalInvoices: number;
|
|
53030
|
+
/** Quantitysold */
|
|
53031
|
+
quantitySold: number;
|
|
53032
|
+
grossSalesAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
53033
|
+
discountAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
53034
|
+
netSalesAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
53035
|
+
taxAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
53036
|
+
totalAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
53037
|
+
cost: components["schemas"]["CurrencyAmountSchema"];
|
|
53038
|
+
grossProfit: components["schemas"]["CurrencyAmountSchema"];
|
|
53039
|
+
/** Profitmargin */
|
|
53040
|
+
profitMargin: number;
|
|
53041
|
+
};
|
|
53042
|
+
/** SalesBySalespersonListSchema */
|
|
53043
|
+
SalesBySalespersonListSchema: {
|
|
53044
|
+
info: components["schemas"]["PageInfoSchema"];
|
|
53045
|
+
/** Results */
|
|
53046
|
+
results: components["schemas"]["SalesBySalespersonSchema"][];
|
|
53047
|
+
totals?: components["schemas"]["SalesTotalsSchema"] | null;
|
|
53048
|
+
};
|
|
53049
|
+
/**
|
|
53050
|
+
* SalesBySalespersonSchema
|
|
53051
|
+
* @description Performance tracking of sales staff
|
|
53052
|
+
*/
|
|
53053
|
+
SalesBySalespersonSchema: {
|
|
53054
|
+
salesperson: components["schemas"]["SalespersonSummarySchema"];
|
|
53055
|
+
/** Numberofinvoices */
|
|
53056
|
+
numberOfInvoices: number;
|
|
53057
|
+
/** Quantitysold */
|
|
53058
|
+
quantitySold: number;
|
|
53059
|
+
grossSalesAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
53060
|
+
discountAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
53061
|
+
netSalesAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
53062
|
+
taxAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
53063
|
+
totalAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
53064
|
+
cost: components["schemas"]["CurrencyAmountSchema"];
|
|
53065
|
+
grossProfit: components["schemas"]["CurrencyAmountSchema"];
|
|
53066
|
+
/** Profitmargin */
|
|
53067
|
+
profitMargin: number;
|
|
53068
|
+
averageInvoiceValue: components["schemas"]["CurrencyAmountSchema"];
|
|
53069
|
+
};
|
|
53070
|
+
/** SalespersonSummarySchema */
|
|
53071
|
+
SalespersonSummarySchema: {
|
|
53072
|
+
/**
|
|
53073
|
+
* Id
|
|
53074
|
+
* Format: uuid
|
|
53075
|
+
*/
|
|
53076
|
+
id: string;
|
|
53077
|
+
/** Name */
|
|
53078
|
+
name: string;
|
|
53079
|
+
};
|
|
53080
|
+
/** BranchSummarySchema */
|
|
53081
|
+
BranchSummarySchema: {
|
|
53082
|
+
/** Id */
|
|
53083
|
+
id: number;
|
|
53084
|
+
/** Name */
|
|
53085
|
+
name: string;
|
|
53086
|
+
};
|
|
53087
|
+
/** SalesByWarehouseListSchema */
|
|
53088
|
+
SalesByWarehouseListSchema: {
|
|
53089
|
+
info: components["schemas"]["PageInfoSchema"];
|
|
53090
|
+
/** Results */
|
|
53091
|
+
results: components["schemas"]["SalesByWarehouseSchema"][];
|
|
53092
|
+
totals?: components["schemas"]["SalesTotalsSchema"] | null;
|
|
53093
|
+
};
|
|
53094
|
+
/**
|
|
53095
|
+
* SalesByWarehouseSchema
|
|
53096
|
+
* @description Sales per warehouse/branch
|
|
53097
|
+
*/
|
|
53098
|
+
SalesByWarehouseSchema: {
|
|
53099
|
+
branch: components["schemas"]["BranchSummarySchema"];
|
|
53100
|
+
warehouse?: components["schemas"]["WarehouseSummarySchema"] | null;
|
|
53101
|
+
/** Quantitysold */
|
|
53102
|
+
quantitySold: number;
|
|
53103
|
+
grossSalesAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
53104
|
+
discountAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
53105
|
+
netSalesAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
53106
|
+
taxAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
53107
|
+
totalAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
53108
|
+
cost: components["schemas"]["CurrencyAmountSchema"];
|
|
53109
|
+
grossProfit: components["schemas"]["CurrencyAmountSchema"];
|
|
53110
|
+
/** Profitmargin */
|
|
53111
|
+
profitMargin: number;
|
|
53112
|
+
};
|
|
53113
|
+
/** WarehouseSummarySchema */
|
|
53114
|
+
WarehouseSummarySchema: {
|
|
53115
|
+
/** Id */
|
|
53116
|
+
id: number;
|
|
53117
|
+
/** Name */
|
|
53118
|
+
name: string;
|
|
53119
|
+
};
|
|
53120
|
+
/**
|
|
53121
|
+
* SalesSummarySchema
|
|
53122
|
+
* @description Overall sales summary and profitability
|
|
53123
|
+
*/
|
|
53124
|
+
SalesSummarySchema: {
|
|
53125
|
+
/**
|
|
53126
|
+
* Periodstart
|
|
53127
|
+
* Format: date
|
|
53128
|
+
*/
|
|
53129
|
+
periodStart: string;
|
|
53130
|
+
/**
|
|
53131
|
+
* Periodend
|
|
53132
|
+
* Format: date
|
|
53133
|
+
*/
|
|
53134
|
+
periodEnd: string;
|
|
53135
|
+
/** Totalinvoices */
|
|
53136
|
+
totalInvoices: number;
|
|
53137
|
+
/** Totalcustomers */
|
|
53138
|
+
totalCustomers: number;
|
|
53139
|
+
/** Totalitemssold */
|
|
53140
|
+
totalItemsSold: number;
|
|
53141
|
+
grossSales: components["schemas"]["CurrencyAmountSchema"];
|
|
53142
|
+
totalDiscounts: components["schemas"]["CurrencyAmountSchema"];
|
|
53143
|
+
netSales: components["schemas"]["CurrencyAmountSchema"];
|
|
53144
|
+
totalTax: components["schemas"]["CurrencyAmountSchema"];
|
|
53145
|
+
totalRevenue: components["schemas"]["CurrencyAmountSchema"];
|
|
53146
|
+
costOfGoodsSold: components["schemas"]["CurrencyAmountSchema"];
|
|
53147
|
+
grossProfit: components["schemas"]["CurrencyAmountSchema"];
|
|
53148
|
+
/** Grossmarginpercentage */
|
|
53149
|
+
grossMarginPercentage: number;
|
|
53150
|
+
averageOrderValue: components["schemas"]["CurrencyAmountSchema"];
|
|
53151
|
+
/** Averageitemsperorder */
|
|
53152
|
+
averageItemsPerOrder: number;
|
|
53153
|
+
};
|
|
53154
|
+
/**
|
|
53155
|
+
* SalesReportGranularity
|
|
53156
|
+
* @enum {string}
|
|
53157
|
+
*/
|
|
53158
|
+
SalesReportGranularity: "daily" | "weekly" | "monthly";
|
|
53159
|
+
/**
|
|
53160
|
+
* DailySalesSchema
|
|
53161
|
+
* @description Daily sales data
|
|
53162
|
+
*/
|
|
53163
|
+
DailySalesSchema: {
|
|
53164
|
+
/**
|
|
53165
|
+
* Date
|
|
53166
|
+
* Format: date
|
|
53167
|
+
*/
|
|
53168
|
+
date: string;
|
|
53169
|
+
salesAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
53170
|
+
/** Invoicecount */
|
|
53171
|
+
invoiceCount: number;
|
|
53172
|
+
/** Quantitysold */
|
|
53173
|
+
quantitySold: number;
|
|
53174
|
+
};
|
|
53175
|
+
/**
|
|
53176
|
+
* MonthlySalesSchema
|
|
53177
|
+
* @description Monthly sales data
|
|
53178
|
+
*/
|
|
53179
|
+
MonthlySalesSchema: {
|
|
53180
|
+
/** Year */
|
|
53181
|
+
year: number;
|
|
53182
|
+
/** Month */
|
|
53183
|
+
month: number;
|
|
53184
|
+
/** Monthname */
|
|
53185
|
+
monthName: string;
|
|
53186
|
+
salesAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
53187
|
+
/** Invoicecount */
|
|
53188
|
+
invoiceCount: number;
|
|
53189
|
+
/** Quantitysold */
|
|
53190
|
+
quantitySold: number;
|
|
53191
|
+
/**
|
|
53192
|
+
* Growthpercentage
|
|
53193
|
+
* @description Month-over-month growth
|
|
53194
|
+
*/
|
|
53195
|
+
growthPercentage?: number | null;
|
|
53196
|
+
};
|
|
53197
|
+
/**
|
|
53198
|
+
* SalesTrendSchema
|
|
53199
|
+
* @description Sales trend over time
|
|
53200
|
+
*/
|
|
53201
|
+
SalesTrendSchema: {
|
|
53202
|
+
/** Daily */
|
|
53203
|
+
daily?: components["schemas"]["DailySalesSchema"][] | null;
|
|
53204
|
+
/** Weekly */
|
|
53205
|
+
weekly?: components["schemas"]["WeeklySalesSchema"][] | null;
|
|
53206
|
+
/** Monthly */
|
|
53207
|
+
monthly?: components["schemas"]["MonthlySalesSchema"][] | null;
|
|
53208
|
+
summary: components["schemas"]["SalesTotalsSchema"];
|
|
53209
|
+
};
|
|
53210
|
+
/**
|
|
53211
|
+
* WeeklySalesSchema
|
|
53212
|
+
* @description Weekly sales data
|
|
53213
|
+
*/
|
|
53214
|
+
WeeklySalesSchema: {
|
|
53215
|
+
/** Year */
|
|
53216
|
+
year: number;
|
|
53217
|
+
/** Week */
|
|
53218
|
+
week: number;
|
|
53219
|
+
/**
|
|
53220
|
+
* Weekstart
|
|
53221
|
+
* Format: date
|
|
53222
|
+
*/
|
|
53223
|
+
weekStart: string;
|
|
53224
|
+
/**
|
|
53225
|
+
* Weekend
|
|
53226
|
+
* Format: date
|
|
53227
|
+
*/
|
|
53228
|
+
weekEnd: string;
|
|
53229
|
+
salesAmount: components["schemas"]["CurrencyAmountSchema"];
|
|
53230
|
+
/** Invoicecount */
|
|
53231
|
+
invoiceCount: number;
|
|
53232
|
+
/** Quantitysold */
|
|
53233
|
+
quantitySold: number;
|
|
53234
|
+
/**
|
|
53235
|
+
* Growthpercentage
|
|
53236
|
+
* @description Week-over-week growth
|
|
53237
|
+
*/
|
|
53238
|
+
growthPercentage?: number | null;
|
|
53239
|
+
};
|
|
52578
53240
|
/** RetrieveStatus */
|
|
52579
53241
|
RetrieveStatus: {
|
|
52580
53242
|
/**
|
|
@@ -92979,6 +93641,394 @@ export interface operations {
|
|
|
92979
93641
|
};
|
|
92980
93642
|
};
|
|
92981
93643
|
};
|
|
93644
|
+
reports_salesreport_views_get_sales_by_item_report: {
|
|
93645
|
+
parameters: {
|
|
93646
|
+
query?: {
|
|
93647
|
+
periodType?: "today" | "yesterday" | "thisWeek" | "lastWeek" | "thisMonth" | "lastMonth" | "thisQuarter" | "lastQuarter" | "thisYear" | "lastYear" | "custom";
|
|
93648
|
+
/** @description Start date (YYYY-MM-DD) for custom period */
|
|
93649
|
+
startDate?: string | null;
|
|
93650
|
+
/** @description End date (YYYY-MM-DD) for custom period */
|
|
93651
|
+
endDate?: string | null;
|
|
93652
|
+
/** @description Data sources: salesInvoice, posInvoice, onlineOrder (empty for all) */
|
|
93653
|
+
sources?: components["schemas"]["SalesReportSourceType"][] | null;
|
|
93654
|
+
branchesIds?: number[] | null;
|
|
93655
|
+
warehousesIds?: number[] | null;
|
|
93656
|
+
categoriesIds?: number[] | null;
|
|
93657
|
+
brandsIds?: number[] | null;
|
|
93658
|
+
familiesIds?: number[] | null;
|
|
93659
|
+
itemsIds?: number[] | null;
|
|
93660
|
+
};
|
|
93661
|
+
header?: never;
|
|
93662
|
+
path?: never;
|
|
93663
|
+
cookie?: never;
|
|
93664
|
+
};
|
|
93665
|
+
requestBody?: never;
|
|
93666
|
+
responses: {
|
|
93667
|
+
/** @description OK */
|
|
93668
|
+
200: {
|
|
93669
|
+
headers: {
|
|
93670
|
+
[name: string]: unknown;
|
|
93671
|
+
};
|
|
93672
|
+
content: {
|
|
93673
|
+
"application/json": components["schemas"]["SalesByItemListSchema"];
|
|
93674
|
+
};
|
|
93675
|
+
};
|
|
93676
|
+
/** @description Bad Request */
|
|
93677
|
+
400: {
|
|
93678
|
+
headers: {
|
|
93679
|
+
[name: string]: unknown;
|
|
93680
|
+
};
|
|
93681
|
+
content: {
|
|
93682
|
+
"application/json": components["schemas"]["ErrorMessages"];
|
|
93683
|
+
};
|
|
93684
|
+
};
|
|
93685
|
+
/** @description Forbidden */
|
|
93686
|
+
403: {
|
|
93687
|
+
headers: {
|
|
93688
|
+
[name: string]: unknown;
|
|
93689
|
+
};
|
|
93690
|
+
content: {
|
|
93691
|
+
"application/json": components["schemas"]["MessageResponse"];
|
|
93692
|
+
};
|
|
93693
|
+
};
|
|
93694
|
+
};
|
|
93695
|
+
};
|
|
93696
|
+
reports_salesreport_views_get_sales_by_category_report: {
|
|
93697
|
+
parameters: {
|
|
93698
|
+
query?: {
|
|
93699
|
+
periodType?: "today" | "yesterday" | "thisWeek" | "lastWeek" | "thisMonth" | "lastMonth" | "thisQuarter" | "lastQuarter" | "thisYear" | "lastYear" | "custom";
|
|
93700
|
+
/** @description Start date (YYYY-MM-DD) for custom period */
|
|
93701
|
+
startDate?: string | null;
|
|
93702
|
+
/** @description End date (YYYY-MM-DD) for custom period */
|
|
93703
|
+
endDate?: string | null;
|
|
93704
|
+
/** @description Data sources: salesInvoice, posInvoice, onlineOrder (empty for all) */
|
|
93705
|
+
sources?: components["schemas"]["SalesReportSourceType"][] | null;
|
|
93706
|
+
branchesIds?: number[] | null;
|
|
93707
|
+
warehousesIds?: number[] | null;
|
|
93708
|
+
categoriesIds?: number[] | null;
|
|
93709
|
+
};
|
|
93710
|
+
header?: never;
|
|
93711
|
+
path?: never;
|
|
93712
|
+
cookie?: never;
|
|
93713
|
+
};
|
|
93714
|
+
requestBody?: never;
|
|
93715
|
+
responses: {
|
|
93716
|
+
/** @description OK */
|
|
93717
|
+
200: {
|
|
93718
|
+
headers: {
|
|
93719
|
+
[name: string]: unknown;
|
|
93720
|
+
};
|
|
93721
|
+
content: {
|
|
93722
|
+
"application/json": components["schemas"]["SalesByCategoryListSchema"];
|
|
93723
|
+
};
|
|
93724
|
+
};
|
|
93725
|
+
/** @description Bad Request */
|
|
93726
|
+
400: {
|
|
93727
|
+
headers: {
|
|
93728
|
+
[name: string]: unknown;
|
|
93729
|
+
};
|
|
93730
|
+
content: {
|
|
93731
|
+
"application/json": components["schemas"]["ErrorMessages"];
|
|
93732
|
+
};
|
|
93733
|
+
};
|
|
93734
|
+
/** @description Forbidden */
|
|
93735
|
+
403: {
|
|
93736
|
+
headers: {
|
|
93737
|
+
[name: string]: unknown;
|
|
93738
|
+
};
|
|
93739
|
+
content: {
|
|
93740
|
+
"application/json": components["schemas"]["MessageResponse"];
|
|
93741
|
+
};
|
|
93742
|
+
};
|
|
93743
|
+
};
|
|
93744
|
+
};
|
|
93745
|
+
reports_salesreport_views_get_sales_by_brand_report: {
|
|
93746
|
+
parameters: {
|
|
93747
|
+
query?: {
|
|
93748
|
+
periodType?: "today" | "yesterday" | "thisWeek" | "lastWeek" | "thisMonth" | "lastMonth" | "thisQuarter" | "lastQuarter" | "thisYear" | "lastYear" | "custom";
|
|
93749
|
+
/** @description Start date (YYYY-MM-DD) for custom period */
|
|
93750
|
+
startDate?: string | null;
|
|
93751
|
+
/** @description End date (YYYY-MM-DD) for custom period */
|
|
93752
|
+
endDate?: string | null;
|
|
93753
|
+
/** @description Data sources: salesInvoice, posInvoice, onlineOrder (empty for all) */
|
|
93754
|
+
sources?: components["schemas"]["SalesReportSourceType"][] | null;
|
|
93755
|
+
branchesIds?: number[] | null;
|
|
93756
|
+
warehousesIds?: number[] | null;
|
|
93757
|
+
brandsIds?: number[] | null;
|
|
93758
|
+
};
|
|
93759
|
+
header?: never;
|
|
93760
|
+
path?: never;
|
|
93761
|
+
cookie?: never;
|
|
93762
|
+
};
|
|
93763
|
+
requestBody?: never;
|
|
93764
|
+
responses: {
|
|
93765
|
+
/** @description OK */
|
|
93766
|
+
200: {
|
|
93767
|
+
headers: {
|
|
93768
|
+
[name: string]: unknown;
|
|
93769
|
+
};
|
|
93770
|
+
content: {
|
|
93771
|
+
"application/json": components["schemas"]["SalesByBrandListSchema"];
|
|
93772
|
+
};
|
|
93773
|
+
};
|
|
93774
|
+
/** @description Bad Request */
|
|
93775
|
+
400: {
|
|
93776
|
+
headers: {
|
|
93777
|
+
[name: string]: unknown;
|
|
93778
|
+
};
|
|
93779
|
+
content: {
|
|
93780
|
+
"application/json": components["schemas"]["ErrorMessages"];
|
|
93781
|
+
};
|
|
93782
|
+
};
|
|
93783
|
+
/** @description Forbidden */
|
|
93784
|
+
403: {
|
|
93785
|
+
headers: {
|
|
93786
|
+
[name: string]: unknown;
|
|
93787
|
+
};
|
|
93788
|
+
content: {
|
|
93789
|
+
"application/json": components["schemas"]["MessageResponse"];
|
|
93790
|
+
};
|
|
93791
|
+
};
|
|
93792
|
+
};
|
|
93793
|
+
};
|
|
93794
|
+
reports_salesreport_views_get_sales_by_customer_report: {
|
|
93795
|
+
parameters: {
|
|
93796
|
+
query?: {
|
|
93797
|
+
periodType?: "today" | "yesterday" | "thisWeek" | "lastWeek" | "thisMonth" | "lastMonth" | "thisQuarter" | "lastQuarter" | "thisYear" | "lastYear" | "custom";
|
|
93798
|
+
/** @description Start date (YYYY-MM-DD) for custom period */
|
|
93799
|
+
startDate?: string | null;
|
|
93800
|
+
/** @description End date (YYYY-MM-DD) for custom period */
|
|
93801
|
+
endDate?: string | null;
|
|
93802
|
+
/** @description Data sources: salesInvoice, posInvoice, onlineOrder (empty for all) */
|
|
93803
|
+
sources?: components["schemas"]["SalesReportSourceType"][] | null;
|
|
93804
|
+
branchesIds?: number[] | null;
|
|
93805
|
+
customersIds?: number[] | null;
|
|
93806
|
+
};
|
|
93807
|
+
header?: never;
|
|
93808
|
+
path?: never;
|
|
93809
|
+
cookie?: never;
|
|
93810
|
+
};
|
|
93811
|
+
requestBody?: never;
|
|
93812
|
+
responses: {
|
|
93813
|
+
/** @description OK */
|
|
93814
|
+
200: {
|
|
93815
|
+
headers: {
|
|
93816
|
+
[name: string]: unknown;
|
|
93817
|
+
};
|
|
93818
|
+
content: {
|
|
93819
|
+
"application/json": components["schemas"]["SalesByCustomerListSchema"];
|
|
93820
|
+
};
|
|
93821
|
+
};
|
|
93822
|
+
/** @description Bad Request */
|
|
93823
|
+
400: {
|
|
93824
|
+
headers: {
|
|
93825
|
+
[name: string]: unknown;
|
|
93826
|
+
};
|
|
93827
|
+
content: {
|
|
93828
|
+
"application/json": components["schemas"]["ErrorMessages"];
|
|
93829
|
+
};
|
|
93830
|
+
};
|
|
93831
|
+
/** @description Forbidden */
|
|
93832
|
+
403: {
|
|
93833
|
+
headers: {
|
|
93834
|
+
[name: string]: unknown;
|
|
93835
|
+
};
|
|
93836
|
+
content: {
|
|
93837
|
+
"application/json": components["schemas"]["MessageResponse"];
|
|
93838
|
+
};
|
|
93839
|
+
};
|
|
93840
|
+
};
|
|
93841
|
+
};
|
|
93842
|
+
reports_salesreport_views_get_sales_by_salesperson_report: {
|
|
93843
|
+
parameters: {
|
|
93844
|
+
query?: {
|
|
93845
|
+
periodType?: "today" | "yesterday" | "thisWeek" | "lastWeek" | "thisMonth" | "lastMonth" | "thisQuarter" | "lastQuarter" | "thisYear" | "lastYear" | "custom";
|
|
93846
|
+
/** @description Start date (YYYY-MM-DD) for custom period */
|
|
93847
|
+
startDate?: string | null;
|
|
93848
|
+
/** @description End date (YYYY-MM-DD) for custom period */
|
|
93849
|
+
endDate?: string | null;
|
|
93850
|
+
branchesIds?: number[] | null;
|
|
93851
|
+
salespersonsIds?: string[] | null;
|
|
93852
|
+
};
|
|
93853
|
+
header?: never;
|
|
93854
|
+
path?: never;
|
|
93855
|
+
cookie?: never;
|
|
93856
|
+
};
|
|
93857
|
+
requestBody?: never;
|
|
93858
|
+
responses: {
|
|
93859
|
+
/** @description OK */
|
|
93860
|
+
200: {
|
|
93861
|
+
headers: {
|
|
93862
|
+
[name: string]: unknown;
|
|
93863
|
+
};
|
|
93864
|
+
content: {
|
|
93865
|
+
"application/json": components["schemas"]["SalesBySalespersonListSchema"];
|
|
93866
|
+
};
|
|
93867
|
+
};
|
|
93868
|
+
/** @description Bad Request */
|
|
93869
|
+
400: {
|
|
93870
|
+
headers: {
|
|
93871
|
+
[name: string]: unknown;
|
|
93872
|
+
};
|
|
93873
|
+
content: {
|
|
93874
|
+
"application/json": components["schemas"]["ErrorMessages"];
|
|
93875
|
+
};
|
|
93876
|
+
};
|
|
93877
|
+
/** @description Forbidden */
|
|
93878
|
+
403: {
|
|
93879
|
+
headers: {
|
|
93880
|
+
[name: string]: unknown;
|
|
93881
|
+
};
|
|
93882
|
+
content: {
|
|
93883
|
+
"application/json": components["schemas"]["MessageResponse"];
|
|
93884
|
+
};
|
|
93885
|
+
};
|
|
93886
|
+
};
|
|
93887
|
+
};
|
|
93888
|
+
reports_salesreport_views_get_sales_by_warehouse_report: {
|
|
93889
|
+
parameters: {
|
|
93890
|
+
query?: {
|
|
93891
|
+
periodType?: "today" | "yesterday" | "thisWeek" | "lastWeek" | "thisMonth" | "lastMonth" | "thisQuarter" | "lastQuarter" | "thisYear" | "lastYear" | "custom";
|
|
93892
|
+
/** @description Start date (YYYY-MM-DD) for custom period */
|
|
93893
|
+
startDate?: string | null;
|
|
93894
|
+
/** @description End date (YYYY-MM-DD) for custom period */
|
|
93895
|
+
endDate?: string | null;
|
|
93896
|
+
/** @description Data sources: salesInvoice, posInvoice, onlineOrder (empty for all) */
|
|
93897
|
+
sources?: components["schemas"]["SalesReportSourceType"][] | null;
|
|
93898
|
+
branchesIds?: number[] | null;
|
|
93899
|
+
warehousesIds?: number[] | null;
|
|
93900
|
+
};
|
|
93901
|
+
header?: never;
|
|
93902
|
+
path?: never;
|
|
93903
|
+
cookie?: never;
|
|
93904
|
+
};
|
|
93905
|
+
requestBody?: never;
|
|
93906
|
+
responses: {
|
|
93907
|
+
/** @description OK */
|
|
93908
|
+
200: {
|
|
93909
|
+
headers: {
|
|
93910
|
+
[name: string]: unknown;
|
|
93911
|
+
};
|
|
93912
|
+
content: {
|
|
93913
|
+
"application/json": components["schemas"]["SalesByWarehouseListSchema"];
|
|
93914
|
+
};
|
|
93915
|
+
};
|
|
93916
|
+
/** @description Bad Request */
|
|
93917
|
+
400: {
|
|
93918
|
+
headers: {
|
|
93919
|
+
[name: string]: unknown;
|
|
93920
|
+
};
|
|
93921
|
+
content: {
|
|
93922
|
+
"application/json": components["schemas"]["ErrorMessages"];
|
|
93923
|
+
};
|
|
93924
|
+
};
|
|
93925
|
+
/** @description Forbidden */
|
|
93926
|
+
403: {
|
|
93927
|
+
headers: {
|
|
93928
|
+
[name: string]: unknown;
|
|
93929
|
+
};
|
|
93930
|
+
content: {
|
|
93931
|
+
"application/json": components["schemas"]["MessageResponse"];
|
|
93932
|
+
};
|
|
93933
|
+
};
|
|
93934
|
+
};
|
|
93935
|
+
};
|
|
93936
|
+
reports_salesreport_views_get_sales_summary_report: {
|
|
93937
|
+
parameters: {
|
|
93938
|
+
query?: {
|
|
93939
|
+
periodType?: "today" | "yesterday" | "thisWeek" | "lastWeek" | "thisMonth" | "lastMonth" | "thisQuarter" | "lastQuarter" | "thisYear" | "lastYear" | "custom";
|
|
93940
|
+
/** @description Start date (YYYY-MM-DD) for custom period */
|
|
93941
|
+
startDate?: string | null;
|
|
93942
|
+
/** @description End date (YYYY-MM-DD) for custom period */
|
|
93943
|
+
endDate?: string | null;
|
|
93944
|
+
/** @description Data sources: salesInvoice, posInvoice, onlineOrder (empty for all) */
|
|
93945
|
+
sources?: components["schemas"]["SalesReportSourceType"][] | null;
|
|
93946
|
+
branchesIds?: number[] | null;
|
|
93947
|
+
};
|
|
93948
|
+
header?: never;
|
|
93949
|
+
path?: never;
|
|
93950
|
+
cookie?: never;
|
|
93951
|
+
};
|
|
93952
|
+
requestBody?: never;
|
|
93953
|
+
responses: {
|
|
93954
|
+
/** @description OK */
|
|
93955
|
+
200: {
|
|
93956
|
+
headers: {
|
|
93957
|
+
[name: string]: unknown;
|
|
93958
|
+
};
|
|
93959
|
+
content: {
|
|
93960
|
+
"application/json": components["schemas"]["SalesSummarySchema"];
|
|
93961
|
+
};
|
|
93962
|
+
};
|
|
93963
|
+
/** @description Bad Request */
|
|
93964
|
+
400: {
|
|
93965
|
+
headers: {
|
|
93966
|
+
[name: string]: unknown;
|
|
93967
|
+
};
|
|
93968
|
+
content: {
|
|
93969
|
+
"application/json": components["schemas"]["ErrorMessages"];
|
|
93970
|
+
};
|
|
93971
|
+
};
|
|
93972
|
+
/** @description Forbidden */
|
|
93973
|
+
403: {
|
|
93974
|
+
headers: {
|
|
93975
|
+
[name: string]: unknown;
|
|
93976
|
+
};
|
|
93977
|
+
content: {
|
|
93978
|
+
"application/json": components["schemas"]["MessageResponse"];
|
|
93979
|
+
};
|
|
93980
|
+
};
|
|
93981
|
+
};
|
|
93982
|
+
};
|
|
93983
|
+
reports_salesreport_views_get_sales_trend_report: {
|
|
93984
|
+
parameters: {
|
|
93985
|
+
query?: {
|
|
93986
|
+
/** @description Time granularity: daily, weekly, or monthly */
|
|
93987
|
+
granularity?: "daily" | "weekly" | "monthly";
|
|
93988
|
+
periodType?: "today" | "yesterday" | "thisWeek" | "lastWeek" | "thisMonth" | "lastMonth" | "thisQuarter" | "lastQuarter" | "thisYear" | "lastYear" | "custom";
|
|
93989
|
+
/** @description Start date (YYYY-MM-DD) for custom period */
|
|
93990
|
+
startDate?: string | null;
|
|
93991
|
+
/** @description End date (YYYY-MM-DD) for custom period */
|
|
93992
|
+
endDate?: string | null;
|
|
93993
|
+
/** @description Data sources: salesInvoice, posInvoice, onlineOrder (empty for all) */
|
|
93994
|
+
sources?: components["schemas"]["SalesReportSourceType"][] | null;
|
|
93995
|
+
branchesIds?: number[] | null;
|
|
93996
|
+
};
|
|
93997
|
+
header?: never;
|
|
93998
|
+
path?: never;
|
|
93999
|
+
cookie?: never;
|
|
94000
|
+
};
|
|
94001
|
+
requestBody?: never;
|
|
94002
|
+
responses: {
|
|
94003
|
+
/** @description OK */
|
|
94004
|
+
200: {
|
|
94005
|
+
headers: {
|
|
94006
|
+
[name: string]: unknown;
|
|
94007
|
+
};
|
|
94008
|
+
content: {
|
|
94009
|
+
"application/json": components["schemas"]["SalesTrendSchema"];
|
|
94010
|
+
};
|
|
94011
|
+
};
|
|
94012
|
+
/** @description Bad Request */
|
|
94013
|
+
400: {
|
|
94014
|
+
headers: {
|
|
94015
|
+
[name: string]: unknown;
|
|
94016
|
+
};
|
|
94017
|
+
content: {
|
|
94018
|
+
"application/json": components["schemas"]["ErrorMessages"];
|
|
94019
|
+
};
|
|
94020
|
+
};
|
|
94021
|
+
/** @description Forbidden */
|
|
94022
|
+
403: {
|
|
94023
|
+
headers: {
|
|
94024
|
+
[name: string]: unknown;
|
|
94025
|
+
};
|
|
94026
|
+
content: {
|
|
94027
|
+
"application/json": components["schemas"]["MessageResponse"];
|
|
94028
|
+
};
|
|
94029
|
+
};
|
|
94030
|
+
};
|
|
94031
|
+
};
|
|
92982
94032
|
task_views_list_status_by_order: {
|
|
92983
94033
|
parameters: {
|
|
92984
94034
|
query?: {
|
|
@@ -95813,7 +96863,7 @@ export interface operations {
|
|
|
95813
96863
|
notification_views_list_notification: {
|
|
95814
96864
|
parameters: {
|
|
95815
96865
|
query?: {
|
|
95816
|
-
/** @description Search notification by title
|
|
96866
|
+
/** @description Search notification by title or message */
|
|
95817
96867
|
search?: string | null;
|
|
95818
96868
|
};
|
|
95819
96869
|
header?: never;
|