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

TypeScript client for Fineract APIs

import { HttpClient } from "../utils/http-client";
import { MappedReportResponse, LoanPaymentsDueParams, LoanPaymentsDueOverdueParams, ExpectedPaymentsByDateBasicParams } from "../types/reports";
/**
 * API client for Fineract "run reports" functionality.
 * Provides helper methods to execute reports and obtain their tabular data.
 */
export declare class FineractReportsApi {
    private readonly httpClient;
    private readonly basePath;
    private mapReportResponse;
    constructor(httpClient: HttpClient);
    /**
     * Internal generic report executor (intentionally private to restrict consumers
     * to approved convenience methods only).
     */
    private run;
    /**
     * Convenience wrapper for the specific "Loan payments due" report.
     * @param params Report parameters (office, fromX, toY, loanOfficerId)
     */
    getLoanPaymentsDue(params: LoanPaymentsDueParams): Promise<MappedReportResponse>;
    /**
     * Convenience wrapper for the "Loan payments due (Overdue Loans)" report.
     * @param params Report parameters including overdue range.
     */
    getLoanPaymentsDueOverdue(params: LoanPaymentsDueOverdueParams): Promise<MappedReportResponse>;
    /**
     * Convenience wrapper for the "Expected Payments By Date - Basic" report.
     * @param params Report parameters including date range and office/officer.
     */
    getExpectedPaymentsByDateBasic(params: ExpectedPaymentsByDateBasicParams): Promise<MappedReportResponse>;
}
//# sourceMappingURL=fineract-reports-api.d.ts.map