@cbm-common/cbm-types 0.0.3 → 0.0.5

package/lib/domain/models/cash-liquidation.domain.model.d.ts

@@ -0,0 +1,319 @@
+export declare namespace CbmCashLiquidationModel {
+    interface ListParams {
+        page: number;
+        size: number;
+        user_id?: string;
+        reverse_status?: boolean;
+        document_number?: string;
+        payment_term_id?: string;
+        date_end?: number;
+        date_begin?: number;
+        cost_center_id?: string;
+        client_id?: string;
+    }
+    interface ListResponse {
+        success: boolean;
+        pageNum: number;
+        pageSize: number;
+        pages: number;
+        total: number;
+        items: ListResponse.Item[];
+    }
+    namespace ListResponse {
+        interface Item {
+            _id: string;
+            company_id: string;
+            cost_center_id: string;
+            document_nomenclature: string;
+            document_number: string;
+            movement_number?: string;
+            date: number;
+            commentary?: string;
+            company_NIF: string;
+            company_address: string;
+            company_trade_name: string;
+            company_business_name: string;
+            cost_center_code: string;
+            cost_center_name: string;
+            created_at: number;
+            user_id: string;
+            cash_register: boolean;
+            created_user: string;
+            reverse_status: boolean;
+            cash_liquidation_detail: Item.Detail[];
+            cash_liquidation_payment_options: Item.Payment[];
+            total_liquidation: number;
+            total_payment: number;
+            reverse_at?: number;
+            reverse_reason?: string;
+            reverse_user?: string;
+        }
+        namespace Item {
+            interface Detail {
+                _id: string;
+                cash_liquidation_id: string;
+                client_id?: string;
+                client_document_number?: string;
+                client_trade_name?: string;
+                client_business_name?: string;
+                client_phone_code?: string;
+                client_address?: string;
+                client_cellphone?: string;
+                client_email?: string;
+                collection_origin_id: string;
+                collection_origin_name: string;
+                client_branch_id?: null;
+                client_branch_code?: null;
+                client_branch_name?: null;
+                client_branch_address?: null;
+                client_branch_email?: null;
+                client_branch_cellphone?: null;
+                client_branch_phone?: null;
+                client_branch_phone_code?: null;
+                client_province_id?: string;
+                client_canton_id?: string;
+                client_parish_id?: string;
+                client_province_code?: string;
+                client_province_name?: string;
+                client_canton_code?: string;
+                client_canton_name?: string;
+                client_parish_code?: string;
+                client_parish_name?: string;
+                document_number: string;
+                document_date: number;
+                previous_balance: number;
+                subsequent_balance: number;
+                liquidated_value: number;
+                created_at: number;
+                created_user: string;
+            }
+            interface Payment {
+                _id: string;
+                cash_liquidation_id: string;
+                payment_term_id: string;
+                financial_bank_id?: string;
+                financial_bank_account_number?: string;
+                card_type?: string;
+                batch_code?: string;
+                value: number;
+                financial_bank_name?: string;
+                operation_number?: null | string;
+                payment_term_code: string;
+                payment_term_name: string;
+                account_id?: string;
+                date?: number;
+                account_name?: string;
+                account_code?: string;
+                bank_cheque?: string;
+                number_cheque?: string;
+            }
+        }
+    }
+    interface SaveBody {
+        cost_center_id: string;
+        date: number;
+        date_deposit: number;
+        commentary?: string;
+        company_NIF: string;
+        company_address: string;
+        company_trade_name: string;
+        company_business_name: string;
+        cost_center_name: string;
+        cost_center_code: string;
+        cash_liquidation_detail: SaveBody.Detail[];
+        cash_liquidation_payment_options: SaveBody.Payment[];
+    }
+    namespace SaveBody {
+        interface Detail {
+            client_id: string;
+            client_document_number: string;
+            client_trade_name: string;
+            client_business_name: string;
+            client_phone_code?: string;
+            client_address: string;
+            client_cellphone?: string;
+            client_email: string;
+            collection_origin_id: string;
+            collection_origin_name: string;
+            client_branch_id?: string;
+            client_branch_code?: string;
+            client_branch_name?: string;
+            client_branch_address?: string;
+            client_branch_email?: string;
+            client_branch_cellphone?: string;
+            client_branch_phone?: string;
+            client_branch_phone_code?: string;
+            client_province_id?: string;
+            client_canton_id?: string;
+            client_parish_id?: string;
+            client_province_code?: string;
+            client_province_name?: string;
+            client_canton_code?: string;
+            client_canton_name?: string;
+            client_parish_code?: string;
+            client_parish_name?: string;
+            document_date: number;
+            document_number: string;
+            previous_balance: number;
+            subsequent_balance: number;
+            liquidated_value: number;
+        }
+        interface Payment {
+            payment_term_id: string;
+            financial_bank_id?: string;
+            financial_bank_account_number?: string;
+            account_id?: string;
+            card_type?: string;
+            batch_code?: string;
+            value: number;
+            financial_bank_name?: string;
+            account_name?: string;
+            account_code?: string;
+            payment_term_name: string;
+            payment_term_code: string;
+            operation_number?: string;
+            bank_cheque?: string;
+            number_cheque?: string;
+        }
+    }
+    interface GetOneResponse {
+        success: boolean;
+        data: GetOneResponse.Data;
+    }
+    namespace GetOneResponse {
+        interface Data {
+            _id: string;
+            company_id: string;
+            cost_center_id: string;
+            document_nomenclature: string;
+            document_number: string;
+            movement_number?: string;
+            date: number;
+            date_deposit?: number;
+            commentary?: string;
+            company_NIF: string;
+            company_address: string;
+            company_trade_name: string;
+            company_business_name: string;
+            cost_center_code: string;
+            cost_center_name: string;
+            created_at: number;
+            user_id: string;
+            cash_register: boolean;
+            created_user: string;
+            reverse_status: boolean;
+            reverse_user?: string;
+            reverse_at?: number;
+            reverse_reason?: string;
+            cash_liquidation_detail: Data.Detail[];
+            cash_liquidation_payment_options: Data.Payment[];
+            total_liquidation: number;
+            total_payment: number;
+        }
+        namespace Data {
+            interface Detail {
+                _id: string;
+                cash_liquidation_id: string;
+                client_id: string;
+                client_document_number: string;
+                client_trade_name: string;
+                client_business_name: string;
+                client_phone_code?: string;
+                client_address: string;
+                client_cellphone?: string;
+                client_email: string;
+                collection_origin_id: string;
+                collection_origin_name: string;
+                client_branch_id?: string;
+                client_branch_code?: string;
+                client_branch_name?: string;
+                client_branch_address?: string;
+                client_branch_email?: string;
+                client_branch_cellphone?: string;
+                client_branch_phone?: string;
+                client_branch_phone_code?: string;
+                client_province_id?: string;
+                client_canton_id?: string;
+                client_parish_id?: string;
+                client_province_code?: string;
+                client_province_name?: string;
+                client_canton_code?: string;
+                client_canton_name?: string;
+                client_parish_code?: string;
+                client_parish_name?: string;
+                document_number: string;
+                previous_balance: number;
+                subsequent_balance: number;
+                liquidated_value: number;
+                document_date: number;
+                created_at: number;
+                created_user: string;
+            }
+            interface Payment {
+                _id: string;
+                account_id?: string;
+                cash_liquidation_id: string;
+                payment_term_id: string;
+                financial_bank_id?: string;
+                financial_bank_account_number?: string;
+                card_type?: string;
+                batch_code?: string;
+                value: number;
+                account_name?: string;
+                account_code?: string;
+                financial_bank_name?: string;
+                operation_number?: string;
+                payment_term_code: string;
+                payment_term_name: string;
+                bank_cheque?: string;
+                number_cheque?: string;
+            }
+        }
+    }
+    interface ConfirmResponse {
+        success: boolean;
+        message: string;
+        data?: any;
+    }
+    interface DownloadExcelParams {
+        timezone: string;
+        locale: string;
+        user_id?: string;
+        payment_term_id?: string;
+        reverse_status?: boolean;
+        document_number?: string;
+        date_end?: number;
+        date_begin?: number;
+        type?: string;
+        cost_center_id?: string;
+        client_id?: string;
+    }
+    interface DownloadGeneralPdfParams {
+        timezone: string;
+        locale: string;
+        user_id?: string;
+        payment_term_id?: string;
+        reverse_status?: boolean;
+        document_number?: string;
+        date_end?: number;
+        date_begin?: number;
+        type?: string;
+        cost_center_id?: string;
+        client_id?: string;
+    }
+    interface DownloadIndividualPdfParams {
+        timezone: string;
+        locale: string;
+        id: string;
+    }
+    interface DownloadIndividualExcelParams {
+        timezone: string;
+        locale: string;
+        id: string;
+    }
+    interface SendEmailParams {
+        timezone: string;
+        locale: string;
+        emails?: string;
+    }
+}

