Get clients reports

GET /api/v2/clients/{ClientGUID}/reports
Bearer auth

Return all reports related to a client.

Except for certain legacy Transvas reports, the 'DownloadPath' output will be a string URL pointing to the report's download path. If the output is an array, each element will represent a separate download path for the reports.

Path parameters

  • ClientGUID string(uuid) Required

    The GUID of the client you want to retrieve reports for.

Responses

  • 200 application/json

    Success

    Hide response attributes Show response attributes object
    • success boolean

      Default value is true.

    • data array[object]
      Hide data attributes Show data attributes object
      • ReportRequestGUID string

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

      • ModuleTool string
      • ReportName string
      • Requested string(date-time)
      • RequestedUserName string
      • LastViewed string(date-time)
      • LastViewedUserName string

      • DownloadPath string(uri) | array(uri)

        Except for legacy Tranvas support, if the ReportRequestGUID matches legacy Tranvas report ID, it may return an array of download paths, including the validation report.

        One of:
        string-1 string(uri) array-2 array(uri)
      • FileExtension string
  • 403 application/json

    Permission error.

    Hide response attributes Show response attributes object
    • success boolean

      Default value is false.

    • message string
  • 404 application/json

    Client not found.

    Hide response attributes Show response attributes object
    • success boolean

      Default value is false.

    • message string
GET /api/v2/clients/{ClientGUID}/reports 
curl \
 --request GET 'https://api.fincalc.co.uk/api/v2/clients/{ClientGUID}/reports' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "data": [
    {
      "Requested": "2025-02-17T12:25:42.000Z",
      "LastViewed": "2025-02-17T12:26:05.000Z",
      "ModuleTool": "Cashflow Modeller",
      "ReportName": "Technical Report (Stress Testing)",
      "DownloadPath": "https://api.fincalc.co.uk/api/v2/clients/07A10E8E-A128-5F99-ABC8-5B29F64A8639/reports/BCF55A6E-191F-7C24-26D4-AE3BB598D9D2/download",
      "FileExtension": "pdf",
      "ReportRequestGUID": "BCF55A6E-191F-7C24-26D4-AE3BB598D9D2",
      "RequestedUserName": "Danny Guest",
      "LastViewedUserName": "Danny Guest"
    },
    {
      "Requested": "2025-02-18T10:30:00.000Z",
      "LastViewed": "2025-02-18T11:00:00.000Z",
      "ModuleTool": "Transvas with TVC",
      "ReportName": "PP Fund Growth Report",
      "DownloadPath": [
        "https://api.fincalc.co.uk/api/v2/clients/07A10E8E-A128-5F99-ABC8-5B29F64A8639/reports/13682/download",
        "https://api.fincalc.co.uk/api/v2/clients/07A10E8E-A128-5F99-ABC8-5B29F64A8639/reports/13682/download?validation=true"
      ],
      "FileExtension": "pdf",
      "ReportRequestGUID": "13682",
      "RequestedUserName": "Danny Guest",
      "LastViewedUserName": "Danny Guest"
    }
  ],
  "success": true
}
Response examples (403) 
{
  "success": false,
  "message": "You do not have permission to view that client."
}
Response examples (404) 
{
  "success": false,
  "message": "Client not found."
}