@kipicore/dbcore 1.1.630 → 1.1.632

package/dist/interfaces/accountBudgetConsumptionInterface.d.ts

@@ -0,0 +1,10 @@
+import { IDefaultAttributes } from './commonInterface';
+export interface IAccountBudgetConsumptionModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    budgetId: string;
+    journalLineId: string;
+    amount: number;
+    consumedOn: Date;
+}

package/dist/interfaces/accountBudgetConsumptionInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/accountBudgetInterface.d.ts

@@ -0,0 +1,35 @@
+import { IDefaultAttributes } from './commonInterface';
+import { AccountBudgetType } from '../constants/app';
+export interface IAccountBudgetModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    financialYearId: string;
+    costCenterId?: string;
+    ledgerId?: string;
+    groupId?: string;
+    budgetName: string;
+    budgetType: AccountBudgetType;
+    amount: number;
+}
+export interface IAccountBudgetImportRmsResponse {
+    importedCount: number;
+    budgets: IAccountBudgetModelAttributes[];
+}
+export interface IAccountBudgetUtilizationResponse {
+    budgetId: string;
+    allocatedAmount: number;
+    consumedAmount: number;
+    remainingAmount: number;
+    utilizationPercentage: number;
+}
+export interface IAccountBudgetForecastResponse {
+    budgetId: string;
+    allocatedAmount: number;
+    consumedAmount: number;
+    elapsedDays: number;
+    totalDays: number;
+    dailyRunRate: number;
+    projectedConsumption: number;
+    isOverBudgetProjected: boolean;
+}

package/dist/interfaces/accountBudgetInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/accountBudgetPeriodInterface.d.ts

@@ -0,0 +1,10 @@
+import { IDefaultAttributes } from './commonInterface';
+export interface IAccountBudgetPeriodModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    budgetId: string;
+    periodStart: Date;
+    periodEnd: Date;
+    allocatedAmount: number;
+}

package/dist/interfaces/accountBudgetPeriodInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/accountCostCenterInterface.d.ts

@@ -11,3 +11,6 @@ export interface IAccountCostCenterModelAttributes extends IDefaultAttributes {
     refType: string | null;
     refId: string | null;
 }
+export interface IAccountCostCenterTree extends IAccountCostCenterModelAttributes {
+    children?: IAccountCostCenterTree[];
+}

package/dist/interfaces/accountDashboardInterface.d.ts

@@ -0,0 +1,75 @@
+export interface IAccountantDashboardResponse {
+    instituteId: string;
+    academicCalendarId: string;
+    financialYearId: string;
+    metrics: {
+        pendingVouchersCount: number;
+        unreconciledBankLinesCount: number;
+        pendingExpenseRequestsCount: number;
+        draftInvoicesCount: number;
+        todayReceiptsAmount: number;
+        todayPaymentsAmount: number;
+    };
+    recentPendingVouchers: {
+        id: string;
+        voucherNumber: string;
+        voucherDate: Date;
+        amount: number;
+        status: string;
+    }[];
+}
+export interface IPrincipalDashboardResponse {
+    instituteId: string;
+    academicCalendarId: string;
+    financialYearId: string;
+    metrics: {
+        currentMonthFeeCollection: number;
+        annualFeeCollectionTarget: number;
+        collectionPercentage: number;
+        currentMonthOperationalExpense: number;
+        liquidBankAndCashBalance: number;
+    };
+    topExpenseCategories: {
+        categoryName: string;
+        totalAmount: number;
+        percentageOfTotal: number;
+    }[];
+}
+export interface ITrusteeDashboardResponse {
+    instituteId: string;
+    academicCalendarId: string;
+    financialYearId: string;
+    metrics: {
+        ytdRevenue: number;
+        ytdExpenditure: number;
+        netSurplusOrDeficit: number;
+        totalFixedAssetValuation: number;
+        overallFundUtilizationRate: number;
+    };
+    fundCorpusSummary: {
+        fundId: string;
+        fundName: string;
+        allocatedAmount: number;
+        utilizedAmount: number;
+        balanceAmount: number;
+    }[];
+}
+export interface ICaDashboardResponse {
+    instituteId: string;
+    academicCalendarId: string;
+    financialYearId: string;
+    complianceMetrics: {
+        unpostedVouchersCount: number;
+        draftVouchersCount: number;
+        isPeriodLocked: boolean;
+        netGstPayable: number;
+        unreconciledBankDifference: number;
+        isTrialBalanceBalanced: boolean;
+    };
+    auditFlags: {
+        flagType: string;
+        severity: 'HIGH' | 'MEDIUM' | 'LOW';
+        message: string;
+        count: number;
+    }[];
+}

package/dist/interfaces/accountDashboardInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/accountDonorInterface.d.ts

