@erp-galoper/types 1.0.754 → 1.0.756
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 +975 -755
- package/package.json +1 -1
package/openapi.ts
CHANGED
|
@@ -5635,7 +5635,7 @@ export interface paths {
|
|
|
5635
5635
|
patch: operations["common_currency_views_update_currency"];
|
|
5636
5636
|
trace?: never;
|
|
5637
5637
|
};
|
|
5638
|
-
"/api/v1/pos/sessions
|
|
5638
|
+
"/api/v1/pos/sessions": {
|
|
5639
5639
|
parameters: {
|
|
5640
5640
|
query?: never;
|
|
5641
5641
|
header?: never;
|
|
@@ -5644,17 +5644,16 @@ export interface paths {
|
|
|
5644
5644
|
};
|
|
5645
5645
|
/**
|
|
5646
5646
|
* List Sessions
|
|
5647
|
-
* @description Endpoint
|
|
5648
|
-
*
|
|
5649
|
-
*
|
|
5650
|
-
*
|
|
5651
|
-
* - 400:
|
|
5652
|
-
*
|
|
5653
|
-
*
|
|
5654
|
-
*
|
|
5655
|
-
*
|
|
5656
|
-
* -
|
|
5657
|
-
* - internalServerError
|
|
5647
|
+
* @description Endpoint for listing sessions.
|
|
5648
|
+
*
|
|
5649
|
+
* Responses:
|
|
5650
|
+
* - 200: SessionListSchema
|
|
5651
|
+
* - 400: invalidFilterFormat
|
|
5652
|
+
* - 403: permissionDenied
|
|
5653
|
+
* - 500: serverError
|
|
5654
|
+
*
|
|
5655
|
+
* Permission key:
|
|
5656
|
+
* - session: ['view']
|
|
5658
5657
|
*/
|
|
5659
5658
|
get: operations["pos_session_views_list_sessions"];
|
|
5660
5659
|
put?: never;
|
|
@@ -5665,7 +5664,7 @@ export interface paths {
|
|
|
5665
5664
|
patch?: never;
|
|
5666
5665
|
trace?: never;
|
|
5667
5666
|
};
|
|
5668
|
-
"/api/v1/pos/sessions/{id}
|
|
5667
|
+
"/api/v1/pos/sessions/{id}": {
|
|
5669
5668
|
parameters: {
|
|
5670
5669
|
query?: never;
|
|
5671
5670
|
header?: never;
|
|
@@ -5673,23 +5672,19 @@ export interface paths {
|
|
|
5673
5672
|
cookie?: never;
|
|
5674
5673
|
};
|
|
5675
5674
|
/**
|
|
5676
|
-
* Get
|
|
5677
|
-
* @description Endpoint
|
|
5678
|
-
*
|
|
5679
|
-
*
|
|
5680
|
-
*
|
|
5681
|
-
* -
|
|
5682
|
-
*
|
|
5683
|
-
*
|
|
5684
|
-
*
|
|
5685
|
-
*
|
|
5686
|
-
*
|
|
5687
|
-
* - 404:
|
|
5688
|
-
* - sessionDoesNotExist
|
|
5689
|
-
* - settingsDoesNotExist
|
|
5690
|
-
* - companyDoesNotExist
|
|
5675
|
+
* Get Session
|
|
5676
|
+
* @description Endpoint for retrieving a specific session by ID.
|
|
5677
|
+
*
|
|
5678
|
+
* Responses:
|
|
5679
|
+
* - 200: SessionSchema
|
|
5680
|
+
* - 403: permissionDenied
|
|
5681
|
+
* - 404: sessionDoesNotExist
|
|
5682
|
+
* - 500: serverError
|
|
5683
|
+
*
|
|
5684
|
+
* Permission key:
|
|
5685
|
+
* - session: ['view']
|
|
5691
5686
|
*/
|
|
5692
|
-
get: operations["
|
|
5687
|
+
get: operations["pos_session_views_get_session"];
|
|
5693
5688
|
put?: never;
|
|
5694
5689
|
post?: never;
|
|
5695
5690
|
delete?: never;
|
|
@@ -5698,7 +5693,7 @@ export interface paths {
|
|
|
5698
5693
|
patch?: never;
|
|
5699
5694
|
trace?: never;
|
|
5700
5695
|
};
|
|
5701
|
-
"/api/v1/pos/sessions/{id}/
|
|
5696
|
+
"/api/v1/pos/sessions/{id}/x-report/": {
|
|
5702
5697
|
parameters: {
|
|
5703
5698
|
query?: never;
|
|
5704
5699
|
header?: never;
|
|
@@ -5706,22 +5701,13 @@ export interface paths {
|
|
|
5706
5701
|
cookie?: never;
|
|
5707
5702
|
};
|
|
5708
5703
|
/**
|
|
5709
|
-
* Get
|
|
5710
|
-
* @description
|
|
5711
|
-
*
|
|
5712
|
-
*
|
|
5713
|
-
*
|
|
5714
|
-
* - 400:
|
|
5715
|
-
* - invalidFilterFormat
|
|
5716
|
-
* - paginationError
|
|
5717
|
-
* - 403:
|
|
5718
|
-
* - permissionDenied
|
|
5719
|
-
* - 404:
|
|
5720
|
-
* - sessionDoesNotExist
|
|
5721
|
-
* - 500:
|
|
5722
|
-
* - internalServerError
|
|
5704
|
+
* Get Session X Report
|
|
5705
|
+
* @description Get X-Report data for a specific session
|
|
5706
|
+
*
|
|
5707
|
+
* Permission key:
|
|
5708
|
+
* - x_report: ['view']
|
|
5723
5709
|
*/
|
|
5724
|
-
get: operations["
|
|
5710
|
+
get: operations["pos_session_views_get_session_x_report"];
|
|
5725
5711
|
put?: never;
|
|
5726
5712
|
post?: never;
|
|
5727
5713
|
delete?: never;
|
|
@@ -5730,7 +5716,7 @@ export interface paths {
|
|
|
5730
5716
|
patch?: never;
|
|
5731
5717
|
trace?: never;
|
|
5732
5718
|
};
|
|
5733
|
-
"/api/v1/pos/sessions/
|
|
5719
|
+
"/api/v1/pos/sessions/z-report/": {
|
|
5734
5720
|
parameters: {
|
|
5735
5721
|
query?: never;
|
|
5736
5722
|
header?: never;
|
|
@@ -5738,22 +5724,21 @@ export interface paths {
|
|
|
5738
5724
|
cookie?: never;
|
|
5739
5725
|
};
|
|
5740
5726
|
/**
|
|
5741
|
-
* Get
|
|
5742
|
-
* @description
|
|
5743
|
-
*
|
|
5744
|
-
*
|
|
5745
|
-
*
|
|
5746
|
-
* -
|
|
5747
|
-
*
|
|
5748
|
-
*
|
|
5749
|
-
* -
|
|
5750
|
-
*
|
|
5751
|
-
*
|
|
5752
|
-
*
|
|
5753
|
-
* -
|
|
5754
|
-
* - internalServerError
|
|
5727
|
+
* Get Session Z Report
|
|
5728
|
+
* @description Get Z-Report data for multiple sessions.
|
|
5729
|
+
* Can be filtered by either date range or specific session IDs.
|
|
5730
|
+
*
|
|
5731
|
+
* **Responses:**
|
|
5732
|
+
* - 200: Z-Report data
|
|
5733
|
+
* - 400: - invalidParameters
|
|
5734
|
+
* - 403: - permissionDenied
|
|
5735
|
+
* - 404: - sessionDoesNotExist
|
|
5736
|
+
* - 500: - serverError
|
|
5737
|
+
*
|
|
5738
|
+
* Permission key:
|
|
5739
|
+
* - z_report: ['view']
|
|
5755
5740
|
*/
|
|
5756
|
-
get: operations["
|
|
5741
|
+
get: operations["pos_session_views_get_session_z_report"];
|
|
5757
5742
|
put?: never;
|
|
5758
5743
|
post?: never;
|
|
5759
5744
|
delete?: never;
|
|
@@ -5762,7 +5747,7 @@ export interface paths {
|
|
|
5762
5747
|
patch?: never;
|
|
5763
5748
|
trace?: never;
|
|
5764
5749
|
};
|
|
5765
|
-
"/api/v1/pos/
|
|
5750
|
+
"/api/v1/pos/invoices": {
|
|
5766
5751
|
parameters: {
|
|
5767
5752
|
query?: never;
|
|
5768
5753
|
header?: never;
|
|
@@ -5770,22 +5755,24 @@ export interface paths {
|
|
|
5770
5755
|
cookie?: never;
|
|
5771
5756
|
};
|
|
5772
5757
|
/**
|
|
5773
|
-
*
|
|
5774
|
-
* @description
|
|
5775
|
-
*
|
|
5776
|
-
*
|
|
5777
|
-
*
|
|
5778
|
-
* -
|
|
5758
|
+
* List Invoices
|
|
5759
|
+
* @description Endpoint for listing invoices with search, date range filter, and pagination.
|
|
5760
|
+
*
|
|
5761
|
+
* Query Parameters:
|
|
5762
|
+
* - `start_date`: Start date for filtering (YYYY-MM-DD)
|
|
5763
|
+
* - `end_date`: End date for filtering (YYYY-MM-DD)
|
|
5764
|
+
* - `search`: Search invoices by type, barcode, or customer details
|
|
5765
|
+
* - `page`: Page number
|
|
5766
|
+
* - `pageSize`: Number of invoices per page
|
|
5767
|
+
*
|
|
5768
|
+
* Responses:
|
|
5769
|
+
* - 200: CustomerListSchema
|
|
5770
|
+
* - 400: paginationError
|
|
5779
5771
|
* - invalidFilterFormat
|
|
5780
|
-
*
|
|
5781
|
-
* -
|
|
5782
|
-
* - permissionDenied
|
|
5783
|
-
* - 404:
|
|
5784
|
-
* - sessionDoesNotExist
|
|
5785
|
-
* - 500:
|
|
5786
|
-
* - internalServerError
|
|
5772
|
+
* - 403: permissionDenied
|
|
5773
|
+
* - 500: serverError
|
|
5787
5774
|
*/
|
|
5788
|
-
get: operations["
|
|
5775
|
+
get: operations["pos_invoice_views_list_invoices"];
|
|
5789
5776
|
put?: never;
|
|
5790
5777
|
post?: never;
|
|
5791
5778
|
delete?: never;
|
|
@@ -5794,7 +5781,7 @@ export interface paths {
|
|
|
5794
5781
|
patch?: never;
|
|
5795
5782
|
trace?: never;
|
|
5796
5783
|
};
|
|
5797
|
-
"/api/v1/pos/
|
|
5784
|
+
"/api/v1/pos/invoices/{id}/": {
|
|
5798
5785
|
parameters: {
|
|
5799
5786
|
query?: never;
|
|
5800
5787
|
header?: never;
|
|
@@ -5802,19 +5789,24 @@ export interface paths {
|
|
|
5802
5789
|
cookie?: never;
|
|
5803
5790
|
};
|
|
5804
5791
|
/**
|
|
5805
|
-
* Get Invoice
|
|
5806
|
-
* @description
|
|
5807
|
-
*
|
|
5808
|
-
*
|
|
5809
|
-
*
|
|
5810
|
-
*
|
|
5811
|
-
*
|
|
5812
|
-
* 403:
|
|
5813
|
-
* -
|
|
5814
|
-
*
|
|
5815
|
-
*
|
|
5792
|
+
* Get Pos Invoice
|
|
5793
|
+
* @description Endpoint for retrieving a single POS invoice by ID.
|
|
5794
|
+
*
|
|
5795
|
+
* **Request Headers:**
|
|
5796
|
+
*
|
|
5797
|
+
* Responses:
|
|
5798
|
+
* - 200: POSInvoiceSchema
|
|
5799
|
+
* - 403: permissionDenied
|
|
5800
|
+
* - noModuleAccess
|
|
5801
|
+
* - noBranchAccess
|
|
5802
|
+
* - 404: posInvoiceDoesNotExist
|
|
5803
|
+
* - 500: serverError
|
|
5804
|
+
*
|
|
5805
|
+
* **Permissions:**
|
|
5806
|
+
* - No explicit permission key is checked within the function logic itself, but the user must have the `is_cashier` attribute
|
|
5807
|
+
* set to `True` to successfully create a session. This implicitly acts as a role-based permission.
|
|
5816
5808
|
*/
|
|
5817
|
-
get: operations["
|
|
5809
|
+
get: operations["pos_invoice_views_get_pos_invoice"];
|
|
5818
5810
|
put?: never;
|
|
5819
5811
|
post?: never;
|
|
5820
5812
|
delete?: never;
|
|
@@ -5823,7 +5815,7 @@ export interface paths {
|
|
|
5823
5815
|
patch?: never;
|
|
5824
5816
|
trace?: never;
|
|
5825
5817
|
};
|
|
5826
|
-
"/api/v1/pos/
|
|
5818
|
+
"/api/v1/pos/gift-receipts": {
|
|
5827
5819
|
parameters: {
|
|
5828
5820
|
query?: never;
|
|
5829
5821
|
header?: never;
|
|
@@ -5831,19 +5823,29 @@ export interface paths {
|
|
|
5831
5823
|
cookie?: never;
|
|
5832
5824
|
};
|
|
5833
5825
|
/**
|
|
5834
|
-
*
|
|
5835
|
-
* @description
|
|
5836
|
-
*
|
|
5837
|
-
*
|
|
5838
|
-
*
|
|
5839
|
-
*
|
|
5840
|
-
*
|
|
5841
|
-
*
|
|
5842
|
-
*
|
|
5843
|
-
*
|
|
5844
|
-
*
|
|
5826
|
+
* List Gift Receipts
|
|
5827
|
+
* @description Endpoint for listing gift receipts with search, date range filter, and pagination.
|
|
5828
|
+
*
|
|
5829
|
+
* Query Parameters:
|
|
5830
|
+
* - `start_date`: Start date for filtering (YYYY-MM-DD)
|
|
5831
|
+
* - `end_date`: End date for filtering (YYYY-MM-DD)
|
|
5832
|
+
* - `search`: Search gift receipts by barcode, invoice details, or customer phone number, email, or name, item name, item barcode, item category name, item brand name
|
|
5833
|
+
* - `page`: Page number
|
|
5834
|
+
* - `pageSize`: Number of gift receipts per page
|
|
5835
|
+
*
|
|
5836
|
+
* Responses:
|
|
5837
|
+
* - 200: GiftReceiptListSchema
|
|
5838
|
+
* - 400: paginationError
|
|
5839
|
+
* - invalidFilterFormat
|
|
5840
|
+
* - invalidDateFormat
|
|
5841
|
+
* - 403: permissionDenied
|
|
5842
|
+
* - 500: serverError
|
|
5843
|
+
*
|
|
5844
|
+
* **Permissions:**
|
|
5845
|
+
* - No explicit permission key is checked within the function logic itself, but the user must have the `is_cashier`
|
|
5846
|
+
* attribute set to `True` to successfully create a session. This implicitly acts as a role-based permission.
|
|
5845
5847
|
*/
|
|
5846
|
-
get: operations["
|
|
5848
|
+
get: operations["pos_invoice_gift_receipt_views_list_gift_receipts"];
|
|
5847
5849
|
put?: never;
|
|
5848
5850
|
post?: never;
|
|
5849
5851
|
delete?: never;
|
|
@@ -5852,7 +5854,7 @@ export interface paths {
|
|
|
5852
5854
|
patch?: never;
|
|
5853
5855
|
trace?: never;
|
|
5854
5856
|
};
|
|
5855
|
-
"/api/v1/pos/
|
|
5857
|
+
"/api/v1/pos/gift-receipts/{id}/": {
|
|
5856
5858
|
parameters: {
|
|
5857
5859
|
query?: never;
|
|
5858
5860
|
header?: never;
|
|
@@ -5860,19 +5862,21 @@ export interface paths {
|
|
|
5860
5862
|
cookie?: never;
|
|
5861
5863
|
};
|
|
5862
5864
|
/**
|
|
5863
|
-
* Get
|
|
5864
|
-
* @description
|
|
5865
|
-
*
|
|
5866
|
-
*
|
|
5867
|
-
*
|
|
5868
|
-
*
|
|
5869
|
-
* -
|
|
5870
|
-
*
|
|
5871
|
-
*
|
|
5872
|
-
*
|
|
5873
|
-
*
|
|
5865
|
+
* Get Gift Receipt
|
|
5866
|
+
* @description Endpoint for retrieving a single gift receipt by ID.
|
|
5867
|
+
*
|
|
5868
|
+
* Responses:
|
|
5869
|
+
* - 200: GiftReceiptSchema
|
|
5870
|
+
* - 403: permissionDenied
|
|
5871
|
+
* - noBranchAccess
|
|
5872
|
+
* - 404: giftReceiptDoesNotExist
|
|
5873
|
+
* - 500: serverError
|
|
5874
|
+
*
|
|
5875
|
+
* **Permissions:**
|
|
5876
|
+
* - No explicit permission key is checked within the function logic itself, but the user must have the `is_cashier`
|
|
5877
|
+
* attribute set to `True` to successfully create a session. This implicitly acts as a role-based permission.
|
|
5874
5878
|
*/
|
|
5875
|
-
get: operations["
|
|
5879
|
+
get: operations["pos_invoice_gift_receipt_views_get_gift_receipt"];
|
|
5876
5880
|
put?: never;
|
|
5877
5881
|
post?: never;
|
|
5878
5882
|
delete?: never;
|
|
@@ -18624,11 +18628,6 @@ export interface components {
|
|
|
18624
18628
|
* @default []
|
|
18625
18629
|
*/
|
|
18626
18630
|
hr: components["schemas"]["BasePermissionsSchema_Hr"];
|
|
18627
|
-
/**
|
|
18628
|
-
* @description pos actions
|
|
18629
|
-
* @default []
|
|
18630
|
-
*/
|
|
18631
|
-
pos: components["schemas"]["BasePermissionsSchema_Pos"];
|
|
18632
18631
|
/**
|
|
18633
18632
|
* @description project actions
|
|
18634
18633
|
* @default []
|
|
@@ -18651,6 +18650,12 @@ export interface components {
|
|
|
18651
18650
|
* @default []
|
|
18652
18651
|
*/
|
|
18653
18652
|
calendar: Record<string, never>;
|
|
18653
|
+
/**
|
|
18654
|
+
* Pos
|
|
18655
|
+
* @description pos actions
|
|
18656
|
+
* @default []
|
|
18657
|
+
*/
|
|
18658
|
+
pos: Record<string, never>;
|
|
18654
18659
|
/**
|
|
18655
18660
|
* Approval
|
|
18656
18661
|
* @description approval actions
|
|
@@ -18951,20 +18956,6 @@ export interface components {
|
|
|
18951
18956
|
* @enum {string}
|
|
18952
18957
|
*/
|
|
18953
18958
|
BasePermissionsSchema_Inventory_WarehouseEnum: "add" | "change" | "delete" | "view";
|
|
18954
|
-
/** BasePermissionsSchema_Pos */
|
|
18955
|
-
BasePermissionsSchema_Pos: {
|
|
18956
|
-
/**
|
|
18957
|
-
* Session
|
|
18958
|
-
* @description session actions
|
|
18959
|
-
* @default []
|
|
18960
|
-
*/
|
|
18961
|
-
session: components["schemas"]["BasePermissionsSchema_Pos_SessionEnum"][];
|
|
18962
|
-
};
|
|
18963
|
-
/**
|
|
18964
|
-
* BasePermissionsSchema_Pos_SessionEnum
|
|
18965
|
-
* @enum {string}
|
|
18966
|
-
*/
|
|
18967
|
-
BasePermissionsSchema_Pos_SessionEnum: "add" | "change" | "delete" | "view";
|
|
18968
18959
|
/** BasePermissionsSchema_Project */
|
|
18969
18960
|
BasePermissionsSchema_Project: {
|
|
18970
18961
|
/**
|
|
@@ -27109,357 +27100,609 @@ export interface components {
|
|
|
27109
27100
|
/** Usdrate */
|
|
27110
27101
|
usdRate?: number;
|
|
27111
27102
|
};
|
|
27112
|
-
/**
|
|
27113
|
-
|
|
27103
|
+
/**
|
|
27104
|
+
* SessionStatus
|
|
27105
|
+
* @enum {string}
|
|
27106
|
+
*/
|
|
27107
|
+
SessionStatus: "opened" | "closed";
|
|
27108
|
+
/** SessionListSchema */
|
|
27109
|
+
SessionListSchema: {
|
|
27114
27110
|
info: components["schemas"]["PageInfoSchema"];
|
|
27115
27111
|
/** Results */
|
|
27116
27112
|
results: components["schemas"]["SessionSchema"][];
|
|
27117
27113
|
};
|
|
27118
27114
|
/** SessionSchema */
|
|
27119
27115
|
SessionSchema: {
|
|
27116
|
+
/**
|
|
27117
|
+
* Datecreated
|
|
27118
|
+
* Format: date-time
|
|
27119
|
+
*/
|
|
27120
|
+
dateCreated: string;
|
|
27121
|
+
/** Datemodified */
|
|
27122
|
+
dateModified: string | null;
|
|
27123
|
+
createdBy: components["schemas"]["RecordUserSchema"];
|
|
27124
|
+
modifiedBy: components["schemas"]["RecordUserSchema"] | null;
|
|
27120
27125
|
/**
|
|
27121
27126
|
* Id
|
|
27122
27127
|
* Format: uuid
|
|
27123
27128
|
*/
|
|
27124
27129
|
id: string;
|
|
27125
|
-
|
|
27130
|
+
/** Name */
|
|
27131
|
+
name: string;
|
|
27132
|
+
user: components["schemas"]["UserSummaryInfo"];
|
|
27126
27133
|
/**
|
|
27127
27134
|
* Startdate
|
|
27128
27135
|
* Format: date-time
|
|
27129
27136
|
*/
|
|
27130
27137
|
startDate: string;
|
|
27131
27138
|
/** Enddate */
|
|
27132
|
-
endDate
|
|
27139
|
+
endDate?: string | null;
|
|
27140
|
+
/** Primaryopeningbalance */
|
|
27141
|
+
primaryOpeningBalance: number;
|
|
27142
|
+
/** Secondaryopeningbalance */
|
|
27143
|
+
secondaryOpeningBalance: number | null;
|
|
27144
|
+
/** Primaryclosingbalance */
|
|
27145
|
+
primaryClosingBalance: number | null;
|
|
27146
|
+
/** Secondaryclosingbalance */
|
|
27147
|
+
secondaryClosingBalance: number | null;
|
|
27133
27148
|
/** Posted */
|
|
27134
|
-
posted: boolean
|
|
27135
|
-
|
|
27136
|
-
|
|
27137
|
-
|
|
27138
|
-
|
|
27139
|
-
};
|
|
27140
|
-
/** UserInfo */
|
|
27141
|
-
UserInfo: {
|
|
27149
|
+
posted: boolean;
|
|
27150
|
+
status: components["schemas"]["SessionStatus"];
|
|
27151
|
+
};
|
|
27152
|
+
/** UserSummaryInfo */
|
|
27153
|
+
UserSummaryInfo: {
|
|
27142
27154
|
/** Id */
|
|
27143
27155
|
id: number;
|
|
27144
27156
|
/** Username */
|
|
27145
27157
|
username: string;
|
|
27146
27158
|
};
|
|
27147
|
-
/**
|
|
27148
|
-
|
|
27149
|
-
/**
|
|
27150
|
-
|
|
27151
|
-
/**
|
|
27152
|
-
|
|
27153
|
-
/**
|
|
27154
|
-
|
|
27155
|
-
/**
|
|
27156
|
-
|
|
27157
|
-
};
|
|
27158
|
-
/**
|
|
27159
|
-
|
|
27160
|
-
/**
|
|
27161
|
-
|
|
27162
|
-
/**
|
|
27163
|
-
|
|
27164
|
-
/**
|
|
27165
|
-
|
|
27166
|
-
/**
|
|
27167
|
-
|
|
27168
|
-
|
|
27169
|
-
|
|
27170
|
-
|
|
27171
|
-
|
|
27172
|
-
|
|
27173
|
-
|
|
27174
|
-
|
|
27175
|
-
|
|
27176
|
-
|
|
27177
|
-
|
|
27178
|
-
|
|
27179
|
-
|
|
27180
|
-
/**
|
|
27181
|
-
|
|
27182
|
-
|
|
27183
|
-
|
|
27184
|
-
|
|
27185
|
-
|
|
27186
|
-
|
|
27187
|
-
|
|
27188
|
-
|
|
27189
|
-
/**
|
|
27190
|
-
|
|
27191
|
-
/**
|
|
27192
|
-
|
|
27193
|
-
/**
|
|
27194
|
-
|
|
27195
|
-
|
|
27196
|
-
|
|
27197
|
-
TotalsSchema: {
|
|
27198
|
-
/** Totalsalesusd */
|
|
27199
|
-
totalSalesUsd: number;
|
|
27200
|
-
/** Totalsalescompany */
|
|
27201
|
-
totalSalesCompany: number;
|
|
27202
|
-
/** Totaldiscountsusd */
|
|
27203
|
-
totalDiscountsUsd: number;
|
|
27204
|
-
/** Totaldiscountscompany */
|
|
27205
|
-
totalDiscountsCompany: number;
|
|
27206
|
-
/** Totalrefundsusd */
|
|
27207
|
-
totalRefundsUsd: number;
|
|
27208
|
-
/** Totalrefundscompany */
|
|
27209
|
-
totalRefundsCompany: number;
|
|
27210
|
-
/** Netsalesusd */
|
|
27211
|
-
netSalesUsd: number;
|
|
27212
|
-
/** Netsalescompany */
|
|
27213
|
-
netSalesCompany: number;
|
|
27159
|
+
/** XReportDiscountsDataSchema */
|
|
27160
|
+
XReportDiscountsDataSchema: {
|
|
27161
|
+
/** Totaldiscounts */
|
|
27162
|
+
totalDiscounts: number;
|
|
27163
|
+
/** Secondarytotaldiscounts */
|
|
27164
|
+
secondaryTotalDiscounts?: number | null;
|
|
27165
|
+
/** Totalinvoices */
|
|
27166
|
+
totalInvoices: number;
|
|
27167
|
+
/** Totalitems */
|
|
27168
|
+
totalItems: number;
|
|
27169
|
+
};
|
|
27170
|
+
/** XReportExchangesDataSchema */
|
|
27171
|
+
XReportExchangesDataSchema: {
|
|
27172
|
+
/** Totalexchanges */
|
|
27173
|
+
totalExchanges: number;
|
|
27174
|
+
/** Secondarytotalexchanges */
|
|
27175
|
+
secondaryTotalExchanges?: number | null;
|
|
27176
|
+
/** Totalinvoices */
|
|
27177
|
+
totalInvoices: number;
|
|
27178
|
+
/** Totalitems */
|
|
27179
|
+
totalItems: number;
|
|
27180
|
+
};
|
|
27181
|
+
/** XReportExpectedCashDataSchema */
|
|
27182
|
+
XReportExpectedCashDataSchema: {
|
|
27183
|
+
/** Expectedcashprimary */
|
|
27184
|
+
expectedCashPrimary: number;
|
|
27185
|
+
/** Expectedcashsecondary */
|
|
27186
|
+
expectedCashSecondary?: number | null;
|
|
27187
|
+
};
|
|
27188
|
+
/** XReportReturnsDataSchema */
|
|
27189
|
+
XReportReturnsDataSchema: {
|
|
27190
|
+
/** Totalreturns */
|
|
27191
|
+
totalReturns: number;
|
|
27192
|
+
/** Secondarytotalreturns */
|
|
27193
|
+
secondaryTotalReturns?: number | null;
|
|
27194
|
+
/** Totalinvoices */
|
|
27195
|
+
totalInvoices: number;
|
|
27196
|
+
/** Totalitems */
|
|
27197
|
+
totalItems: number;
|
|
27198
|
+
};
|
|
27199
|
+
/** XReportSalesDataSchema */
|
|
27200
|
+
XReportSalesDataSchema: {
|
|
27201
|
+
/** Totalsales */
|
|
27202
|
+
totalSales: number;
|
|
27203
|
+
/** Secondarytotalsales */
|
|
27204
|
+
secondaryTotalSales?: number | null;
|
|
27205
|
+
/** Totalinvoices */
|
|
27206
|
+
totalInvoices: number;
|
|
27207
|
+
/** Totalitems */
|
|
27208
|
+
totalItems: number;
|
|
27214
27209
|
};
|
|
27215
27210
|
/** XReportSchema */
|
|
27216
27211
|
XReportSchema: {
|
|
27217
|
-
|
|
27218
|
-
|
|
27219
|
-
|
|
27220
|
-
|
|
27221
|
-
|
|
27222
|
-
|
|
27223
|
-
|
|
27224
|
-
|
|
27212
|
+
summary: components["schemas"]["XReportSummarySchema"];
|
|
27213
|
+
salesData: components["schemas"]["XReportSalesDataSchema"];
|
|
27214
|
+
returnsData: components["schemas"]["XReportReturnsDataSchema"];
|
|
27215
|
+
voidedData: components["schemas"]["XReportVoidedDataSchema"];
|
|
27216
|
+
voidedItemsData: components["schemas"]["XReportVoidedItemsDataSchema"];
|
|
27217
|
+
exchangesData: components["schemas"]["XReportExchangesDataSchema"];
|
|
27218
|
+
voidedExchangesData: components["schemas"]["XReportVoidedExchangesDataSchema"];
|
|
27219
|
+
voidedReturnsData: components["schemas"]["XReportVoidedReturnsDataSchema"];
|
|
27220
|
+
discountsData: components["schemas"]["XReportDiscountsDataSchema"];
|
|
27221
|
+
taxData: components["schemas"]["XReportTaxDataSchema"];
|
|
27222
|
+
expectedCashData: components["schemas"]["XReportExpectedCashDataSchema"];
|
|
27223
|
+
/**
|
|
27224
|
+
* Multicurrencyenabled
|
|
27225
|
+
* @description if enabled, show secondary currency data
|
|
27226
|
+
*/
|
|
27227
|
+
multiCurrencyEnabled: boolean;
|
|
27228
|
+
};
|
|
27229
|
+
/** XReportSummarySchema */
|
|
27230
|
+
XReportSummarySchema: {
|
|
27231
|
+
session?: components["schemas"]["SessionSchema"] | null;
|
|
27232
|
+
/**
|
|
27233
|
+
* Exportdate
|
|
27234
|
+
* Format: date-time
|
|
27235
|
+
*/
|
|
27236
|
+
exportDate: string;
|
|
27237
|
+
};
|
|
27238
|
+
/** XReportTaxDataSchema */
|
|
27239
|
+
XReportTaxDataSchema: {
|
|
27240
|
+
/** Totaltax */
|
|
27241
|
+
totalTax: number;
|
|
27242
|
+
/** Secondarytotaltax */
|
|
27243
|
+
secondaryTotalTax?: number | null;
|
|
27244
|
+
};
|
|
27245
|
+
/** XReportVoidedDataSchema */
|
|
27246
|
+
XReportVoidedDataSchema: {
|
|
27247
|
+
/** Totalvoided */
|
|
27248
|
+
totalVoided: number;
|
|
27249
|
+
/** Secondarytotalvoided */
|
|
27250
|
+
secondaryTotalVoided?: number | null;
|
|
27251
|
+
/** Totalinvoices */
|
|
27252
|
+
totalInvoices: number;
|
|
27253
|
+
/** Totalitems */
|
|
27254
|
+
totalItems: number;
|
|
27255
|
+
};
|
|
27256
|
+
/** XReportVoidedExchangesDataSchema */
|
|
27257
|
+
XReportVoidedExchangesDataSchema: {
|
|
27258
|
+
/** Totalvoided */
|
|
27259
|
+
totalVoided: number;
|
|
27260
|
+
/** Secondarytotalvoided */
|
|
27261
|
+
secondaryTotalVoided?: number | null;
|
|
27262
|
+
/** Totalinvoices */
|
|
27263
|
+
totalInvoices: number;
|
|
27264
|
+
/** Totalitems */
|
|
27265
|
+
totalItems: number;
|
|
27266
|
+
};
|
|
27267
|
+
/** XReportVoidedItemsDataSchema */
|
|
27268
|
+
XReportVoidedItemsDataSchema: {
|
|
27269
|
+
/** Totalvoided */
|
|
27270
|
+
totalVoided: number;
|
|
27271
|
+
/** Secondarytotalvoided */
|
|
27272
|
+
secondaryTotalVoided?: number | null;
|
|
27273
|
+
/** Totalitems */
|
|
27274
|
+
totalItems: number;
|
|
27275
|
+
};
|
|
27276
|
+
/** XReportVoidedReturnsDataSchema */
|
|
27277
|
+
XReportVoidedReturnsDataSchema: {
|
|
27278
|
+
/** Totalvoided */
|
|
27279
|
+
totalVoided: number;
|
|
27280
|
+
/** Secondarytotalvoided */
|
|
27281
|
+
secondaryTotalVoided?: number | null;
|
|
27282
|
+
/** Totalinvoices */
|
|
27283
|
+
totalInvoices: number;
|
|
27284
|
+
/** Totalitems */
|
|
27285
|
+
totalItems: number;
|
|
27286
|
+
};
|
|
27287
|
+
/** BreakdownItemSchema */
|
|
27288
|
+
BreakdownItemSchema: {
|
|
27289
|
+
/** Name */
|
|
27290
|
+
name: string;
|
|
27291
|
+
/** Amount */
|
|
27292
|
+
amount: number;
|
|
27293
|
+
/** Secondaryamount */
|
|
27294
|
+
secondaryAmount?: number | null;
|
|
27295
|
+
/** Itemcount */
|
|
27296
|
+
itemCount: number;
|
|
27225
27297
|
};
|
|
27226
|
-
/**
|
|
27227
|
-
|
|
27298
|
+
/** CurrencySummarySchema */
|
|
27299
|
+
CurrencySummarySchema: {
|
|
27228
27300
|
/** Id */
|
|
27229
27301
|
id: number;
|
|
27230
|
-
/**
|
|
27231
|
-
|
|
27232
|
-
/**
|
|
27233
|
-
|
|
27234
|
-
/** Company */
|
|
27235
|
-
company?: string | null;
|
|
27236
|
-
/** Phone1 */
|
|
27237
|
-
phone1?: string | null;
|
|
27238
|
-
/** Phone2 */
|
|
27239
|
-
phone2?: string | null;
|
|
27302
|
+
/** Code */
|
|
27303
|
+
code: string;
|
|
27304
|
+
/** Name */
|
|
27305
|
+
name: string;
|
|
27240
27306
|
};
|
|
27241
|
-
/**
|
|
27242
|
-
|
|
27243
|
-
/**
|
|
27244
|
-
|
|
27245
|
-
|
|
27246
|
-
|
|
27247
|
-
|
|
27248
|
-
|
|
27249
|
-
|
|
27250
|
-
|
|
27251
|
-
|
|
27252
|
-
|
|
27253
|
-
|
|
27254
|
-
|
|
27255
|
-
|
|
27256
|
-
|
|
27257
|
-
|
|
27258
|
-
|
|
27259
|
-
|
|
27260
|
-
|
|
27261
|
-
|
|
27262
|
-
|
|
27263
|
-
|
|
27264
|
-
|
|
27265
|
-
|
|
27266
|
-
|
|
27267
|
-
/**
|
|
27268
|
-
|
|
27269
|
-
|
|
27307
|
+
/** TaxBreakdownItemSchema */
|
|
27308
|
+
TaxBreakdownItemSchema: {
|
|
27309
|
+
/** Name */
|
|
27310
|
+
name: string;
|
|
27311
|
+
/** Rate */
|
|
27312
|
+
rate: number;
|
|
27313
|
+
/** Amount */
|
|
27314
|
+
amount: number;
|
|
27315
|
+
/** Secondaryamount */
|
|
27316
|
+
secondaryAmount?: number | null;
|
|
27317
|
+
};
|
|
27318
|
+
/** ZReportDateRangeSchema */
|
|
27319
|
+
ZReportDateRangeSchema: {
|
|
27320
|
+
/** Startdate */
|
|
27321
|
+
startDate?: string | null;
|
|
27322
|
+
/** Enddate */
|
|
27323
|
+
endDate?: string | null;
|
|
27324
|
+
};
|
|
27325
|
+
/** ZReportDiscountsDataSchema */
|
|
27326
|
+
ZReportDiscountsDataSchema: {
|
|
27327
|
+
/** Totaldiscounts */
|
|
27328
|
+
totalDiscounts: number;
|
|
27329
|
+
/** Secondarytotaldiscounts */
|
|
27330
|
+
secondaryTotalDiscounts?: number | null;
|
|
27331
|
+
/** Totalinvoices */
|
|
27332
|
+
totalInvoices: number;
|
|
27333
|
+
/** Totalitems */
|
|
27334
|
+
totalItems: number;
|
|
27335
|
+
/** Groupeddata */
|
|
27336
|
+
groupedData: components["schemas"]["BreakdownItemSchema"][];
|
|
27337
|
+
};
|
|
27338
|
+
/** ZReportExchangesDataSchema */
|
|
27339
|
+
ZReportExchangesDataSchema: {
|
|
27340
|
+
/** Totalexchanges */
|
|
27341
|
+
totalExchanges: number;
|
|
27342
|
+
/** Secondarytotalexchanges */
|
|
27343
|
+
secondaryTotalExchanges?: number | null;
|
|
27344
|
+
/** Totalinvoices */
|
|
27345
|
+
totalInvoices: number;
|
|
27346
|
+
/** Totalitems */
|
|
27347
|
+
totalItems: number;
|
|
27348
|
+
/** Groupeddata */
|
|
27349
|
+
groupedData: components["schemas"]["BreakdownItemSchema"][];
|
|
27350
|
+
};
|
|
27351
|
+
/** ZReportExpectedCashDataSchema */
|
|
27352
|
+
ZReportExpectedCashDataSchema: {
|
|
27353
|
+
/** Expectedcashprimary */
|
|
27354
|
+
expectedCashPrimary: number;
|
|
27355
|
+
/** Expectedcashsecondary */
|
|
27356
|
+
expectedCashSecondary?: number | null;
|
|
27357
|
+
/** Totalopeningbalanceprimary */
|
|
27358
|
+
totalOpeningBalancePrimary: number;
|
|
27359
|
+
/** Totalopeningbalancesecondary */
|
|
27360
|
+
totalOpeningBalanceSecondary?: number | null;
|
|
27361
|
+
/** Totalclosingbalanceprimary */
|
|
27362
|
+
totalClosingBalancePrimary: number;
|
|
27363
|
+
/** Totalclosingbalancesecondary */
|
|
27364
|
+
totalClosingBalanceSecondary?: number | null;
|
|
27365
|
+
};
|
|
27366
|
+
/** ZReportReturnsDataSchema */
|
|
27367
|
+
ZReportReturnsDataSchema: {
|
|
27368
|
+
/** Totalreturns */
|
|
27369
|
+
totalReturns: number;
|
|
27370
|
+
/** Secondarytotalreturns */
|
|
27371
|
+
secondaryTotalReturns?: number | null;
|
|
27372
|
+
/** Totalinvoices */
|
|
27373
|
+
totalInvoices: number;
|
|
27374
|
+
/** Totalitems */
|
|
27375
|
+
totalItems: number;
|
|
27376
|
+
/** Groupeddata */
|
|
27377
|
+
groupedData: components["schemas"]["BreakdownItemSchema"][];
|
|
27378
|
+
};
|
|
27379
|
+
/** ZReportSalesDataSchema */
|
|
27380
|
+
ZReportSalesDataSchema: {
|
|
27381
|
+
/** Totalsales */
|
|
27382
|
+
totalSales: number;
|
|
27383
|
+
/** Secondarytotalsales */
|
|
27384
|
+
secondaryTotalSales?: number | null;
|
|
27385
|
+
/** Totalinvoices */
|
|
27386
|
+
totalInvoices: number;
|
|
27387
|
+
/** Totalitems */
|
|
27388
|
+
totalItems: number;
|
|
27389
|
+
/** Groupeddata */
|
|
27390
|
+
groupedData: components["schemas"]["BreakdownItemSchema"][];
|
|
27391
|
+
};
|
|
27392
|
+
/** ZReportSchema */
|
|
27393
|
+
ZReportSchema: {
|
|
27394
|
+
summary: components["schemas"]["ZReportSummarySchema"];
|
|
27395
|
+
salesData: components["schemas"]["ZReportSalesDataSchema"];
|
|
27396
|
+
returnsData: components["schemas"]["ZReportReturnsDataSchema"];
|
|
27397
|
+
exchangesData: components["schemas"]["ZReportExchangesDataSchema"];
|
|
27398
|
+
voidedData: components["schemas"]["ZReportVoidedDataSchema"];
|
|
27399
|
+
voidedExchangeData: components["schemas"]["ZReportVoidedExchangesDataSchema"];
|
|
27400
|
+
voidedReturnData: components["schemas"]["ZReportVoidedReturnsDataSchema"];
|
|
27401
|
+
voidedItemsData: components["schemas"]["ZReportVoidedItemsDataSchema"];
|
|
27402
|
+
discountsData: components["schemas"]["ZReportDiscountsDataSchema"];
|
|
27403
|
+
taxData: components["schemas"]["ZReportTaxDataSchema"];
|
|
27404
|
+
expectedCashData: components["schemas"]["ZReportExpectedCashDataSchema"];
|
|
27405
|
+
/** Multicurrencyenabled */
|
|
27406
|
+
multiCurrencyEnabled: boolean;
|
|
27407
|
+
/** Reportgroupby */
|
|
27408
|
+
reportGroupBy: string;
|
|
27409
|
+
primaryCurrency: components["schemas"]["CurrencySummarySchema"];
|
|
27410
|
+
secondaryCurrency?: components["schemas"]["CurrencySummarySchema"] | null;
|
|
27411
|
+
};
|
|
27412
|
+
/** ZReportSummarySchema */
|
|
27413
|
+
ZReportSummarySchema: {
|
|
27414
|
+
/** Sessioncount */
|
|
27415
|
+
sessionCount: number;
|
|
27416
|
+
/**
|
|
27417
|
+
* Exportdate
|
|
27418
|
+
* Format: date-time
|
|
27270
27419
|
*/
|
|
27271
|
-
|
|
27420
|
+
exportDate: string;
|
|
27421
|
+
dateRange?: components["schemas"]["ZReportDateRangeSchema"] | null;
|
|
27422
|
+
/** Sessions */
|
|
27423
|
+
sessions?: string[] | null;
|
|
27424
|
+
};
|
|
27425
|
+
/** ZReportTaxDataSchema */
|
|
27426
|
+
ZReportTaxDataSchema: {
|
|
27427
|
+
/** Totaltax */
|
|
27428
|
+
totalTax: number;
|
|
27429
|
+
/** Secondarytotaltax */
|
|
27430
|
+
secondaryTotalTax?: number | null;
|
|
27431
|
+
/** Groupeddata */
|
|
27432
|
+
groupedData: components["schemas"]["TaxBreakdownItemSchema"][];
|
|
27433
|
+
};
|
|
27434
|
+
/** ZReportVoidedDataSchema */
|
|
27435
|
+
ZReportVoidedDataSchema: {
|
|
27436
|
+
/** Totalvoided */
|
|
27437
|
+
totalVoided: number;
|
|
27438
|
+
/** Secondarytotalvoided */
|
|
27439
|
+
secondaryTotalVoided?: number | null;
|
|
27440
|
+
/** Totalinvoices */
|
|
27441
|
+
totalInvoices: number;
|
|
27442
|
+
/** Totalitems */
|
|
27443
|
+
totalItems: number;
|
|
27444
|
+
/** Groupeddata */
|
|
27445
|
+
groupedData: components["schemas"]["BreakdownItemSchema"][];
|
|
27446
|
+
};
|
|
27447
|
+
/** ZReportVoidedExchangesDataSchema */
|
|
27448
|
+
ZReportVoidedExchangesDataSchema: {
|
|
27449
|
+
/** Totalvoided */
|
|
27450
|
+
totalVoided: number;
|
|
27451
|
+
/** Secondarytotalvoided */
|
|
27452
|
+
secondaryTotalVoided?: number | null;
|
|
27453
|
+
/** Totalinvoices */
|
|
27454
|
+
totalInvoices: number;
|
|
27455
|
+
/** Totalitems */
|
|
27456
|
+
totalItems: number;
|
|
27457
|
+
/** Groupeddata */
|
|
27458
|
+
groupedData: components["schemas"]["BreakdownItemSchema"][];
|
|
27459
|
+
};
|
|
27460
|
+
/** ZReportVoidedItemsDataSchema */
|
|
27461
|
+
ZReportVoidedItemsDataSchema: {
|
|
27462
|
+
/** Totalvoided */
|
|
27463
|
+
totalVoided: number;
|
|
27464
|
+
/** Secondarytotalvoided */
|
|
27465
|
+
secondaryTotalVoided?: number | null;
|
|
27466
|
+
/** Totalitems */
|
|
27467
|
+
totalItems: number;
|
|
27468
|
+
/** Groupeddata */
|
|
27469
|
+
groupedData: components["schemas"]["BreakdownItemSchema"][];
|
|
27470
|
+
};
|
|
27471
|
+
/** ZReportVoidedReturnsDataSchema */
|
|
27472
|
+
ZReportVoidedReturnsDataSchema: {
|
|
27473
|
+
/** Totalvoided */
|
|
27474
|
+
totalVoided: number;
|
|
27475
|
+
/** Secondarytotalvoided */
|
|
27476
|
+
secondaryTotalVoided?: number | null;
|
|
27477
|
+
/** Totalinvoices */
|
|
27478
|
+
totalInvoices: number;
|
|
27479
|
+
/** Totalitems */
|
|
27480
|
+
totalItems: number;
|
|
27481
|
+
/** Groupeddata */
|
|
27482
|
+
groupedData: components["schemas"]["BreakdownItemSchema"][];
|
|
27483
|
+
};
|
|
27484
|
+
/**
|
|
27485
|
+
* InvoiceStatus
|
|
27486
|
+
* @enum {string}
|
|
27487
|
+
*/
|
|
27488
|
+
InvoiceStatus: "in_progress" | "on_hold" | "voided" | "completed";
|
|
27489
|
+
/** CustomerSharedSchema */
|
|
27490
|
+
CustomerSharedSchema: {
|
|
27491
|
+
/** Id */
|
|
27492
|
+
id: number;
|
|
27493
|
+
/** Name */
|
|
27494
|
+
name: string;
|
|
27495
|
+
/** Accountnumber */
|
|
27496
|
+
accountNumber: string;
|
|
27497
|
+
/** Phone */
|
|
27498
|
+
phone?: string | null;
|
|
27499
|
+
type: components["schemas"]["TypeOfCustomerValue"];
|
|
27500
|
+
currency: components["schemas"]["CurrencySummaryInfo"] | null;
|
|
27272
27501
|
/**
|
|
27273
|
-
*
|
|
27274
|
-
* @
|
|
27502
|
+
* Currencies
|
|
27503
|
+
* @default []
|
|
27275
27504
|
*/
|
|
27276
|
-
|
|
27505
|
+
currencies: components["schemas"]["CurrencySummaryInfo"][];
|
|
27506
|
+
};
|
|
27507
|
+
/** GiftReceiptItemSummarySchema */
|
|
27508
|
+
GiftReceiptItemSummarySchema: {
|
|
27277
27509
|
/**
|
|
27278
|
-
*
|
|
27279
|
-
*
|
|
27510
|
+
* Id
|
|
27511
|
+
* Format: uuid
|
|
27280
27512
|
*/
|
|
27281
|
-
|
|
27513
|
+
id: string;
|
|
27514
|
+
/** Quantity */
|
|
27515
|
+
quantity: number;
|
|
27516
|
+
};
|
|
27517
|
+
/** GiftReceiptSummarySchema */
|
|
27518
|
+
GiftReceiptSummarySchema: {
|
|
27282
27519
|
/**
|
|
27283
|
-
*
|
|
27284
|
-
*
|
|
27520
|
+
* Id
|
|
27521
|
+
* Format: uuid
|
|
27285
27522
|
*/
|
|
27286
|
-
|
|
27523
|
+
id: string;
|
|
27524
|
+
/** Receiptnumber */
|
|
27525
|
+
receiptNumber: string;
|
|
27287
27526
|
/**
|
|
27288
|
-
*
|
|
27289
|
-
*
|
|
27527
|
+
* Date
|
|
27528
|
+
* Format: date-time
|
|
27290
27529
|
*/
|
|
27291
|
-
|
|
27530
|
+
date: string;
|
|
27531
|
+
};
|
|
27532
|
+
/**
|
|
27533
|
+
* InvoiceItemStatus
|
|
27534
|
+
* @enum {string}
|
|
27535
|
+
*/
|
|
27536
|
+
InvoiceItemStatus: "purchased" | "returned" | "voided" | "exchanged";
|
|
27537
|
+
/** InvoiceListSchema */
|
|
27538
|
+
InvoiceListSchema: {
|
|
27539
|
+
info: components["schemas"]["PageInfoSchema"];
|
|
27540
|
+
/** Results */
|
|
27541
|
+
results: components["schemas"]["POSInvoiceSchema"][];
|
|
27542
|
+
};
|
|
27543
|
+
/**
|
|
27544
|
+
* InvoiceType
|
|
27545
|
+
* @enum {string}
|
|
27546
|
+
*/
|
|
27547
|
+
InvoiceType: "default" | "exchange" | "return";
|
|
27548
|
+
/** ItemInvoiceSummarySchema */
|
|
27549
|
+
ItemInvoiceSummarySchema: {
|
|
27292
27550
|
/**
|
|
27293
|
-
*
|
|
27294
|
-
*
|
|
27551
|
+
* Id
|
|
27552
|
+
* Format: uuid
|
|
27295
27553
|
*/
|
|
27296
|
-
|
|
27554
|
+
id: string;
|
|
27555
|
+
item: components["schemas"]["ItemSummaryInfo"];
|
|
27556
|
+
/** @description This field is the package of the item. */
|
|
27557
|
+
itemPackage: components["schemas"]["ItemPackageSummarySchema"] | null;
|
|
27297
27558
|
/**
|
|
27298
|
-
*
|
|
27299
|
-
*
|
|
27559
|
+
* @description
|
|
27560
|
+
* if the item is voided it cant be modified,
|
|
27561
|
+
* if the invoice type is default the item status is purchased or voided,
|
|
27562
|
+
* if the invoice type is exchange the item status is purchased, returned or voided,
|
|
27563
|
+
*
|
|
27564
|
+
* @default purchased
|
|
27300
27565
|
*/
|
|
27301
|
-
|
|
27566
|
+
status: components["schemas"]["InvoiceItemStatus"];
|
|
27567
|
+
/** Quantity */
|
|
27568
|
+
quantity: number;
|
|
27302
27569
|
/**
|
|
27303
|
-
*
|
|
27304
|
-
* @
|
|
27570
|
+
* Unitprice
|
|
27571
|
+
* @description This field is a number representing the unit price of the item.
|
|
27305
27572
|
*/
|
|
27306
|
-
|
|
27573
|
+
unitPrice: string;
|
|
27307
27574
|
/**
|
|
27308
|
-
*
|
|
27309
|
-
* @
|
|
27575
|
+
* Primarysubtotal
|
|
27576
|
+
* @description This field is a number representing the primary subtotal of the invoice.
|
|
27310
27577
|
*/
|
|
27311
|
-
|
|
27578
|
+
primarySubtotal: string;
|
|
27312
27579
|
/**
|
|
27313
|
-
*
|
|
27314
|
-
* @
|
|
27580
|
+
* Secondarysubtotal
|
|
27581
|
+
* @description
|
|
27582
|
+
* This field is a number representing the secondary subtotal of the invoice.
|
|
27583
|
+
* This field is visible only if multicurrency is enabled.
|
|
27584
|
+
*
|
|
27315
27585
|
*/
|
|
27316
|
-
|
|
27586
|
+
secondarySubtotal: string | null;
|
|
27317
27587
|
/**
|
|
27318
|
-
*
|
|
27319
|
-
* @
|
|
27588
|
+
* Discount
|
|
27589
|
+
* @default 0
|
|
27320
27590
|
*/
|
|
27321
|
-
|
|
27591
|
+
discount: number;
|
|
27322
27592
|
/**
|
|
27323
|
-
*
|
|
27324
|
-
* @
|
|
27593
|
+
* Primarytotal
|
|
27594
|
+
* @description This field is a number representing the primary total of the item.
|
|
27325
27595
|
*/
|
|
27326
|
-
|
|
27596
|
+
primaryTotal: string;
|
|
27327
27597
|
/**
|
|
27328
|
-
*
|
|
27329
|
-
* @
|
|
27598
|
+
* Secondarytotal
|
|
27599
|
+
* @description
|
|
27600
|
+
* This field is a number representing the secondary total of the item.
|
|
27601
|
+
* This field is visible only if multicurrency is enabled.
|
|
27602
|
+
*
|
|
27330
27603
|
*/
|
|
27331
|
-
|
|
27604
|
+
secondaryTotal: string | null;
|
|
27332
27605
|
/**
|
|
27333
|
-
*
|
|
27334
|
-
* @
|
|
27335
|
-
* @example 1
|
|
27606
|
+
* Remainingquantity
|
|
27607
|
+
* @description This field is a number representing the remaining quantity of the item.
|
|
27336
27608
|
*/
|
|
27337
|
-
|
|
27609
|
+
remainingQuantity: number;
|
|
27338
27610
|
/**
|
|
27339
|
-
*
|
|
27340
|
-
* @
|
|
27341
|
-
* @
|
|
27611
|
+
* Promotionsandoffers
|
|
27612
|
+
* @description A list of promotions and offers applied to the sales invoice.
|
|
27613
|
+
* @default []
|
|
27342
27614
|
*/
|
|
27343
|
-
|
|
27344
|
-
};
|
|
27345
|
-
/** ListInvoiceSchema */
|
|
27346
|
-
ListInvoiceSchema: {
|
|
27347
|
-
info: components["schemas"]["PageInfoSchema"];
|
|
27348
|
-
/** Results */
|
|
27349
|
-
results: components["schemas"]["InvoiceSchema"][];
|
|
27615
|
+
promotionsAndOffers: components["schemas"]["PromotionsAndOffersSharedSchema"][];
|
|
27350
27616
|
};
|
|
27351
|
-
/**
|
|
27352
|
-
|
|
27353
|
-
|
|
27354
|
-
|
|
27355
|
-
|
|
27617
|
+
/** ItemSummaryInfo */
|
|
27618
|
+
ItemSummaryInfo: {
|
|
27619
|
+
/** Id */
|
|
27620
|
+
id: number;
|
|
27621
|
+
/** Name */
|
|
27622
|
+
name: string;
|
|
27356
27623
|
};
|
|
27357
|
-
/**
|
|
27358
|
-
|
|
27624
|
+
/** POSInvoiceItemSchema */
|
|
27625
|
+
POSInvoiceItemSchema: {
|
|
27359
27626
|
/**
|
|
27360
27627
|
* Id
|
|
27361
27628
|
* Format: uuid
|
|
27362
27629
|
*/
|
|
27363
27630
|
id: string;
|
|
27364
|
-
|
|
27365
|
-
|
|
27366
|
-
|
|
27367
|
-
currency: components["schemas"]["CurrencyList"];
|
|
27368
|
-
/**
|
|
27369
|
-
* Status
|
|
27370
|
-
* @example in_progress
|
|
27371
|
-
*/
|
|
27372
|
-
status: string;
|
|
27373
|
-
/**
|
|
27374
|
-
* Barcode
|
|
27375
|
-
* @example 123456789
|
|
27376
|
-
*/
|
|
27377
|
-
barcode: number;
|
|
27378
|
-
/**
|
|
27379
|
-
* Companysubtotal
|
|
27380
|
-
* @example 1
|
|
27381
|
-
*/
|
|
27382
|
-
companySubTotal: number;
|
|
27383
|
-
/**
|
|
27384
|
-
* Companyitemsdiscountamount
|
|
27385
|
-
* @example 1
|
|
27386
|
-
*/
|
|
27387
|
-
companyItemsDiscountAmount: number;
|
|
27388
|
-
/**
|
|
27389
|
-
* Companytotaldiscountamount
|
|
27390
|
-
* @example 1
|
|
27391
|
-
*/
|
|
27392
|
-
companyTotalDiscountAmount: number;
|
|
27393
|
-
/**
|
|
27394
|
-
* Usdtotaldiscountamount
|
|
27395
|
-
* @example 1
|
|
27396
|
-
*/
|
|
27397
|
-
usdTotalDiscountAmount: number;
|
|
27398
|
-
/**
|
|
27399
|
-
* Companynetitemstotal
|
|
27400
|
-
* @example 1
|
|
27401
|
-
*/
|
|
27402
|
-
companyNetItemsTotal: number;
|
|
27403
|
-
/**
|
|
27404
|
-
* Totalcompany
|
|
27405
|
-
* @example 1
|
|
27406
|
-
*/
|
|
27407
|
-
totalCompany: number;
|
|
27631
|
+
item: components["schemas"]["ItemSummaryInfo"];
|
|
27632
|
+
/** @description This field is the package of the item. */
|
|
27633
|
+
itemPackage: components["schemas"]["ItemPackageSummarySchema"] | null;
|
|
27408
27634
|
/**
|
|
27409
|
-
*
|
|
27410
|
-
*
|
|
27635
|
+
* @description
|
|
27636
|
+
* if the item is voided it cant be modified,
|
|
27637
|
+
* if the invoice type is default the item status is purchased or voided,
|
|
27638
|
+
* if the invoice type is exchange the item status is purchased, returned or voided,
|
|
27639
|
+
*
|
|
27640
|
+
* @default purchased
|
|
27411
27641
|
*/
|
|
27412
|
-
|
|
27642
|
+
status: components["schemas"]["InvoiceItemStatus"];
|
|
27643
|
+
relatedInvoiceItem?: components["schemas"]["ItemInvoiceSummarySchema"] | null;
|
|
27644
|
+
giftReceiptItem?: components["schemas"]["GiftReceiptItemSummarySchema"] | null;
|
|
27645
|
+
/** Quantity */
|
|
27646
|
+
quantity: number;
|
|
27413
27647
|
/**
|
|
27414
|
-
*
|
|
27415
|
-
* @
|
|
27648
|
+
* Unitprice
|
|
27649
|
+
* @description This field is a number representing the unit price of the item.
|
|
27416
27650
|
*/
|
|
27417
|
-
|
|
27651
|
+
unitPrice: string;
|
|
27418
27652
|
/**
|
|
27419
|
-
*
|
|
27420
|
-
* @
|
|
27653
|
+
* Primarysubtotal
|
|
27654
|
+
* @description This field is a number representing the primary subtotal of the invoice.
|
|
27421
27655
|
*/
|
|
27422
|
-
|
|
27656
|
+
primarySubtotal: string;
|
|
27423
27657
|
/**
|
|
27424
|
-
*
|
|
27425
|
-
* @
|
|
27658
|
+
* Secondarysubtotal
|
|
27659
|
+
* @description
|
|
27660
|
+
* This field is a number representing the secondary subtotal of the invoice.
|
|
27661
|
+
* This field is visible only if multicurrency is enabled.
|
|
27662
|
+
*
|
|
27426
27663
|
*/
|
|
27427
|
-
|
|
27664
|
+
secondarySubtotal: string | null;
|
|
27428
27665
|
/**
|
|
27429
|
-
*
|
|
27430
|
-
* @
|
|
27666
|
+
* Discount
|
|
27667
|
+
* @default 0
|
|
27431
27668
|
*/
|
|
27432
|
-
|
|
27669
|
+
discount: number;
|
|
27433
27670
|
/**
|
|
27434
|
-
*
|
|
27435
|
-
* @
|
|
27671
|
+
* Primarytotal
|
|
27672
|
+
* @description This field is a number representing the primary total of the item.
|
|
27436
27673
|
*/
|
|
27437
|
-
|
|
27674
|
+
primaryTotal: string;
|
|
27438
27675
|
/**
|
|
27439
|
-
*
|
|
27440
|
-
* @
|
|
27676
|
+
* Secondarytotal
|
|
27677
|
+
* @description
|
|
27678
|
+
* This field is a number representing the secondary total of the item.
|
|
27679
|
+
* This field is visible only if multicurrency is enabled.
|
|
27680
|
+
*
|
|
27441
27681
|
*/
|
|
27442
|
-
|
|
27682
|
+
secondaryTotal: string | null;
|
|
27443
27683
|
/**
|
|
27444
|
-
*
|
|
27445
|
-
* @
|
|
27684
|
+
* Remainingquantity
|
|
27685
|
+
* @description This field is a number representing the remaining quantity of the item.
|
|
27446
27686
|
*/
|
|
27447
|
-
|
|
27687
|
+
remainingQuantity: number;
|
|
27448
27688
|
/**
|
|
27449
|
-
*
|
|
27450
|
-
* @
|
|
27451
|
-
* @
|
|
27689
|
+
* Promotionsandoffers
|
|
27690
|
+
* @description A list of promotions and offers applied to the sales invoice.
|
|
27691
|
+
* @default []
|
|
27452
27692
|
*/
|
|
27453
|
-
|
|
27693
|
+
promotionsAndOffers: components["schemas"]["PromotionsAndOffersSharedSchema"][];
|
|
27694
|
+
};
|
|
27695
|
+
/** POSInvoiceSchema */
|
|
27696
|
+
POSInvoiceSchema: {
|
|
27454
27697
|
/**
|
|
27455
|
-
*
|
|
27456
|
-
*
|
|
27457
|
-
* @example 1
|
|
27698
|
+
* Datecreated
|
|
27699
|
+
* Format: date-time
|
|
27458
27700
|
*/
|
|
27459
|
-
|
|
27460
|
-
|
|
27461
|
-
|
|
27462
|
-
|
|
27701
|
+
dateCreated: string;
|
|
27702
|
+
/** Datemodified */
|
|
27703
|
+
dateModified: string | null;
|
|
27704
|
+
createdBy: components["schemas"]["RecordUserSchema"];
|
|
27705
|
+
modifiedBy: components["schemas"]["RecordUserSchema"] | null;
|
|
27463
27706
|
/**
|
|
27464
27707
|
* Id
|
|
27465
27708
|
* Format: uuid
|
|
@@ -27467,327 +27710,341 @@ export interface components {
|
|
|
27467
27710
|
id: string;
|
|
27468
27711
|
/** Invoicenumber */
|
|
27469
27712
|
invoiceNumber: string;
|
|
27470
|
-
customer: components["schemas"]["CustomerInfo"];
|
|
27471
|
-
currency: components["schemas"]["CurrencyList"];
|
|
27472
|
-
/**
|
|
27473
|
-
* Status
|
|
27474
|
-
* @example in_progress
|
|
27475
|
-
*/
|
|
27476
|
-
status: string;
|
|
27477
|
-
/**
|
|
27478
|
-
* Barcode
|
|
27479
|
-
* @example 123456789
|
|
27480
|
-
*/
|
|
27481
|
-
barcode: number;
|
|
27482
|
-
/**
|
|
27483
|
-
* Companysubtotal
|
|
27484
|
-
* @example 1
|
|
27485
|
-
*/
|
|
27486
|
-
companySubTotal: number;
|
|
27487
|
-
/**
|
|
27488
|
-
* Companyitemsdiscountamount
|
|
27489
|
-
* @example 1
|
|
27490
|
-
*/
|
|
27491
|
-
companyItemsDiscountAmount: number;
|
|
27492
|
-
/**
|
|
27493
|
-
* Companytotaldiscountamount
|
|
27494
|
-
* @example 1
|
|
27495
|
-
*/
|
|
27496
|
-
companyTotalDiscountAmount: number;
|
|
27497
27713
|
/**
|
|
27498
|
-
*
|
|
27499
|
-
*
|
|
27714
|
+
* Date
|
|
27715
|
+
* Format: date-time
|
|
27500
27716
|
*/
|
|
27501
|
-
|
|
27717
|
+
date: string;
|
|
27718
|
+
customer: components["schemas"]["CustomerSharedSchema"];
|
|
27719
|
+
status: components["schemas"]["InvoiceStatus"];
|
|
27720
|
+
/** Barcode */
|
|
27721
|
+
barcode: string;
|
|
27722
|
+
type: components["schemas"]["InvoiceType"];
|
|
27723
|
+
session: components["schemas"]["SessionSummarySchema"];
|
|
27724
|
+
relatedInvoice?: components["schemas"]["PosInvoiceSummarySchema"] | null;
|
|
27725
|
+
giftReceipt?: components["schemas"]["GiftReceiptSummarySchema"] | null;
|
|
27502
27726
|
/**
|
|
27503
|
-
*
|
|
27504
|
-
* @
|
|
27727
|
+
* Primarysubtotal
|
|
27728
|
+
* @description This field is a number representing the primary subtotal of the invoice.
|
|
27505
27729
|
*/
|
|
27506
|
-
|
|
27730
|
+
primarySubtotal: string;
|
|
27507
27731
|
/**
|
|
27508
|
-
*
|
|
27509
|
-
* @
|
|
27732
|
+
* Secondarysubtotal
|
|
27733
|
+
* @description
|
|
27734
|
+
* This field is a number representing the secondary subtotal of the invoice.
|
|
27735
|
+
* This field is visible only if multicurrency is enabled.
|
|
27736
|
+
*
|
|
27510
27737
|
*/
|
|
27511
|
-
|
|
27738
|
+
secondarySubtotal: string | null;
|
|
27512
27739
|
/**
|
|
27513
|
-
*
|
|
27514
|
-
* @
|
|
27740
|
+
* Discount
|
|
27741
|
+
* @default 0
|
|
27515
27742
|
*/
|
|
27516
|
-
|
|
27743
|
+
discount: number | null;
|
|
27517
27744
|
/**
|
|
27518
|
-
*
|
|
27519
|
-
* @
|
|
27745
|
+
* Primarydiscountedtotal
|
|
27746
|
+
* @description This field is a number representing the primary discounted total of the invoice.
|
|
27520
27747
|
*/
|
|
27521
|
-
|
|
27748
|
+
primaryDiscountedTotal: string;
|
|
27522
27749
|
/**
|
|
27523
|
-
*
|
|
27524
|
-
* @
|
|
27750
|
+
* Secondarydiscountedtotal
|
|
27751
|
+
* @description
|
|
27752
|
+
* This field is a number representing the secondary discounted total of the invoice.
|
|
27753
|
+
* This field is visible only if multicurrency is enabled.
|
|
27754
|
+
*
|
|
27525
27755
|
*/
|
|
27526
|
-
|
|
27756
|
+
secondaryDiscountedTotal: string | null;
|
|
27527
27757
|
/**
|
|
27528
|
-
*
|
|
27529
|
-
* @
|
|
27758
|
+
* Primarytaxamount
|
|
27759
|
+
* @description This field is a number representing the primary tax amount of the invoice.
|
|
27530
27760
|
*/
|
|
27531
|
-
|
|
27761
|
+
primaryTaxAmount: string;
|
|
27532
27762
|
/**
|
|
27533
|
-
*
|
|
27534
|
-
* @
|
|
27763
|
+
* Secondarytaxamount
|
|
27764
|
+
* @description
|
|
27765
|
+
* This field is a number representing the secondary tax amount of the invoice.
|
|
27766
|
+
* This field is visible only if multicurrency is enabled.
|
|
27767
|
+
*
|
|
27535
27768
|
*/
|
|
27536
|
-
|
|
27769
|
+
secondaryTaxAmount: string | null;
|
|
27537
27770
|
/**
|
|
27538
|
-
*
|
|
27539
|
-
* @
|
|
27771
|
+
* Primarytotal
|
|
27772
|
+
* @description This field is a number representing the primary total of the invoice.
|
|
27540
27773
|
*/
|
|
27541
|
-
|
|
27774
|
+
primaryTotal: string;
|
|
27542
27775
|
/**
|
|
27543
|
-
*
|
|
27544
|
-
* @
|
|
27776
|
+
* Secondarytotal
|
|
27777
|
+
* @description
|
|
27778
|
+
* This field is a number representing the secondary total of the invoice.
|
|
27779
|
+
* This field is visible only if multicurrency is enabled.
|
|
27780
|
+
*
|
|
27545
27781
|
*/
|
|
27546
|
-
|
|
27782
|
+
secondaryTotal?: string | null;
|
|
27547
27783
|
/**
|
|
27548
|
-
*
|
|
27549
|
-
* @
|
|
27784
|
+
* Promotionsandoffers
|
|
27785
|
+
* @description A list of promotions and offers applied to the sales invoice.
|
|
27786
|
+
* @default []
|
|
27550
27787
|
*/
|
|
27551
|
-
|
|
27788
|
+
promotionsAndOffers: components["schemas"]["PromotionsAndOffersSharedSchema"][];
|
|
27789
|
+
/** Items */
|
|
27790
|
+
items: components["schemas"]["POSInvoiceItemSchema"][];
|
|
27552
27791
|
/**
|
|
27553
|
-
*
|
|
27554
|
-
* @
|
|
27555
|
-
* @example 1
|
|
27792
|
+
* Payments
|
|
27793
|
+
* @description A list of payments applied to the sales invoice.
|
|
27556
27794
|
*/
|
|
27557
|
-
|
|
27795
|
+
payments: components["schemas"]["POSPaymentSchema"][];
|
|
27558
27796
|
/**
|
|
27559
|
-
*
|
|
27560
|
-
* @
|
|
27561
|
-
* @example 1
|
|
27797
|
+
* Refunds
|
|
27798
|
+
* @description A list of refunds applied to the sales invoice.
|
|
27562
27799
|
*/
|
|
27563
|
-
|
|
27564
|
-
/** Invoiceitems */
|
|
27565
|
-
invoiceItems: components["schemas"]["InvoiceItemGetSchema"][];
|
|
27566
|
-
/** Invoicepayments */
|
|
27567
|
-
invoicePayments: components["schemas"]["InvoicePaymentSchema"][];
|
|
27800
|
+
refunds: components["schemas"]["POSRefundSchema"][];
|
|
27568
27801
|
};
|
|
27569
|
-
/**
|
|
27570
|
-
|
|
27571
|
-
|
|
27802
|
+
/**
|
|
27803
|
+
* POSPaymentSchema
|
|
27804
|
+
* @description Schema for payment response after creation or retrieval.
|
|
27805
|
+
*
|
|
27806
|
+
* Includes all payment details and calculated currencies.
|
|
27807
|
+
* Used for API responses when returning payment information.
|
|
27808
|
+
*/
|
|
27809
|
+
POSPaymentSchema: {
|
|
27572
27810
|
/**
|
|
27573
27811
|
* Id
|
|
27574
27812
|
* Format: uuid
|
|
27575
|
-
* @
|
|
27813
|
+
* @description Unique identifier for the payment (UUID format). Used for referencing this payment in the system.
|
|
27576
27814
|
*/
|
|
27577
27815
|
id: string;
|
|
27578
27816
|
/**
|
|
27579
|
-
*
|
|
27580
|
-
* @
|
|
27817
|
+
* Amount
|
|
27818
|
+
* @description Payment amount in the specified currency (should be treated as a number). The actual amount provided by the customer.
|
|
27581
27819
|
*/
|
|
27582
|
-
|
|
27820
|
+
amount: string;
|
|
27821
|
+
/** @description Currency information used for this payment. Contains currency ID, name, code, and other relevant information. If multi-currency is disabled, this will always be the primary currency. If multi-currency is enabled, this can be either primary or secondary currency. */
|
|
27822
|
+
currency: components["schemas"]["CurrencySummaryInfo"];
|
|
27583
27823
|
/**
|
|
27584
|
-
*
|
|
27585
|
-
* @
|
|
27824
|
+
* Rate
|
|
27825
|
+
* @description Exchange rate used for currency conversion (should be treated as a number). Taken from the invoice at the time of payment to ensure consistency. Used to convert between primary and secondary currencies.Only include if multi-currency is enabled
|
|
27586
27826
|
*/
|
|
27587
|
-
|
|
27827
|
+
rate?: string | null;
|
|
27588
27828
|
/**
|
|
27589
|
-
*
|
|
27590
|
-
* @
|
|
27829
|
+
* Primarychangedue
|
|
27830
|
+
* @description Change given in primary currency (should be treated as a number). The amount returned to the customer in the business's primary currency. Primary currency is the company's currency
|
|
27591
27831
|
*/
|
|
27592
|
-
|
|
27832
|
+
primaryChangeDue?: string | null;
|
|
27593
27833
|
/**
|
|
27594
|
-
*
|
|
27595
|
-
* @
|
|
27834
|
+
* Secondarychangedue
|
|
27835
|
+
* @description Change given in secondary currency (should be treated as a number). The amount returned to the customer in the secondary currency if applicable. Secondary currency is the company's currency set as secondary currency in system settings. This will be zero when multi-currency is disabled.
|
|
27596
27836
|
*/
|
|
27597
|
-
|
|
27837
|
+
secondaryChangeDue?: string | null;
|
|
27838
|
+
};
|
|
27839
|
+
/**
|
|
27840
|
+
* POSRefundSchema
|
|
27841
|
+
* @description Schema for refund response after creation or retrieval.
|
|
27842
|
+
*
|
|
27843
|
+
* Includes all refund details and calculated currencies.
|
|
27844
|
+
* Used for API responses when returning refund information.
|
|
27845
|
+
*/
|
|
27846
|
+
POSRefundSchema: {
|
|
27598
27847
|
/**
|
|
27599
|
-
*
|
|
27600
|
-
*
|
|
27848
|
+
* Datecreated
|
|
27849
|
+
* Format: date-time
|
|
27601
27850
|
*/
|
|
27602
|
-
|
|
27851
|
+
dateCreated: string;
|
|
27852
|
+
/** Datemodified */
|
|
27853
|
+
dateModified: string | null;
|
|
27854
|
+
createdBy: components["schemas"]["RecordUserSchema"];
|
|
27855
|
+
modifiedBy: components["schemas"]["RecordUserSchema"] | null;
|
|
27603
27856
|
/**
|
|
27604
|
-
*
|
|
27605
|
-
*
|
|
27857
|
+
* Id
|
|
27858
|
+
* Format: uuid
|
|
27859
|
+
* @description Unique identifier for the refund (UUID format). Used for referencing this refund in the system.
|
|
27606
27860
|
*/
|
|
27607
|
-
|
|
27861
|
+
id: string;
|
|
27608
27862
|
/**
|
|
27609
|
-
*
|
|
27610
|
-
* @
|
|
27863
|
+
* Amount
|
|
27864
|
+
* @description Refund amount in the specified currency (should be treated as a number). The actual amount refunded to the customer.
|
|
27611
27865
|
*/
|
|
27612
|
-
|
|
27866
|
+
amount: string;
|
|
27867
|
+
/** @description Currency information used for this refund. Contains currency ID, name, code, and other relevant information. If multi-currency is disabled, this will always be the primary currency. If multi-currency is enabled, this can be either primary or secondary currency. */
|
|
27868
|
+
currency: components["schemas"]["CurrencySummaryInfo"];
|
|
27613
27869
|
/**
|
|
27614
|
-
*
|
|
27615
|
-
* @
|
|
27870
|
+
* Rate
|
|
27871
|
+
* @description Exchange rate used for currency conversion (should be treated as a number). Taken from the invoice at the time of refund to ensure consistency. Used to convert between primary and secondary currencies.
|
|
27616
27872
|
*/
|
|
27617
|
-
|
|
27873
|
+
rate: string;
|
|
27618
27874
|
/**
|
|
27619
|
-
*
|
|
27620
|
-
* @
|
|
27875
|
+
* Primaryrefunddue
|
|
27876
|
+
* @description Change given in primary currency (should be treated as a number). The amount the customer returns as change in the business's primary currency. Primary currency is the company's default currency set in system settings.
|
|
27621
27877
|
*/
|
|
27622
|
-
|
|
27878
|
+
primaryRefundDue: string;
|
|
27623
27879
|
/**
|
|
27624
|
-
*
|
|
27625
|
-
* @
|
|
27880
|
+
* Secondaryrefunddue
|
|
27881
|
+
* @description Change given in secondary currency (should be treated as a number). The amount the customer returns as change in the secondary currency if applicable. Secondary currency is any currency that is not the company's default currency. This will be zero when multi-currency is disabled.
|
|
27626
27882
|
*/
|
|
27627
|
-
|
|
27883
|
+
secondaryRefundDue: string;
|
|
27884
|
+
};
|
|
27885
|
+
/** PosInvoiceSummarySchema */
|
|
27886
|
+
PosInvoiceSummarySchema: {
|
|
27628
27887
|
/**
|
|
27629
|
-
*
|
|
27630
|
-
*
|
|
27888
|
+
* Id
|
|
27889
|
+
* Format: uuid
|
|
27631
27890
|
*/
|
|
27632
|
-
|
|
27891
|
+
id: string;
|
|
27892
|
+
/** Invoicenumber */
|
|
27893
|
+
invoiceNumber: string;
|
|
27633
27894
|
/**
|
|
27634
|
-
*
|
|
27635
|
-
*
|
|
27895
|
+
* Date
|
|
27896
|
+
* Format: date-time
|
|
27636
27897
|
*/
|
|
27637
|
-
|
|
27898
|
+
date: string;
|
|
27899
|
+
customer: components["schemas"]["CustomerSharedSchema"];
|
|
27900
|
+
};
|
|
27901
|
+
/** PromotionsAndOffersSharedSchema */
|
|
27902
|
+
PromotionsAndOffersSharedSchema: {
|
|
27638
27903
|
/**
|
|
27639
|
-
*
|
|
27640
|
-
*
|
|
27904
|
+
* Id
|
|
27905
|
+
* Format: uuid
|
|
27641
27906
|
*/
|
|
27642
|
-
|
|
27643
|
-
};
|
|
27644
|
-
/** InvoicePaymentSchema */
|
|
27645
|
-
InvoicePaymentSchema: {
|
|
27646
|
-
/** Amount */
|
|
27647
|
-
amount: number;
|
|
27648
|
-
/** Changeduecompany */
|
|
27649
|
-
changeDueCompany: number;
|
|
27650
|
-
/** Changedueusd */
|
|
27651
|
-
changeDueUsd: number;
|
|
27652
|
-
currency: components["schemas"]["CurrencyList"];
|
|
27653
|
-
/** @example cash */
|
|
27654
|
-
paymentMethod: components["schemas"]["PaymentMethodSchema"];
|
|
27655
|
-
};
|
|
27656
|
-
/** Item */
|
|
27657
|
-
Item: {
|
|
27658
|
-
/** Barcode */
|
|
27659
|
-
barcode: string;
|
|
27660
|
-
/** Name */
|
|
27661
|
-
name: string;
|
|
27662
|
-
/** Id */
|
|
27663
|
-
id: number;
|
|
27664
|
-
};
|
|
27665
|
-
/** PaymentMethodSchema */
|
|
27666
|
-
PaymentMethodSchema: {
|
|
27667
|
-
/** Id */
|
|
27668
|
-
id: number;
|
|
27907
|
+
id: string;
|
|
27669
27908
|
/** Name */
|
|
27670
27909
|
name: string;
|
|
27910
|
+
/** Promotiontype */
|
|
27911
|
+
promotionType: string;
|
|
27912
|
+
/** Discountvalue */
|
|
27913
|
+
discountValue: number | null;
|
|
27914
|
+
currency: components["schemas"]["CurrencySummaryInfo"] | null;
|
|
27671
27915
|
};
|
|
27672
|
-
/**
|
|
27673
|
-
|
|
27674
|
-
/** Amount */
|
|
27675
|
-
amount: number;
|
|
27676
|
-
/** Customeradditionalpaymentcompany */
|
|
27677
|
-
customerAdditionalPaymentCompany: number;
|
|
27678
|
-
/** Customeradditionalpaymentusd */
|
|
27679
|
-
customerAdditionalPaymentUsd: number;
|
|
27680
|
-
currency: components["schemas"]["CurrencyList"];
|
|
27681
|
-
/** @example cash */
|
|
27682
|
-
paymentMethod: components["schemas"]["PaymentMethodSchema"];
|
|
27683
|
-
};
|
|
27684
|
-
/** ReturnInvoiceInfoSchema */
|
|
27685
|
-
ReturnInvoiceInfoSchema: {
|
|
27916
|
+
/** SessionSummarySchema */
|
|
27917
|
+
SessionSummarySchema: {
|
|
27686
27918
|
/**
|
|
27687
27919
|
* Id
|
|
27688
27920
|
* Format: uuid
|
|
27689
27921
|
*/
|
|
27690
27922
|
id: string;
|
|
27691
|
-
/** Returnnumber */
|
|
27692
|
-
returnNumber: string;
|
|
27693
|
-
customer: components["schemas"]["CustomerInfo"];
|
|
27694
|
-
currency: components["schemas"]["CurrencyList"];
|
|
27695
|
-
/**
|
|
27696
|
-
* Status
|
|
27697
|
-
* @example in_progress
|
|
27698
|
-
*/
|
|
27699
|
-
status: string;
|
|
27700
27923
|
/**
|
|
27701
|
-
*
|
|
27702
|
-
*
|
|
27703
|
-
*/
|
|
27704
|
-
barcode: number;
|
|
27705
|
-
/**
|
|
27706
|
-
* Companysubtotal
|
|
27707
|
-
* @example 1
|
|
27708
|
-
*/
|
|
27709
|
-
companySubTotal: number;
|
|
27710
|
-
/**
|
|
27711
|
-
* Companyitemsdiscountamount
|
|
27712
|
-
* @example 1
|
|
27713
|
-
*/
|
|
27714
|
-
companyItemsDiscountAmount: number;
|
|
27715
|
-
/**
|
|
27716
|
-
* Companytotaldiscountamount
|
|
27717
|
-
* @example 1
|
|
27718
|
-
*/
|
|
27719
|
-
companyTotalDiscountAmount: number;
|
|
27720
|
-
/**
|
|
27721
|
-
* Usdtotaldiscountamount
|
|
27722
|
-
* @example 1
|
|
27723
|
-
*/
|
|
27724
|
-
usdTotalDiscountAmount: number;
|
|
27725
|
-
/**
|
|
27726
|
-
* Companynetitemstotal
|
|
27727
|
-
* @example 1
|
|
27728
|
-
*/
|
|
27729
|
-
companyNetItemsTotal: number;
|
|
27730
|
-
/**
|
|
27731
|
-
* Totalcompany
|
|
27732
|
-
* @example 1
|
|
27924
|
+
* Startdate
|
|
27925
|
+
* Format: date-time
|
|
27733
27926
|
*/
|
|
27734
|
-
|
|
27927
|
+
startDate: string;
|
|
27928
|
+
/** Enddate */
|
|
27929
|
+
endDate?: string | null;
|
|
27930
|
+
status: components["schemas"]["SessionStatus"];
|
|
27931
|
+
};
|
|
27932
|
+
/** GiftReceiptItemSchema */
|
|
27933
|
+
GiftReceiptItemSchema: {
|
|
27735
27934
|
/**
|
|
27736
|
-
*
|
|
27737
|
-
*
|
|
27935
|
+
* Id
|
|
27936
|
+
* Format: uuid
|
|
27738
27937
|
*/
|
|
27739
|
-
|
|
27938
|
+
id: string;
|
|
27939
|
+
invoiceItem: components["schemas"]["POSInvoiceItemSummarySchema"];
|
|
27940
|
+
/** Quantity */
|
|
27941
|
+
quantity: number;
|
|
27942
|
+
/** Primarysubtotal */
|
|
27943
|
+
primarySubtotal?: string | null;
|
|
27944
|
+
/** Secondarysubtotal */
|
|
27945
|
+
secondarySubtotal?: string | null;
|
|
27946
|
+
/** Primarytaxamount */
|
|
27947
|
+
primaryTaxAmount?: string | null;
|
|
27948
|
+
/** Secondarytaxamount */
|
|
27949
|
+
secondaryTaxAmount?: string | null;
|
|
27950
|
+
/** Primarytotal */
|
|
27951
|
+
primaryTotal?: string | null;
|
|
27952
|
+
/** Secondarytotal */
|
|
27953
|
+
secondaryTotal?: string | null;
|
|
27954
|
+
/** Remainingquantity */
|
|
27955
|
+
remainingQuantity?: number | null;
|
|
27956
|
+
};
|
|
27957
|
+
/** GiftReceiptListSchema */
|
|
27958
|
+
GiftReceiptListSchema: {
|
|
27959
|
+
info: components["schemas"]["PageInfoSchema"];
|
|
27960
|
+
/** Results */
|
|
27961
|
+
results: components["schemas"]["GiftReceiptSchema"][];
|
|
27962
|
+
};
|
|
27963
|
+
/** GiftReceiptSchema */
|
|
27964
|
+
GiftReceiptSchema: {
|
|
27740
27965
|
/**
|
|
27741
|
-
*
|
|
27742
|
-
*
|
|
27966
|
+
* Datecreated
|
|
27967
|
+
* Format: date-time
|
|
27743
27968
|
*/
|
|
27744
|
-
|
|
27969
|
+
dateCreated: string;
|
|
27970
|
+
/** Datemodified */
|
|
27971
|
+
dateModified: string | null;
|
|
27972
|
+
createdBy: components["schemas"]["RecordUserSchema"];
|
|
27973
|
+
modifiedBy: components["schemas"]["RecordUserSchema"] | null;
|
|
27745
27974
|
/**
|
|
27746
|
-
*
|
|
27747
|
-
*
|
|
27975
|
+
* Id
|
|
27976
|
+
* Format: uuid
|
|
27748
27977
|
*/
|
|
27749
|
-
|
|
27978
|
+
id: string;
|
|
27979
|
+
/** Receiptnumber */
|
|
27980
|
+
receiptNumber: string;
|
|
27750
27981
|
/**
|
|
27751
|
-
*
|
|
27752
|
-
*
|
|
27982
|
+
* Date
|
|
27983
|
+
* Format: date-time
|
|
27753
27984
|
*/
|
|
27754
|
-
|
|
27985
|
+
date: string;
|
|
27986
|
+
invoice: components["schemas"]["PosInvoiceSummarySchema"];
|
|
27987
|
+
/** Barcode */
|
|
27988
|
+
barcode: string;
|
|
27989
|
+
/** Primarysubtotal */
|
|
27990
|
+
primarySubtotal?: string | null;
|
|
27991
|
+
/** Secondarysubtotal */
|
|
27992
|
+
secondarySubtotal?: string | null;
|
|
27993
|
+
/** Primarytaxamount */
|
|
27994
|
+
primaryTaxAmount?: string | null;
|
|
27995
|
+
/** Secondarytaxamount */
|
|
27996
|
+
secondaryTaxAmount?: string | null;
|
|
27997
|
+
/** Primarytotal */
|
|
27998
|
+
primaryTotal?: string | null;
|
|
27999
|
+
/** Secondarytotal */
|
|
28000
|
+
secondaryTotal?: string | null;
|
|
28001
|
+
/** Items */
|
|
28002
|
+
items: components["schemas"]["GiftReceiptItemSchema"][];
|
|
28003
|
+
};
|
|
28004
|
+
/** POSInvoiceItemSummarySchema */
|
|
28005
|
+
POSInvoiceItemSummarySchema: {
|
|
27755
28006
|
/**
|
|
27756
|
-
*
|
|
27757
|
-
*
|
|
28007
|
+
* Id
|
|
28008
|
+
* Format: uuid
|
|
27758
28009
|
*/
|
|
27759
|
-
|
|
28010
|
+
id: string;
|
|
28011
|
+
item: components["schemas"]["ItemSummaryInfo"];
|
|
28012
|
+
/** @description This field is the package of the item. */
|
|
28013
|
+
itemPackage: components["schemas"]["ItemPackageSummarySchema"] | null;
|
|
27760
28014
|
/**
|
|
27761
|
-
*
|
|
27762
|
-
*
|
|
28015
|
+
* @description
|
|
28016
|
+
* if the item is voided it cant be modified,
|
|
28017
|
+
* if the invoice type is default the item status is purchased or voided,
|
|
28018
|
+
* if the invoice type is exchange the item status is purchased, retuned or voided,
|
|
28019
|
+
*
|
|
28020
|
+
* @default purchased
|
|
27763
28021
|
*/
|
|
27764
|
-
|
|
28022
|
+
status: components["schemas"]["InvoiceItemStatus"];
|
|
28023
|
+
/** Quantity */
|
|
28024
|
+
quantity: number;
|
|
27765
28025
|
/**
|
|
27766
|
-
*
|
|
27767
|
-
* @
|
|
28026
|
+
* Unitprice
|
|
28027
|
+
* @description This field is a number representing the unit price of the item.
|
|
27768
28028
|
*/
|
|
27769
|
-
|
|
28029
|
+
unitPrice: string;
|
|
27770
28030
|
/**
|
|
27771
|
-
*
|
|
27772
|
-
* @
|
|
28031
|
+
* Discount
|
|
28032
|
+
* @default 0
|
|
27773
28033
|
*/
|
|
27774
|
-
|
|
28034
|
+
discount: number;
|
|
27775
28035
|
/**
|
|
27776
|
-
*
|
|
27777
|
-
* @
|
|
27778
|
-
* @example 1
|
|
28036
|
+
* Primarytotal
|
|
28037
|
+
* @description This field is a number representing the primary total of the item.
|
|
27779
28038
|
*/
|
|
27780
|
-
|
|
28039
|
+
primaryTotal: string;
|
|
27781
28040
|
/**
|
|
27782
|
-
*
|
|
27783
|
-
* @
|
|
27784
|
-
*
|
|
28041
|
+
* Secondarytotal
|
|
28042
|
+
* @description
|
|
28043
|
+
* This field is a number representing the secondary total of the item.
|
|
28044
|
+
* This field is visible only if multicurrency is enabled.
|
|
28045
|
+
*
|
|
27785
28046
|
*/
|
|
27786
|
-
|
|
27787
|
-
/** Invoiceitems */
|
|
27788
|
-
invoiceItems: components["schemas"]["InvoiceItemGetSchema"][];
|
|
27789
|
-
/** Invoicerefunds */
|
|
27790
|
-
invoiceRefunds: components["schemas"]["PosRefundSchema"][];
|
|
28047
|
+
secondaryTotal: string | null;
|
|
27791
28048
|
};
|
|
27792
28049
|
/** CitySchema */
|
|
27793
28050
|
CitySchema: {
|
|
@@ -27904,24 +28161,6 @@ export interface components {
|
|
|
27904
28161
|
/** Price */
|
|
27905
28162
|
price: number | string;
|
|
27906
28163
|
};
|
|
27907
|
-
/** CustomerSharedSchema */
|
|
27908
|
-
CustomerSharedSchema: {
|
|
27909
|
-
/** Id */
|
|
27910
|
-
id: number;
|
|
27911
|
-
/** Name */
|
|
27912
|
-
name: string;
|
|
27913
|
-
/** Accountnumber */
|
|
27914
|
-
accountNumber: string;
|
|
27915
|
-
/** Phone */
|
|
27916
|
-
phone?: string | null;
|
|
27917
|
-
type: components["schemas"]["TypeOfCustomerValue"];
|
|
27918
|
-
currency: components["schemas"]["CurrencySummaryInfo"] | null;
|
|
27919
|
-
/**
|
|
27920
|
-
* Currencies
|
|
27921
|
-
* @default []
|
|
27922
|
-
*/
|
|
27923
|
-
currencies: components["schemas"]["CurrencySummaryInfo"][];
|
|
27924
|
-
};
|
|
27925
28164
|
/** ListShippingMethods */
|
|
27926
28165
|
ListShippingMethods: {
|
|
27927
28166
|
info: components["schemas"]["PageInfoSchema"];
|
|
@@ -30746,15 +30985,6 @@ export interface components {
|
|
|
30746
30985
|
*/
|
|
30747
30986
|
paymentInAdvanceAccountNonResident?: number;
|
|
30748
30987
|
};
|
|
30749
|
-
/** CurrencySummarySchema */
|
|
30750
|
-
CurrencySummarySchema: {
|
|
30751
|
-
/** Id */
|
|
30752
|
-
id: number;
|
|
30753
|
-
/** Code */
|
|
30754
|
-
code: string;
|
|
30755
|
-
/** Name */
|
|
30756
|
-
name: string;
|
|
30757
|
-
};
|
|
30758
30988
|
/**
|
|
30759
30989
|
* ReportGroupBy
|
|
30760
30990
|
* @enum {string}
|
|
@@ -33751,13 +33981,6 @@ export interface components {
|
|
|
33751
33981
|
/** Totaldifference */
|
|
33752
33982
|
totalDifference: number;
|
|
33753
33983
|
};
|
|
33754
|
-
/** ItemSummaryInfo */
|
|
33755
|
-
ItemSummaryInfo: {
|
|
33756
|
-
/** Id */
|
|
33757
|
-
id: number;
|
|
33758
|
-
/** Name */
|
|
33759
|
-
name: string;
|
|
33760
|
-
};
|
|
33761
33984
|
/** PurchaseInvoiceDifferenceSchema */
|
|
33762
33985
|
PurchaseInvoiceDifferenceSchema: {
|
|
33763
33986
|
/** Itemdifferences */
|
|
@@ -37056,13 +37279,6 @@ export interface components {
|
|
|
37056
37279
|
* @enum {string}
|
|
37057
37280
|
*/
|
|
37058
37281
|
EmployeeType: "receivable" | "payable";
|
|
37059
|
-
/** UserSummaryInfo */
|
|
37060
|
-
UserSummaryInfo: {
|
|
37061
|
-
/** Id */
|
|
37062
|
-
id: number;
|
|
37063
|
-
/** Username */
|
|
37064
|
-
username: string;
|
|
37065
|
-
};
|
|
37066
37282
|
/** CreateBankAccountsSchema */
|
|
37067
37283
|
CreateBankAccountsSchema: {
|
|
37068
37284
|
/** Name */
|
|
@@ -39437,21 +39653,6 @@ export interface components {
|
|
|
39437
39653
|
/** Name */
|
|
39438
39654
|
name: string;
|
|
39439
39655
|
};
|
|
39440
|
-
/** PromotionsAndOffersSharedSchema */
|
|
39441
|
-
PromotionsAndOffersSharedSchema: {
|
|
39442
|
-
/**
|
|
39443
|
-
* Id
|
|
39444
|
-
* Format: uuid
|
|
39445
|
-
*/
|
|
39446
|
-
id: string;
|
|
39447
|
-
/** Name */
|
|
39448
|
-
name: string;
|
|
39449
|
-
/** Promotiontype */
|
|
39450
|
-
promotionType: string;
|
|
39451
|
-
/** Discountvalue */
|
|
39452
|
-
discountValue: number | null;
|
|
39453
|
-
currency: components["schemas"]["CurrencySummaryInfo"] | null;
|
|
39454
|
-
};
|
|
39455
39656
|
/** SalesPriceListSummaryInfo */
|
|
39456
39657
|
SalesPriceListSummaryInfo: {
|
|
39457
39658
|
/**
|
|
@@ -59439,6 +59640,16 @@ export interface operations {
|
|
|
59439
59640
|
page?: number;
|
|
59440
59641
|
/** @description Page size */
|
|
59441
59642
|
pageSize?: number;
|
|
59643
|
+
/** @description Filter by session status (e.g., 'opened') */
|
|
59644
|
+
status?: components["schemas"]["SessionStatus"] | null;
|
|
59645
|
+
/** @description Filter sessions from this date (YYYY-MM-DD) */
|
|
59646
|
+
startDate?: string | null;
|
|
59647
|
+
/** @description Filter sessions until this date (YYYY-MM-DD) */
|
|
59648
|
+
endDate?: string | null;
|
|
59649
|
+
/** @description Filter by user ID (requires appropriate permissions) */
|
|
59650
|
+
userId?: number | null;
|
|
59651
|
+
/** @description Filter by session name */
|
|
59652
|
+
name?: string | null;
|
|
59442
59653
|
};
|
|
59443
59654
|
header?: never;
|
|
59444
59655
|
path?: never;
|
|
@@ -59452,7 +59663,7 @@ export interface operations {
|
|
|
59452
59663
|
[name: string]: unknown;
|
|
59453
59664
|
};
|
|
59454
59665
|
content: {
|
|
59455
|
-
"application/json": components["schemas"]["
|
|
59666
|
+
"application/json": components["schemas"]["SessionListSchema"];
|
|
59456
59667
|
};
|
|
59457
59668
|
};
|
|
59458
59669
|
/** @description Bad Request */
|
|
@@ -59461,7 +59672,7 @@ export interface operations {
|
|
|
59461
59672
|
[name: string]: unknown;
|
|
59462
59673
|
};
|
|
59463
59674
|
content: {
|
|
59464
|
-
"application/json": components["schemas"]["
|
|
59675
|
+
"application/json": components["schemas"]["ErrorMessages"];
|
|
59465
59676
|
};
|
|
59466
59677
|
};
|
|
59467
59678
|
/** @description Forbidden */
|
|
@@ -59484,7 +59695,7 @@ export interface operations {
|
|
|
59484
59695
|
};
|
|
59485
59696
|
};
|
|
59486
59697
|
};
|
|
59487
|
-
|
|
59698
|
+
pos_session_views_get_session: {
|
|
59488
59699
|
parameters: {
|
|
59489
59700
|
query?: never;
|
|
59490
59701
|
header?: never;
|
|
@@ -59501,7 +59712,7 @@ export interface operations {
|
|
|
59501
59712
|
[name: string]: unknown;
|
|
59502
59713
|
};
|
|
59503
59714
|
content: {
|
|
59504
|
-
"application/json": components["schemas"]["
|
|
59715
|
+
"application/json": components["schemas"]["SessionSchema"];
|
|
59505
59716
|
};
|
|
59506
59717
|
};
|
|
59507
59718
|
/** @description Bad Request */
|
|
@@ -59510,7 +59721,7 @@ export interface operations {
|
|
|
59510
59721
|
[name: string]: unknown;
|
|
59511
59722
|
};
|
|
59512
59723
|
content: {
|
|
59513
|
-
"application/json": components["schemas"]["
|
|
59724
|
+
"application/json": components["schemas"]["ErrorMessages"];
|
|
59514
59725
|
};
|
|
59515
59726
|
};
|
|
59516
59727
|
/** @description Forbidden */
|
|
@@ -59531,16 +59742,20 @@ export interface operations {
|
|
|
59531
59742
|
"application/json": components["schemas"]["MessageResponse"];
|
|
59532
59743
|
};
|
|
59533
59744
|
};
|
|
59745
|
+
/** @description Internal Server Error */
|
|
59746
|
+
500: {
|
|
59747
|
+
headers: {
|
|
59748
|
+
[name: string]: unknown;
|
|
59749
|
+
};
|
|
59750
|
+
content: {
|
|
59751
|
+
"application/json": components["schemas"]["MessageResponse"];
|
|
59752
|
+
};
|
|
59753
|
+
};
|
|
59534
59754
|
};
|
|
59535
59755
|
};
|
|
59536
|
-
|
|
59756
|
+
pos_session_views_get_session_x_report: {
|
|
59537
59757
|
parameters: {
|
|
59538
|
-
query?:
|
|
59539
|
-
/** @description Page number */
|
|
59540
|
-
page?: number;
|
|
59541
|
-
/** @description Page size */
|
|
59542
|
-
pageSize?: number;
|
|
59543
|
-
};
|
|
59758
|
+
query?: never;
|
|
59544
59759
|
header?: never;
|
|
59545
59760
|
path: {
|
|
59546
59761
|
id: string;
|
|
@@ -59555,7 +59770,7 @@ export interface operations {
|
|
|
59555
59770
|
[name: string]: unknown;
|
|
59556
59771
|
};
|
|
59557
59772
|
content: {
|
|
59558
|
-
"application/json": components["schemas"]["
|
|
59773
|
+
"application/json": components["schemas"]["XReportSchema"];
|
|
59559
59774
|
};
|
|
59560
59775
|
};
|
|
59561
59776
|
/** @description Bad Request */
|
|
@@ -59564,16 +59779,7 @@ export interface operations {
|
|
|
59564
59779
|
[name: string]: unknown;
|
|
59565
59780
|
};
|
|
59566
59781
|
content: {
|
|
59567
|
-
"application/json": components["schemas"]["
|
|
59568
|
-
};
|
|
59569
|
-
};
|
|
59570
|
-
/** @description Unauthorized */
|
|
59571
|
-
401: {
|
|
59572
|
-
headers: {
|
|
59573
|
-
[name: string]: unknown;
|
|
59574
|
-
};
|
|
59575
|
-
content: {
|
|
59576
|
-
"application/json": components["schemas"]["MessageResponse"];
|
|
59782
|
+
"application/json": components["schemas"]["ErrorMessages"];
|
|
59577
59783
|
};
|
|
59578
59784
|
};
|
|
59579
59785
|
/** @description Forbidden */
|
|
@@ -59605,18 +59811,18 @@ export interface operations {
|
|
|
59605
59811
|
};
|
|
59606
59812
|
};
|
|
59607
59813
|
};
|
|
59608
|
-
|
|
59814
|
+
pos_session_views_get_session_z_report: {
|
|
59609
59815
|
parameters: {
|
|
59610
59816
|
query?: {
|
|
59611
|
-
/** @description
|
|
59612
|
-
|
|
59613
|
-
/** @description
|
|
59614
|
-
|
|
59817
|
+
/** @description Start date (YYYY-MM-DD) */
|
|
59818
|
+
start_date?: string | null;
|
|
59819
|
+
/** @description End date (YYYY-MM-DD) */
|
|
59820
|
+
end_date?: string | null;
|
|
59821
|
+
/** @description Session IDs filtered by status 'closed' */
|
|
59822
|
+
session_ids?: string[] | null;
|
|
59615
59823
|
};
|
|
59616
59824
|
header?: never;
|
|
59617
|
-
path
|
|
59618
|
-
id: string;
|
|
59619
|
-
};
|
|
59825
|
+
path?: never;
|
|
59620
59826
|
cookie?: never;
|
|
59621
59827
|
};
|
|
59622
59828
|
requestBody?: never;
|
|
@@ -59627,7 +59833,7 @@ export interface operations {
|
|
|
59627
59833
|
[name: string]: unknown;
|
|
59628
59834
|
};
|
|
59629
59835
|
content: {
|
|
59630
|
-
"application/json": components["schemas"]["
|
|
59836
|
+
"application/json": components["schemas"]["ZReportSchema"];
|
|
59631
59837
|
};
|
|
59632
59838
|
};
|
|
59633
59839
|
/** @description Bad Request */
|
|
@@ -59636,11 +59842,11 @@ export interface operations {
|
|
|
59636
59842
|
[name: string]: unknown;
|
|
59637
59843
|
};
|
|
59638
59844
|
content: {
|
|
59639
|
-
"application/json": components["schemas"]["
|
|
59845
|
+
"application/json": components["schemas"]["ErrorMessages"];
|
|
59640
59846
|
};
|
|
59641
59847
|
};
|
|
59642
|
-
/** @description
|
|
59643
|
-
|
|
59848
|
+
/** @description Forbidden */
|
|
59849
|
+
403: {
|
|
59644
59850
|
headers: {
|
|
59645
59851
|
[name: string]: unknown;
|
|
59646
59852
|
};
|
|
@@ -59668,18 +59874,28 @@ export interface operations {
|
|
|
59668
59874
|
};
|
|
59669
59875
|
};
|
|
59670
59876
|
};
|
|
59671
|
-
|
|
59877
|
+
pos_invoice_views_list_invoices: {
|
|
59672
59878
|
parameters: {
|
|
59673
59879
|
query?: {
|
|
59674
59880
|
/** @description Page number */
|
|
59675
59881
|
page?: number;
|
|
59676
59882
|
/** @description Page size */
|
|
59677
59883
|
pageSize?: number;
|
|
59884
|
+
/** @description Search by invoice type, barcode, customer first name, customer last name, status, primary_total, secondary_total, customer__phone1, customer__phone2 */
|
|
59885
|
+
search?: string | null;
|
|
59886
|
+
/** @description Filter invoices by status */
|
|
59887
|
+
status?: components["schemas"]["InvoiceStatus"] | null;
|
|
59888
|
+
/** @description Filter invoices by invoice number */
|
|
59889
|
+
invoiceNumber?: string | null;
|
|
59890
|
+
/** @description Filter invoices by session ID, it should be the current session by default */
|
|
59891
|
+
session_id?: string | null;
|
|
59892
|
+
/** @description Filter invoices from this date (YYYY-MM-DD) */
|
|
59893
|
+
start_date?: string | null;
|
|
59894
|
+
/** @description Filter invoices up to this date (YYYY-MM-DD) */
|
|
59895
|
+
end_date?: string | null;
|
|
59678
59896
|
};
|
|
59679
59897
|
header?: never;
|
|
59680
|
-
path
|
|
59681
|
-
id: string;
|
|
59682
|
-
};
|
|
59898
|
+
path?: never;
|
|
59683
59899
|
cookie?: never;
|
|
59684
59900
|
};
|
|
59685
59901
|
requestBody?: never;
|
|
@@ -59690,7 +59906,7 @@ export interface operations {
|
|
|
59690
59906
|
[name: string]: unknown;
|
|
59691
59907
|
};
|
|
59692
59908
|
content: {
|
|
59693
|
-
"application/json": components["schemas"]["
|
|
59909
|
+
"application/json": components["schemas"]["InvoiceListSchema"];
|
|
59694
59910
|
};
|
|
59695
59911
|
};
|
|
59696
59912
|
/** @description Bad Request */
|
|
@@ -59699,20 +59915,11 @@ export interface operations {
|
|
|
59699
59915
|
[name: string]: unknown;
|
|
59700
59916
|
};
|
|
59701
59917
|
content: {
|
|
59702
|
-
"application/json": components["schemas"]["
|
|
59703
|
-
};
|
|
59704
|
-
};
|
|
59705
|
-
/** @description Unauthorized */
|
|
59706
|
-
401: {
|
|
59707
|
-
headers: {
|
|
59708
|
-
[name: string]: unknown;
|
|
59709
|
-
};
|
|
59710
|
-
content: {
|
|
59711
|
-
"application/json": components["schemas"]["MessageResponse"];
|
|
59918
|
+
"application/json": components["schemas"]["ErrorMessages"];
|
|
59712
59919
|
};
|
|
59713
59920
|
};
|
|
59714
|
-
/** @description
|
|
59715
|
-
|
|
59921
|
+
/** @description Forbidden */
|
|
59922
|
+
403: {
|
|
59716
59923
|
headers: {
|
|
59717
59924
|
[name: string]: unknown;
|
|
59718
59925
|
};
|
|
@@ -59731,7 +59938,7 @@ export interface operations {
|
|
|
59731
59938
|
};
|
|
59732
59939
|
};
|
|
59733
59940
|
};
|
|
59734
|
-
|
|
59941
|
+
pos_invoice_views_get_pos_invoice: {
|
|
59735
59942
|
parameters: {
|
|
59736
59943
|
query?: never;
|
|
59737
59944
|
header?: never;
|
|
@@ -59748,7 +59955,7 @@ export interface operations {
|
|
|
59748
59955
|
[name: string]: unknown;
|
|
59749
59956
|
};
|
|
59750
59957
|
content: {
|
|
59751
|
-
"application/json": components["schemas"]["
|
|
59958
|
+
"application/json": components["schemas"]["POSInvoiceSchema"];
|
|
59752
59959
|
};
|
|
59753
59960
|
};
|
|
59754
59961
|
/** @description Forbidden */
|
|
@@ -59780,13 +59987,26 @@ export interface operations {
|
|
|
59780
59987
|
};
|
|
59781
59988
|
};
|
|
59782
59989
|
};
|
|
59783
|
-
|
|
59990
|
+
pos_invoice_gift_receipt_views_list_gift_receipts: {
|
|
59784
59991
|
parameters: {
|
|
59785
|
-
query?:
|
|
59786
|
-
|
|
59787
|
-
|
|
59788
|
-
|
|
59992
|
+
query?: {
|
|
59993
|
+
/** @description Page number */
|
|
59994
|
+
page?: number;
|
|
59995
|
+
/** @description Page size */
|
|
59996
|
+
pageSize?: number;
|
|
59997
|
+
/** @description Search by gift receipt barcode, invoice number, customer first name, customer last name, customer phone number, customer email, item name, item barcode, item category name, item brand name */
|
|
59998
|
+
search?: string | null;
|
|
59999
|
+
/** @description Filter gift receipts by receipt number */
|
|
60000
|
+
receiptNumber?: string | null;
|
|
60001
|
+
/** @description Filter gift receipts by session ID, it should be the current session by default */
|
|
60002
|
+
session_id?: string | null;
|
|
60003
|
+
/** @description Filter gift receipts from this date (YYYY-MM-DD) */
|
|
60004
|
+
start_date?: string | null;
|
|
60005
|
+
/** @description Filter gift receipts up to this date (YYYY-MM-DD) */
|
|
60006
|
+
end_date?: string | null;
|
|
59789
60007
|
};
|
|
60008
|
+
header?: never;
|
|
60009
|
+
path?: never;
|
|
59790
60010
|
cookie?: never;
|
|
59791
60011
|
};
|
|
59792
60012
|
requestBody?: never;
|
|
@@ -59797,20 +60017,20 @@ export interface operations {
|
|
|
59797
60017
|
[name: string]: unknown;
|
|
59798
60018
|
};
|
|
59799
60019
|
content: {
|
|
59800
|
-
"application/json": components["schemas"]["
|
|
60020
|
+
"application/json": components["schemas"]["GiftReceiptListSchema"];
|
|
59801
60021
|
};
|
|
59802
60022
|
};
|
|
59803
|
-
/** @description
|
|
59804
|
-
|
|
60023
|
+
/** @description Bad Request */
|
|
60024
|
+
400: {
|
|
59805
60025
|
headers: {
|
|
59806
60026
|
[name: string]: unknown;
|
|
59807
60027
|
};
|
|
59808
60028
|
content: {
|
|
59809
|
-
"application/json": components["schemas"]["
|
|
60029
|
+
"application/json": components["schemas"]["ErrorMessages"];
|
|
59810
60030
|
};
|
|
59811
60031
|
};
|
|
59812
|
-
/** @description
|
|
59813
|
-
|
|
60032
|
+
/** @description Forbidden */
|
|
60033
|
+
403: {
|
|
59814
60034
|
headers: {
|
|
59815
60035
|
[name: string]: unknown;
|
|
59816
60036
|
};
|
|
@@ -59829,7 +60049,7 @@ export interface operations {
|
|
|
59829
60049
|
};
|
|
59830
60050
|
};
|
|
59831
60051
|
};
|
|
59832
|
-
|
|
60052
|
+
pos_invoice_gift_receipt_views_get_gift_receipt: {
|
|
59833
60053
|
parameters: {
|
|
59834
60054
|
query?: never;
|
|
59835
60055
|
header?: never;
|
|
@@ -59846,7 +60066,7 @@ export interface operations {
|
|
|
59846
60066
|
[name: string]: unknown;
|
|
59847
60067
|
};
|
|
59848
60068
|
content: {
|
|
59849
|
-
"application/json": components["schemas"]["
|
|
60069
|
+
"application/json": components["schemas"]["GiftReceiptSchema"];
|
|
59850
60070
|
};
|
|
59851
60071
|
};
|
|
59852
60072
|
/** @description Forbidden */
|