@kipicore/dbcore 1.1.630 → 1.1.632

package/dist/interfaces/accountReportSnapshotInterface.js

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

package/dist/interfaces/accountReportingInterface.d.ts

@@ -0,0 +1,282 @@
+import { IAccountJournalLineModelAttributes } from './accountJournalLineInterface';
+import { IAccountVoucherModelAttributes } from './accountVoucherInterface';
+import { IAccountJournalEntryModelAttributes } from './accountJournalEntryInterface';
+import { IAccountLedgerModelAttributes } from './accountLedgerInterface';
+import { IAccountFixedAssetModelAttributes } from './accountFixedAssetInterface';
+export interface IDayBookEntry {
+    voucherId: string;
+    voucherNumber: string;
+    voucherDate: Date;
+    voucherType: string;
+    narration?: string;
+    partyName?: string;
+    lines: IAccountJournalLineModelAttributes[];
+    totalDebit: number;
+    totalCredit: number;
+}
+export interface IDayBookResponse {
+    instituteId: string;
+    academicCalendarId: string;
+    financialYearId: string;
+    dateRange: {
+        startDate?: Date;
+        endDate?: Date;
+    };
+    entries: IDayBookEntry[];
+    grandTotalDebit: number;
+    grandTotalCredit: number;
+}
+export interface IJournalRegisterResponse {
+    instituteId: string;
+    academicCalendarId: string;
+    financialYearId: string;
+    entries: {
+        journalEntry: IAccountJournalEntryModelAttributes;
+        lines: IAccountJournalLineModelAttributes[];
+        isBalanced: boolean;
+    }[];
+    totalCount: number;
+}
+export interface IVoucherRegisterResponse {
+    instituteId: string;
+    academicCalendarId: string;
+    financialYearId: string;
+    vouchers: IAccountVoucherModelAttributes[];
+    summaryByType: {
+        [voucherType: string]: {
+            count: number;
+            totalAmount: number;
+        };
+    };
+    summaryByStatus: {
+        [status: string]: {
+            count: number;
+            totalAmount: number;
+        };
+    };
+    totalCount: number;
+}
+export interface ITrialBalanceItem {
+    ledgerId: string;
+    ledgerName: string;
+    ledgerCode?: string;
+    groupId?: string;
+    groupName?: string;
+    openingBalance: number;
+    periodDebit: number;
+    periodCredit: number;
+    closingDebit: number;
+    closingCredit: number;
+}
+export interface ITrialBalanceResponse {
+    instituteId: string;
+    academicCalendarId: string;
+    financialYearId: string;
+    asOfDate?: Date;
+    items: ITrialBalanceItem[];
+    totalOpeningDebit: number;
+    totalOpeningCredit: number;
+    totalPeriodDebit: number;
+    totalPeriodCredit: number;
+    totalClosingDebit: number;
+    totalClosingCredit: number;
+    isBalanced: boolean;
+}
+export interface ICashBookResponse {
+    instituteId: string;
+    academicCalendarId: string;
+    financialYearId: string;
+    ledgerId?: string;
+    ledgerName?: string;
+    openingBalance: number;
+    receipts: IAccountJournalLineModelAttributes[];
+    payments: IAccountJournalLineModelAttributes[];
+    totalReceipts: number;
+    totalPayments: number;
+    closingBalance: number;
+}
+export interface IIncomeExpenseGroupSummary {
+    groupId: string;
+    groupName: string;
+    totalAmount: number;
+    ledgers: {
+        ledgerId: string;
+        ledgerName: string;
+        amount: number;
+    }[];
+}
+export interface IIncomeExpenseResponse {
+    instituteId: string;
+    academicCalendarId: string;
+    financialYearId: string;
+    operatingIncome: IIncomeExpenseGroupSummary[];
+    nonOperatingIncome: IIncomeExpenseGroupSummary[];
+    operatingExpense: IIncomeExpenseGroupSummary[];
+    nonOperatingExpense: IIncomeExpenseGroupSummary[];
+    totalIncome: number;
+    totalExpense: number;
+    netSurplusOrDeficit: number;
+}
+export interface IBalanceSheetResponse {
+    instituteId: string;
+    academicCalendarId: string;
+    financialYearId: string;
+    asOfDate?: Date;
+    assets: IIncomeExpenseGroupSummary[];
+    liabilities: IIncomeExpenseGroupSummary[];
+    capitalAndReserves: IIncomeExpenseGroupSummary[];
+    totalAssets: number;
+    totalLiabilities: number;
+    totalCapital: number;
+    netSurplusOrDeficit: number;
+    isBalanced: boolean;
+}
+export interface ICashFlowResponse {
+    instituteId: string;
+    academicCalendarId: string;
+    financialYearId: string;
+    operatingCashFlow: number;
+    investingCashFlow: number;
+    financingCashFlow: number;
+    netCashChange: number;
+    openingCashBalance: number;
+    closingCashBalance: number;
+}
+export interface ILedgerStatementResponse {
+    instituteId: string;
+    academicCalendarId: string;
+    financialYearId: string;
+    ledger: IAccountLedgerModelAttributes;
+    openingBalance: number;
+    lines: (IAccountJournalLineModelAttributes & {
+        runningBalance: number;
+    })[];
+    totalDebit: number;
+    totalCredit: number;
+    closingBalance: number;
+}
+export interface ICostCenterReportResponse {
+    instituteId: string;
+    academicCalendarId: string;
+    financialYearId: string;
+    costCenters: {
+        costCenterId: string;
+        costCenterName: string;
+        totalRevenue: number;
+        totalExpense: number;
+        netMargin: number;
+    }[];
+}
+export interface IStudentOutstandingItem {
+    studentId: string;
+    studentName?: string;
+    batchId?: string;
+    totalBilled: number;
+    totalPaid: number;
+    outstandingAmount: number;
+}
+export interface IStudentOutstandingResponse {
+    instituteId: string;
+    academicCalendarId: string;
+    financialYearId: string;
+    students: IStudentOutstandingItem[];
+    totalOutstanding: number;
+}
+export interface IAssetRegisterResponse {
+    instituteId: string;
+    academicCalendarId: string;
+    financialYearId: string;
+    assets: (IAccountFixedAssetModelAttributes & {
+        accumulatedDepreciation: number;
+        netBookValue: number;
+    })[];
+    totalGrossBlock: number;
+    totalAccumulatedDepreciation: number;
+    totalNetBookValue: number;
+}
+export interface IDepreciationRegisterResponse {
+    instituteId: string;
+    academicCalendarId: string;
+    financialYearId: string;
+    schedules: {
+        assetId: string;
+        assetName?: string;
+        scheduledDate: Date;
+        depreciationAmount: number;
+        isPosted: boolean;
+        voucherId?: string;
+    }[];
+    totalScheduled: number;
+    totalPosted: number;
+}
+export interface IBudgetVsActualItem {
+    budgetId: string;
+    budgetName: string;
+    budgetType: string;
+    allocatedAmount: number;
+    consumedAmount: number;
+    varianceAmount: number;
+    utilizationPercentage: number;
+}
+export interface IBudgetVsActualResponse {
+    instituteId: string;
+    academicCalendarId: string;
+    financialYearId: string;
+    budgets: IBudgetVsActualItem[];
+    totalAllocated: number;
+    totalConsumed: number;
+    overallUtilizationPercentage: number;
+}
+export interface IGstRegisterResponse {
+    instituteId: string;
+    academicCalendarId: string;
+    financialYearId: string;
+    entries: {
+        taxCode: string;
+        taxRate: number;
+        taxableAmount: number;
+        cgstAmount: number;
+        sgstAmount: number;
+        igstAmount: number;
+        totalTaxAmount: number;
+    }[];
+    totalInputTax: number;
+    totalOutputTax: number;
+    netGstLiability: number;
+}
+export interface IAuditTrailResponse {
+    instituteId: string;
+    academicCalendarId: string;
+    financialYearId: string;
+    logs: {
+        id: string;
+        entityName: string;
+        entityId: string;
+        action: string;
+        performedBy?: string;
+        timestamp: Date;
+        changes?: Record<string, unknown>;
+    }[];
+    totalLogs: number;
+}
+export interface IAuditPackageResponse {
+    instituteId: string;
+    academicCalendarId: string;
+    financialYearId: string;
+    generatedAt: Date;
+    trialBalanceSummary: {
+        totalDebit: number;
+        totalCredit: number;
+        isBalanced: boolean;
+    };
+    balanceSheetSummary: {
+        totalAssets: number;
+        totalLiabilitiesAndCapital: number;
+        isBalanced: boolean;
+    };
+    gstLiabilitySummary: {
+        netGstLiability: number;
+    };
+    auditLogCount: number;
+    status: 'READY' | 'PENDING';
+}

