Report Definitions

Create ReportDefinition

Creates a new ReportDefinition

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reportDefinition_Key
required
integer <int32>

ID of the report definition. Note: This field is marked as NOT NULL in the database and therefore required by the API.

bR_Report_ID
string or null <= 512 characters

Contains the GUID for the corresponding Advanced Reporting ID in Bold Reports.

combine_Navigation
required
boolean

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.

criteria_Object
string or null <= 128 characters

The PowerBuilder object used to enter criteria.

custom_Report
string or null <= 2048 characters

Identifies a custom report to be used.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

exclude_Adjustment_Category
required
boolean

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.

exclude_Other_Category
required
boolean

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.

exclude_Total_Category
required
boolean

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.

group_Categories_Only
required
boolean

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.

help_File
string or null <= 256 characters

Help file associated with the report object

help_Topic_ID
integer or null <int32>

Topic ID within the help file associated with the report object

invoice_Category_Column_Count
integer or null <int32>

Identifies how many category columns are used within the report.

navigation_Report
required
boolean

Indicates that the report has navigation. Note: This field is marked as NOT NULL in the database and therefore required by the API.

report_Category
string or null <= 16 characters

Identifies which category the report belongs to.

report_Description
required
string [ 1 .. 512 ] characters

Full description of the report.

report_Detail_Object
string or null <= 128 characters

Specifies a secondary report that may be used in conjunction with the main report

report_Example
string or null <= 128 characters

Utilize the file explorer to choose an example of the chosen report.

report_ID
required
string [ 1 .. 32 ] characters

ID of the report being defined.

report_Library
string or null <= 128 characters

Identifies which report library the User wishes to choose from.

report_Name
required
string [ 1 .. 128 ] characters

Name of the report.

report_Object
string or null <= 128 characters

Indicates which report will be used with the automation step.

schedule_Report
required
boolean

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.

series_Report
required
boolean

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.

trackable_Report
required
boolean

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.

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

Responses
200

Success

401

Unauthorized

post/report-definitions
Request samples
{
  • "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"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ReportDefinition

Lists all ReportDefinition

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
criteriaObject
string

Criteria Object

page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/report-definitions
Request samples 
Response samples 
No sample
Get ReportDefinition
Gets ReportDefinition


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportDefinitionKey
required
integer <int32> 
ReportDefinition Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/report-definitions/{reportDefinitionKey}
Request samples 
Response samples 
No sample
Update ReportDefinition
Updates a specific ReportDefinition.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportDefinitionKey
required
integer <int32> 
ReportDefinition Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
reportDefinition_Key
required
integer <int32> 
ID of the report definition. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
bR_Report_ID
string or null  <= 512 characters 
Contains the GUID for the corresponding Advanced Reporting ID in Bold Reports.


 
combine_Navigation
required
boolean
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.


 
criteria_Object
string or null  <= 128 characters 
The PowerBuilder object used to enter criteria.


 
custom_Report
string or null  <= 2048 characters 
Identifies a custom report to be used.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
exclude_Adjustment_Category
required
boolean
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.


 
exclude_Other_Category
required
boolean
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.


 
exclude_Total_Category
required
boolean
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.


 
group_Categories_Only
required
boolean
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.


 
help_File
string or null  <= 256 characters 
Help file associated with the report object


 
help_Topic_ID
integer or null <int32> 
Topic ID within the help file associated with the report object


 
invoice_Category_Column_Count
integer or null <int32> 
Identifies how many category columns are used within the report.


 
navigation_Report
required
boolean
Indicates that the report has navigation. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
report_Category
string or null  <= 16 characters 
Identifies which category the report belongs to.


 
report_Description
required
string  [ 1 .. 512 ] characters 
Full description of the report.


 
report_Detail_Object
string or null  <= 128 characters 
Specifies a secondary report that may be used in conjunction with the main report


 
report_Example
string or null  <= 128 characters 
Utilize the file explorer to choose an example of the chosen report.


 
report_ID
required
string  [ 1 .. 32 ] characters 
ID of the report being defined.


 
report_Library
string or null  <= 128 characters 
Identifies which report library the User wishes to choose from.


 
report_Name
required
string  [ 1 .. 128 ] characters 
Name of the report.


 
report_Object
string or null  <= 128 characters 
Indicates which report will be used with the automation step.


 
schedule_Report
required
boolean
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.


 
series_Report
required
boolean
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.


 
trackable_Report
required
boolean
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.


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
Responses 
200
Success


401
Unauthorized


put/report-definitions/{reportDefinitionKey}
Request samples 
{
  • "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"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ReportDefinition
Deletes an ReportDefinition


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportDefinitionKey
required
integer <int32> 
ReportDefinition Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/report-definitions/{reportDefinitionKey}
Request samples 
Create or Update Batch ReportDefinition
Create or Update multiple ReportDefinition at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
reportDefinition_Key
required
integer <int32> 
ID of the report definition. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
bR_Report_ID
string or null  <= 512 characters 
Contains the GUID for the corresponding Advanced Reporting ID in Bold Reports.


 
combine_Navigation
required
boolean
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.


 
criteria_Object
string or null  <= 128 characters 
The PowerBuilder object used to enter criteria.


 
custom_Report
string or null  <= 2048 characters 
Identifies a custom report to be used.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
exclude_Adjustment_Category
required
boolean
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.


 
exclude_Other_Category
required
boolean
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.


 
exclude_Total_Category
required
boolean
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.


 
group_Categories_Only
required
boolean
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.


 
help_File
string or null  <= 256 characters 
Help file associated with the report object


 
help_Topic_ID
integer or null <int32> 
Topic ID within the help file associated with the report object


 
invoice_Category_Column_Count
integer or null <int32> 
Identifies how many category columns are used within the report.


 
navigation_Report
required
boolean
Indicates that the report has navigation. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
report_Category
string or null  <= 16 characters 
Identifies which category the report belongs to.


 
report_Description
required
string  [ 1 .. 512 ] characters 
Full description of the report.


 
report_Detail_Object
string or null  <= 128 characters 
Specifies a secondary report that may be used in conjunction with the main report


 
report_Example
string or null  <= 128 characters 
Utilize the file explorer to choose an example of the chosen report.


 
report_ID
required
string  [ 1 .. 32 ] characters 
ID of the report being defined.


 
report_Library
string or null  <= 128 characters 
Identifies which report library the User wishes to choose from.


 
report_Name
required
string  [ 1 .. 128 ] characters 
Name of the report.


 
report_Object
string or null  <= 128 characters 
Indicates which report will be used with the automation step.


 
schedule_Report
required
boolean
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.


 
series_Report
required
boolean
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.


 
trackable_Report
required
boolean
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.


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
Responses 
207
Success


401
Unauthorized


put/report-definitions-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}