@erp-galoper/types 1.0.1747 → 1.0.1748
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 +414 -138
- package/package.json +1 -1
package/openapi.ts
CHANGED
|
@@ -635,6 +635,7 @@ export interface paths {
|
|
|
635
635
|
* - itemCreated
|
|
636
636
|
* - 400:
|
|
637
637
|
* - invalidParameters
|
|
638
|
+
* - nameConflict
|
|
638
639
|
* - skuCodeConflict
|
|
639
640
|
* - barcodeConflict
|
|
640
641
|
* - itemDoesNotExist
|
|
@@ -689,6 +690,7 @@ export interface paths {
|
|
|
689
690
|
* - itemsImported
|
|
690
691
|
* - 400:
|
|
691
692
|
* - invalidParameters
|
|
693
|
+
* - nameConflict
|
|
692
694
|
* - skuCodeConflict
|
|
693
695
|
* - barcodeConflict
|
|
694
696
|
* - itemDoesNotExist
|
|
@@ -725,6 +727,40 @@ export interface paths {
|
|
|
725
727
|
patch?: never;
|
|
726
728
|
trace?: never;
|
|
727
729
|
};
|
|
730
|
+
"/api/v1/inventory/items/bulk-update": {
|
|
731
|
+
parameters: {
|
|
732
|
+
query?: never;
|
|
733
|
+
header?: never;
|
|
734
|
+
path?: never;
|
|
735
|
+
cookie?: never;
|
|
736
|
+
};
|
|
737
|
+
get?: never;
|
|
738
|
+
put?: never;
|
|
739
|
+
post?: never;
|
|
740
|
+
delete?: never;
|
|
741
|
+
options?: never;
|
|
742
|
+
head?: never;
|
|
743
|
+
/**
|
|
744
|
+
* Bulk Update Items
|
|
745
|
+
* @description Bulk update items using the same patch fields as update item.
|
|
746
|
+
*
|
|
747
|
+
* Example:
|
|
748
|
+
* [
|
|
749
|
+
* {
|
|
750
|
+
* "id": 1,
|
|
751
|
+
* "shortName": "Prod A",
|
|
752
|
+
* "skuCode": "SKU-001",
|
|
753
|
+
* "purchasePrice": 10,
|
|
754
|
+
* "defaultSellingPrice": 15,
|
|
755
|
+
* "transactionalGroup": 2,
|
|
756
|
+
* "allowSales": true,
|
|
757
|
+
* "hasExpiryDate": true
|
|
758
|
+
* }
|
|
759
|
+
* ]
|
|
760
|
+
*/
|
|
761
|
+
patch: operations["inventory_item_views_bulk_update_items"];
|
|
762
|
+
trace?: never;
|
|
763
|
+
};
|
|
728
764
|
"/api/v1/inventory/items/{id}/": {
|
|
729
765
|
parameters: {
|
|
730
766
|
query?: never;
|
|
@@ -765,6 +801,7 @@ export interface paths {
|
|
|
765
801
|
* - 400:
|
|
766
802
|
* - invalidParameters
|
|
767
803
|
* - nothingToChange
|
|
804
|
+
* - nameConflict
|
|
768
805
|
* - skuCodeConflict
|
|
769
806
|
* - barcodeConflict
|
|
770
807
|
* - itemDoesNotExist
|
|
@@ -20003,6 +20040,11 @@ export interface paths {
|
|
|
20003
20040
|
* The report provides real-time insights into the quantity of each item currently in stock,
|
|
20004
20041
|
* on order, committed to sales, and expected from suppliers.
|
|
20005
20042
|
*
|
|
20043
|
+
* showItemsWith options:
|
|
20044
|
+
* - all: Show all items (default)
|
|
20045
|
+
* - excludeZeroQty: Exclude items with zero total stock quantity
|
|
20046
|
+
* - zeroQtyOnly: Only items with zero total stock quantity
|
|
20047
|
+
*
|
|
20006
20048
|
* Responses:
|
|
20007
20049
|
* - 200: Item Availability Report results
|
|
20008
20050
|
* - 400: "invalidFilterFormat"
|
|
@@ -20031,20 +20073,11 @@ export interface paths {
|
|
|
20031
20073
|
};
|
|
20032
20074
|
/**
|
|
20033
20075
|
* Get Inventory Valuation Report
|
|
20034
|
-
* @description Generate an Inventory Valuation Report as of a specific
|
|
20076
|
+
* @description Generate an Inventory Valuation Report as of a specific date.
|
|
20035
20077
|
*
|
|
20036
20078
|
* The report calculates the total monetary value of inventory stock on hand
|
|
20037
|
-
* by applying cost calculation to net movements from ItemMovement records
|
|
20038
|
-
*
|
|
20039
|
-
* **Period Types:**
|
|
20040
|
-
* - all: All historical movements up to now
|
|
20041
|
-
* - this_fiscal_year: Current fiscal year end
|
|
20042
|
-
* - last_fiscal_year: Previous fiscal year end
|
|
20043
|
-
* - this_month: End of current month
|
|
20044
|
-
* - last_month: End of previous month
|
|
20045
|
-
* - this_quarter: End of current fiscal quarter
|
|
20046
|
-
* - last_quarter: End of previous fiscal quarter
|
|
20047
|
-
* - today: Current date
|
|
20079
|
+
* by applying cost calculation to net movements from ItemMovement records
|
|
20080
|
+
* up to and including the as-of date.
|
|
20048
20081
|
*
|
|
20049
20082
|
* **Filters:**
|
|
20050
20083
|
* - branches: Filter by specific branch(es)
|
|
@@ -20059,14 +20092,14 @@ export interface paths {
|
|
|
20059
20092
|
*
|
|
20060
20093
|
* **Responses:**
|
|
20061
20094
|
* - 200: Inventory Valuation Report with total value and item breakdown
|
|
20062
|
-
* - 400: "
|
|
20095
|
+
* - 400: "invalidAsOfDate"
|
|
20063
20096
|
* - "paginationError"
|
|
20064
20097
|
* - 403: "permissionDenied"
|
|
20065
20098
|
* - "noModuleAccess"
|
|
20066
20099
|
* - "noBranchAccess"
|
|
20067
20100
|
* - 500: "serverError"
|
|
20068
20101
|
*
|
|
20069
|
-
* **Permission key:**
|
|
20102
|
+
* **Permission key:** valuationreport: ["view"]
|
|
20070
20103
|
*/
|
|
20071
20104
|
get: operations["reports_inventoryreport_views_get_inventory_valuation_report"];
|
|
20072
20105
|
put?: never;
|
|
@@ -24000,6 +24033,12 @@ export interface components {
|
|
|
24000
24033
|
* @default []
|
|
24001
24034
|
*/
|
|
24002
24035
|
profitandloss: components["schemas"]["BasePermissionsSchema_Report_Accounting_ProfitandlossEnum"][];
|
|
24036
|
+
/**
|
|
24037
|
+
* Transactions Report
|
|
24038
|
+
* @description transactions_report actions
|
|
24039
|
+
* @default []
|
|
24040
|
+
*/
|
|
24041
|
+
transactions_report: components["schemas"]["BasePermissionsSchema_Report_Accounting_Transactions_reportEnum"][];
|
|
24003
24042
|
/**
|
|
24004
24043
|
* Trialbalance
|
|
24005
24044
|
* @description trialbalance actions
|
|
@@ -24012,6 +24051,12 @@ export interface components {
|
|
|
24012
24051
|
* @default []
|
|
24013
24052
|
*/
|
|
24014
24053
|
statementofaccount: string[];
|
|
24054
|
+
/**
|
|
24055
|
+
* Transactionsreport
|
|
24056
|
+
* @description transactionsreport actions
|
|
24057
|
+
* @default []
|
|
24058
|
+
*/
|
|
24059
|
+
transactionsreport: string[];
|
|
24015
24060
|
};
|
|
24016
24061
|
/**
|
|
24017
24062
|
* BasePermissionsSchema_Report_Accounting_AccountstatementEnum
|
|
@@ -24038,6 +24083,11 @@ export interface components {
|
|
|
24038
24083
|
* @enum {string}
|
|
24039
24084
|
*/
|
|
24040
24085
|
BasePermissionsSchema_Report_Accounting_ProfitandlossEnum: "export" | "view";
|
|
24086
|
+
/**
|
|
24087
|
+
* BasePermissionsSchema_Report_Accounting_Transactions_reportEnum
|
|
24088
|
+
* @enum {string}
|
|
24089
|
+
*/
|
|
24090
|
+
BasePermissionsSchema_Report_Accounting_Transactions_reportEnum: "export" | "print" | "view";
|
|
24041
24091
|
/**
|
|
24042
24092
|
* BasePermissionsSchema_Report_Accounting_TrialbalanceEnum
|
|
24043
24093
|
* @enum {string}
|
|
@@ -24116,6 +24166,12 @@ export interface components {
|
|
|
24116
24166
|
* @default []
|
|
24117
24167
|
*/
|
|
24118
24168
|
stockreport: components["schemas"]["BasePermissionsSchema_Report_Inventory_StockreportEnum"][];
|
|
24169
|
+
/**
|
|
24170
|
+
* Valuationreport
|
|
24171
|
+
* @description valuationreport actions
|
|
24172
|
+
* @default []
|
|
24173
|
+
*/
|
|
24174
|
+
valuationreport: components["schemas"]["BasePermissionsSchema_Report_Inventory_ValuationreportEnum"][];
|
|
24119
24175
|
};
|
|
24120
24176
|
/**
|
|
24121
24177
|
* BasePermissionsSchema_Report_Inventory_ItemavailabilityreportEnum
|
|
@@ -24132,6 +24188,11 @@ export interface components {
|
|
|
24132
24188
|
* @constant
|
|
24133
24189
|
*/
|
|
24134
24190
|
BasePermissionsSchema_Report_Inventory_StockreportEnum: "view";
|
|
24191
|
+
/**
|
|
24192
|
+
* BasePermissionsSchema_Report_Inventory_ValuationreportEnum
|
|
24193
|
+
* @enum {string}
|
|
24194
|
+
*/
|
|
24195
|
+
BasePermissionsSchema_Report_Inventory_ValuationreportEnum: "export" | "view";
|
|
24135
24196
|
/** BasePermissionsSchema_Report_Pos */
|
|
24136
24197
|
BasePermissionsSchema_Report_Pos: {
|
|
24137
24198
|
/**
|
|
@@ -25990,6 +26051,11 @@ export interface components {
|
|
|
25990
26051
|
* @constant
|
|
25991
26052
|
*/
|
|
25992
26053
|
ItemIncludeOption: "opening_stock";
|
|
26054
|
+
/**
|
|
26055
|
+
* ItemSearchMode
|
|
26056
|
+
* @enum {string}
|
|
26057
|
+
*/
|
|
26058
|
+
ItemSearchMode: "contains" | "startswith" | "endswith" | "exact" | "similar";
|
|
25993
26059
|
/**
|
|
25994
26060
|
* ItemSortBy
|
|
25995
26061
|
* @enum {string}
|
|
@@ -26211,7 +26277,7 @@ export interface components {
|
|
|
26211
26277
|
/** Lastpurchasedprice */
|
|
26212
26278
|
lastPurchasedPrice?: number | string | null;
|
|
26213
26279
|
/** Lastpurchasedpricecurrency */
|
|
26214
|
-
lastPurchasedPriceCurrency
|
|
26280
|
+
lastPurchasedPriceCurrency?: number | null;
|
|
26215
26281
|
};
|
|
26216
26282
|
/** ItemSchema */
|
|
26217
26283
|
ItemSchema: {
|
|
@@ -26362,11 +26428,19 @@ export interface components {
|
|
|
26362
26428
|
/** Maxdiscountsales */
|
|
26363
26429
|
maxDiscountSales: number | null;
|
|
26364
26430
|
defaultSaleUnitOfMeasure: components["schemas"]["UnitOfMeasureSchema"] | null;
|
|
26365
|
-
/**
|
|
26431
|
+
/**
|
|
26432
|
+
* Defaultsellingprice
|
|
26433
|
+
* @description When retrieving an item for sales features, send companyRate, secondaryRate, and customerId as query params on /api/v1/inventory/items/{id}/. The value is converted to the customer currency using the same rules documented on sales document unitPrice fields.
|
|
26434
|
+
*/
|
|
26366
26435
|
defaultSellingPrice: number | null;
|
|
26436
|
+
/** @description Currency of defaultSellingPrice after conversion when customerId is provided on item retrieval; otherwise the stored default selling price currency. */
|
|
26367
26437
|
defaultSellingPriceCurrency?: components["schemas"]["CurrencySummaryInfo"] | null;
|
|
26368
|
-
/**
|
|
26438
|
+
/**
|
|
26439
|
+
* Purchaseprice
|
|
26440
|
+
* @description When retrieving an item for purchase features, send companyRate, secondaryRate, and supplierId as query params on /api/v1/inventory/items/{id}/. The value is converted to the supplier currency using the same rules documented on purchase document unitPrice fields.
|
|
26441
|
+
*/
|
|
26369
26442
|
purchasePrice: number | null;
|
|
26443
|
+
/** @description Currency of purchasePrice after conversion when supplierId is provided on item retrieval; otherwise the stored default purchase price currency. */
|
|
26370
26444
|
defaultPurchasePriceCurrency?: components["schemas"]["CurrencySummaryInfo"] | null;
|
|
26371
26445
|
/** Leadtime */
|
|
26372
26446
|
leadTime?: string | null;
|
|
@@ -26619,11 +26693,19 @@ export interface components {
|
|
|
26619
26693
|
/** Maxdiscountsales */
|
|
26620
26694
|
maxDiscountSales: number | null;
|
|
26621
26695
|
defaultSaleUnitOfMeasure: components["schemas"]["UnitOfMeasureSchema"] | null;
|
|
26622
|
-
/**
|
|
26696
|
+
/**
|
|
26697
|
+
* Defaultsellingprice
|
|
26698
|
+
* @description When retrieving an item for sales features, send companyRate, secondaryRate, and customerId as query params on /api/v1/inventory/items/{id}/. The value is converted to the customer currency using the same rules documented on sales document unitPrice fields.
|
|
26699
|
+
*/
|
|
26623
26700
|
defaultSellingPrice: number | null;
|
|
26701
|
+
/** @description Currency of defaultSellingPrice after conversion when customerId is provided on item retrieval; otherwise the stored default selling price currency. */
|
|
26624
26702
|
defaultSellingPriceCurrency?: components["schemas"]["CurrencySummaryInfo"] | null;
|
|
26625
|
-
/**
|
|
26703
|
+
/**
|
|
26704
|
+
* Purchaseprice
|
|
26705
|
+
* @description When retrieving an item for purchase features, send companyRate, secondaryRate, and supplierId as query params on /api/v1/inventory/items/{id}/. The value is converted to the supplier currency using the same rules documented on purchase document unitPrice fields.
|
|
26706
|
+
*/
|
|
26626
26707
|
purchasePrice: number | null;
|
|
26708
|
+
/** @description Currency of purchasePrice after conversion when supplierId is provided on item retrieval; otherwise the stored default purchase price currency. */
|
|
26627
26709
|
defaultPurchasePriceCurrency?: components["schemas"]["CurrencySummaryInfo"] | null;
|
|
26628
26710
|
/** Leadtime */
|
|
26629
26711
|
leadTime?: string | null;
|
|
@@ -27641,6 +27723,106 @@ export interface components {
|
|
|
27641
27723
|
*/
|
|
27642
27724
|
unitOfMeasure: number;
|
|
27643
27725
|
};
|
|
27726
|
+
/** BulkUpdateItemsResponse */
|
|
27727
|
+
BulkUpdateItemsResponse: {
|
|
27728
|
+
/** Message */
|
|
27729
|
+
message: string;
|
|
27730
|
+
/** Code */
|
|
27731
|
+
code: string;
|
|
27732
|
+
/** Updatedcount */
|
|
27733
|
+
updatedCount: number;
|
|
27734
|
+
};
|
|
27735
|
+
/** BulkUpdateItemEntrySchema */
|
|
27736
|
+
BulkUpdateItemEntrySchema: {
|
|
27737
|
+
/** Shortname */
|
|
27738
|
+
shortName?: string | null;
|
|
27739
|
+
/** Skucode */
|
|
27740
|
+
skuCode?: string | null;
|
|
27741
|
+
/**
|
|
27742
|
+
* Barcodes
|
|
27743
|
+
* @description list of barcodes with type and code
|
|
27744
|
+
* @default []
|
|
27745
|
+
*/
|
|
27746
|
+
barcodes: components["schemas"]["UpdateBarcodeSchema"][];
|
|
27747
|
+
/** Active */
|
|
27748
|
+
active?: boolean | null;
|
|
27749
|
+
/** Family */
|
|
27750
|
+
family?: number | null;
|
|
27751
|
+
/** Brand */
|
|
27752
|
+
brand?: number | null;
|
|
27753
|
+
/**
|
|
27754
|
+
* Categories
|
|
27755
|
+
* @description get categories from api/v1/inventory/categories/?type=item
|
|
27756
|
+
* @default []
|
|
27757
|
+
*/
|
|
27758
|
+
categories: number[];
|
|
27759
|
+
/**
|
|
27760
|
+
* Tags
|
|
27761
|
+
* @default []
|
|
27762
|
+
*/
|
|
27763
|
+
tags: number[] | null;
|
|
27764
|
+
/**
|
|
27765
|
+
* Specs
|
|
27766
|
+
* @default []
|
|
27767
|
+
*/
|
|
27768
|
+
specs: number[];
|
|
27769
|
+
/**
|
|
27770
|
+
* Taxes
|
|
27771
|
+
* @default []
|
|
27772
|
+
*/
|
|
27773
|
+
taxes: number[];
|
|
27774
|
+
/** Transactionalgroup */
|
|
27775
|
+
transactionalGroup?: number | null;
|
|
27776
|
+
/** Allowsales */
|
|
27777
|
+
allowSales?: boolean | null;
|
|
27778
|
+
/** Maxdiscountsales */
|
|
27779
|
+
maxDiscountSales?: number | null;
|
|
27780
|
+
/** Defaultsellingprice */
|
|
27781
|
+
defaultSellingPrice?: number | null;
|
|
27782
|
+
/** Defaultsellingpricecurrency */
|
|
27783
|
+
defaultSellingPriceCurrency?: number | null;
|
|
27784
|
+
/** Purchaseprice */
|
|
27785
|
+
purchasePrice?: number | null;
|
|
27786
|
+
/** Defaultpurchasepricecurrency */
|
|
27787
|
+
defaultPurchasePriceCurrency?: number | null;
|
|
27788
|
+
/** Minimumquantityorder */
|
|
27789
|
+
minimumQuantityOrder?: number | null;
|
|
27790
|
+
/** Isexchangeable */
|
|
27791
|
+
isExchangeable?: boolean | null;
|
|
27792
|
+
/** Hasexpirydate */
|
|
27793
|
+
hasExpiryDate?: boolean | null;
|
|
27794
|
+
/** Returnableitem */
|
|
27795
|
+
returnableItem?: boolean | null;
|
|
27796
|
+
/**
|
|
27797
|
+
* Allownegativestock
|
|
27798
|
+
* @description Cannot be enabled for items tracked by serial number or batch
|
|
27799
|
+
*/
|
|
27800
|
+
allowNegativeStock?: boolean | null;
|
|
27801
|
+
/** Id */
|
|
27802
|
+
id: number;
|
|
27803
|
+
};
|
|
27804
|
+
/** UpdateBarcodeSchema */
|
|
27805
|
+
UpdateBarcodeSchema: {
|
|
27806
|
+
/**
|
|
27807
|
+
* Id
|
|
27808
|
+
* Format: uuid
|
|
27809
|
+
*/
|
|
27810
|
+
id?: string;
|
|
27811
|
+
/**
|
|
27812
|
+
* @description get default barcode type from inventory settings(/api/v1/settings/inventory/) if field value exist
|
|
27813
|
+
* - required when barcode is provided
|
|
27814
|
+
* - Not applicable for service items - always null for type=service
|
|
27815
|
+
*/
|
|
27816
|
+
barcodeType: components["schemas"]["BarcodeTypeValues"];
|
|
27817
|
+
/** Barcode */
|
|
27818
|
+
barcode: string;
|
|
27819
|
+
/**
|
|
27820
|
+
* Default
|
|
27821
|
+
* @description Whether this is the default barcode
|
|
27822
|
+
* @default false
|
|
27823
|
+
*/
|
|
27824
|
+
default: boolean;
|
|
27825
|
+
};
|
|
27644
27826
|
/** DeleteItemSchema */
|
|
27645
27827
|
DeleteItemSchema: {
|
|
27646
27828
|
/** Id */
|
|
@@ -27940,28 +28122,6 @@ export interface components {
|
|
|
27940
28122
|
*/
|
|
27941
28123
|
inventoryMovementMethod?: components["schemas"]["INVENTORY_MOVEMENT_METHOD"] | null;
|
|
27942
28124
|
};
|
|
27943
|
-
/** UpdateBarcodeSchema */
|
|
27944
|
-
UpdateBarcodeSchema: {
|
|
27945
|
-
/**
|
|
27946
|
-
* Id
|
|
27947
|
-
* Format: uuid
|
|
27948
|
-
*/
|
|
27949
|
-
id?: string;
|
|
27950
|
-
/**
|
|
27951
|
-
* @description get default barcode type from inventory settings(/api/v1/settings/inventory/) if field value exist
|
|
27952
|
-
* - required when barcode is provided
|
|
27953
|
-
* - Not applicable for service items - always null for type=service
|
|
27954
|
-
*/
|
|
27955
|
-
barcodeType: components["schemas"]["BarcodeTypeValues"];
|
|
27956
|
-
/** Barcode */
|
|
27957
|
-
barcode: string;
|
|
27958
|
-
/**
|
|
27959
|
-
* Default
|
|
27960
|
-
* @description Whether this is the default barcode
|
|
27961
|
-
* @default false
|
|
27962
|
-
*/
|
|
27963
|
-
default: boolean;
|
|
27964
|
-
};
|
|
27965
28125
|
/** UpdateChildrenItemSchema */
|
|
27966
28126
|
UpdateChildrenItemSchema: {
|
|
27967
28127
|
/**
|
|
@@ -29266,7 +29426,7 @@ export interface components {
|
|
|
29266
29426
|
* TransactionTypesSchema
|
|
29267
29427
|
* @enum {string}
|
|
29268
29428
|
*/
|
|
29269
|
-
TransactionTypesSchema: "journalVoucher" | "salesInvoice" | "downPaymentItem" | "receiptVoucher" | "salesReturnInvoice" | "returnCreditNote" | "purchaseInvoice" | "paymentVoucher" | "purchaseReturnInvoice" | "returnDebitNote" | "advancePaymentItems" | "Expense" | "openingBalance" | "posInvoice" | "posSession" | "salesCreditNote" | "purchaseCreditNote" | "expenseVoucher" | "closingCommission" | "commissionPayout" | "salesRefundVoucherItem" | "refundVoucherItem" | "receiptVoucherItem" | "paymentVoucherItem" | "expensePaymentVoucherItem";
|
|
29429
|
+
TransactionTypesSchema: "journalVoucher" | "journalVoucherItems" | "salesInvoice" | "downPaymentItem" | "receiptVoucher" | "salesReturnInvoice" | "returnCreditNote" | "purchaseInvoice" | "paymentVoucher" | "purchaseReturnInvoice" | "returnDebitNote" | "advancePaymentItems" | "Expense" | "openingBalance" | "posInvoice" | "posSession" | "salesCreditNote" | "purchaseCreditNote" | "expenseVoucher" | "closingCommission" | "commissionPayout" | "salesRefundVoucherItem" | "refundVoucherItem" | "receiptVoucherItem" | "paymentVoucherItem" | "expensePaymentVoucherItem";
|
|
29270
29430
|
/**
|
|
29271
29431
|
* DocumentType
|
|
29272
29432
|
* @enum {string}
|
|
@@ -30050,12 +30210,19 @@ export interface components {
|
|
|
30050
30210
|
defaultCostStrategy?: components["schemas"]["CostStrategy"] | null;
|
|
30051
30211
|
/** Pdfdocumentfooter */
|
|
30052
30212
|
pdfDocumentFooter?: string;
|
|
30213
|
+
/** @description visible when inventory module is on */
|
|
30214
|
+
stockUpdateTrigger: components["schemas"]["StockUpdateTrigger"];
|
|
30053
30215
|
};
|
|
30054
30216
|
/**
|
|
30055
30217
|
* HistoricalCostType
|
|
30056
30218
|
* @enum {string}
|
|
30057
30219
|
*/
|
|
30058
30220
|
HistoricalCostType: "purchaseOrder" | "purchaseInvoice";
|
|
30221
|
+
/**
|
|
30222
|
+
* StockUpdateTrigger
|
|
30223
|
+
* @enum {string}
|
|
30224
|
+
*/
|
|
30225
|
+
StockUpdateTrigger: "invoice" | "goods_note";
|
|
30059
30226
|
/** UpdateInventorySetting */
|
|
30060
30227
|
UpdateInventorySetting: {
|
|
30061
30228
|
barCodeType?: components["schemas"]["BarcodeType"] | null;
|
|
@@ -30083,6 +30250,8 @@ export interface components {
|
|
|
30083
30250
|
defaultCostStrategy?: components["schemas"]["CostStrategy"] | null;
|
|
30084
30251
|
/** Pdfdocumentfooter */
|
|
30085
30252
|
pdfDocumentFooter?: string;
|
|
30253
|
+
/** @description visible when inventory module is on */
|
|
30254
|
+
stockUpdateTrigger: components["schemas"]["StockUpdateTrigger"];
|
|
30086
30255
|
};
|
|
30087
30256
|
/**
|
|
30088
30257
|
* HistoricalCostTypeInRetrieve
|
|
@@ -30124,6 +30293,12 @@ export interface components {
|
|
|
30124
30293
|
defaultCostStrategy?: components["schemas"]["GetCostStrategy"] | null;
|
|
30125
30294
|
/** Pdfdocumentfooter */
|
|
30126
30295
|
pdfDocumentFooter: string | null;
|
|
30296
|
+
/**
|
|
30297
|
+
* @description - when updating from goods_note to invoice,
|
|
30298
|
+
* user should be warned that tracking of inventory for all items will be considered as quantity
|
|
30299
|
+
* and goods notes will be auto generated from all new invoices
|
|
30300
|
+
*/
|
|
30301
|
+
stockUpdateTrigger: components["schemas"]["StockUpdateTrigger"];
|
|
30127
30302
|
};
|
|
30128
30303
|
/** ItemVariationsResponse */
|
|
30129
30304
|
ItemVariationsResponse: {
|
|
@@ -30626,12 +30801,6 @@ export interface components {
|
|
|
30626
30801
|
endBusinessHour: string;
|
|
30627
30802
|
/** Allowratechange */
|
|
30628
30803
|
allowRateChange: boolean;
|
|
30629
|
-
/**
|
|
30630
|
-
* @description - when updating from goods_note to invoice,
|
|
30631
|
-
* user should be warned that tracking of inventory for all items will be considered as quantity
|
|
30632
|
-
* and goods notes will be auto generated from all new invoices
|
|
30633
|
-
*/
|
|
30634
|
-
stockUpdateTrigger: components["schemas"]["StockUpdateTrigger"];
|
|
30635
30804
|
/**
|
|
30636
30805
|
* Usesecondarycurrency
|
|
30637
30806
|
* @description visible when multicurrency is True
|
|
@@ -30650,12 +30819,7 @@ export interface components {
|
|
|
30650
30819
|
* RoundingTypes
|
|
30651
30820
|
* @enum {string}
|
|
30652
30821
|
*/
|
|
30653
|
-
RoundingTypes: "
|
|
30654
|
-
/**
|
|
30655
|
-
* StockUpdateTrigger
|
|
30656
|
-
* @enum {string}
|
|
30657
|
-
*/
|
|
30658
|
-
StockUpdateTrigger: "invoice" | "goods_note";
|
|
30822
|
+
RoundingTypes: "halfExpand" | "halfTrunc" | "halfEven" | "expand" | "trunc" | "ceil" | "floor";
|
|
30659
30823
|
/** UpdateSystemSetting */
|
|
30660
30824
|
UpdateSystemSetting: {
|
|
30661
30825
|
/** Multicurrency */
|
|
@@ -30669,8 +30833,6 @@ export interface components {
|
|
|
30669
30833
|
endBusinessHour: string | null;
|
|
30670
30834
|
/** Allowratechange */
|
|
30671
30835
|
allowRateChange: boolean;
|
|
30672
|
-
/** @description visible when inventory module is on */
|
|
30673
|
-
stockUpdateTrigger: components["schemas"]["StockUpdateTrigger"];
|
|
30674
30836
|
/**
|
|
30675
30837
|
* Usesecondarycurrency
|
|
30676
30838
|
* @description visible when multicurrency is True
|
|
@@ -33857,9 +34019,14 @@ export interface components {
|
|
|
33857
34019
|
/** Accountnumber */
|
|
33858
34020
|
accountNumber: string;
|
|
33859
34021
|
accountType: components["schemas"]["AccountModelType"];
|
|
33860
|
-
|
|
33861
|
-
|
|
34022
|
+
type: components["schemas"]["AccountType"];
|
|
34023
|
+
currency: components["schemas"]["CurrencySummaryInfo"];
|
|
33862
34024
|
};
|
|
34025
|
+
/**
|
|
34026
|
+
* AccountType
|
|
34027
|
+
* @enum {string}
|
|
34028
|
+
*/
|
|
34029
|
+
AccountType: "accountStatement" | "customerStatement" | "supplierStatement" | "bankStatement" | "employeeStatement";
|
|
33863
34030
|
/** DocumentObjectSchema */
|
|
33864
34031
|
DocumentObjectSchema: {
|
|
33865
34032
|
/**
|
|
@@ -39004,7 +39171,12 @@ export interface components {
|
|
|
39004
39171
|
itemPackage?: string;
|
|
39005
39172
|
/**
|
|
39006
39173
|
* Estimatedcost
|
|
39007
|
-
* @description
|
|
39174
|
+
* @description - This field is a number.
|
|
39175
|
+
* - get cost using route /api/v1/inventory/items/{id}/ with required query params:
|
|
39176
|
+
* - companyRate if supplier currency is different than company currency, rate is taken from the document itself
|
|
39177
|
+
* - secondaryRate if supplier currency is different than secondary currency, rate is taken from the document itself
|
|
39178
|
+
* - supplierId = selected suggested supplier id when available
|
|
39179
|
+
* and read purchasePrice from the response
|
|
39008
39180
|
*/
|
|
39009
39181
|
estimatedCost?: number | string | null;
|
|
39010
39182
|
};
|
|
@@ -39188,7 +39360,12 @@ export interface components {
|
|
|
39188
39360
|
reasonForRestock: number | null;
|
|
39189
39361
|
/**
|
|
39190
39362
|
* Estimatedcost
|
|
39191
|
-
* @description
|
|
39363
|
+
* @description - This field is a number.
|
|
39364
|
+
* - get cost using route /api/v1/inventory/items/{id}/ with required query params:
|
|
39365
|
+
* - companyRate if supplier currency is different than company currency, rate is taken from the document itself
|
|
39366
|
+
* - secondaryRate if supplier currency is different than secondary currency, rate is taken from the document itself
|
|
39367
|
+
* - supplierId = selected suggested supplier id when available
|
|
39368
|
+
* and read purchasePrice from the response
|
|
39192
39369
|
*/
|
|
39193
39370
|
estimatedCost: number | string | null;
|
|
39194
39371
|
/**
|
|
@@ -39294,7 +39471,12 @@ export interface components {
|
|
|
39294
39471
|
reasonForRestock: number | null;
|
|
39295
39472
|
/**
|
|
39296
39473
|
* Estimatedcost
|
|
39297
|
-
* @description
|
|
39474
|
+
* @description - This field is a number.
|
|
39475
|
+
* - get cost using route /api/v1/inventory/items/{id}/ with required query params:
|
|
39476
|
+
* - companyRate if supplier currency is different than company currency, rate is taken from the document itself
|
|
39477
|
+
* - secondaryRate if supplier currency is different than secondary currency, rate is taken from the document itself
|
|
39478
|
+
* - supplierId = selected suggested supplier id when available
|
|
39479
|
+
* and read purchasePrice from the response
|
|
39298
39480
|
*/
|
|
39299
39481
|
estimatedCost: number | string | null;
|
|
39300
39482
|
/**
|
|
@@ -40563,7 +40745,16 @@ export interface components {
|
|
|
40563
40745
|
* - The quantity of the items, incase of package, it should be unitPackage * quantity of the package
|
|
40564
40746
|
*/
|
|
40565
40747
|
quantity?: number;
|
|
40566
|
-
/**
|
|
40748
|
+
/**
|
|
40749
|
+
* Unitprice
|
|
40750
|
+
* @description - This field is a number.
|
|
40751
|
+
* - Should be greater than zero.
|
|
40752
|
+
* - get price using route /api/v1/inventory/items/{id}/ with required query params:
|
|
40753
|
+
* - companyRate if supplier currency is different than company currency, rate is taken from the document itself
|
|
40754
|
+
* - secondaryRate if supplier currency is different than secondary currency, rate is taken from the document itself
|
|
40755
|
+
* - supplierId = selected supplier id
|
|
40756
|
+
* and read purchasePrice from the response
|
|
40757
|
+
*/
|
|
40567
40758
|
unitPrice: number;
|
|
40568
40759
|
/**
|
|
40569
40760
|
* Unitofmeasure
|
|
@@ -41393,7 +41584,16 @@ export interface components {
|
|
|
41393
41584
|
* - The quantity of the items, incase of package, it should be unitPackage * quantity of the package
|
|
41394
41585
|
*/
|
|
41395
41586
|
quantity?: number;
|
|
41396
|
-
/**
|
|
41587
|
+
/**
|
|
41588
|
+
* Unitprice
|
|
41589
|
+
* @description - This field is a number.
|
|
41590
|
+
* - Should be greater than zero.
|
|
41591
|
+
* - get price using route /api/v1/inventory/items/{id}/ with required query params:
|
|
41592
|
+
* - companyRate if supplier currency is different than company currency, rate is taken from the document itself
|
|
41593
|
+
* - secondaryRate if supplier currency is different than secondary currency, rate is taken from the document itself
|
|
41594
|
+
* - supplierId = selected supplier id
|
|
41595
|
+
* and read purchasePrice from the response
|
|
41596
|
+
*/
|
|
41397
41597
|
unitPrice: number;
|
|
41398
41598
|
/**
|
|
41399
41599
|
* Unitofmeasure
|
|
@@ -43018,7 +43218,7 @@ export interface components {
|
|
|
43018
43218
|
password: string | null;
|
|
43019
43219
|
/**
|
|
43020
43220
|
* Warehouse
|
|
43021
|
-
* @description call the user/me endpoint to get a list of warehouses,this field should be required and visible only incase of inventory is enabled and stock_update_trigger
|
|
43221
|
+
* @description call the user/me endpoint to get a list of warehouses,this field should be required and visible only incase of inventory is enabled and stock_update_trigger is invoice in InventorySettings
|
|
43022
43222
|
*/
|
|
43023
43223
|
warehouse: number | null;
|
|
43024
43224
|
/**
|
|
@@ -43072,7 +43272,13 @@ export interface components {
|
|
|
43072
43272
|
unitOfMeasurement?: number | null;
|
|
43073
43273
|
/**
|
|
43074
43274
|
* Unitprice
|
|
43075
|
-
* @description
|
|
43275
|
+
* @description - This field is a number.
|
|
43276
|
+
* - Should be greater than zero.
|
|
43277
|
+
* - get price using route /api/v1/inventory/items/{id}/ with required query params:
|
|
43278
|
+
* - companyRate if supplier currency is different than company currency, rate is taken from the document itself
|
|
43279
|
+
* - secondaryRate if supplier currency is different than secondary currency, rate is taken from the document itself
|
|
43280
|
+
* - supplierId = selected supplier id
|
|
43281
|
+
* and read purchasePrice from the response
|
|
43076
43282
|
*/
|
|
43077
43283
|
unitPrice: number;
|
|
43078
43284
|
/**
|
|
@@ -43134,7 +43340,16 @@ export interface components {
|
|
|
43134
43340
|
* @example 1
|
|
43135
43341
|
*/
|
|
43136
43342
|
unitOfMeasurement: number | null;
|
|
43137
|
-
/**
|
|
43343
|
+
/**
|
|
43344
|
+
* Unitprice
|
|
43345
|
+
* @description - This field is a number.
|
|
43346
|
+
* - Should be greater than zero.
|
|
43347
|
+
* - get price using route /api/v1/inventory/items/{id}/ with required query params:
|
|
43348
|
+
* - companyRate if supplier currency is different than company currency, rate is taken from the document itself
|
|
43349
|
+
* - secondaryRate if supplier currency is different than secondary currency, rate is taken from the document itself
|
|
43350
|
+
* - supplierId = selected supplier id
|
|
43351
|
+
* and read purchasePrice from the response
|
|
43352
|
+
*/
|
|
43138
43353
|
unitPrice: number;
|
|
43139
43354
|
/**
|
|
43140
43355
|
* Itempackage
|
|
@@ -43231,7 +43446,7 @@ export interface components {
|
|
|
43231
43446
|
password: string | null;
|
|
43232
43447
|
/**
|
|
43233
43448
|
* Warehouse
|
|
43234
|
-
* @description Warehouse ID, hit the user/warehouses endpoint to get the list of warehouses, or get them from /me endpoint,this field should be required and visible only incase of inventory is enabled and stock_update_trigger is invoice
|
|
43449
|
+
* @description Warehouse ID, hit the user/warehouses endpoint to get the list of warehouses, or get them from /me endpoint,this field should be required and visible only incase of inventory is enabled and stock_update_trigger is invoice in InventorySettings
|
|
43235
43450
|
*/
|
|
43236
43451
|
warehouse: number | null;
|
|
43237
43452
|
/**
|
|
@@ -44759,8 +44974,11 @@ export interface components {
|
|
|
44759
44974
|
id: number;
|
|
44760
44975
|
/** Name */
|
|
44761
44976
|
name: string;
|
|
44762
|
-
/**
|
|
44763
|
-
|
|
44977
|
+
/**
|
|
44978
|
+
* Barcodes
|
|
44979
|
+
* @default []
|
|
44980
|
+
*/
|
|
44981
|
+
barcodes: components["schemas"]["RetrieveBarcodeSchema"][];
|
|
44764
44982
|
/** Skucode */
|
|
44765
44983
|
skuCode?: string | null;
|
|
44766
44984
|
family?: components["schemas"]["CommonFamilySchema"] | null;
|
|
@@ -48756,29 +48974,19 @@ export interface components {
|
|
|
48756
48974
|
* Unitprice
|
|
48757
48975
|
* @description - This field is a number.
|
|
48758
48976
|
* - Should be greater than zero.
|
|
48759
|
-
* - if price list is on get price using route /api/v1/inventory/items/ with required query params:
|
|
48760
|
-
* - priceListIds =
|
|
48977
|
+
* - if price list is on get price using route /api/v1/inventory/items/{id}/ with required query params:
|
|
48978
|
+
* - priceListIds = selected price-list-id
|
|
48761
48979
|
* - type = sales
|
|
48762
48980
|
* - companyRate if customer currency is different than company currency, rate is taken from document itself
|
|
48763
|
-
* -
|
|
48981
|
+
* - secondaryRate if customer currency is different than secondary currency, rate is taken from document itself
|
|
48982
|
+
* - customerId = selected customer id
|
|
48764
48983
|
* and access unitOfMeasure field to get min price and max price
|
|
48765
48984
|
*
|
|
48766
|
-
* - if price list off get price using route /api/v1/inventory/items/
|
|
48767
|
-
*
|
|
48768
|
-
*
|
|
48769
|
-
*
|
|
48770
|
-
*
|
|
48771
|
-
* 2) if customer currency equals company currency price is defaultSellingPrice / secondaryRate
|
|
48772
|
-
*
|
|
48773
|
-
* 3) if customer currency equals to secondary currency price is defaultSellingPrice / companyRate
|
|
48774
|
-
*
|
|
48775
|
-
* 4) if customer currency is foreign(e.g., EUR) price is:
|
|
48776
|
-
* - if defaultSellingPriceCurrency is equals company currency defaultSellingPrice / companyRate
|
|
48777
|
-
* - if defaultSellingPriceCurrency is equals secondary currency defaultSellingPrice / secondaryRate
|
|
48778
|
-
*
|
|
48779
|
-
* this logic is applied to item and item package
|
|
48780
|
-
*
|
|
48781
|
-
* - when price list is on user is allowed to change price if have permission, permissionKey : price : [ change ]
|
|
48985
|
+
* - if price list off get price using route /api/v1/inventory/items/{id}/ with required query params:
|
|
48986
|
+
* - companyRate if customer currency is different than company currency, rate is taken from document itself
|
|
48987
|
+
* - secondaryRate if customer currency is different than secondary currency, rate is taken from document itself
|
|
48988
|
+
* - customerId = selected customer id
|
|
48989
|
+
* and read defaultSellingPrice from the response
|
|
48782
48990
|
*/
|
|
48783
48991
|
unitPrice: string;
|
|
48784
48992
|
/**
|
|
@@ -51091,29 +51299,19 @@ export interface components {
|
|
|
51091
51299
|
* Unitprice
|
|
51092
51300
|
* @description - This field is a number.
|
|
51093
51301
|
* - Should be greater than zero.
|
|
51094
|
-
* - if price list is on get price using route /api/v1/inventory/items/ with required query params:
|
|
51095
|
-
* - priceListIds =
|
|
51302
|
+
* - if price list is on get price using route /api/v1/inventory/items/{id}/ with required query params:
|
|
51303
|
+
* - priceListIds = selected price-list-id
|
|
51096
51304
|
* - type = sales
|
|
51097
51305
|
* - companyRate if customer currency is different than company currency, rate is taken from document itself
|
|
51098
|
-
* -
|
|
51306
|
+
* - secondaryRate if customer currency is different than secondary currency, rate is taken from document itself
|
|
51307
|
+
* - customerId = selected customer id
|
|
51099
51308
|
* and access unitOfMeasure field to get min price and max price
|
|
51100
51309
|
*
|
|
51101
|
-
* - if price list off get price using route /api/v1/inventory/items/
|
|
51102
|
-
*
|
|
51103
|
-
*
|
|
51104
|
-
*
|
|
51105
|
-
*
|
|
51106
|
-
* 2) if customer currency equals company currency price is defaultSellingPrice / secondaryRate
|
|
51107
|
-
*
|
|
51108
|
-
* 3) if customer currency equals to secondary currency price is defaultSellingPrice / companyRate
|
|
51109
|
-
*
|
|
51110
|
-
* 4) if customer currency is foreign(e.g., EUR) price is:
|
|
51111
|
-
* - if defaultSellingPriceCurrency is equals company currency defaultSellingPrice / companyRate
|
|
51112
|
-
* - if defaultSellingPriceCurrency is equals secondary currency defaultSellingPrice / secondaryRate
|
|
51113
|
-
*
|
|
51114
|
-
* this logic is applied to item and item package
|
|
51115
|
-
*
|
|
51116
|
-
* - when price list is on user is allowed to change price if have permission, permissionKey : price : [ change ]
|
|
51310
|
+
* - if price list off get price using route /api/v1/inventory/items/{id}/ with required query params:
|
|
51311
|
+
* - companyRate if customer currency is different than company currency, rate is taken from document itself
|
|
51312
|
+
* - secondaryRate if customer currency is different than secondary currency, rate is taken from document itself
|
|
51313
|
+
* - customerId = selected customer id
|
|
51314
|
+
* and read defaultSellingPrice from the response
|
|
51117
51315
|
*/
|
|
51118
51316
|
unitPrice: number;
|
|
51119
51317
|
/**
|
|
@@ -52656,7 +52854,7 @@ export interface components {
|
|
|
52656
52854
|
* RecognitionFrequency
|
|
52657
52855
|
* @enum {string}
|
|
52658
52856
|
*/
|
|
52659
|
-
RecognitionFrequency: "monthly" | "quarterly" | "annually"
|
|
52857
|
+
RecognitionFrequency: "monthly" | "quarterly" | "annually";
|
|
52660
52858
|
/** SalesInvoiceItemsSchema */
|
|
52661
52859
|
SalesInvoiceItemsSchema: {
|
|
52662
52860
|
/**
|
|
@@ -53100,29 +53298,19 @@ export interface components {
|
|
|
53100
53298
|
* Unitprice
|
|
53101
53299
|
* @description - This field is a number.
|
|
53102
53300
|
* - Should be greater than zero.
|
|
53103
|
-
* - if price list is on get price using route /api/v1/inventory/items/ with required query params:
|
|
53104
|
-
* - priceListIds =
|
|
53301
|
+
* - if price list is on get price using route /api/v1/inventory/items/{id}/ with required query params:
|
|
53302
|
+
* - priceListIds = selected price-list-id
|
|
53105
53303
|
* - type = sales
|
|
53106
53304
|
* - companyRate if customer currency is different than company currency, rate is taken from document itself
|
|
53107
|
-
* -
|
|
53305
|
+
* - secondaryRate if customer currency is different than secondary currency, rate is taken from document itself
|
|
53306
|
+
* - customerId = selected customer id
|
|
53108
53307
|
* and access unitOfMeasure field to get min price and max price
|
|
53109
53308
|
*
|
|
53110
|
-
* - if price list off get price using route /api/v1/inventory/items/
|
|
53111
|
-
*
|
|
53112
|
-
*
|
|
53113
|
-
*
|
|
53114
|
-
*
|
|
53115
|
-
* 2) if customer currency equals company currency price is defaultSellingPrice / secondaryRate
|
|
53116
|
-
*
|
|
53117
|
-
* 3) if customer currency equals to secondary currency price is defaultSellingPrice / companyRate
|
|
53118
|
-
*
|
|
53119
|
-
* 4) if customer currency is foreign(e.g., EUR) price is:
|
|
53120
|
-
* - if defaultSellingPriceCurrency is equals company currency defaultSellingPrice / companyRate
|
|
53121
|
-
* - if defaultSellingPriceCurrency is equals secondary currency defaultSellingPrice / secondaryRate
|
|
53122
|
-
*
|
|
53123
|
-
* this logic is applied to item and item package
|
|
53124
|
-
*
|
|
53125
|
-
* - when price list is on user is allowed to change price if have permission, permissionKey : price : [ change ]
|
|
53309
|
+
* - if price list off get price using route /api/v1/inventory/items/{id}/ with required query params:
|
|
53310
|
+
* - companyRate if customer currency is different than company currency, rate is taken from document itself
|
|
53311
|
+
* - secondaryRate if customer currency is different than secondary currency, rate is taken from document itself
|
|
53312
|
+
* - customerId = selected customer id
|
|
53313
|
+
* and read defaultSellingPrice from the response
|
|
53126
53314
|
*/
|
|
53127
53315
|
unitPrice: number;
|
|
53128
53316
|
/**
|
|
@@ -53293,7 +53481,7 @@ export interface components {
|
|
|
53293
53481
|
/**
|
|
53294
53482
|
* Deliverydate
|
|
53295
53483
|
* Format: date
|
|
53296
|
-
* @description delivery date field should be required and visible only incase of inventory is enabled and stock_update_trigger is invoice in
|
|
53484
|
+
* @description delivery date field should be required and visible only incase of inventory is enabled and stock_update_trigger is invoice in InventorySettings
|
|
53297
53485
|
*/
|
|
53298
53486
|
deliveryDate?: string;
|
|
53299
53487
|
/**
|
|
@@ -53363,6 +53551,25 @@ export interface components {
|
|
|
53363
53551
|
info: components["schemas"]["PageInfoSchema"];
|
|
53364
53552
|
/** Results */
|
|
53365
53553
|
results: components["schemas"]["SalesInvoiceWithoutItemsSchema"][];
|
|
53554
|
+
totals: components["schemas"]["SalesInvoiceTotalsSchema"];
|
|
53555
|
+
};
|
|
53556
|
+
/** SalesInvoiceTotalsSchema */
|
|
53557
|
+
SalesInvoiceTotalsSchema: {
|
|
53558
|
+
/**
|
|
53559
|
+
* Total
|
|
53560
|
+
* @description Aggregated sum of `total` field for all invoices in response (pre-pagination).
|
|
53561
|
+
*/
|
|
53562
|
+
total: string;
|
|
53563
|
+
/**
|
|
53564
|
+
* Companytotal
|
|
53565
|
+
* @description Aggregated sum of `companyTotal` field for all invoices in response (pre-pagination).
|
|
53566
|
+
*/
|
|
53567
|
+
companyTotal: string;
|
|
53568
|
+
/**
|
|
53569
|
+
* Secondarytotal
|
|
53570
|
+
* @description Aggregated sum of `secondaryTotal` field for all invoices in response (pre-pagination).
|
|
53571
|
+
*/
|
|
53572
|
+
secondaryTotal: string;
|
|
53366
53573
|
};
|
|
53367
53574
|
/** SalesInvoiceWithoutItemsSchema */
|
|
53368
53575
|
SalesInvoiceWithoutItemsSchema: {
|
|
@@ -57176,6 +57383,11 @@ export interface components {
|
|
|
57176
57383
|
*/
|
|
57177
57384
|
movements: components["schemas"]["MovementTransactionSchema"][];
|
|
57178
57385
|
};
|
|
57386
|
+
/**
|
|
57387
|
+
* ShowItemsWithEnum
|
|
57388
|
+
* @enum {string}
|
|
57389
|
+
*/
|
|
57390
|
+
ShowItemsWithEnum: "all" | "excludeZeroQty" | "zeroQtyOnly";
|
|
57179
57391
|
/** ItemAvailabilityReportResponse */
|
|
57180
57392
|
ItemAvailabilityReportResponse: {
|
|
57181
57393
|
info: components["schemas"]["PageInfoSchema"];
|
|
@@ -60103,7 +60315,7 @@ export interface components {
|
|
|
60103
60315
|
* RecognitionFrequencyEnum
|
|
60104
60316
|
* @enum {string}
|
|
60105
60317
|
*/
|
|
60106
|
-
RecognitionFrequencyEnum: "
|
|
60318
|
+
RecognitionFrequencyEnum: "monthly" | "quarterly" | "annually";
|
|
60107
60319
|
/** CreateUpdateExpenseVoucher */
|
|
60108
60320
|
CreateUpdateExpenseVoucher: {
|
|
60109
60321
|
/** Password */
|
|
@@ -61996,6 +62208,8 @@ export interface operations {
|
|
|
61996
62208
|
branchId?: number;
|
|
61997
62209
|
/** @description search by item name, short name, sku code, barcode, serial number, batch number, category, brand, tag, or family */
|
|
61998
62210
|
search?: string;
|
|
62211
|
+
/** @description Search match mode: contains (default), startswith, endswith, exact, or similar. All modes search name, sku, short name, barcode, brand, family, category, tag, serial, and batch. */
|
|
62212
|
+
searchMode?: "contains" | "startswith" | "endswith" | "exact" | "similar";
|
|
61999
62213
|
/** @description List of warehouse IDs to filter quantities by. If not provided, all warehouses will be included. */
|
|
62000
62214
|
warehouses?: number[] | null;
|
|
62001
62215
|
/** @description Include detailed quantity breakdown with warehouse information for each item and item package */
|
|
@@ -62006,13 +62220,13 @@ export interface operations {
|
|
|
62006
62220
|
priceListIds?: string[];
|
|
62007
62221
|
/** @description required when price list ids is provided, should be sales if called in sales features or offers if called in offers and promotions feature */
|
|
62008
62222
|
type?: "sales" | "offers";
|
|
62009
|
-
/** @description
|
|
62223
|
+
/** @description Required when priceListIds is provided and type is sales, or when retrieving default selling/purchase price with customerId/supplierId respectively. Rate is taken from the document itself. */
|
|
62010
62224
|
companyRate?: number | string;
|
|
62011
|
-
/** @description
|
|
62225
|
+
/** @description Required when priceListIds is provided and type is sales, or when retrieving default selling/purchase price with customerId/supplierId respectively and secondary currency is enabled. Rate is taken from the document itself. */
|
|
62012
62226
|
secondaryRate?: number | string;
|
|
62013
|
-
/** @description
|
|
62227
|
+
/** @description Required when retrieving item purchase prices from a supplier price list, or when retrieving the default purchase price with currency conversion in purchase features. */
|
|
62014
62228
|
supplierId?: number;
|
|
62015
|
-
/** @description
|
|
62229
|
+
/** @description Required when retrieving item sales prices from a sales price list, or when retrieving the default selling price with currency conversion in sales features. */
|
|
62016
62230
|
customerId?: number;
|
|
62017
62231
|
/** @description Field to sort items by */
|
|
62018
62232
|
sortBy?: "name" | "shortName" | "skuCode" | "type" | "usage" | "active" | "dateCreated" | "dateModified" | "family" | "brand" | "categories" | "tags" | "";
|
|
@@ -62203,6 +62417,57 @@ export interface operations {
|
|
|
62203
62417
|
};
|
|
62204
62418
|
};
|
|
62205
62419
|
};
|
|
62420
|
+
inventory_item_views_bulk_update_items: {
|
|
62421
|
+
parameters: {
|
|
62422
|
+
query?: never;
|
|
62423
|
+
header?: never;
|
|
62424
|
+
path?: never;
|
|
62425
|
+
cookie?: never;
|
|
62426
|
+
};
|
|
62427
|
+
requestBody: {
|
|
62428
|
+
content: {
|
|
62429
|
+
"application/json": components["schemas"]["BulkUpdateItemEntrySchema"][];
|
|
62430
|
+
};
|
|
62431
|
+
};
|
|
62432
|
+
responses: {
|
|
62433
|
+
/** @description OK */
|
|
62434
|
+
200: {
|
|
62435
|
+
headers: {
|
|
62436
|
+
[name: string]: unknown;
|
|
62437
|
+
};
|
|
62438
|
+
content: {
|
|
62439
|
+
"application/json": components["schemas"]["BulkUpdateItemsResponse"];
|
|
62440
|
+
};
|
|
62441
|
+
};
|
|
62442
|
+
/** @description Bad Request */
|
|
62443
|
+
400: {
|
|
62444
|
+
headers: {
|
|
62445
|
+
[name: string]: unknown;
|
|
62446
|
+
};
|
|
62447
|
+
content: {
|
|
62448
|
+
"application/json": components["schemas"]["ErrorMessages"];
|
|
62449
|
+
};
|
|
62450
|
+
};
|
|
62451
|
+
/** @description Forbidden */
|
|
62452
|
+
403: {
|
|
62453
|
+
headers: {
|
|
62454
|
+
[name: string]: unknown;
|
|
62455
|
+
};
|
|
62456
|
+
content: {
|
|
62457
|
+
"application/json": components["schemas"]["MessageWithCode"];
|
|
62458
|
+
};
|
|
62459
|
+
};
|
|
62460
|
+
/** @description Internal Server Error */
|
|
62461
|
+
500: {
|
|
62462
|
+
headers: {
|
|
62463
|
+
[name: string]: unknown;
|
|
62464
|
+
};
|
|
62465
|
+
content: {
|
|
62466
|
+
"application/json": components["schemas"]["MessageWithCode"];
|
|
62467
|
+
};
|
|
62468
|
+
};
|
|
62469
|
+
};
|
|
62470
|
+
};
|
|
62206
62471
|
inventory_item_views_retrieve_item: {
|
|
62207
62472
|
parameters: {
|
|
62208
62473
|
query?: {
|
|
@@ -62218,13 +62483,13 @@ export interface operations {
|
|
|
62218
62483
|
priceListIds?: string[];
|
|
62219
62484
|
/** @description required when price list ids is provided, should be sales if called in sales features or offers if called in offers and promotions feature */
|
|
62220
62485
|
type?: "sales" | "offers";
|
|
62221
|
-
/** @description
|
|
62486
|
+
/** @description Required when priceListIds is provided and type is sales, or when retrieving default selling/purchase price with customerId/supplierId respectively. Rate is taken from the document itself. */
|
|
62222
62487
|
companyRate?: number | string;
|
|
62223
|
-
/** @description
|
|
62488
|
+
/** @description Required when priceListIds is provided and type is sales, or when retrieving default selling/purchase price with customerId/supplierId respectively and secondary currency is enabled. Rate is taken from the document itself. */
|
|
62224
62489
|
secondaryRate?: number | string;
|
|
62225
|
-
/** @description
|
|
62490
|
+
/** @description Required when retrieving item purchase prices from a supplier price list, or when retrieving the default purchase price with currency conversion in purchase features. */
|
|
62226
62491
|
supplierId?: number;
|
|
62227
|
-
/** @description
|
|
62492
|
+
/** @description Required when retrieving item sales prices from a sales price list, or when retrieving the default selling price with currency conversion in sales features. */
|
|
62228
62493
|
customerId?: number;
|
|
62229
62494
|
};
|
|
62230
62495
|
header?: never;
|
|
@@ -73078,6 +73343,8 @@ export interface operations {
|
|
|
73078
73343
|
currencies: (string | number)[];
|
|
73079
73344
|
/** @description filter by account number or name */
|
|
73080
73345
|
filter_by_account_number_or_name?: string;
|
|
73346
|
+
/** @description When true, combine multiple post entries from the same document into one row */
|
|
73347
|
+
groupEntries?: boolean;
|
|
73081
73348
|
};
|
|
73082
73349
|
header?: never;
|
|
73083
73350
|
path?: never;
|
|
@@ -73146,6 +73413,8 @@ export interface operations {
|
|
|
73146
73413
|
currencies: (string | number)[];
|
|
73147
73414
|
/** @description filter by account number or name */
|
|
73148
73415
|
filter_by_account_number_or_name?: string;
|
|
73416
|
+
/** @description When true, combine multiple post entries from the same document into one row */
|
|
73417
|
+
groupEntries?: boolean;
|
|
73149
73418
|
};
|
|
73150
73419
|
header?: never;
|
|
73151
73420
|
path?: never;
|
|
@@ -73219,6 +73488,8 @@ export interface operations {
|
|
|
73219
73488
|
pageSize?: number;
|
|
73220
73489
|
/** @description currencies ids,if user selected accountCurrency then you should send accountCurrency in list */
|
|
73221
73490
|
currencies: (string | number)[];
|
|
73491
|
+
/** @description When true, combine multiple post entries from the same document into one row */
|
|
73492
|
+
groupEntries?: boolean;
|
|
73222
73493
|
};
|
|
73223
73494
|
header?: never;
|
|
73224
73495
|
path?: never;
|
|
@@ -73449,6 +73720,8 @@ export interface operations {
|
|
|
73449
73720
|
pageSize?: number;
|
|
73450
73721
|
/** @description currencies ids,if user selected accountCurrency then you should send accountCurrency in list */
|
|
73451
73722
|
currencies: (string | number)[];
|
|
73723
|
+
/** @description When true, combine multiple post entries from the same document into one row */
|
|
73724
|
+
groupEntries?: boolean;
|
|
73452
73725
|
};
|
|
73453
73726
|
header?: never;
|
|
73454
73727
|
path?: never;
|
|
@@ -100192,6 +100465,8 @@ export interface operations {
|
|
|
100192
100465
|
unitOfMeasure?: number[] | null;
|
|
100193
100466
|
/** @description Free text search on item name */
|
|
100194
100467
|
search?: string | null;
|
|
100468
|
+
/** @description Filter items by stock quantity: all, excludeZeroQty, zeroQtyOnly */
|
|
100469
|
+
showItemsWith?: "all" | "excludeZeroQty" | "zeroQtyOnly";
|
|
100195
100470
|
/** @description Enable pagination (default: True) */
|
|
100196
100471
|
paginate?: boolean;
|
|
100197
100472
|
};
|
|
@@ -100242,7 +100517,8 @@ export interface operations {
|
|
|
100242
100517
|
reports_inventoryreport_views_get_inventory_valuation_report: {
|
|
100243
100518
|
parameters: {
|
|
100244
100519
|
query: {
|
|
100245
|
-
|
|
100520
|
+
/** @description As-of date for valuation (YYYY-MM-DD) */
|
|
100521
|
+
asOfDate: string;
|
|
100246
100522
|
/** @description List of branch IDs */
|
|
100247
100523
|
branchIds?: number[] | null;
|
|
100248
100524
|
/** @description List of warehouse IDs */
|