Download client report

GET /api/v2/clients/{ClientGUID}/reports/{ReportRequestGUID}/download

Bearer auth

Retrieves a specific report file as a binary stream for download.

Path parameters

ClientGUID string(uuid) Required

The GUID of the client the report relates to.
ReportRequestGUID string Required

Except for legacy Tranvas reports, this is expected to be a GUID. However, we will accept string for legacy use cases.

Responses

200 application/pdf

Successful file download.
403 application/json

Permission error.
Hide response attributes Show response attributes object
- success boolean
  
  Default value is false.
- message string
404 application/json

Report not found.
Hide response attributes Show response attributes object
- success boolean
  
  Default value is false.
- message string

GET /api/v2/clients/{ClientGUID}/reports/{ReportRequestGUID}/download

curl \
 --request GET 'https://api.fincalc.co.uk/api/v2/clients/{ClientGUID}/reports/{ReportRequestGUID}/download' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (403)

{
  "success": false,
  "message": "You do not have permission to view that client."
}

Response examples (404)

{
  "success": false,
  "message": "Report not found."
}