cloud-ide-lms-model/lib/schema/fees/fee_collection_config.d.ts

Package for Model management of Cloud IDEsys LMS

/**
 * Fee Collection Configuration Schema
 * Defines collection mode and installment structure for fee structures
 */
declare class FeeCollectionConfig {
    /** Mongo document id (string representation). */
    _id?: string;
    /** Unique config code (for identification/import). */
    feecolc_code?: string;
    /** Fee structure reference id (`fee_structures`). */
    feecolc_fee_structure_id_feest?: string;
    /** Collection mode (how installments are structured). */
    feecolc_collection_mode?: 'MONTHLY' | 'QUARTERLY' | 'SEMESTER' | 'ANNUAL' | 'CUSTOM';
    /** Number of installments in this collection config. */
    feecolc_installment_count?: number;
    /** Total amount covered by the config (usually sum of heads). */
    feecolc_total_amount?: number;
    /** Student category filter for applicability. */
    feecolc_student_category_filter?: 'ALL' | 'NEW' | 'REGULAR' | 'NEW_AND_REGULAR';
    /** Whether full payment option is enabled (pay all at once). */
    feecolc_full_payment_enabled?: boolean;
    /** Installment id/code representing the full-payment option (if used). */
    feecolc_full_payment_installment?: string;
    /** Fee head id used for full-payment discount/benefit (if used). */
    feecolc_full_payment_fee_head?: string;
    /** Percentage benefit/discount for full payment (if applicable). */
    feecolc_full_payment_percentage?: number;
    /** Message shown to users for the full payment option. */
    feecolc_full_payment_message?: string;
    /** Entity/organization reference id (`core_system_entity`). */
    feecolc_entity_id_syen?: string;
    /** Academic year reference id (`aca_academic_year`). */
    feecolc_academic_year_id_acayr?: string;
    /** Status of the configuration (draft/active/inactive). */
    feecolc_status?: 'DRAFT' | 'ACTIVE' | 'INACTIVE';
    /** Created by user id (`auth_user_mst`). */
    feecolc_created_by_user?: string;
    /** Active status flag. */
    feecolc_isactive?: boolean;
    /** Created timestamp. */
    feecolc_created_at?: Date;
    /** Updated timestamp. */
    feecolc_updated_at?: Date;
}
export { FeeCollectionConfig };