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

Package for Model management of Cloud IDEsys LMS

/**
 * Fee Assignment Schema
 * Assigns fees to individual students
 */
declare class FeeAssignmentBase {
    /** Mongo document id (string representation). */
    _id?: string;
    /** Unique fee assignment number (auto-generated). */
    feeas_assignment_number?: string;
    /** Student reference id (`auth_user_mst`). */
    feeas_student_id_auth?: string;
    /** Fee structure item reference id (`fee_structure_items`). */
    feeas_fee_structure_item_id_feesi?: string;
    /** Fee name shown to users. */
    feeas_fee_name?: string;
    /** Optional fee description/details. */
    feeas_fee_description?: string;
    /** Fee type: one-time or recurring. */
    feeas_fee_type?: 'ONE_TIME' | 'RECURRING';
    /** Payment frequency for recurring fees. */
    feeas_payment_frequency?: 'MONTHLY' | 'QUARTERLY' | 'SEMESTER' | 'ANNUAL' | 'ONE_TIME';
    /** Original fee amount (before discounts/scholarship/waiver). */
    feeas_original_amount?: number;
    /** Discount amount applied on this assignment. */
    feeas_discount_amount?: number;
    /** Scholarship amount applied on this assignment. */
    feeas_scholarship_amount?: number;
    /** Waiver amount applied on this assignment. */
    feeas_waiver_amount?: number;
    /** Tax amount applied. */
    feeas_tax_amount?: number;
    /** Total amount after discounts/scholarship/waiver, including tax. */
    feeas_total_amount?: number;
    /** Amount assigned (may be less than total for partial assignment). */
    feeas_assigned_amount?: number;
    /** Total amount paid so far against this assignment. */
    feeas_paid_amount?: number;
    /** Outstanding amount (= assigned_amount - paid_amount). */
    feeas_outstanding_amount?: number;
    /** Date when fee was assigned. */
    feeas_assignment_date?: Date;
    /** Due date for payment. */
    feeas_due_date?: Date;
    /** Collection window start date. */
    feeas_collection_start_date?: Date;
    /** Collection window end date. */
    feeas_collection_end_date?: Date;
    /** Number of installments allowed/created for this assignment. */
    feeas_installment_count?: number;
    /** Amount per installment. */
    feeas_installment_amount?: number;
    /** Number of installments paid. */
    feeas_paid_installments?: number;
    /** Payment status of the assignment. */
    feeas_payment_status?: 'PENDING' | 'PARTIALLY_PAID' | 'PAID' | 'OVERDUE' | 'WAIVED' | 'CANCELLED';
    /** Whether late fee has been applied. */
    feeas_late_fee_applied?: boolean;
    /** Late fee amount applied. */
    feeas_late_fee_amount?: number;
    /** Class/Program reference id (`aca_class_program_master`). */
    feeas_class_program_id_acacpm?: string;
    /** Section reference id (`aca_prg_trm_section`). */
    feeas_section_id_acapts?: string;
    /** Admission application reference id (`admission_application_main`). */
    feeas_admission_id_admap?: string;
    /** Additional notes. */
    feeas_notes?: string;
    /** User who assigned the fee (auth user id). */
    feeas_created_by_user?: string;
    /** Active status flag. */
    feeas_isactive?: boolean;
}
declare class FeeAssignment extends FeeAssignmentBase {
    /** Fee category reference id (`core_general_master`). */
    feeas_fee_category_sygms?: string;
    /** Fee structure reference id (`fee_structures`). */
    feeas_fee_structure_id_feest?: string;
    /** Academic year reference id (`aca_academic_year`). */
    feeas_academic_year_id_acayr?: string;
    /** Section reference id (`aca_prg_trm_section`). */
    feeas_section_id_acapts?: string;
    /** Entity/organization reference id (`core_system_entity`). */
    feeas_entity_id_syen?: string;
}
export { FeeAssignmentBase, FeeAssignment };