@@ -0,0 +1,12 @@
+import { IDefaultAttributes } from './commonInterface';
+import { AccountDonorType } from '../constants/app';
+export interface IAccountDonorModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    donorName: string;
+    donorType: AccountDonorType;
+    contactDetails?: object;
+    totalDonated?: number;
+    fundId?: string;
+}

package/dist/interfaces/accountDonorInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/accountExpenseCategoryInterface.d.ts

@@ -0,0 +1,10 @@
+import { IDefaultAttributes } from './commonInterface';
+export interface IAccountExpenseCategoryModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    name?: string;
+    defaultLedgerId?: string;
+    defaultCostCenterId?: string;
+    taxTypeId?: string;
+}

package/dist/interfaces/accountExpenseCategoryInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/accountExpensePaymentInterface.d.ts

@@ -0,0 +1,14 @@
+import { IDefaultAttributes } from './commonInterface';
+import { AccountPaymentMode } from '../constants/app';
+export interface IAccountExpensePaymentModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    expenseRequestId: string;
+    bankAccountId?: string;
+    paymentMode: AccountPaymentMode;
+    paidAmount: number;
+    paidDate: Date;
+    voucherId?: string;
+    journalEntryId?: string;
+}

package/dist/interfaces/accountExpensePaymentInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/accountExpenseRequestInterface.d.ts

@@ -0,0 +1,27 @@
+import { IDefaultAttributes } from './commonInterface';
+import { AccountApprovalStatus, AccountExpensePaymentStatus } from '../constants/app';
+export interface IAccountExpenseRequestModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    expenseCategoryId: string;
+    vendorId?: string;
+    amount: number;
+    expenseDate: Date;
+    dueDate?: Date;
+    billFileStorageId?: string;
+    approvalStatus?: AccountApprovalStatus;
+    paymentStatus?: AccountExpensePaymentStatus;
+    journalEntryId?: string;
+}
+export interface IAccountExpenseApproveResponse {
+    id: string;
+    approvalStatus: AccountApprovalStatus;
+    eventGenerated: boolean;
+}
+export interface IAccountExpensePayResponse {
+    id: string;
+    paymentStatus: AccountExpensePaymentStatus;
+    paymentId?: string;
+    eventGenerated: boolean;
+}

package/dist/interfaces/accountExpenseRequestInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/accountFinancialKpiInterface.d.ts

@@ -0,0 +1,13 @@
+import { IDefaultAttributes } from './commonInterface';
+import { AccountFinancialKpiCode } from '../constants/app';
+export interface IAccountFinancialKpiModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    periodStart: Date;
+    periodEnd: Date;
+    kpiCode: AccountFinancialKpiCode;
+    value: number;
+    costCenterId?: string;
+    sourceSnapshotId?: string;
+}

package/dist/interfaces/accountFinancialKpiInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/accountFinancialYearInterface.d.ts

@@ -11,3 +11,9 @@ export interface IAccountFinancialYearModelAttributes extends IDefaultAttributes
     isClosed: boolean;
     status: COMMAN_STATUS;
 }
+export interface IAccountFinancialYearCloseResponse {
+    isClosed: boolean;
+}
+export interface IAccountFinancialYearCarryForwardResponse {
+    carriedForwardCount: number;
+}

package/dist/interfaces/accountFixedAssetInterface.d.ts

@@ -0,0 +1,13 @@
+import { IDefaultAttributes } from './commonInterface';
+export interface IAccountFixedAssetModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    rmsAssetId?: string;
+    categoryId: string;
+    assetCode?: string;
+    purchaseDate: Date;
+    capitalizationDate?: Date;
+    purchaseCost: number;
+    residualValue: number;
+}

package/dist/interfaces/accountFixedAssetInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/accountFundInterface.d.ts

@@ -0,0 +1,24 @@
+import { IDefaultAttributes } from './commonInterface';
+import { AccountFundType, COMMAN_STATUS } from '../constants/app';
+export interface IAccountFundModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    fundName: string;
+    fundType: AccountFundType;
+    totalAmount: number;
+    balanceAmount: number;
+    startDate?: Date;
+    endDate?: Date;
+    status: COMMAN_STATUS;
+    ledgerId?: string;
+}
+export interface IAccountFundUtilizationResponse {
+    fundId: string;
+    fundName: string;
+    totalAmount: number;
+    totalInflow: number;
+    totalOutflow: number;
+    remainingBalance: number;
+    utilizationRate: number;
+}

package/dist/interfaces/accountFundInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/accountFundTransactionInterface.d.ts