package/lib/domain/models/client-branch.domain.model.d.ts

@@ -0,0 +1,35 @@
+export declare namespace CbmClientBranchModel {
+    interface ListParams {
+        enabled?: boolean;
+        client_id: string;
+        filter?: string;
+    }
+    interface ListResponse {
+        success: boolean;
+        data: ListResponse.Data[];
+    }
+    namespace ListResponse {
+        interface Data {
+            _id: string;
+            client_id?: string;
+            province_id?: string;
+            canton_id?: string;
+            parish_id?: string;
+            seller_id?: string;
+            name?: string;
+            code?: string;
+            address?: string;
+            email?: string;
+            cellphone?: string;
+            phone?: string;
+            phone_code?: string;
+            enabled?: boolean;
+            deleted?: boolean;
+            created_user?: string;
+            created_at?: number;
+            disabled_reason?: string;
+            updated_at?: number;
+            updated_user?: string;
+        }
+    }
+}

package/lib/domain/models/client-category.domain.model.d.ts

@@ -0,0 +1,69 @@
+export declare namespace CbmClientCategoryModel {
+    interface ListParams {
+        enabled?: boolean;
+        name?: string;
+        group_id?: string;
+    }
+    interface ListResponse {
+        success: boolean;
+        data: ListResponse.Data[];
+    }
+    namespace ListResponse {
+        interface Data {
+            _id: string;
+            name: string;
+            company_id: string;
+            group_id: string;
+            receivable_account_id: string;
+            advanced_account_id: string;
+            enabled: boolean;
+            created_user: string;
+            created_at: number;
+            updated_at: number;
+            updated_user: string;
+        }
+    }
+    interface SaveBody {
+        group_id: string;
+        name: string;
+        receivable_account_id: string;
+        advanced_acount_id: string;
+    }
+    interface UpdateBody {
+        group_id?: string;
+        name?: string;
+        receivable_account_id?: string;
+        advanced_acount_id?: string;
+    }
+    interface GetOneResponse {
+        success: boolean;
+        data: GetOneResponse.Data;
+    }
+    namespace GetOneResponse {
+        interface Data {
+            _id?: string;
+            company_id?: string;
+            group_id?: string;
+            name?: string;
+            enabled?: string;
+            created_user?: string;
+            receivable_account_id?: string;
+            advanced_acount_id?: string;
+            created_at?: string;
+            updated_at?: string;
+            updated_user?: string;
+        }
+    }
+    interface ConfirmResponse {
+        success: boolean;
+        message: string;
+        data?: any;
+    }
+    interface ChangeStatusBody {
+        enabled: boolean;
+        disabled_reason?: string;
+    }
+    interface ValidateAccountResponse {
+        success: boolean;
+    }
+}

