@erp-galoper/types 1.0.1546 → 1.0.1548
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 +72 -7
- package/package.json +1 -1
package/openapi.ts
CHANGED
|
@@ -607,12 +607,22 @@ export interface paths {
|
|
|
607
607
|
/**
|
|
608
608
|
* List Items
|
|
609
609
|
* @description Endpoint for List items
|
|
610
|
+
*
|
|
611
|
+
* Supports filtering items by document:
|
|
612
|
+
* - Provide documentModel (e.g., 'salesorder', 'salesinvoice', 'purchaseorder') and documentId
|
|
613
|
+
* - The endpoint will automatically detect if the model has 'items' or 'details' relation
|
|
614
|
+
* - Returns only the items that are present in the specified document
|
|
615
|
+
*
|
|
610
616
|
* Responses:
|
|
611
617
|
* - 200: ItemListSchema
|
|
612
618
|
* - 400: {"message": "Error applying filter {error}", "code": "invalidFilterFormat"}
|
|
613
|
-
* - {"message": "
|
|
614
|
-
*
|
|
619
|
+
* - {"message": "documentId is required when documentModel is provided", "code": "documentIdRequired"}
|
|
620
|
+
* - {"message": "Invalid document model: {model}", "code": "invalidDocumentModel"}
|
|
621
|
+
* - {"message": "Model {model} does not have 'items' or 'details' relation", "code": "noItemsRelation"}
|
|
622
|
+
* - {"message": "{items/details} of {model} do not have 'item' field", "code": "noItemField"}
|
|
623
|
+
* - {"message": "Error applying pagination {error}", "code": "paginationError"}
|
|
615
624
|
* - 403: {"message": "You do not have permission to perform this action", "code": "permissionDenied"}
|
|
625
|
+
* - 404: {"message": "Document not found", "code": "documentNotFound"}
|
|
616
626
|
* - 500: {"message": "An internal server error has occurred", "code": "serverError"}
|
|
617
627
|
*/
|
|
618
628
|
get: operations["inventory_item_views_list_items"];
|
|
@@ -25807,6 +25817,11 @@ export interface components {
|
|
|
25807
25817
|
* @enum {string}
|
|
25808
25818
|
*/
|
|
25809
25819
|
ItemSortBy: "name" | "shortName" | "skuCode" | "type" | "usage" | "active" | "dateCreated" | "dateModified" | "family" | "brand" | "categories" | "tags" | "";
|
|
25820
|
+
/**
|
|
25821
|
+
* LogModelName
|
|
25822
|
+
* @enum {string}
|
|
25823
|
+
*/
|
|
25824
|
+
LogModelName: "item" | "customer" | "supplier" | "internalTransferHeader" | "transferRequest" | "stockAdjustment" | "openingQuantity" | "supplierPriceList" | "chartOfAccount" | "journalVoucher" | "requisition" | "requestForQuotation" | "advancePayment" | "paymentVoucher" | "purchaseInvoice" | "purchaseOrder" | "purchaseQuotation" | "purchaseReturnOrder" | "purchaseReturnInvoice" | "refundVoucher" | "purchaseCreditNote" | "project" | "warehouse" | "employeePosition" | "employee" | "accountingSetting" | "defaultGeneralAccounts" | "transactionalSubsidiaryAccounts" | "accountClassification" | "taxes" | "appointmentSettings" | "approvalSettings" | "approvalConfig" | "approvalCondition" | "approvalLevel" | "inventorySettings" | "itemVariantSettings" | "posSettings" | "purchaseSettings" | "salesSetting" | "city" | "zone" | "shippingMethod" | "systemSettings" | "transactionLocking" | "userSetting" | "department" | "company" | "branch" | "region" | "currency" | "facility" | "reason" | "emailSetting" | "bank" | "users" | "roles" | "appointment" | "offerAndPromotion" | "salesQuotation" | "salesOrder" | "downPayment" | "receiptVoucher" | "salesCreditNote" | "salesInvoice" | "salesReturnOrder" | "salesReturnInvoice" | "salesRefundVoucher" | "salesPriceList" | "goodsDeliveryNote" | "returnablePackageReconciliation" | "salesReturnPackage" | "package" | "packageType" | "itemPackage" | "goodsReceiptNote" | "salesPerson" | "commissionStructure" | "commissionPayout" | "closingCommission" | "posInvoice" | "onlineStoreSetting" | "onlineStorageSettings" | "task" | "event" | "dimension" | "expenseCategory" | "expenseVoucher" | "expensePaymentVoucher" | "whatsAppIntegration";
|
|
25810
25825
|
/**
|
|
25811
25826
|
* SortOrder
|
|
25812
25827
|
* @enum {string}
|
|
@@ -29178,11 +29193,6 @@ export interface components {
|
|
|
29178
29193
|
*/
|
|
29179
29194
|
results: components["schemas"]["DocumentsToApprove"][];
|
|
29180
29195
|
};
|
|
29181
|
-
/**
|
|
29182
|
-
* LogModelName
|
|
29183
|
-
* @enum {string}
|
|
29184
|
-
*/
|
|
29185
|
-
LogModelName: "item" | "customer" | "supplier" | "internalTransferHeader" | "transferRequest" | "stockAdjustment" | "openingQuantity" | "supplierPriceList" | "chartOfAccount" | "journalVoucher" | "requisition" | "requestForQuotation" | "advancePayment" | "paymentVoucher" | "purchaseInvoice" | "purchaseOrder" | "purchaseQuotation" | "purchaseReturnOrder" | "purchaseReturnInvoice" | "refundVoucher" | "purchaseCreditNote" | "project" | "warehouse" | "employeePosition" | "employee" | "accountingSetting" | "defaultGeneralAccounts" | "transactionalSubsidiaryAccounts" | "accountClassification" | "taxes" | "appointmentSettings" | "approvalSettings" | "approvalConfig" | "approvalCondition" | "approvalLevel" | "inventorySettings" | "itemVariantSettings" | "posSettings" | "purchaseSettings" | "salesSetting" | "city" | "zone" | "shippingMethod" | "systemSettings" | "transactionLocking" | "userSetting" | "department" | "company" | "branch" | "region" | "currency" | "facility" | "reason" | "emailSetting" | "bank" | "users" | "roles" | "appointment" | "offerAndPromotion" | "salesQuotation" | "salesOrder" | "downPayment" | "receiptVoucher" | "salesCreditNote" | "salesInvoice" | "salesReturnOrder" | "salesReturnInvoice" | "salesRefundVoucher" | "salesPriceList" | "goodsDeliveryNote" | "returnablePackageReconciliation" | "salesReturnPackage" | "package" | "packageType" | "itemPackage" | "goodsReceiptNote" | "salesPerson" | "commissionStructure" | "commissionPayout" | "closingCommission" | "posInvoice" | "onlineStoreSetting" | "onlineStorageSettings" | "task" | "event" | "dimension" | "expenseCategory" | "expenseVoucher" | "expensePaymentVoucher" | "whatsAppIntegration";
|
|
29186
29196
|
/**
|
|
29187
29197
|
* LogType
|
|
29188
29198
|
* @enum {string}
|
|
@@ -39726,6 +39736,12 @@ export interface components {
|
|
|
39726
39736
|
/** Unitprice */
|
|
39727
39737
|
unitPrice: number;
|
|
39728
39738
|
itemPackage: components["schemas"]["ItemPackageSummarySchema"] | null;
|
|
39739
|
+
/**
|
|
39740
|
+
* Includetaxinunitprice
|
|
39741
|
+
* @description If true, the unit price includes tax and will be extracted to calculate the base price
|
|
39742
|
+
* @default false
|
|
39743
|
+
*/
|
|
39744
|
+
includeTaxInUnitPrice: boolean;
|
|
39729
39745
|
/** Discount */
|
|
39730
39746
|
discount?: number | null;
|
|
39731
39747
|
/** Subtotal */
|
|
@@ -40333,6 +40349,12 @@ export interface components {
|
|
|
40333
40349
|
/** Unitprice */
|
|
40334
40350
|
unitPrice: number;
|
|
40335
40351
|
itemPackage: components["schemas"]["ItemPackageSummarySchema"] | null;
|
|
40352
|
+
/**
|
|
40353
|
+
* Includetaxinunitprice
|
|
40354
|
+
* @description If true, the unit price includes tax and will be extracted to calculate the base price
|
|
40355
|
+
* @default false
|
|
40356
|
+
*/
|
|
40357
|
+
includeTaxInUnitPrice: boolean;
|
|
40336
40358
|
/** Discount */
|
|
40337
40359
|
discount?: number | null;
|
|
40338
40360
|
/** Subtotal */
|
|
@@ -41411,6 +41433,12 @@ export interface components {
|
|
|
41411
41433
|
/** Unitprice */
|
|
41412
41434
|
unitPrice: number;
|
|
41413
41435
|
itemPackage: components["schemas"]["ItemPackageSummarySchema"] | null;
|
|
41436
|
+
/**
|
|
41437
|
+
* Includetaxinunitprice
|
|
41438
|
+
* @description If true, the unit price includes tax and will be extracted to calculate the base price
|
|
41439
|
+
* @default false
|
|
41440
|
+
*/
|
|
41441
|
+
includeTaxInUnitPrice: boolean;
|
|
41414
41442
|
/** Discount */
|
|
41415
41443
|
discount: number;
|
|
41416
41444
|
/** Taxes */
|
|
@@ -41831,6 +41859,12 @@ export interface components {
|
|
|
41831
41859
|
* - get default value(s) from /api/v1/inventory/items/{id}/ and filter by type equals purchase
|
|
41832
41860
|
*/
|
|
41833
41861
|
taxes: number[];
|
|
41862
|
+
/**
|
|
41863
|
+
* Includetaxinunitprice
|
|
41864
|
+
* @description If true, the unit price includes tax and will be extracted to calculate the base price
|
|
41865
|
+
* @default false
|
|
41866
|
+
*/
|
|
41867
|
+
includeTaxInUnitPrice: boolean;
|
|
41834
41868
|
};
|
|
41835
41869
|
/** PurchaseInvoiceUpdateSchema */
|
|
41836
41870
|
PurchaseInvoiceUpdateSchema: {
|
|
@@ -46716,6 +46750,12 @@ export interface components {
|
|
|
46716
46750
|
* @description - This field is a number.
|
|
46717
46751
|
*/
|
|
46718
46752
|
packageDepositCharge: string | null;
|
|
46753
|
+
/**
|
|
46754
|
+
* Includetaxinunitprice
|
|
46755
|
+
* @description If true, the unit price includes tax and will be extracted to calculate the base price
|
|
46756
|
+
* @default false
|
|
46757
|
+
*/
|
|
46758
|
+
includeTaxInUnitPrice: boolean;
|
|
46719
46759
|
/**
|
|
46720
46760
|
* Discount
|
|
46721
46761
|
* @default 0
|
|
@@ -48917,6 +48957,12 @@ export interface components {
|
|
|
48917
48957
|
* @description This field is a number representing the deposit charge for the selected package, if applicable.
|
|
48918
48958
|
*/
|
|
48919
48959
|
packageDepositCharge: string | null;
|
|
48960
|
+
/**
|
|
48961
|
+
* Includetaxinunitprice
|
|
48962
|
+
* @description If true, the unit price includes tax and will be extracted to calculate the base price
|
|
48963
|
+
* @default false
|
|
48964
|
+
*/
|
|
48965
|
+
includeTaxInUnitPrice: boolean;
|
|
48920
48966
|
/**
|
|
48921
48967
|
* Discount
|
|
48922
48968
|
* @description The discount percentage applied to the item.
|
|
@@ -50798,6 +50844,12 @@ export interface components {
|
|
|
50798
50844
|
* @description This field is a number representing the deposit charge for the selected package, if applicable.
|
|
50799
50845
|
*/
|
|
50800
50846
|
packageDepositCharge?: string | null;
|
|
50847
|
+
/**
|
|
50848
|
+
* Includetaxinunitprice
|
|
50849
|
+
* @description If true, the unit price includes tax and will be extracted to calculate the base price
|
|
50850
|
+
* @default false
|
|
50851
|
+
*/
|
|
50852
|
+
includeTaxInUnitPrice: boolean;
|
|
50801
50853
|
/**
|
|
50802
50854
|
* Discount
|
|
50803
50855
|
* @description The discount percentage applied to the item.
|
|
@@ -59612,6 +59664,10 @@ export interface operations {
|
|
|
59612
59664
|
sortBy?: "name" | "shortName" | "skuCode" | "type" | "usage" | "active" | "dateCreated" | "dateModified" | "family" | "brand" | "categories" | "tags" | "";
|
|
59613
59665
|
/** @description Sort order: ascending or descending */
|
|
59614
59666
|
order?: "asc" | "desc";
|
|
59667
|
+
/** @description Document model name from LogModelName enum (e.g., "salesOrder", "salesInvoice", "purchaseOrder", "openingQuantity") */
|
|
59668
|
+
documentModel?: components["schemas"]["LogModelName"] | null;
|
|
59669
|
+
/** @description Document ID to get items from (required if documentModel is provided) */
|
|
59670
|
+
documentId?: string | null;
|
|
59615
59671
|
};
|
|
59616
59672
|
header?: never;
|
|
59617
59673
|
path?: never;
|
|
@@ -59646,6 +59702,15 @@ export interface operations {
|
|
|
59646
59702
|
"application/json": components["schemas"]["MessageWithCode"];
|
|
59647
59703
|
};
|
|
59648
59704
|
};
|
|
59705
|
+
/** @description Not Found */
|
|
59706
|
+
404: {
|
|
59707
|
+
headers: {
|
|
59708
|
+
[name: string]: unknown;
|
|
59709
|
+
};
|
|
59710
|
+
content: {
|
|
59711
|
+
"application/json": components["schemas"]["MessageWithCode"];
|
|
59712
|
+
};
|
|
59713
|
+
};
|
|
59649
59714
|
/** @description Internal Server Error */
|
|
59650
59715
|
500: {
|
|
59651
59716
|
headers: {
|