cloud-ide-lms-model
Version:
Package for Model management of Cloud IDEsys LMS
50 lines (49 loc) • 2.08 kB
TypeScript
/**
* Fee Late Fee Rule Schema
* Rules for calculating late fees
*/
declare class FeeLateFeeRule {
/** Mongo document id (string representation). */
_id?: string;
/** Rule name (human-friendly). */
feelfr_rule_name?: string;
/** Rule code (unique/short code). */
feelfr_rule_code?: string;
/** Optional description/details about the rule. */
feelfr_description?: string;
/** Scope type: where the rule applies (entity/class program/fee category). */
feelfr_scope_type?: 'ENTITY' | 'CLASS_PROGRAM' | 'FEE_CATEGORY';
/** Scope id (entity/class/fee category id depending on scope type). */
feelfr_scope_id?: string;
/** Fee categories/heads this rule applies to (or `ALL`). */
feelfr_applies_to_fee_category?: string[];
/** Grace period days after due/collection end before late fee applies. */
feelfr_grace_period_days?: number;
/** How late fee is calculated. */
feelfr_calculation_type?: 'FIXED' | 'PERCENTAGE_OF_DUE' | 'DAILY' | 'SLAB_BASED';
/** Fixed late fee amount (if FIXED). */
feelfr_fixed_amount?: number;
/** Percentage (if PERCENTAGE_OF_DUE). */
feelfr_percentage?: number;
/** Daily rate (if DAILY). */
feelfr_daily_rate?: number;
/** Slab config stored as JSON string (if SLAB_BASED). */
feelfr_slab_config_json?: string;
/** Maximum late fee amount cap (optional). */
feelfr_max_late_fee_amount?: number;
/** Whether late fee applies after collection window end (vs due date). */
feelfr_apply_after_collection_end?: boolean;
/** Academic year reference id (`aca_academic_year`). */
feelfr_academic_year_id_acayr?: string;
/** Entity/organization reference id (`core_system_entity`). */
feelfr_entity_id_syen?: string;
/** Whether the rule is active. */
feelfr_is_active?: boolean;
/** Created by user id (`auth_user_mst`). */
feelfr_created_by_user?: string;
/** Created timestamp. */
feelfr_created_at?: Date;
/** Updated timestamp. */
feelfr_updated_at?: Date;
}
export { FeeLateFeeRule };