package/lib/domain/models/client-group.domain.model.d.ts

@@ -0,0 +1,102 @@
+export declare namespace CbmClientGroupModel {
+    interface ListResponse {
+        success: boolean;
+        data: ListResponse.Data[];
+    }
+    namespace ListResponse {
+        interface Data {
+            _id: string;
+            company_id: string;
+            group_id: string;
+            initial: boolean;
+            level: number;
+            name: string;
+            enabled: boolean;
+            created_user: string;
+            created_at: number;
+        }
+    }
+    interface ListAsTreeParams {
+        name?: string;
+    }
+    interface ListAsTreeResponse {
+        success: boolean;
+        data: ListAsTreeResponse.Children;
+    }
+    namespace ListAsTreeResponse {
+        type Children = Child[];
+        interface Child {
+            label: string;
+            value: Group | Category;
+            children?: Children;
+        }
+        interface Group {
+            _id: string;
+            company_id?: string;
+            group_id?: string;
+            initial?: boolean;
+            level?: number;
+            name?: string;
+            enabled?: boolean;
+            deleted?: boolean;
+            created_user?: string;
+            created_at?: number;
+            updated_user?: string;
+            updated_at?: number;
+            disabled_reason?: string;
+        }
+        interface Category {
+            _id: string;
+            company_id?: string;
+            group_id?: string;
+            name?: string;
+            receivable_account_id?: string;
+            advanced_account_id?: string;
+            enabled?: boolean;
+            deleted?: boolean;
+            created_user?: string;
+            created_at?: number;
+            updated_user?: string;
+            updated_at?: number;
+            disabled_reason?: string;
+        }
+    }
+    interface GetOneResponse {
+        success: boolean;
+        data: GetOneResponse.Data;
+    }
+    namespace GetOneResponse {
+        interface Data {
+            _id?: string;
+            company_id?: string;
+            group_id?: string;
+            initial?: boolean;
+            level?: number;
+            name?: string;
+            enabled?: boolean;
+            created_user?: string;
+            created_at?: number;
+        }
+    }
+    interface SaveBody {
+        group_id: string;
+        initial: boolean;
+        level: number;
+        name: string;
+    }
+    interface UpdateBody {
+        group_id?: string;
+        initial?: boolean;
+        level?: number;
+        name?: string;
+    }
+    interface ChangeStatusBody {
+        enabled: boolean;
+        disabled_reason?: string;
+    }
+    interface ConfirmResponse {
+        success: boolean;
+        message: string;
+        data?: any;
+    }
+}