@@ -0,0 +1,15 @@
+import { IDefaultAttributes } from './commonInterface';
+import { AccountFundTransactionType } from '../constants/app';
+export interface IAccountFundTransactionModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    fundId: string;
+    donorId?: string;
+    grantId?: string;
+    journalLineId?: string;
+    transactionType: AccountFundTransactionType;
+    amount: number;
+    transactionDate: Date;
+    remarks?: string;
+}

package/dist/interfaces/accountFundTransactionInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/accountGrantInterface.d.ts

@@ -0,0 +1,14 @@
+import { IDefaultAttributes } from './commonInterface';
+import { COMMAN_STATUS } from '../constants/app';
+export interface IAccountGrantModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    grantName: string;
+    grantProvider: string;
+    totalAmount: number;
+    startDate?: Date;
+    endDate?: Date;
+    status: COMMAN_STATUS;
+    fundId?: string;
+}

package/dist/interfaces/accountGrantInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/accountGroupInterface.d.ts

@@ -11,3 +11,6 @@ export interface IAccountGroupModelAttributes extends IDefaultAttributes {
     normalBalance: AccountNormalBalance;
     isSystem: boolean;
 }
+export interface IAccountGroupTree extends IAccountGroupModelAttributes {
+    children?: IAccountGroupTree[];
+}

package/dist/interfaces/accountIntegrationConnectionInterface.d.ts

@@ -0,0 +1,9 @@
+import { IDefaultAttributes } from './commonInterface';
+import { AccountIntegrationProvider } from '../constants/app';
+export interface IAccountIntegrationConnectionModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    provider: AccountIntegrationProvider;
+    configJson: any;
+}

package/dist/interfaces/accountIntegrationConnectionInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/accountIntegrationMappingInterface.d.ts

@@ -0,0 +1,14 @@
+import { IDefaultAttributes } from './commonInterface';
+import { AccountIntegrationProvider, AccountIntegrationMappingType } from '../constants/app';
+export interface IAccountIntegrationMappingModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    connectionId: string;
+    provider: AccountIntegrationProvider;
+    mappingType: AccountIntegrationMappingType;
+    kipiObjectType: string;
+    kipiObjectId: string;
+    externalId: string;
+    externalName?: string;
+}

package/dist/interfaces/accountIntegrationMappingInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/accountInventoryPostingInterface.d.ts

@@ -0,0 +1,12 @@
+import { IDefaultAttributes } from './commonInterface';
+import { AccountSourceModule, AccountInventoryMovementType } from '../constants/app';
+export interface IAccountInventoryPostingModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    sourceModule: AccountSourceModule;
+    sourceId: string;
+    movementType: AccountInventoryMovementType;
+    amount: number;
+    journalEntryId: string;
+}

package/dist/interfaces/accountInventoryPostingInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/accountInventoryValuationInterface.d.ts

@@ -0,0 +1,14 @@
+import { IDefaultAttributes } from './commonInterface';
+import { AccountInventoryValuationMethod } from '../constants/app';
+export interface IAccountInventoryValuationModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    resourceId: string;
+    financialYearId: string;
+    valuationMethod: AccountInventoryValuationMethod;
+    quantity: number;
+    unitCost: number;
+    currentValue: number;
+    journalEntryId: string;
+}

package/dist/interfaces/accountInventoryValuationInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/accountJournalEntryInterface.d.ts

@@ -0,0 +1,19 @@
+import { IDefaultAttributes } from './commonInterface';
+import { AccountSourceModule } from '../constants/app';
+export interface IAccountJournalEntryModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    voucherId: string;
+    postingDate: Date;
+    financialYearId: string;
+    eventId?: string;
+    sourceModule?: AccountSourceModule;
+    sourceType?: string;
+    sourceId?: string;
+    isIncludeInstitute?: boolean;
+    isIncludeAcademicCalendar?: boolean;
+    isIncludeVoucher?: boolean;
+    isIncludeFinancialYear?: boolean;
+    isIncludeLines?: boolean;
+}

package/dist/interfaces/accountJournalEntryInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/accountJournalLineInterface.d.ts

@@ -0,0 +1,28 @@
+import { IDefaultAttributes } from './commonInterface';
+import { IAccountJournalEntryModelAttributes } from './accountJournalEntryInterface';
+export interface IAccountJournalLineModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    journalEntryId: string;
+    ledgerId?: string;
+    costCenterId?: string;
+    debitAmount?: number;
+    creditAmount?: number;
+    entityType?: string;
+    entityId?: string;
+    lineNarration?: string;
+    isIncludeInstitute?: boolean;
+    isIncludeAcademicCalendar?: boolean;
+    isIncludeJournalEntry?: boolean;
+    isIncludeLedger?: boolean;
+    isIncludeCostCenter?: boolean;
+}
+export interface IAccountJournalLineWithEntry extends IAccountJournalLineModelAttributes {
+    journalEntry?: IAccountJournalEntryModelAttributes & {
+        voucher?: {
+            voucherNo: string;
+            voucherDate: Date;
+        };
+    };
+}

