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

Package for Model management of Cloud IDEsys LMS

import { FeePaymentItem } from "./fee_payment_item";
/**
 * Fee Payment Schema
 * Records student fee payments
 */
declare class FeePayment {
    /** Mongo document id (string representation). */
    _id?: string;
    /** Unique receipt number (auto-generated). */
    feepay_receipt_number?: string;
    /** Student reference id (`auth_user_mst`). */
    feepay_student_id_auth?: string;
    /** Academic year reference id (`aca_academic_year`). */
    feepay_academic_year_id_acayr?: string;
    /** Entity/organization reference id (`core_system_entity`). */
    feepay_entity_id_syen?: string;
    /** Payment date/time. */
    feepay_payment_date?: Date;
    /** Payment mode reference id (`core_general_master`). */
    feepay_payment_mode_id_sygms?: string;
    /** Payment reference (cheque number, UTR, transaction id, etc.). */
    feepay_payment_reference?: string;
    /** Bank name (if applicable). */
    feepay_bank_name?: string;
    /** Bank branch name (if applicable). */
    feepay_bank_branch_name?: string;
    /** Bank IFSC code (if applicable). */
    feepay_bank_ifsc_code?: string;
    /** Instrument date (cheque/DD date, etc.). */
    feepay_instrument_date?: Date;
    /** Cheque number (if cheque payment). */
    feepay_cheque_number?: string;
    /** Cheque date (if cheque payment). */
    feepay_cheque_date?: Date;
    /** Bank account number (if bank transfer). */
    feepay_bank_account_number?: string;
    /** Transaction reference (for online payments). */
    feepay_transaction_reference?: string;
    /** Discount percentage applied on this payment (0-100). */
    feepay_discount_percentage?: number;
    /** Defines what the discount is applied on. */
    feepay_discount_on?: 'SUB_TOTAL' | 'FEE_HEAD' | 'TOTAL' | 'INSTALLMENT';
    /** Reason for discount (manual notes). */
    feepay_discount_reason?: string;
    /** Total payment amount. */
    feepay_total_amount?: number;
    /** Amount paid towards late fees. */
    feepay_late_fee_amount?: number;
    /** Discount amount applied. */
    feepay_discount_amount?: number;
    /** Additional remarks/notes. */
    feepay_remarks?: string;
    /** Payment status reference id (`core_general_master`). */
    feepay_status_id_sygms?: string;
    /** Receipt template id used (if custom). */
    feepay_receipt_template_id_feert?: string;
    /** User who created the payment entry (auth user id). */
    feepay_created_by_user?: string;
    /** Created timestamp. */
    feepay_created_at?: Date;
    /** Updated timestamp. */
    feepay_updated_at?: Date;
    /** Whether this payment is reconciled in accounts/bank. */
    feepay_is_reconciled?: boolean;
    /** Date of reconciliation. */
    feepay_reconciled_date?: Date;
    /** User who reconciled the payment (auth user id). */
    feepay_reconciled_by?: string;
    /** Remarks for reconciliation. */
    feepay_reconciled_remarks?: string;
    /** Payment line items mapped to assignments/heads. */
    fee_items?: FeePaymentItem[];
}
export { FeePayment };