Skip to main content

Request Report Data

POST 
/api/v1/reports/generate-report

To fetch report data, specify your desired report type, time frame (separated by "from and "to"), format and columns according to the specifications below.

Request​

Body

required

    ReportCode stringrequired

    Possible values: [ReconciliationReport, NewPlans, DebitReport, OutstandingAmounts, FundingReport, ShopperOutstanding]

    From date-time

    UTC format, e.g. "2023-04-29T14:33:44.613Z"

    To date-time

    UTC format, e.g. "2023-04-29T14:33:44.613Z"

    Format ReportFormat2 (string)

    Possible values: [CSV, JSON, XLSX]

    SelectedColumns string[]

    Choose your columns from the available fields. Refer to Report Field Definitions for more info on each field.

    Notes:

    • When the SelectedColumns tag is empty ([]), the system will return default columns
    • If a column's values don't exist, then the system skips it and doesn't export it
    • The order of columns in the exported report depends on the columns' order in the JSON body
    • Exported results are not sorted

Responses​

Response Headers

    Schema

      Errors

      object[]

    • Array [

      • Code string
      Message string
      AdditionalInfo string

    • ]

      • StatusCode int32required
      TraceId string
      IsSuccess booleanrequired
      DelliveredTo DeliveryMethod (integer)

      Possible values: [0, 1]

      FileUrl string
    Loading...