package/dist/interfaces/accountJournalLineInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/accountLedgerBalanceInterface.d.ts

@@ -0,0 +1,17 @@
+import { IDefaultAttributes } from './commonInterface';
+export interface IAccountLedgerBalanceModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    ledgerId?: string;
+    financialYearId?: string;
+    periodMonth?: number;
+    openingBalance?: number;
+    periodDebit?: number;
+    periodCredit?: number;
+    closingBalance?: number;
+    isIncludeInstitute?: boolean;
+    isIncludeAcademicCalendar?: boolean;
+    isIncludeLedger?: boolean;
+    isIncludeFinancialYear?: boolean;
+}

package/dist/interfaces/accountLedgerBalanceInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/accountLedgerInterface.d.ts

@@ -14,3 +14,20 @@ export interface IAccountLedgerModelAttributes extends IDefaultAttributes {
     bankAccountId?: string | null;
     allowManualPosting: boolean;
 }
+export interface IAccountLedgerStatementResponse {
+    openingBalance: number;
+    openingType: 'DR' | 'CR';
+    totalDebit: number;
+    totalCredit: number;
+    closingBalance: number;
+    closingType: 'DR' | 'CR';
+    lines: Array<{
+        date: string;
+        description: string;
+        voucherNo: string;
+        debit: number;
+        credit: number;
+        runningBalance: number;
+        runningType: 'DR' | 'CR';
+    }>;
+}

package/dist/interfaces/accountPartyAccountInterface.d.ts

@@ -0,0 +1,14 @@
+import { IDefaultAttributes } from './commonInterface';
+import { AccountPartyType, AccountPartyMode } from '../constants/app';
+export interface IAccountPartyAccountModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    partyType?: AccountPartyType;
+    partyId?: string;
+    ledgerId?: string;
+    mode?: AccountPartyMode;
+    isIncludeInstitute?: boolean;
+    isIncludeAcademicCalendar?: boolean;
+    isIncludeLedger?: boolean;
+}

package/dist/interfaces/accountPartyAccountInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/accountPostingEventInterface.d.ts

@@ -0,0 +1,32 @@
+import { IDefaultAttributes } from './commonInterface';
+import { AccountSourceModule, AccountEventType, AccountPostingEventStatus } from '../constants/app';
+export interface IAccountPostingEventModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    eventKey?: string;
+    sourceModule?: AccountSourceModule;
+    sourceType?: string;
+    sourceId?: string;
+    eventType?: AccountEventType;
+    eventDate?: Date;
+    payloadJson?: unknown;
+    journalEntryId?: string;
+    errorMessage?: string;
+    status?: AccountPostingEventStatus;
+    isIncludeInstitute?: boolean;
+    isIncludeAcademicCalendar?: boolean;
+    isIncludeJournalEntry?: boolean;
+}
+export interface IAccountPostingEventPreviewResponse {
+    message: string;
+    data: unknown[];
+}
+export interface IAccountPostingEventRetryResponse {
+    id: string;
+    status: AccountPostingEventStatus;
+}
+export interface IAccountPostingEventExecuteResponse {
+    id: string;
+    status: AccountPostingEventStatus;
+}

package/dist/interfaces/accountPostingEventInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/accountPostingRuleInterface.d.ts

@@ -0,0 +1,24 @@
+import { IDefaultAttributes } from './commonInterface';
+import { AccountSourceModule, AccountEventType } from '../constants/app';
+export interface IAccountPostingRuleModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    sourceModule?: AccountSourceModule;
+    eventType?: AccountEventType;
+    priority?: number;
+    conditionsJson?: unknown;
+    debitStrategy?: string;
+    creditStrategy?: string;
+    costCenterStrategy?: string;
+    effectiveFrom?: Date;
+    effectiveTo?: Date;
+    isIncludeInstitute?: boolean;
+    isIncludeAcademicCalendar?: boolean;
+}
+export interface IAccountPostingRuleTestResponse {
+    id: string;
+    status: string;
+    simulatedDebits: unknown[];
+    simulatedCredits: unknown[];
+}

package/dist/interfaces/accountPostingRuleInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/accountReportSnapshotInterface.d.ts

@@ -0,0 +1,14 @@
+import { IDefaultAttributes } from './commonInterface';
+import { AccountReportType } from '../constants/app';
+export interface IAccountReportSnapshotModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    reportType: AccountReportType;
+    financialYearId: string;
+    fromDate: Date;
+    toDate: Date;
+    filtersJson?: any;
+    reportFileStorageId?: string;
+    generatedBy?: string;
+}