package/dist/interfaces/accountReportingInterface.js

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

package/dist/interfaces/accountRuleLedgerMappingInterface.d.ts

@@ -0,0 +1,20 @@
+import { IDefaultAttributes } from './commonInterface';
+export interface IAccountRuleLedgerMappingModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    ruleId?: string;
+    sourceRefType?: string;
+    sourceRefId?: string;
+    debitLedgerId?: string;
+    creditLedgerId?: string;
+    taxTypeId?: string;
+    costCenterId?: string;
+    isDefault?: boolean;
+    isIncludeInstitute?: boolean;
+    isIncludeAcademicCalendar?: boolean;
+    isIncludeRule?: boolean;
+    isIncludeDebitLedger?: boolean;
+    isIncludeCreditLedger?: boolean;
+    isIncludeCostCenter?: boolean;
+}

package/dist/interfaces/accountRuleLedgerMappingInterface.js

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

package/dist/interfaces/accountSettingInterface.d.ts

@@ -0,0 +1,11 @@
+import { Document } from 'mongoose';
+import { IDefaultAttributes } from './commonInterface';
+import { ACCOUNT_SETTING_STATUS } from '../constants/app';
+export interface IAccountSettingModelAttributes extends IDefaultAttributes, Document {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    isSetupCompleted: boolean;
+    config: any;
+    status: ACCOUNT_SETTING_STATUS;
+}

