storemw-core-client 1.0.1

package/dist/services/document/DocumentService.d.ts

@@ -0,0 +1,578 @@
+import { ApiServiceType } from '@/lib';
+import { BuildApiListParamsProps, BuildApiGetParamsProps } from '@/lib';
+export declare const documentTypes: {
+    /** sales */
+    readonly profomaSale: "proforma_sales";
+    readonly salesOrder: "sales";
+    readonly proformaSales: "proforma_sales";
+    readonly cashSales: "cash_sales";
+    readonly retailCashSales: "retail_cash_sales";
+    readonly deliveryOrder: "delivery";
+    readonly replacementDelivery: "replacement_delivery";
+    readonly invoice: "invoices";
+    /** purchase */
+    readonly purchaseOrder: "purchase";
+    readonly purchaseReturn: "purchase_return";
+    readonly purchaseInvoice: "purchase_invoice";
+    /** warehouse */
+    readonly packingOrder: "packing_order";
+    readonly itemPicking: "item_picking";
+    readonly itemReceive: "item_receive";
+    readonly itemTransfer: "item_transfer";
+    readonly itemRepack: "item_repack";
+    readonly itemRelocate: "item_relocate";
+    readonly itemTransform: "item_transform";
+    readonly itemIssue: "item_issue";
+    readonly itemAdjustment: "item_adjustment";
+    readonly stockTake: "stock_take";
+    readonly transferReturn: "transfer_return";
+    readonly transferRequisition: "transfer_requisition";
+    readonly pickOrder: "pick_order";
+    /** logistic */
+    readonly tripOrder: "trip";
+    /** Accounting */
+    readonly salesInvoice: "sales_invoice";
+    readonly salesCreditNote: "sales_credit_note";
+    readonly salesDebitNote: "sales_debit_note";
+};
+export type DocumentType = typeof documentTypes[keyof typeof documentTypes];
+export type DocumentTargetType = typeof documentTypes[keyof typeof documentTypes];
+export type DocumentTargetKey = keyof typeof documentTypes;
+export type DocumentServiceProps = ApiServiceType & {
+    documentTargetType?: DocumentTargetType;
+    documentType?: DocumentType;
+};
+export type ListDocumentProps = BuildApiListParamsProps & {
+    documentType: DocumentType;
+};
+export type GetDocumentProps = BuildApiGetParamsProps & {
+    id: number | string;
+    documentType: DocumentType;
+};
+type Document = {
+    docNumber?: string;
+    docDate: string;
+    remark: string;
+};
+type OverrideProfile = {
+    profileName: string;
+    address1: string;
+    address2: string;
+    postcode: string;
+    contact: string;
+    email: string;
+    area: string;
+    countryId: number;
+    stateId: number;
+};
+type Adjustment = {
+    type: "tax" | "discount";
+    referId?: string;
+    description: string;
+    adjustmentAmount: number;
+    adjustmentPercentage: number;
+};
+type Dependency = {
+    scope: "document" | "document_item";
+    target: DocumentTargetType;
+    targetId: number;
+    type: "reference" | "bind";
+};
+type Item = {
+    itemId: number;
+    code: string;
+    name: string;
+    description: string;
+    qty: number;
+    uomName: string;
+    uomId: number;
+    price: number;
+};
+type Payment = {
+    paymentType: string;
+    paymentDate: string;
+    paymentAction: string;
+    bankName: string;
+    bankAccountNo: string;
+    bankAccountName: string;
+    receiveAmount: number;
+    paymentReference: string;
+    paymentPostDate: string;
+};
+type Amount = {
+    requireCollectAmount: number;
+    collectionAmount: number;
+};
+export type CreateDocumentProps = {
+    documentTargetType?: DocumentTargetType;
+    documentType?: DocumentType;
+    data: {
+        salesOrder: {
+            document: Document;
+            profiles: {
+                customer: {
+                    userId: number;
+                };
+                shippingBranch: {
+                    branchId: number;
+                    override?: OverrideProfile;
+                };
+                billingBranch: {
+                    branchId: number;
+                    override?: OverrideProfile;
+                };
+            };
+            props: {
+                locationId: number;
+            };
+            adjustments?: Adjustment[];
+            items: Item[];
+        };
+    } | {
+        proformaSales: {
+            document: Document;
+            profiles: {
+                retailer: {
+                    userId: number;
+                };
+                shippingBranch: {
+                    branchId: number;
+                    override?: OverrideProfile;
+                };
+                billingBranch: {
+                    branchId: number;
+                    override?: OverrideProfile;
+                };
+            };
+            props?: {
+                locationId: number;
+            };
+            adjustments?: Adjustment[];
+            items: Item[];
+        };
+    } | {
+        cashSales: {
+            document: Document;
+            profiles: {
+                customer: {
+                    userId: number;
+                };
+                shippingBranch: {
+                    branchId: number;
+                };
+                billingBranch: {
+                    branchId: number;
+                };
+            };
+            props: {
+                locationId: number;
+                distributionLocationId: number[];
+            };
+            payment: Payment;
+            adjustments?: Adjustment[];
+            items: Item[];
+        };
+    } | {
+        retailCashSales: {
+            document: Document;
+            profiles: {
+                member: {
+                    userId: number;
+                };
+            };
+            props: {
+                locationId: number;
+                retailOutletId: number;
+            };
+            payment: Payment;
+            adjustments?: Adjustment[];
+            items: Item[];
+        };
+    } | {
+        deliveryOrder: {
+            document: Document;
+            profiles: {
+                customer: {
+                    userId: number;
+                };
+                shippingBranch: {
+                    branchId: number;
+                };
+                billingBranch: {
+                    branchId: number;
+                };
+            };
+            props: {
+                locationId: number;
+                distributionLocationId: number;
+                doAlternativeNo: string;
+                soId: number;
+                containerId: number;
+                trackingNo: number;
+            };
+            status: {
+                isPaymentCollect: boolean;
+            };
+            payment: Payment;
+            amounts: Amount;
+            adjustments?: Adjustment[];
+            items: Item[];
+        };
+    } | {
+        replacementDelivery: {
+            document: Document;
+            profiles: {
+                customer: {
+                    userId: number;
+                };
+                shippingBranch: {
+                    branchId: number;
+                };
+                billingBranch: {
+                    branchId: number;
+                };
+            };
+            props: {
+                locationId: number;
+                distributionLocationId: number;
+                collectionRemark: string;
+            };
+            status: {
+                isPaymentCollect: boolean;
+            };
+            dependencies?: Dependency[];
+            amounts: Amount;
+            adjustments?: Adjustment[];
+            items: Item[];
+        };
+    } | {
+        tripOrder: {
+            document: Document;
+            profiles: {
+                driver: {
+                    userId: number;
+                };
+            };
+            status: {
+                isConfirm: boolean;
+            };
+            props: {
+                locationId: number;
+                referenceNo: string;
+                logisticId: number;
+            };
+            documents: {
+                documentId: number;
+                documentDocId: number;
+                remark: string;
+                sequence: number;
+            }[];
+        };
+    } | {
+        salesInvoice: {
+            document: Document;
+            profiles: {
+                customer: {
+                    userId: number;
+                };
+                billingBranch: {
+                    branchId: number;
+                    override?: OverrideProfile;
+                };
+            };
+            props?: {
+                locationId: number;
+            };
+            dependencies?: Dependency[];
+            adjustments?: Adjustment[];
+            items: Item[];
+        };
+    } | {
+        salesDebitNote: {
+            document: Document;
+            profiles: {
+                customer: {
+                    userId: number;
+                };
+            };
+            props?: {
+                locationId: number;
+            };
+            dependencies?: Dependency[];
+            adjustments?: Adjustment[];
+            items: Item[];
+        };
+    } | {
+        salesCreditNote: {
+            document: Document;
+            profiles: {
+                customer: {
+                    userId: number;
+                };
+            };
+            props?: {
+                locationId: number;
+            };
+            dependencies?: Dependency[];
+            adjustments?: Adjustment[];
+            items: Item[];
+        };
+    };
+};
+export type UpdateDocumentProps = {
+    id: number;
+    documentTargetType?: DocumentTargetType;
+    documentType?: DocumentType;
+    data: {
+        salesOrder: {
+            document: Document;
+            profiles: {
+                customer: {
+                    userId: number;
+                };
+                shippingBranch: {
+                    branchId: number;
+                    override?: OverrideProfile;
+                };
+                billingBranch: {
+                    branchId: number;
+                    override?: OverrideProfile;
+                };
+            };
+            props: {
+                locationId: number;
+            };
+            adjustments?: Adjustment[];
+            items: Item[];
+        };
+    } | {
+        proformaSales: {
+            document: Document;
+            profiles: {
+                retailer: {
+                    userId: number;
+                };
+                shippingBranch: {
+                    branchId: number;
+                    override?: OverrideProfile;
+                };
+                billingBranch: {
+                    branchId: number;
+                    override?: OverrideProfile;
+                };
+            };
+            props?: {
+                locationId: number;
+            };
+            adjustments?: Adjustment[];
+            items: Item[];
+        };
+    } | {
+        cashSales: {
+            document: Document;
+            profiles: {
+                customer: {
+                    userId: number;
+                };
+                shippingBranch: {
+                    branchId: number;
+                };
+                billingBranch: {
+                    branchId: number;
+                };
+            };
+            props: {
+                locationId: number;
+                distributionLocationId: number[];
+            };
+            payment: Payment;
+            adjustments?: Adjustment[];
+            items: Item[];
+        };
+    } | {
+        retailCashSales: {
+            document: Document;
+            profiles: {
+                member: {
+                    userId: number;
+                };
+            };
+            props: {
+                locationId: number;
+                retailOutletId: number;
+            };
+            payment: Payment;
+            adjustments?: Adjustment[];
+            items: Item[];
+        };
+    } | {
+        deliveryOrder: {
+            document: Document;
+            profiles: {
+                customer: {
+                    userId: number;
+                };
+                shippingBranch: {
+                    branchId: number;
+                };
+                billingBranch: {
+                    branchId: number;
+                };
+            };
+            props: {
+                locationId: number;
+                distributionLocationId: number;
+                doAlternativeNo: string;
+                soId: number;
+                containerId: number;
+                trackingNo: number;
+            };
+            status: {
+                isPaymentCollect: boolean;
+            };
+            payment: Payment;
+            amounts: Amount;
+            adjustments?: Adjustment[];
+            items: Item[];
+        };
+    } | {
+        replacementDelivery: {
+            document: Document;
+            profiles: {
+                customer: {
+                    userId: number;
+                };
+                shippingBranch: {
+                    branchId: number;
+                };
+                billingBranch: {
+                    branchId: number;
+                };
+            };
+            props: {
+                locationId: number;
+                distributionLocationId: number;
+                collectionRemark: string;
+            };
+            status: {
+                isPaymentCollect: boolean;
+            };
+            dependencies?: Dependency[];
+            amounts: Amount;
+            adjustments?: Adjustment[];
+            items: Item[];
+        };
+    } | {
+        tripOrder: {
+            document: Document;
+            profiles: {
+                driver: {
+                    userId: number;
+                };
+            };
+            status: {
+                isConfirm: boolean;
+            };
+            props: {
+                locationId: number;
+                referenceNo: string;
+                logisticId: number;
+            };
+            documents: {
+                documentId: number;
+                documentDocId: number;
+                remark: string;
+                sequence: number;
+            }[];
+        };
+    } | {
+        salesInvoice: {
+            document: Document;
+            profiles: {
+                customer: {
+                    userId: number;
+                };
+                billingBranch: {
+                    branchId: number;
+                    override?: OverrideProfile;
+                };
+            };
+            props?: {
+                locationId: number;
+            };
+            dependencies?: Dependency[];
+            adjustments?: Adjustment[];
+            items: Item[];
+        };
+    } | {
+        salesDebitNote: {
+            document: Document;
+            profiles: {
+                customer: {
+                    userId: number;
+                };
+            };
+            props?: {
+                locationId: number;
+            };
+            dependencies?: Dependency[];
+            adjustments?: Adjustment[];
+            items: Item[];
+        };
+    } | {
+        salesCreditNote: {
+            document: Document;
+            profiles: {
+                customer: {
+                    userId: number;
+                };
+            };
+            props?: {
+                locationId: number;
+            };
+            dependencies?: Dependency[];
+            adjustments?: Adjustment[];
+            items: Item[];
+        };
+    };
+};
+export type RemoveDocumentProps = {
+    documentTargetType?: DocumentTargetType;
+    ids: number[];
+};
+export type GetDataTypeDocumentProps = {
+    documentType?: DocumentType;
+};
+export declare const DocumentService: (props?: DocumentServiceProps) => {
+    list: (props: ListDocumentProps) => Promise<{
+        status: boolean;
+        message: string;
+        data?: any;
+    }>;
+    get: (props: GetDocumentProps) => Promise<{
+        status: boolean;
+        message: string;
+        data?: any;
+    }>;
+    create: ({ data, documentType: overrideDocumentType, documentTargetType: overrideDocumentTargetType }: CreateDocumentProps) => Promise<{
+        status: boolean;
+        message: string;
+        data?: any;
+    }>;
+    update: ({ id, data, documentType: overrideDocumentType, documentTargetType: overrideDocumentTargetType }: UpdateDocumentProps) => Promise<{
+        status: boolean;
+        message: string;
+        data?: any;
+    }>;
+    remove: ({ ids, documentTargetType: overrideDocumentTargetType }: RemoveDocumentProps) => Promise<{
+        status: boolean;
+        message: string;
+        data?: any;
+    }>;
+    getDataTypes: ({ documentType: overrideDocumentType }: GetDataTypeDocumentProps) => Promise<{
+        status: boolean;
+        message: string;
+        data?: any;
+    }>;
+};
+export {};