@erp-galoper/types 1.0.1965 → 1.0.1967

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.
Files changed (2) hide show
  1. package/openapi.ts +39 -9
  2. package/package.json +1 -1
package/openapi.ts CHANGED
@@ -15587,6 +15587,7 @@ export interface paths {
15587
15587
  * - recognitionFrequencyIsRequired
15588
15588
  * - recognitionStartDateIsRequired
15589
15589
  * - depositChargeChangeNotAllowed
15590
+ * - packageDepositChargeRequired
15590
15591
  * - unitPackageIsRequired
15591
15592
  * - salesPersonIsNotActive
15592
15593
  *
@@ -15653,6 +15654,7 @@ export interface paths {
15653
15654
  * - recognitionFrequencyIsRequired
15654
15655
  * - recognitionStartDateIsRequired
15655
15656
  * - depositChargeChangeNotAllowed
15657
+ * - packageDepositChargeRequired
15656
15658
  * - unitPackageIsRequired
15657
15659
  * - customerChangeNotAllowed
15658
15660
  * - salesPersonIsNotActive
@@ -16869,6 +16871,7 @@ export interface paths {
16869
16871
  * - recognitionFrequencyIsRequired
16870
16872
  * - recognitionStartDateIsRequired
16871
16873
  * - depositChargeChangeNotAllowed
16874
+ * - packageDepositChargeRequired
16872
16875
  * - unitPackageIsRequired
16873
16876
  * - salesQuotationDoesNotExist
16874
16877
  * - salesQuotationCustomerDoesNotMatchWithSalesOrderCustomer
@@ -16937,6 +16940,7 @@ export interface paths {
16937
16940
  * - recognitionFrequencyIsRequired
16938
16941
  * - recognitionStartDateIsRequired
16939
16942
  * - depositChargeChangeNotAllowed
16943
+ * - packageDepositChargeRequired
16940
16944
  * - unitPackageIsRequired
16941
16945
  * - salesQuotationDoesNotExist
16942
16946
  * - customerChangeNotAllowed
@@ -17869,6 +17873,7 @@ export interface paths {
17869
17873
  * - recognitionFrequencyIsRequired
17870
17874
  * - recognitionStartDateIsRequired
17871
17875
  * - depositChargeChangeNotAllowed
17876
+ * - packageDepositChargeRequired
17872
17877
  * - unitPackageIsRequired
17873
17878
  * - salesOrderDoesNotExist
17874
17879
  * - customerShouldBeSameAsDownPaymentCustomer
@@ -17940,6 +17945,7 @@ export interface paths {
17940
17945
  * - recognitionFrequencyIsRequired
17941
17946
  * - recognitionStartDateIsRequired
17942
17947
  * - depositChargeChangeNotAllowed
17948
+ * - packageDepositChargeRequired
17943
17949
  * - unitPackageIsRequired
17944
17950
  * - salesOrderDoesNotExist
17945
17951
  * - customerChangeNotAllowed
@@ -50490,6 +50496,7 @@ export interface components {
50490
50496
  /**
50491
50497
  * @description Unit of measure used for pricing this line.
50492
50498
  * For retail price lists this is always the item's default sales UOM (or the package UOM when a package is selected).
50499
+ * For POS price lists (isPos is true), only the item's default sales unit of measure is allowed.
50493
50500
  */
50494
50501
  unitOfMeasure: components["schemas"]["UnitOfMeasureSummaryInfo"];
50495
50502
  /**
@@ -50612,6 +50619,7 @@ export interface components {
50612
50619
  canDelete: boolean;
50613
50620
  /**
50614
50621
  * Ispos
50622
+ * @description When true, this is a POS retail price list. Only items priced in their default sales unit of measure are allowed.
50615
50623
  * @default false
50616
50624
  */
50617
50625
  isPos: boolean;
@@ -50643,6 +50651,10 @@ export interface components {
50643
50651
  * - allowSales equal to true
50644
50652
  * - viewType equal to flat, role not equal to template
50645
50653
  * - item can be filtered by: name, barcode, sku code or short name
50654
+ *
50655
+ * **When the price list has isPos set to true:**
50656
+ * - Only items where the unit of measure equals the item's default sales unit of measure (`default_sale_unit_of_measure`) should be included
50657
+ * - The frontend should not allow selecting a different unit of measure for POS price lists
50646
50658
  */
50647
50659
  item: string;
50648
50660
  /**
@@ -50669,6 +50681,11 @@ export interface components {
50669
50681
  * - Sending a different unit of measure is rejected with error code `invalidUnitOfMeasureForRetail` on field `items.{index}.unitOfMeasure`.
50670
50682
  * - The frontend should auto-populate this field from the item's default sales UOM (or the package UOM) and should not allow the user to change it for retail lists.
50671
50683
  *
50684
+ * **POS price lists (isPos is true):**
50685
+ * - Only items where the unit of measure equals the item's default sales unit of measure (`default_sale_unit_of_measure`) are allowed.
50686
+ * - When `itemPackage` is provided, this field must exactly match the package's unit of measure.
50687
+ * - The frontend should only present items and units of measure that satisfy this constraint when building a POS price list.
50688
+ *
50672
50689
  * **Duplicate validation:**
50673
50690
  * - The same item + itemPackage + unitOfMeasure combination cannot appear more than once per price list (enforced by database unique constraint).
50674
50691
  * - For retail lists, unit of measure is normalized before insert, so conflicting lines are rejected at save time with error code `duplicateItemInPriceList`.
@@ -50743,6 +50760,10 @@ export interface components {
50743
50760
  /**
50744
50761
  * Ispos
50745
50762
  * @description Only applicable when price list type is retail. Only one retail price list per branch can have is_pos set to true.
50763
+ *
50764
+ * When isPos is true:
50765
+ * - regions, customers, and customerGroups are not applicable
50766
+ * - Only items where the unit of measure equals the item's default sales unit of measure (`default_sale_unit_of_measure`) should be added to the price list
50746
50767
  * @default false
50747
50768
  */
50748
50769
  isPos: boolean;
@@ -50811,6 +50832,8 @@ export interface components {
50811
50832
  * @description List of items with their corresponding prices defined in this price list. At least one item must be included.
50812
50833
  *
50813
50834
  * Each line is uniquely identified by the combination of `item`, `itemPackage`, and `unitOfMeasure` (enforced by database unique constraint).
50835
+ *
50836
+ * **When isPos is true:** only include items where `unitOfMeasure` equals the item's default sales unit of measure. Non-sales units of measure are not allowed.
50814
50837
  */
50815
50838
  items: components["schemas"]["CreateUpdateSalesPriceListItemSchema"][];
50816
50839
  };
@@ -50874,6 +50897,7 @@ export interface components {
50874
50897
  canDelete: boolean;
50875
50898
  /**
50876
50899
  * Ispos
50900
+ * @description When true, this is a POS retail price list. Only items priced in their default sales unit of measure are allowed.
50877
50901
  * @default false
50878
50902
  */
50879
50903
  isPos: boolean;
@@ -51092,6 +51116,12 @@ export interface components {
51092
51116
  * @default false
51093
51117
  */
51094
51118
  returnable: boolean;
51119
+ /**
51120
+ * Hasdeposit
51121
+ * @description Whether the package has a deposit charge collected on sale
51122
+ * @default false
51123
+ */
51124
+ hasDeposit: boolean;
51095
51125
  /**
51096
51126
  * Depositcharge
51097
51127
  * @description Deposit charge of the package
@@ -51171,9 +51201,15 @@ export interface components {
51171
51201
  * @default false
51172
51202
  */
51173
51203
  returnable: boolean;
51204
+ /**
51205
+ * Hasdeposit
51206
+ * @description Whether the package has a deposit charge collected on sale
51207
+ * @default false
51208
+ */
51209
+ hasDeposit: boolean;
51174
51210
  /**
51175
51211
  * Depositcharge
51176
- * @description - Visible when returnable is true and field isReturnablePackagePaid is enabled in sales settings
51212
+ * @description - Visible when returnable is true and hasDeposit is true
51177
51213
  * - If provided, depositChargeCurrency must also be provided, they are co-dependent
51178
51214
  * - If conditions are not met, this value is automatically set to null even if sent in payload
51179
51215
  * - Optional not required
@@ -51183,7 +51219,7 @@ export interface components {
51183
51219
  * Depositchargecurrency
51184
51220
  * Format: uuid
51185
51221
  * @description - Currency of the deposit charge, only company currency or USD
51186
- * - Visible when returnable is true and field isReturnablePackagePaid is enabled in sales settings
51222
+ * - Visible when returnable is true and hasDeposit is true
51187
51223
  * - If provided, depositCharge must also be provided, they are co-dependent
51188
51224
  * - If conditions are not met, this value is automatically set to null even if sent in payload
51189
51225
  * - Optional not required
@@ -51261,8 +51297,6 @@ export interface components {
51261
51297
  id: number;
51262
51298
  /** Usepricelist */
51263
51299
  usePriceList: boolean;
51264
- /** Isreturnablepackagepaid */
51265
- isReturnablePackagePaid: boolean;
51266
51300
  /** Allowsalesorderforexpiredquotation */
51267
51301
  allowSalesOrderForExpiredQuotation: boolean;
51268
51302
  /** Reserveonorder */
@@ -51275,8 +51309,6 @@ export interface components {
51275
51309
  CreateSalesSettingsSchema: {
51276
51310
  /** Usepricelist */
51277
51311
  usePriceList: boolean;
51278
- /** Isreturnablepackagepaid */
51279
- isReturnablePackagePaid: boolean;
51280
51312
  /** Allowsalesorderforexpiredquotation */
51281
51313
  allowSalesOrderForExpiredQuotation: boolean;
51282
51314
  /** Reserveonorder */
@@ -51290,8 +51322,6 @@ export interface components {
51290
51322
  UpdateSalesSettingsSchema: {
51291
51323
  /** Usepricelist */
51292
51324
  usePriceList?: boolean;
51293
- /** Isreturnablepackagepaid */
51294
- isReturnablePackagePaid?: boolean;
51295
51325
  /** Allowsalesorderforexpiredquotation */
51296
51326
  allowSalesOrderForExpiredQuotation?: boolean;
51297
51327
  /** Reserveonorder */
@@ -56545,7 +56575,7 @@ export interface components {
56545
56575
  /**
56546
56576
  * Packagedepositcharge
56547
56577
  * @description - This field is a number.
56548
- * - It is required when the package is selected and has a deposit charge and is_returnable_package_paid is true from sales_settings.
56578
+ * - It is required when the package is selected, has a deposit charge, and hasDeposit is true on that package.
56549
56579
  */
56550
56580
  packageDepositCharge?: number;
56551
56581
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@erp-galoper/types",
3
- "version": "1.0.1965",
3
+ "version": "1.0.1967",
4
4
  "main": "openapi.ts",
5
5
  "types": "openapi.ts",
6
6
  "files": ["openapi.ts"],