VBAReporting

List VBAReporting Reports

Retrieves a list of all available VBAReporting reports by optional category.

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
category
string

category

header Parameters
vbasoftware-database
required
string

The target database name to query.

Responses
200

Successfully retrieved the list of Bold reports.

401

Unauthorized

get/vbareporting/reports
Request samples 
Response samples 
No sample
Retrieve VBAReporting Report
Retrieves a specific VBAReporting report by its VBAReporting ID.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
vbaReportingId
required
string
Unique VBAReporting report ID.


 
header Parameters
vbasoftware-database
required
string
The target database name to query.


 
Responses 
200
Successfully retrieved the VBA report


401
Unauthorized


404
No VBA report found


get/vbareporting/reports/{vbaReportingId}
Request samples 
Response samples 
No sample
Download VBAReporting Report
Downloads a specific VBAReporting report by its VBAReporting ID in PDF format. The report is generated based on the provided parameters. If parameters are missing or not supplied, the report will attempt to run and return results. The caller should ensure that the parameter names and values match the report's requirements.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
The target database name to query.


 
Request Body schema: 
required
vbaReportingId
required
string <uuid> 
Unique identifier for the report in VBA Bold Reports.


 
object or null
Key-value pairs representing parameters required by the report (e.g., date range, client ID).  The parameter names must match the parameters for the BR_Report


 
Responses 
200
Successfully downloaded the VBA report.


401
Unauthorized


404
No VBA report found


post/vbareporting/reports/download
Request samples 
{
  • "vbaReportingId": "d6630060-3c3f-45b9-9b9d-0c2e97ed7ca8",
  • "reportParameters": {
    }
}
Response samples 
{
  • "id": "string",
  • "name": "string",
  • "category": "string",
  • "description": "string",
  • "reportData": "string"
}