package/dist/interfaces/accountSettingInterface.js

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

package/dist/interfaces/accountSyncJobInterface.d.ts

@@ -0,0 +1,15 @@
+import { IDefaultAttributes } from './commonInterface';
+import { AccountIntegrationProvider, AccountSyncAction } from '../constants/app';
+export interface IAccountSyncJobModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    connectionId: string;
+    provider: AccountIntegrationProvider;
+    objectType: string;
+    objectId: string;
+    action: AccountSyncAction;
+    payloadRef: any;
+    attempts?: number;
+    nextRetryAt?: Date;
+}

package/dist/interfaces/accountSyncJobInterface.js

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

package/dist/interfaces/accountSyncLogInterface.d.ts

@@ -0,0 +1,13 @@
+import { IDefaultAttributes } from './commonInterface';
+import { AccountSyncStatus } from '../constants/app';
+export interface IAccountSyncLogModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    syncJobId: string;
+    status: AccountSyncStatus;
+    requestRef?: any;
+    responseRef?: any;
+    message?: string;
+    attemptNo: number;
+}

package/dist/interfaces/accountSyncLogInterface.js

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

package/dist/interfaces/accountTaxEntryInterface.d.ts

@@ -0,0 +1,24 @@
+import { IDefaultAttributes } from './commonInterface';
+export interface IAccountTaxEntryModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    taxTypeId: string;
+    journalLineId: string;
+    taxAmount: number;
+    baseAmount: number;
+}
+export interface IAccountGstSummaryLineResponse {
+    taxCode: string;
+    taxRate: number;
+    totalBaseAmount: number;
+    totalTaxAmount: number;
+}
+export interface IAccountGstSummaryResponse {
+    instituteId: string;
+    financialYearId: string;
+    lines: IAccountGstSummaryLineResponse[];
+    totalBaseAmount: number;
+    totalTaxAmount: number;
+    netGstPayable: number;
+}

package/dist/interfaces/accountTaxEntryInterface.js

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

