Package org.apache.fineract.client.services

Interface RunReportsApi

public interface RunReportsApi

  • Method Summary

    Modifier and Type
    Method
    Description
    retrofit2.Call<RunReportsResponse>
    runReportGetData(String reportName, Map<String,String> parameters, Boolean isSelfServiceUserReport)
    Running a Report This resource allows you to run and receive output from pre-defined Apache Fineract reports.
    retrofit2.Call<okhttp3.ResponseBody>
    runReportGetFile(String reportName, Map<String,String> parameters, Boolean isSelfServiceUserReport)
    Run Report which returns a response such as a PDF, CSV, XLS or XSLX file.

  • Method Details

    • runReportGetData

      @GET("v1/runreports/{reportName}") retrofit2.Call<RunReportsResponse> runReportGetData(@Path("reportName") String reportName, @QueryMap Map<String,String> parameters, @Query("isSelfServiceUserReport") Boolean isSelfServiceUserReport)
      Running a Report This resource allows you to run and receive output from pre-defined Apache Fineract reports. Reports can also be used to provide data for searching and workflow functionality. The default output is a JSON formatted \"Generic Resultset\". The Generic Resultset contains Column Heading as well as Data information. However, you can export to CSV format by simply adding \"&exportCSV=true\" to the end of your URL. If Pentaho reports have been pre-defined, they can also be run through this resource. Pentaho reports can return HTML, PDF or CSV formats. The Apache Fineract reference application uses a JQuery plugin called stretchy reporting which, itself, uses this reports resource to provide a pretty flexible reporting User Interface (UI). Example Requests: runreports/Client%20Listing?R_officeId=1 runreports/Client%20Listing?R_officeId=1&exportCSV=true runreports/OfficeIdSelectOne?R_officeId=1&parameterType=true runreports/OfficeIdSelectOne?R_officeId=1&parameterType=true&exportCSV=true runreports/Expected%20Payments%20By%20Date%20-%20Formatted?R_endDate=2013-04-30&R_loanOfficerId=-1&R_officeId=1&R_startDate=2013-04-16&output-type=HTML&R_officeId=1 runreports/Expected%20Payments%20By%20Date%20-%20Formatted?R_endDate=2013-04-30&R_loanOfficerId=-1&R_officeId=1&R_startDate=2013-04-16&output-type=XLS&R_officeId=1 runreports/Expected%20Payments%20By%20Date%20-%20Formatted?R_endDate=2013-04-30&R_loanOfficerId=-1&R_officeId=1&R_startDate=2013-04-16&output-type=CSV&R_officeId=1 runreports/Expected%20Payments%20By%20Date%20-%20Formatted?R_endDate=2013-04-30&R_loanOfficerId=-1&R_officeId=1&R_startDate=2013-04-16&output-type=PDF&R_officeId=1
      Parameters:
      reportName - reportName (required)
      isSelfServiceUserReport - isSelfServiceUserReport (optional, default to false)
      Returns:
      Call<GetReportNameResponse>

    • runReportGetFile

      @GET("v1/runreports/{reportName}") retrofit2.Call<okhttp3.ResponseBody> runReportGetFile(@Path("reportName") String reportName, @QueryMap Map<String,String> parameters, @Query("isSelfServiceUserReport") Boolean isSelfServiceUserReport)
      Run Report which returns a response such as a PDF, CSV, XLS or XSLX file.