Request Report

All report times are based on UTC time.

The StatusSummary report will generate a report based on data available when the report is run.

The Breakage, Dormancy, NegativeBalance, and EODBalanceSummary reports will use one date input.

If no date is provided, they will default to the date 2 days prior to the current date.

All other reports will take 2 date inputs.

Request

Security:

Bearer

path Parameters

version

required

string

query Parameters

report_name	string report name
program_guid	string <uuid> program guid
date_from	string <date-time> from date (optional)
date_to	string <date-time> to date (optional)
override_flag	string override flag (optional)
overwrite_flag	string overwrite flag (optional)
time_zone	string time zone (optional; defaults to UTC when not provided; supported values: UTC, Eastern Standard Time)
time_format	string time format (optional; defaults to 24-hour format when not provided; supported values: 24H, 12H)

Responses

200

The report request was accepted. The body's status is Completed when the report is ready to download, or Pending/Rerun while it is still being generated (the body then carries a message and retry_after_seconds, and the response carries Location and Retry-After headers); download it using the returned reference_id

400

Bad request

401

Unauthorized

404

Report name not found

500

Server Error

503

A dependency timed out or is unavailable; the outcome is not known, retry the request later

get/api/{version}/reports

Request samples

curl
JavaScript
Node.js

curl -i -X GET \
  'https://qvapikeybank.qolopay.com/api/{version}/reports?report_name=string&program_guid=497f6eca-6276-4993-bfeb-53cbbbba6f08&date_from=2019-08-24T14%3A15%3A22Z&date_to=2019-08-24T14%3A15%3A22Z&override_flag=string&overwrite_flag=string&time_zone=string&time_format=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Response samples

application/json

{"date_from": "2019-08-24T14:15:22Z",
"date_to": "2019-08-24T14:15:22Z",
"error": "string",
"ext_name": "string",
"filename": "string",
"program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
"program_name": "string",
"reference_id": "97c1ff22-6e4f-4821-b1d3-5236781d37b8",
"report_name": "string",
"rpt_lastgenerated": "2019-08-24T14:15:22Z",
"rpt_requested": "2019-08-24T14:15:22Z",
"message": "string",
"status": "Pending",
"retry_after_seconds": 0
}