package/dist/interfaces/accountTaxTypeInterface.d.ts

@@ -0,0 +1,13 @@
+import { IDefaultAttributes } from './commonInterface';
+import { AccountTaxKind } from '../constants/app';
+export interface IAccountTaxTypeModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    code: string;
+    name: string;
+    taxKind: AccountTaxKind;
+    rate: number;
+    inputLedgerId?: string;
+    outputLedgerId?: string;
+}

package/dist/interfaces/accountTaxTypeInterface.js

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

package/dist/interfaces/accountVendorInvoiceInterface.d.ts

@@ -0,0 +1,41 @@
+import { IDefaultAttributes } from './commonInterface';
+import { AccountApprovalStatus, AccountExpensePaymentStatus } from '../constants/app';
+import { IAccountLedgerBalanceModelAttributes } from './accountLedgerBalanceInterface';
+import { IAccountJournalLineModelAttributes } from './accountJournalLineInterface';
+export interface IAccountVendorInvoiceModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    vendorId?: string;
+    invoiceNumber: string;
+    invoiceDate: Date;
+    dueDate?: Date;
+    totalAmount: number;
+    taxAmount: number;
+    netAmount: number;
+    status: AccountApprovalStatus;
+    paymentStatus: AccountExpensePaymentStatus;
+    fileStorageId?: string;
+    journalEntryId?: string;
+}
+export interface IAccountVendorInvoiceApproveResponse {
+    id: string;
+    status: AccountApprovalStatus;
+    eventGenerated: boolean;
+}
+export interface IAccountVendorInvoicePayResponse {
+    id: string;
+    paymentStatus: AccountExpensePaymentStatus;
+    paymentId?: string;
+    eventGenerated: boolean;
+}
+export interface IAccountVendorLedgerResponse {
+    vendorId: string;
+    ledgerBalance: IAccountLedgerBalanceModelAttributes;
+    journalLines: IAccountJournalLineModelAttributes[];
+}
+export interface IAccountVendorOutstandingResponse {
+    vendorId: string;
+    totalOutstanding: number;
+    invoices: IAccountVendorInvoiceModelAttributes[];
+}

package/dist/interfaces/accountVendorInvoiceInterface.js

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

package/dist/interfaces/accountVendorPaymentInterface.d.ts

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

package/dist/interfaces/accountVendorPaymentInterface.js

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

package/dist/interfaces/accountVoucherInterface.d.ts

@@ -0,0 +1,42 @@
+import { IDefaultAttributes } from './commonInterface';
+import { AccountSourceModule, AccountApprovalStatus, AccountVoucherStatus } from '../constants/app';
+export interface IAccountVoucherModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    voucherTypeId: string;
+    voucherNumber: string;
+    voucherDate: Date;
+    financialYearId: string;
+    sourceModule?: AccountSourceModule;
+    sourceId?: string;
+    referenceNumber?: string;
+    narration?: string;
+    approvalStatus: AccountApprovalStatus;
+    status: AccountVoucherStatus;
+    reversedVoucherId?: string;
+    isIncludeInstitute?: boolean;
+    isIncludeAcademicCalendar?: boolean;
+    isIncludeVoucherType?: boolean;
+    isIncludeFinancialYear?: boolean;
+    isIncludeReversedVoucher?: boolean;
+    isIncludeJournalEntries?: boolean;
+}
+export interface IAccountVoucherApproveResponse {
+    id: string;
+    approvalStatus: AccountApprovalStatus;
+}
+export interface IAccountVoucherPostResponse {
+    id: string;
+    status: AccountVoucherStatus;
+    journalEntryId: string;
+}
+export interface IAccountVoucherCancelResponse {
+    id: string;
+    status: AccountVoucherStatus;
+}
+export interface IAccountVoucherReverseResponse {
+    id: string;
+    status: AccountVoucherStatus;
+    reversalEntryId?: string;
+}

package/dist/interfaces/accountVoucherInterface.js

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

package/dist/interfaces/accountWebhookDeliveryInterface.d.ts

