Web Services

Execute a report as fields

Execute a Report as fields.

POST

/web-services/gb/reporting/executeReportAsFields

curl --request POST \
  --url https://api.catch-e.com/web-services/gb/reporting/executeReportAsFields \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/vnd.catch-e-api.v1+json' \
  --data '
{
  "parameters": {
    "date_filter": "01/02/2023",
    "fbt_year_ending": "2023,",
    "filter_suspend_date": "00/00/0000",
    "fm_con_contract_id": "123456",
    "fm_con_fbt_email_flag": "no",
    "fm_con_reg_no": "ABC123",
    "fm_dri_driver_id": "123456",
    "module_code": "fm_",
    "report_date": "01/07/2023",
    "t1.contract_id": "123456"
  },
  "report_path": "/core/fleet/reports/pdf_novated_driver_budgeted_with_transactions.phpo"
}
'

<string>

This API is deprecated and must not be used for any future development under any circumstances.

For further assistance, contact your account manager immediately.

This method requires the WebServices and WebServices:Deprecated permissions to be associated with your role.

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

Body

JSON payload

parametersobjectrequired

Report parameters

These parameters will vary significantly depending on the report_path specified

report_pathstringrequired

Report path to execute

Example: /core/fleet/reports/pdf_novated_driver_budgeted_with_transactions.phpo

Response

Success

bodystring

Still need help? Ask the team