Report Queries

Get report group by report group id

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

GET

/gb/report-groups/{report_group_id}

curl --request GET \
  --url https://api.catch-e.com/gb/report-groups/{report_group_id} \
  --header 'Authorization: <api-key>'

{
  "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"
}

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

Path Parameters

report_group_idstringrequired

Report Group Id

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

Response

Success

default_flagenum<string>

Available options: yes, no

file_extension_idstring

invoice_typeenum<string>

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

namestring

report_group_idstring

report_query_idstring

report_typeenum<string>

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

sort_orderinteger

status_flagenum<string>

Available options: active, inactive

Still need help? Ask the team