Report Queries

Get Report Groups

This method requires the ReportGroups:Get permission to be associated with your role.

GET

/gb/report-groups

Get Report Groups

curl --request GET \
  --url 'https://api.catch-e.com/gb/report-groups?report_type=pay-run&client_id=%3Cstring%3E&include_inactive%20flag=no&page=1&page_size=25' \
  --header 'Authorization: <api-key>'

{
  "_embedded": {
    "gb_report_groups": [
      {
        "default_flag": "yes",
        "file_extension_id": "<string>",
        "invoice_type": "pay-run",
        "name": "<string>",
        "report_group_id": "<string>",
        "report_query_id": "<string>",
        "report_type": "pay-run",
        "sort_order": 123,
        "status_flag": "active"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.catch-e.com/gb/report-groups"
    }
  },
  "page": 1,
  "page_count": 1,
  "page_size": 25,
  "total_items": 1
}

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Query Parameters

report_typeenum<string>query

(Optional) Report type

Available options: pay-run, pay-run-reports, periodic-lease, combined, recharge-fuel, recharge

client_idstringquery

(Optional) Client Id

Only show report groups for the specified client.

Maximum string length: 10

Pattern: ^[1-9]{1}[0-9]*$

include_inactive flagenum<string>querydefault:no

(Optional) Include inactive report groups

Available options: no, yes

pageintegerquerydefault:1

Optional page number

Required range: 1 <= x <= 2147483647

page_sizeintegerquerydefault:25

Optional page size

Required range: -1 <= x <= 2147483647

Response

Success

_embeddedobject

Show child attributes

_linksobject

pageinteger

Example: 1

page_countinteger

Example: 1

page_sizeinteger

Example: 25

total_itemsinteger

Example: 1

Still need help? Ask the team