@crediblex.io/fineract-api-client/dist/types/reports.d.ts

TypeScript client for Fineract APIs

export interface ReportColumnHeader {
    columnName: string;
    columnType: string;
    columnDisplayType: string;
    isColumnNullable: boolean;
    isColumnPrimaryKey: boolean;
    isColumnUnique: boolean;
    isColumnIndexed: boolean;
    columnValues: any[];
}
export interface ReportDataRow {
    row: any[];
}
export interface ReportResponse {
    columnHeaders: ReportColumnHeader[];
    data: ReportDataRow[];
}
export interface MappedReportResponse {
    /** Mapped rows keyed by column name */
    data: Array<Record<string, any>>;
}
export interface LoanPaymentsDueParams extends ReportQueryParams {
    /** Inclusive starting installment sequence number (maps to R_fromX). */
    fromInstallment: number;
    /** Inclusive ending installment sequence number (maps to R_toY). */
    toInstallment: number;
}
export interface LoanPaymentsDueOverdueParams extends ReportQueryParams {
    /** Inclusive starting installment sequence number (maps to R_fromX). */
    fromInstallment: number;
    /** Inclusive ending installment sequence number (maps to R_toY). */
    toInstallment: number;
    /** Minimum days overdue (inclusive, maps to R_overdueX). */
    overdueFromDays: number;
    /** Maximum days overdue (inclusive, maps to R_overdueY). */
    overdueToDays: number;
}
export interface ExpectedPaymentsByDateBasicParams extends ReportQueryParams {
    /** Inclusive start date (yyyy-MM-dd, maps to R_startDate). */
    startDate: string;
    /** Inclusive end date (yyyy-MM-dd, maps to R_endDate). */
    endDate: string;
    /** Locale required by Fineract (e.g. 'en'). */
    locale: string;
    /** Date format expected by Fineract (e.g. 'yyyy-MM-dd'). */
    dateFormat: string;
}
export type ReportQueryParams = Record<string, string | number | boolean>;
//# sourceMappingURL=reports.d.ts.map