@erp-galoper/types 1.0.1039 → 1.0.1041

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 +179 -48
  2. package/package.json +1 -1
package/openapi.ts CHANGED
@@ -16726,7 +16726,7 @@ export interface paths {
16726
16726
  * - SalesInvoicesShouldHaveSameGlobalTaxRate
16727
16727
  * - cannotReturnDeferredInvoice
16728
16728
  * - projectDoesNotExist
16729
- *
16729
+ * - salesInvoiceWarehouseMismatchWithReturnInvoiceWarehouse
16730
16730
  * - 403: - "permissionDenied"
16731
16731
  * - "noModuleAccess"
16732
16732
  * - "noBranchAccess"
@@ -21778,11 +21778,20 @@ export interface components {
21778
21778
  active: boolean;
21779
21779
  /** Description */
21780
21780
  description?: string | null;
21781
- /** Skucode */
21781
+ /**
21782
+ * Skucode
21783
+ * @description show it as code instead of barcode if service
21784
+ */
21782
21785
  skuCode?: string | null;
21783
- /** Barcodetype */
21786
+ /**
21787
+ * Barcodetype
21788
+ * @description if barcode type is not set then barcode should be null
21789
+ */
21784
21790
  barcodeType: string | null;
21785
- /** Barcode */
21791
+ /**
21792
+ * Barcode
21793
+ * @description show it as code instead of barcode if service
21794
+ */
21786
21795
  barcode?: string | null;
21787
21796
  type?: components["schemas"]["ItemType"] | null;
21788
21797
  usage?: components["schemas"]["ItemUsage"] | null;
@@ -21866,15 +21875,22 @@ export interface components {
21866
21875
  defaultPurchasePriceCurrency?: components["schemas"]["CurrencySummaryInfo"] | null;
21867
21876
  /** Leadtime */
21868
21877
  leadTime?: string | null;
21869
- /** Minimumquantityorder */
21878
+ /**
21879
+ * Minimumquantityorder
21880
+ * @description Not applicable for service items - always null for type=service
21881
+ */
21870
21882
  minimumQuantityOrder?: number | null;
21871
21883
  defaultPurchaseUnitOfMeasure: components["schemas"]["UnitOfMeasureSchema"] | null;
21872
- /** Minimumquantityinstock */
21884
+ /**
21885
+ * Minimumquantityinstock
21886
+ * @description Not applicable for service items - always null for type=service
21887
+ */
21873
21888
  minimumQuantityInStock?: number | null;
21874
21889
  /** Warrantyperiod */
21875
21890
  warrantyPeriod?: string | null;
21876
21891
  /**
21877
21892
  * Allownegativestock
21893
+ * @description Not applicable for service items - always null for type=service
21878
21894
  * @default false
21879
21895
  */
21880
21896
  allowNegativeStock: boolean;
@@ -21894,6 +21910,7 @@ export interface components {
21894
21910
  * @default false
21895
21911
  */
21896
21912
  isInventoryTracked: boolean | null;
21913
+ /** @description Not applicable for service items - always null for type=service */
21897
21914
  trackInventoryBy?: components["schemas"]["TrackInventoryBy"] | null;
21898
21915
  /**
21899
21916
  * Hasexpirydate
@@ -21917,6 +21934,7 @@ export interface components {
21917
21934
  alertDate?: number | null;
21918
21935
  /**
21919
21936
  * Itempackages
21937
+ * @description Not applicable for service items - always empty list for type=service
21920
21938
  * @default []
21921
21939
  */
21922
21940
  itemPackages: components["schemas"]["ItemPackageWithCanDeleteAndCanUpdateQuantityOrUomSchema"][];
@@ -21968,11 +21986,20 @@ export interface components {
21968
21986
  active: boolean;
21969
21987
  /** Description */
21970
21988
  description?: string | null;
21971
- /** Skucode */
21989
+ /**
21990
+ * Skucode
21991
+ * @description show it as code instead of barcode if service
21992
+ */
21972
21993
  skuCode?: string | null;
21973
- /** Barcodetype */
21994
+ /**
21995
+ * Barcodetype
21996
+ * @description if barcode type is not set then barcode should be null
21997
+ */
21974
21998
  barcodeType: string | null;
21975
- /** Barcode */
21999
+ /**
22000
+ * Barcode
22001
+ * @description show it as code instead of barcode if service
22002
+ */
21976
22003
  barcode?: string | null;
21977
22004
  type?: components["schemas"]["ItemType"] | null;
21978
22005
  usage?: components["schemas"]["ItemUsage"] | null;
@@ -22056,15 +22083,22 @@ export interface components {
22056
22083
  defaultPurchasePriceCurrency?: components["schemas"]["CurrencySummaryInfo"] | null;
22057
22084
  /** Leadtime */
22058
22085
  leadTime?: string | null;
22059
- /** Minimumquantityorder */
22086
+ /**
22087
+ * Minimumquantityorder
22088
+ * @description Not applicable for service items - always null for type=service
22089
+ */
22060
22090
  minimumQuantityOrder?: number | null;
22061
22091
  defaultPurchaseUnitOfMeasure: components["schemas"]["UnitOfMeasureSchema"] | null;
22062
- /** Minimumquantityinstock */
22092
+ /**
22093
+ * Minimumquantityinstock
22094
+ * @description Not applicable for service items - always null for type=service
22095
+ */
22063
22096
  minimumQuantityInStock?: number | null;
22064
22097
  /** Warrantyperiod */
22065
22098
  warrantyPeriod?: string | null;
22066
22099
  /**
22067
22100
  * Allownegativestock
22101
+ * @description Not applicable for service items - always null for type=service
22068
22102
  * @default false
22069
22103
  */
22070
22104
  allowNegativeStock: boolean;
@@ -22084,6 +22118,7 @@ export interface components {
22084
22118
  * @default false
22085
22119
  */
22086
22120
  isInventoryTracked: boolean | null;
22121
+ /** @description Not applicable for service items - always null for type=service */
22087
22122
  trackInventoryBy?: components["schemas"]["TrackInventoryBy"] | null;
22088
22123
  /**
22089
22124
  * Hasexpirydate
@@ -22107,6 +22142,7 @@ export interface components {
22107
22142
  alertDate?: number | null;
22108
22143
  /**
22109
22144
  * Itempackages
22145
+ * @description Not applicable for service items - always empty list for type=service
22110
22146
  * @default []
22111
22147
  */
22112
22148
  itemPackages: components["schemas"]["ItemPackageWithCanDeleteAndCanUpdateQuantityOrUomSchema"][];
@@ -22416,6 +22452,7 @@ export interface components {
22416
22452
  * @default false
22417
22453
  */
22418
22454
  isInventoryTracked: boolean | null;
22455
+ /** @description Not applicable for service items - always null for type=service */
22419
22456
  trackInventoryBy?: components["schemas"]["TrackInventoryBy"] | null;
22420
22457
  /**
22421
22458
  * Hasexpirydate
@@ -22460,14 +22497,21 @@ export interface components {
22460
22497
  active: boolean;
22461
22498
  /** Description */
22462
22499
  description?: string | null;
22463
- /** Skucode */
22500
+ /**
22501
+ * Skucode
22502
+ * @description Not applicable for service items - always null for type=service
22503
+ */
22464
22504
  skuCode?: string | null;
22465
22505
  /** @description
22466
22506
  * get default barcode type from inventory settings(/api/v1/settings/inventory/) if field value exist
22467
22507
  * - required when barcode is provided
22508
+ * - Not applicable for service items - always null for type=service
22468
22509
  * */
22469
22510
  barcodeType?: components["schemas"]["BarcodeTypeValues"] | null;
22470
- /** Barcode */
22511
+ /**
22512
+ * Barcode
22513
+ * @description if service show it as code instead of barcode
22514
+ */
22471
22515
  barcode?: string | null;
22472
22516
  type: components["schemas"]["ItemType"];
22473
22517
  /** @description
@@ -22523,21 +22567,45 @@ export interface components {
22523
22567
  * @default false
22524
22568
  */
22525
22569
  returnableItem: boolean;
22526
- /** Width */
22570
+ /**
22571
+ * Width
22572
+ * @description Not applicable for service items - always null for type=service
22573
+ */
22527
22574
  width?: number | null;
22528
- /** Widthunitofmeasure */
22575
+ /**
22576
+ * Widthunitofmeasure
22577
+ * @description Not applicable for service items - always null for type=service
22578
+ */
22529
22579
  widthUnitOfMeasure?: number | null;
22530
- /** Height */
22580
+ /**
22581
+ * Height
22582
+ * @description Not applicable for service items - always null for type=service
22583
+ */
22531
22584
  height?: number | null;
22532
- /** Heightunitofmeasure */
22585
+ /**
22586
+ * Heightunitofmeasure
22587
+ * @description Not applicable for service items - always null for type=service
22588
+ */
22533
22589
  heightUnitOfMeasure?: number | null;
22534
- /** Length */
22590
+ /**
22591
+ * Length
22592
+ * @description Not applicable for service items - always null for type=service
22593
+ */
22535
22594
  length?: number | null;
22536
- /** Lengthunitofmeasure */
22595
+ /**
22596
+ * Lengthunitofmeasure
22597
+ * @description Not applicable for service items - always null for type=service
22598
+ */
22537
22599
  lengthUnitOfMeasure?: number | null;
22538
- /** Weight */
22600
+ /**
22601
+ * Weight
22602
+ * @description Not applicable for service items - always null for type=service
22603
+ */
22539
22604
  weight?: number | null;
22540
- /** Weightunitofmeasure */
22605
+ /**
22606
+ * Weightunitofmeasure
22607
+ * @description Not applicable for service items - always null for type=service
22608
+ */
22541
22609
  weightUnitOfMeasure?: number | null;
22542
22610
  /**
22543
22611
  * Availableinpos
@@ -22578,17 +22646,23 @@ export interface components {
22578
22646
  defaultPurchasePriceCurrency?: number | null;
22579
22647
  /** Leadtime */
22580
22648
  leadTime?: string | null;
22581
- /** Minimumquantityorder */
22649
+ /**
22650
+ * Minimumquantityorder
22651
+ * @description Not applicable for service items - always null for type=service
22652
+ */
22582
22653
  minimumQuantityOrder?: number | null;
22583
22654
  /** Defaultpurchaseunitofmeasure */
22584
22655
  defaultPurchaseUnitOfMeasure?: number | null;
22585
- /** Minimumquantityinstock */
22656
+ /**
22657
+ * Minimumquantityinstock
22658
+ * @description Not applicable for service items - always null for type=service
22659
+ */
22586
22660
  minimumQuantityInStock?: number | null;
22587
22661
  /** Warrantyperiod */
22588
22662
  warrantyPeriod?: string | null;
22589
22663
  /**
22590
22664
  * Allownegativestock
22591
- * @description get default value from inventory settings(/api/v1/settings/inventory/)
22665
+ * @description Not applicable for service items - always null for type=service. Get default value from inventory settings(/api/v1/settings/inventory/)
22592
22666
  * @default false
22593
22667
  */
22594
22668
  allowNegativeStock: boolean;
@@ -22617,6 +22691,7 @@ export interface components {
22617
22691
  * @default false
22618
22692
  */
22619
22693
  isInventoryTracked: boolean | null;
22694
+ /** @description Not applicable for service items - always null for type=service */
22620
22695
  trackInventoryBy?: components["schemas"]["TrackInventoryBy"] | null;
22621
22696
  /**
22622
22697
  * Hasexpirydate
@@ -22655,7 +22730,7 @@ export interface components {
22655
22730
  commissionCalculation?: components["schemas"]["ItemCommissionCalculation"];
22656
22731
  /**
22657
22732
  * Packages
22658
- * @description package and unit of measure should be unique
22733
+ * @description Not applicable for service items - always empty list for type=service. Package and unit of measure should be unique
22659
22734
  */
22660
22735
  packages: components["schemas"]["CreateOrUpdatePackageItemSchema"][];
22661
22736
  /**
@@ -22738,11 +22813,17 @@ export interface components {
22738
22813
  active?: boolean | null;
22739
22814
  /** Description */
22740
22815
  description?: string | null;
22741
- /** Skucode */
22816
+ /**
22817
+ * Skucode
22818
+ * @description Not applicable for service items - always null for type=service
22819
+ */
22742
22820
  skuCode?: string | null;
22743
- /** @description get default barcode type from inventory settings(/api/v1/settings/inventory/) if field value exist */
22821
+ /** @description Get default barcode type from inventory settings(/api/v1/settings/inventory/) if field value exist */
22744
22822
  barcodeType?: components["schemas"]["BarcodeTypeValues"] | null;
22745
- /** Barcode */
22823
+ /**
22824
+ * Barcode
22825
+ * @description if barcode type is not set then barcode should be null
22826
+ */
22746
22827
  barcode?: string | null;
22747
22828
  type?: components["schemas"]["ItemType"] | null;
22748
22829
  /** @description
@@ -22791,21 +22872,45 @@ export interface components {
22791
22872
  alternativeItems: components["schemas"]["AlternativeItemIsTwoWaysSchema"][];
22792
22873
  /** Returnableitem */
22793
22874
  returnableItem?: boolean | null;
22794
- /** Width */
22875
+ /**
22876
+ * Width
22877
+ * @description Not applicable for service items - always null for type=service
22878
+ */
22795
22879
  width?: number | null;
22796
- /** Widthunitofmeasure */
22880
+ /**
22881
+ * Widthunitofmeasure
22882
+ * @description Not applicable for service items - always null for type=service
22883
+ */
22797
22884
  widthUnitOfMeasure?: number | null;
22798
- /** Height */
22885
+ /**
22886
+ * Height
22887
+ * @description Not applicable for service items - always null for type=service
22888
+ */
22799
22889
  height?: number | null;
22800
- /** Heightunitofmeasure */
22890
+ /**
22891
+ * Heightunitofmeasure
22892
+ * @description Not applicable for service items - always null for type=service
22893
+ */
22801
22894
  heightUnitOfMeasure?: number | null;
22802
- /** Length */
22895
+ /**
22896
+ * Length
22897
+ * @description Not applicable for service items - always null for type=service
22898
+ */
22803
22899
  length?: number | null;
22804
- /** Lengthunitofmeasure */
22900
+ /**
22901
+ * Lengthunitofmeasure
22902
+ * @description Not applicable for service items - always null for type=service
22903
+ */
22805
22904
  lengthUnitOfMeasure?: number | null;
22806
- /** Weight */
22905
+ /**
22906
+ * Weight
22907
+ * @description Not applicable for service items - always null for type=service
22908
+ */
22807
22909
  weight?: number | null;
22808
- /** Weightunitofmeasure */
22910
+ /**
22911
+ * Weightunitofmeasure
22912
+ * @description Not applicable for service items - always null for type=service
22913
+ */
22809
22914
  weightUnitOfMeasure?: number | null;
22810
22915
  /** Availableinpos */
22811
22916
  availableInPos?: boolean | null;
@@ -22840,17 +22945,23 @@ export interface components {
22840
22945
  defaultPurchasePriceCurrency?: number | null;
22841
22946
  /** Leadtime */
22842
22947
  leadTime?: string | null;
22843
- /** Minimumquantityorder */
22948
+ /**
22949
+ * Minimumquantityorder
22950
+ * @description Not applicable for service items - always null for type=service
22951
+ */
22844
22952
  minimumQuantityOrder?: number | null;
22845
22953
  /** Defaultpurchaseunitofmeasure */
22846
22954
  defaultPurchaseUnitOfMeasure?: number | null;
22847
- /** Minimumquantityinstock */
22955
+ /**
22956
+ * Minimumquantityinstock
22957
+ * @description Not applicable for service items - always null for type=service
22958
+ */
22848
22959
  minimumQuantityInStock?: number | null;
22849
22960
  /** Warrantyperiod */
22850
22961
  warrantyPeriod?: string | null;
22851
22962
  /**
22852
22963
  * Allownegativestock
22853
- * @description get default value from inventory settings(/api/v1/settings/inventory/)
22964
+ * @description Not applicable for service items - always null for type=service. Get default value from inventory settings(/api/v1/settings/inventory/)
22854
22965
  */
22855
22966
  allowNegativeStock?: boolean | null;
22856
22967
  /** Autoreorder */
@@ -22875,6 +22986,7 @@ export interface components {
22875
22986
  * @default false
22876
22987
  */
22877
22988
  isInventoryTracked: boolean | null;
22989
+ /** @description Not applicable for service items - always null for type=service */
22878
22990
  trackInventoryBy?: components["schemas"]["TrackInventoryBy"] | null;
22879
22991
  /**
22880
22992
  * Hasexpirydate
@@ -22904,7 +23016,7 @@ export interface components {
22904
23016
  alertDate?: number | null;
22905
23017
  /**
22906
23018
  * Packages
22907
- * @description package and unit of measure should be unique
23019
+ * @description Not applicable for service items - always empty list for type=service. Package and unit of measure should be unique
22908
23020
  * @default []
22909
23021
  */
22910
23022
  packages: components["schemas"]["CreateOrUpdatePackageItemSchema"][];
@@ -25805,7 +25917,8 @@ export interface components {
25805
25917
  /**
25806
25918
  * Item
25807
25919
  * @description
25808
- * - /api/v1/inventory/items/ and filter by active=true
25920
+ * - /api/v1/inventory/items/ and filter by active=true and type=product
25921
+ * - Service items (type=service) are not allowed in stock adjustments
25809
25922
  *
25810
25923
  */
25811
25924
  item: number;
@@ -25955,7 +26068,8 @@ export interface components {
25955
26068
  /**
25956
26069
  * Item
25957
26070
  * @description
25958
- * - /api/v1/inventory/items/ and filter by active=true
26071
+ * - /api/v1/inventory/items/ and filter by active=true and type=product
26072
+ * - Service items (type=service) are not allowed in stock adjustments
25959
26073
  *
25960
26074
  */
25961
26075
  item: number;
@@ -26111,7 +26225,8 @@ export interface components {
26111
26225
  /**
26112
26226
  * Item
26113
26227
  * @description
26114
- * - get active items only, use route /api/v1/inventory/items/ and filter by active=true
26228
+ * - get active items only, use route /api/v1/inventory/items/ and filter by active=true and type=product
26229
+ * - Service items (type=service) are not allowed in opening stock
26115
26230
  *
26116
26231
  */
26117
26232
  item: number;
@@ -26266,7 +26381,8 @@ export interface components {
26266
26381
  /**
26267
26382
  * Item
26268
26383
  * @description
26269
- * - get active items only, use route /api/v1/inventory/items/ and filter by active=true
26384
+ * - get active items only, use route /api/v1/inventory/items/ and filter by active=true and type=product
26385
+ * - Service items (type=service) are not allowed in opening stock
26270
26386
  *
26271
26387
  */
26272
26388
  item: number;
@@ -26369,7 +26485,8 @@ export interface components {
26369
26485
  /**
26370
26486
  * Item
26371
26487
  * @description
26372
- * - Select only active items
26488
+ * - Select only active items with type=product
26489
+ * - Service items (type=service) are not allowed in internal transfers
26373
26490
  * - Check item availability in source warehouse
26374
26491
  * - Get item's tracking method for validation rules
26375
26492
  *
@@ -26511,7 +26628,8 @@ export interface components {
26511
26628
  /**
26512
26629
  * Item
26513
26630
  * @description
26514
- * - Select only active items
26631
+ * - Select only active items with type=product
26632
+ * - Service items (type=service) are not allowed in internal transfers
26515
26633
  * - Check item availability in source warehouse
26516
26634
  * - Get item's tracking method for validation rules
26517
26635
  *
@@ -37460,7 +37578,13 @@ export interface components {
37460
37578
  * @description ID of the goods receipt item (for update only)
37461
37579
  */
37462
37580
  id?: string | null;
37463
- /** Item */
37581
+ /**
37582
+ * Item
37583
+ * @description
37584
+ * - if from purchase invoice or order, items of purchase invoice or order should be filtered by the ones with items of type=product`
37585
+ * - Service items (type=service) are not allowed in goods receipt notes
37586
+ *
37587
+ */
37464
37588
  item: number;
37465
37589
  /**
37466
37590
  * Unitofmeasure
@@ -46355,6 +46479,7 @@ export interface components {
46355
46479
  * Format: date
46356
46480
  */
46357
46481
  date: string;
46482
+ warehouse: components["schemas"]["WarehouseSummaryInfo"] | null;
46358
46483
  /** Description */
46359
46484
  description: string | null;
46360
46485
  /** Notes */
@@ -46434,6 +46559,7 @@ export interface components {
46434
46559
  * - isDeferred equals to false
46435
46560
  * - status equals to posted or submitted
46436
46561
  * - approval status equals to approved or not_required
46562
+ * - warehouse equals to {warehouse-id} if exist
46437
46563
  * */
46438
46564
  salesInvoice: components["schemas"]["SalesInvoiceForReturnInvoiceCreateSchema"];
46439
46565
  /**
@@ -46559,6 +46685,7 @@ export interface components {
46559
46685
  * Format: date
46560
46686
  */
46561
46687
  date: string;
46688
+ warehouse: components["schemas"]["WarehouseSummaryInfo"] | null;
46562
46689
  /** Description */
46563
46690
  description: string | null;
46564
46691
  /** Notes */
@@ -47593,7 +47720,11 @@ export interface components {
47593
47720
  id?: string | null;
47594
47721
  /**
47595
47722
  * Item
47596
- * @description If there is a linked invoice or order in the GDN, the item should be associated with that specific invoice or order.
47723
+ * @description
47724
+ * - If there is a linked invoice or order in the GDN, the item should be associated with that specific invoice or order
47725
+ * - if from sales invoice or order, items of sales invoice or order should be filtered by the ones with items of type=product`
47726
+ * - Service items (type=service) are not allowed in goods delivery notes
47727
+ *
47597
47728
  */
47598
47729
  item: number;
47599
47730
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@erp-galoper/types",
3
- "version": "1.0.1039",
3
+ "version": "1.0.1041",
4
4
  "main": "openapi.ts",
5
5
  "types": "openapi.ts",
6
6
  "files": ["openapi.ts"],