APIs for VBASoftware
VBASoftware (v1)
- application/json
- text/json
- application/*+json
ID of the report definition. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Contains the GUID for the corresponding Advanced Reporting ID in Bold Reports.
This will combine the results of a criteria window with multiple criteria. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Flag indicating if the adjustment category should be excluded from the report Note: This field is marked as NOT NULL in the database and therefore required by the API.
Flag indicating if the other category should be excluded from the report Note: This field is marked as NOT NULL in the database and therefore required by the API.
Flag indicating if the total category should be excluded from the report Note: This field is marked as NOT NULL in the database and therefore required by the API.
Limits the report to only showing Rate Categories defined at the Group, not all Rate Categories on the Invoice. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Identifies how many category columns are used within the report.
Indicates that the report has navigation. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Specifies a secondary report that may be used in conjunction with the main report
Utilize the file explorer to choose an example of the chosen report.
Identifies which report library the User wishes to choose from.
Indicates which report will be used with the automation step.
Indicates that the report may be used with scheduling functionality. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates that the report may be added to a report series. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates that tracking functionality will be used for the report. Note: This field is marked as NOT NULL in the database and therefore required by the API.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/report-definitions
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://vbapi.vbasoftware.com/vbasoftware/report-definitions \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"reportDefinition_Key": 0,
"bR_Report_ID": "string",
"combine_Navigation": true,
"criteria_Object": "string",
"custom_Report": "string",
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"exclude_Adjustment_Category": true,
"exclude_Other_Category": true,
"exclude_Total_Category": true,
"group_Categories_Only": true,
"help_File": "string",
"help_Topic_ID": 0,
"invoice_Category_Column_Count": 0,
"navigation_Report": true,
"report_Category": "string",
"report_Description": "string",
"report_Detail_Object": "string",
"report_Example": "string",
"report_ID": "string",
"report_Library": "string",
"report_Name": "string",
"report_Object": "string",
"schedule_Report": true,
"series_Report": true,
"trackable_Report": true,
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string",
"vbA_Canned_Report": true
}'No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/report-definitions
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://vbapi.vbasoftware.com/vbasoftware/report-definitions?criteriaObject=string&page=1&pageSize=100&sortBy=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/report-definitions/{reportDefinitionKey}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://vbapi.vbasoftware.com/vbasoftware/report-definitions/{reportDefinitionKey}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'No response example