@erp-galoper/types 1.0.1718 → 1.0.1720
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 +208 -10
- package/package.json +1 -1
package/openapi.ts
CHANGED
|
@@ -20022,6 +20022,61 @@ export interface paths {
|
|
|
20022
20022
|
patch?: never;
|
|
20023
20023
|
trace?: never;
|
|
20024
20024
|
};
|
|
20025
|
+
"/api/v1/reports/inventory/valuation-report/": {
|
|
20026
|
+
parameters: {
|
|
20027
|
+
query?: never;
|
|
20028
|
+
header?: never;
|
|
20029
|
+
path?: never;
|
|
20030
|
+
cookie?: never;
|
|
20031
|
+
};
|
|
20032
|
+
/**
|
|
20033
|
+
* Get Inventory Valuation Report
|
|
20034
|
+
* @description Generate an Inventory Valuation Report as of a specific period end date.
|
|
20035
|
+
*
|
|
20036
|
+
* 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
|
|
20048
|
+
*
|
|
20049
|
+
* **Filters:**
|
|
20050
|
+
* - branches: Filter by specific branch(es)
|
|
20051
|
+
* - warehouses: Filter by specific warehouse(s)
|
|
20052
|
+
* - categories: Filter by item category
|
|
20053
|
+
* - brands: Filter by item brand
|
|
20054
|
+
* - families: Filter by item family
|
|
20055
|
+
* - items: Filter by specific item(s)
|
|
20056
|
+
* - search: Search by item name, short name, barcode, SKU code, serial number, batch number, category, brand, or family
|
|
20057
|
+
* - paginated: Enable pagination (default: true). Set to false to return all records.
|
|
20058
|
+
* - includeNegativeStock: Include items with negative quantities (default: false)
|
|
20059
|
+
*
|
|
20060
|
+
* **Responses:**
|
|
20061
|
+
* - 200: Inventory Valuation Report with total value and item breakdown
|
|
20062
|
+
* - 400: "invalidPeriodType"
|
|
20063
|
+
* - "paginationError"
|
|
20064
|
+
* - 403: "permissionDenied"
|
|
20065
|
+
* - "noModuleAccess"
|
|
20066
|
+
* - "noBranchAccess"
|
|
20067
|
+
* - 500: "serverError"
|
|
20068
|
+
*
|
|
20069
|
+
* **Permission key:** inventoryreport: ["view"]
|
|
20070
|
+
*/
|
|
20071
|
+
get: operations["reports_inventoryreport_views_get_inventory_valuation_report"];
|
|
20072
|
+
put?: never;
|
|
20073
|
+
post?: never;
|
|
20074
|
+
delete?: never;
|
|
20075
|
+
options?: never;
|
|
20076
|
+
head?: never;
|
|
20077
|
+
patch?: never;
|
|
20078
|
+
trace?: never;
|
|
20079
|
+
};
|
|
20025
20080
|
"/api/v1/reports/by-item/": {
|
|
20026
20081
|
parameters: {
|
|
20027
20082
|
query?: never;
|
|
@@ -57481,6 +57536,92 @@ export interface components {
|
|
|
57481
57536
|
*/
|
|
57482
57537
|
locations: components["schemas"]["ItemLocationSchema"][];
|
|
57483
57538
|
};
|
|
57539
|
+
/**
|
|
57540
|
+
* CurrencyAmountSchema
|
|
57541
|
+
* @description Amount in both primary and secondary currencies
|
|
57542
|
+
*/
|
|
57543
|
+
CurrencyAmountSchema: {
|
|
57544
|
+
/** Primary */
|
|
57545
|
+
primary: number;
|
|
57546
|
+
/** Secondary */
|
|
57547
|
+
secondary: number;
|
|
57548
|
+
};
|
|
57549
|
+
/**
|
|
57550
|
+
* IUOMGroupValuationSchema
|
|
57551
|
+
* @description UOM group with packed/unpacked inventory valuation
|
|
57552
|
+
*/
|
|
57553
|
+
IUOMGroupValuationSchema: {
|
|
57554
|
+
unitOfMeasure: components["schemas"]["UnitOfMeasureSchema"];
|
|
57555
|
+
unpacked: components["schemas"]["UnpackedInventoryValuationSchema"] | null;
|
|
57556
|
+
packed: components["schemas"]["PackedInventoryValuationSchema"] | null;
|
|
57557
|
+
/** Quantity */
|
|
57558
|
+
quantity: number;
|
|
57559
|
+
cost: components["schemas"]["CurrencyAmountSchema"];
|
|
57560
|
+
};
|
|
57561
|
+
/**
|
|
57562
|
+
* InventoryValuationLineSchema
|
|
57563
|
+
* @description Individual line item in the valuation report
|
|
57564
|
+
*/
|
|
57565
|
+
InventoryValuationLineSchema: {
|
|
57566
|
+
item: components["schemas"]["ItemDetailSchemaForReport"];
|
|
57567
|
+
/** Unitofmeasures */
|
|
57568
|
+
unitOfMeasures: components["schemas"]["IUOMGroupValuationSchema"][];
|
|
57569
|
+
/** Quantity */
|
|
57570
|
+
quantity: number;
|
|
57571
|
+
cost: components["schemas"]["CurrencyAmountSchema"];
|
|
57572
|
+
};
|
|
57573
|
+
/**
|
|
57574
|
+
* InventoryValuationLocationSchema
|
|
57575
|
+
* @description Location-specific inventory valuation data
|
|
57576
|
+
*/
|
|
57577
|
+
InventoryValuationLocationSchema: {
|
|
57578
|
+
branch: components["schemas"]["BranchSummaryInfo"];
|
|
57579
|
+
warehouse: components["schemas"]["WarehouseSummaryInfo"];
|
|
57580
|
+
/** Quantity */
|
|
57581
|
+
quantity: number;
|
|
57582
|
+
cost: components["schemas"]["CurrencyAmountSchema"];
|
|
57583
|
+
};
|
|
57584
|
+
/**
|
|
57585
|
+
* InventoryValuationReportResponse
|
|
57586
|
+
* @description Inventory valuation report response with pagination
|
|
57587
|
+
*/
|
|
57588
|
+
InventoryValuationReportResponse: {
|
|
57589
|
+
info: components["schemas"]["PageInfoSchema"];
|
|
57590
|
+
/** Results */
|
|
57591
|
+
results: components["schemas"]["InventoryValuationLineSchema"][];
|
|
57592
|
+
totals: components["schemas"]["InventoryValuationTotalsSchema"];
|
|
57593
|
+
};
|
|
57594
|
+
/**
|
|
57595
|
+
* InventoryValuationTotalsSchema
|
|
57596
|
+
* @description Grand totals for inventory valuation across all pages
|
|
57597
|
+
*/
|
|
57598
|
+
InventoryValuationTotalsSchema: {
|
|
57599
|
+
/** Totalquantity */
|
|
57600
|
+
totalQuantity: number;
|
|
57601
|
+
totalValue: components["schemas"]["CurrencyAmountSchema"];
|
|
57602
|
+
};
|
|
57603
|
+
/**
|
|
57604
|
+
* PackedInventoryValuationSchema
|
|
57605
|
+
* @description Packed inventory UOM valuation data
|
|
57606
|
+
*/
|
|
57607
|
+
PackedInventoryValuationSchema: {
|
|
57608
|
+
/** Quantity */
|
|
57609
|
+
quantity: number;
|
|
57610
|
+
cost: components["schemas"]["CurrencyAmountSchema"];
|
|
57611
|
+
/** Locations */
|
|
57612
|
+
locations: components["schemas"]["InventoryValuationLocationSchema"][];
|
|
57613
|
+
};
|
|
57614
|
+
/**
|
|
57615
|
+
* UnpackedInventoryValuationSchema
|
|
57616
|
+
* @description Unpacked inventory UOM valuation data
|
|
57617
|
+
*/
|
|
57618
|
+
UnpackedInventoryValuationSchema: {
|
|
57619
|
+
/** Quantity */
|
|
57620
|
+
quantity: number;
|
|
57621
|
+
cost: components["schemas"]["CurrencyAmountSchema"];
|
|
57622
|
+
/** Locations */
|
|
57623
|
+
locations: components["schemas"]["InventoryValuationLocationSchema"][];
|
|
57624
|
+
};
|
|
57484
57625
|
/**
|
|
57485
57626
|
* SalesReportPeriodType
|
|
57486
57627
|
* @enum {string}
|
|
@@ -57505,16 +57646,6 @@ export interface components {
|
|
|
57505
57646
|
/** Name */
|
|
57506
57647
|
name: string;
|
|
57507
57648
|
};
|
|
57508
|
-
/**
|
|
57509
|
-
* CurrencyAmountSchema
|
|
57510
|
-
* @description Amount in both primary and secondary currencies
|
|
57511
|
-
*/
|
|
57512
|
-
CurrencyAmountSchema: {
|
|
57513
|
-
/** Primary */
|
|
57514
|
-
primary: number;
|
|
57515
|
-
/** Secondary */
|
|
57516
|
-
secondary: number;
|
|
57517
|
-
};
|
|
57518
57649
|
/** FamilySummarySchema */
|
|
57519
57650
|
FamilySummarySchema: {
|
|
57520
57651
|
/** Id */
|
|
@@ -99927,6 +100058,73 @@ export interface operations {
|
|
|
99927
100058
|
};
|
|
99928
100059
|
};
|
|
99929
100060
|
};
|
|
100061
|
+
reports_inventoryreport_views_get_inventory_valuation_report: {
|
|
100062
|
+
parameters: {
|
|
100063
|
+
query: {
|
|
100064
|
+
periodType: "thisMonth" | "lastMonth" | "thisQuarter" | "lastQuarter" | "thisFiscalYear" | "lastFiscalYear" | "custom" | "today" | "all";
|
|
100065
|
+
/** @description List of branch IDs */
|
|
100066
|
+
branchIds?: number[] | null;
|
|
100067
|
+
/** @description List of warehouse IDs */
|
|
100068
|
+
warehouseIds?: number[] | null;
|
|
100069
|
+
/** @description List of category IDs */
|
|
100070
|
+
categoryIds?: number[] | null;
|
|
100071
|
+
/** @description List of brand IDs */
|
|
100072
|
+
brandIds?: number[] | null;
|
|
100073
|
+
/** @description List of family IDs */
|
|
100074
|
+
familyIds?: number[] | null;
|
|
100075
|
+
/** @description List of item IDs */
|
|
100076
|
+
itemIds?: number[] | null;
|
|
100077
|
+
/** @description Search by item name, short name, barcode, SKU code, serial number, batch number, category, brand, or family */
|
|
100078
|
+
search?: string | null;
|
|
100079
|
+
/** @description Enable pagination (default: true) */
|
|
100080
|
+
paginated?: boolean;
|
|
100081
|
+
/** @description Include negative stock items */
|
|
100082
|
+
includeNegativeStock?: boolean;
|
|
100083
|
+
};
|
|
100084
|
+
header?: never;
|
|
100085
|
+
path?: never;
|
|
100086
|
+
cookie?: never;
|
|
100087
|
+
};
|
|
100088
|
+
requestBody?: never;
|
|
100089
|
+
responses: {
|
|
100090
|
+
/** @description OK */
|
|
100091
|
+
200: {
|
|
100092
|
+
headers: {
|
|
100093
|
+
[name: string]: unknown;
|
|
100094
|
+
};
|
|
100095
|
+
content: {
|
|
100096
|
+
"application/json": components["schemas"]["InventoryValuationReportResponse"];
|
|
100097
|
+
};
|
|
100098
|
+
};
|
|
100099
|
+
/** @description Bad Request */
|
|
100100
|
+
400: {
|
|
100101
|
+
headers: {
|
|
100102
|
+
[name: string]: unknown;
|
|
100103
|
+
};
|
|
100104
|
+
content: {
|
|
100105
|
+
"application/json": components["schemas"]["ErrorMessages"];
|
|
100106
|
+
};
|
|
100107
|
+
};
|
|
100108
|
+
/** @description Forbidden */
|
|
100109
|
+
403: {
|
|
100110
|
+
headers: {
|
|
100111
|
+
[name: string]: unknown;
|
|
100112
|
+
};
|
|
100113
|
+
content: {
|
|
100114
|
+
"application/json": components["schemas"]["MessageWithCode"];
|
|
100115
|
+
};
|
|
100116
|
+
};
|
|
100117
|
+
/** @description Internal Server Error */
|
|
100118
|
+
500: {
|
|
100119
|
+
headers: {
|
|
100120
|
+
[name: string]: unknown;
|
|
100121
|
+
};
|
|
100122
|
+
content: {
|
|
100123
|
+
"application/json": components["schemas"]["MessageWithCode"];
|
|
100124
|
+
};
|
|
100125
|
+
};
|
|
100126
|
+
};
|
|
100127
|
+
};
|
|
99930
100128
|
reports_salesreport_views_get_sales_by_item_report: {
|
|
99931
100129
|
parameters: {
|
|
99932
100130
|
query?: {
|