@@ -0,0 +1,14 @@
+import { IDefaultAttributes } from './commonInterface';
+import { AccountWebhookDeliveryStatus } from '../constants/app';
+export interface IAccountWebhookDeliveryModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    subscriptionId: string;
+    eventId: string;
+    status: AccountWebhookDeliveryStatus;
+    attempts: number;
+    lastError?: string;
+    requestRef?: any;
+    responseRef?: any;
+}

package/dist/interfaces/accountWebhookDeliveryInterface.js

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

package/dist/interfaces/accountWebhookSubscriptionInterface.d.ts

@@ -0,0 +1,11 @@
+import { IDefaultAttributes } from './commonInterface';
+import { AccountWebhookEventType } from '../constants/app';
+export interface IAccountWebhookSubscriptionModelAttributes extends IDefaultAttributes {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    eventType: AccountWebhookEventType;
+    targetUrl: string;
+    secretRef?: string;
+    isActive?: boolean;
+}

package/dist/interfaces/accountWebhookSubscriptionInterface.js

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

package/dist/interfaces/accountsActivityStreamInterface.d.ts

@@ -0,0 +1,14 @@
+import { IDefaultAttributes } from './commonInterface';
+import { AccountEventType, AccountSourceModule } from '../constants/app';
+import { Document } from 'mongoose';
+export interface IAccountsActivityStreamModelAttributes extends IDefaultAttributes, Document {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    eventType?: AccountEventType;
+    sourceModule?: AccountSourceModule;
+    sourceId?: string;
+    actorId?: string;
+    summary?: string;
+    metadata?: any;
+}

package/dist/interfaces/accountsActivityStreamInterface.js

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

package/dist/interfaces/accountsAttachmentInterface.d.ts

@@ -0,0 +1,14 @@
+import { IDefaultAttributes } from './commonInterface';
+import { Document } from 'mongoose';
+export interface IAccountsAttachmentModelAttributes extends IDefaultAttributes, Document {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    fileStorageId?: string;
+    entityType?: string;
+    entityId?: string;
+    documentType?: string;
+    checksum?: string;
+    uploadedBy?: string;
+    metadata?: any;
+}

package/dist/interfaces/accountsAttachmentInterface.js

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

package/dist/interfaces/accountsAuditLogInterface.d.ts

@@ -0,0 +1,19 @@
+import { IDefaultAttributes } from './commonInterface';
+import { AccountAuditAction } from '../constants/app';
+import { Document } from 'mongoose';
+export interface IAccountsAuditLogModelAttributes extends IDefaultAttributes, Document {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    campusId?: string;
+    financialYearId?: string;
+    entityName?: string;
+    entityId?: string;
+    action?: AccountAuditAction;
+    performedBy?: string;
+    ipAddress?: string;
+    userAgent?: string;
+    oldValue?: any;
+    newValue?: any;
+    requestId?: string;
+}

package/dist/interfaces/accountsAuditLogInterface.js

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

package/dist/interfaces/accountsNotificationInterface.d.ts

@@ -0,0 +1,15 @@
+import { IDefaultAttributes } from './commonInterface';
+import { Document } from 'mongoose';
+export interface IAccountsNotificationModelAttributes extends IDefaultAttributes, Document {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    recipientId?: string;
+    channel?: string;
+    subject?: string;
+    message?: string;
+    status?: string;
+    sentAt?: Date;
+    readAt?: Date;
+    metadata?: any;
+}

package/dist/interfaces/accountsNotificationInterface.js

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

package/dist/interfaces/accountsSyncPayloadInterface.d.ts

@@ -0,0 +1,14 @@
+import { IDefaultAttributes } from './commonInterface';
+import { Document } from 'mongoose';
+export interface IAccountsSyncPayloadModelAttributes extends IDefaultAttributes, Document {
+    id: string;
+    instituteId: string;
+    academicCalendarId: string;
+    entityType?: string;
+    entityId?: string;
+    payload?: any;
+    syncStatus?: string;
+    errorMessage?: string;
+    retryCount?: number;
+    lastSyncAt?: Date;
+}

package/dist/interfaces/accountsSyncPayloadInterface.js

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