Get Single Report Artifact for Company

This route will return a report artifact specified by the url escaped :reportPath


URL parameters are used to determine the year/month/day/frequency type and the report type is determined by the provided name.

Response Reference

When given a valid reportPath, this returns a bytestream to download the specified report.

Response Sample

The response will be a text/csv or application/pdf file, as they’re the reports which are generated by the reportGenerator.

Error Reference

Code Message Explanation
500 Failed to download file. Please try again or reach out to Phin Support for assistance Could not retrieve the report for this partner/company.