@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20240531.2 → 1.20240913.2

package/models/report-definition.ts

@@ -21,19 +21,19 @@
  */
 export interface ReportDefinition {
     /**
-     * ID of the report definition.  Note: The database will apply a default value of `0` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
+     * ID of the report definition. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof ReportDefinition
      */
     'reportDefinition_Key': number;
     /**
-     * Unique identifier for the report in the VBAReports system.
+     * Contains the GUID for the corresponding Advanced Reporting ID in Bold Reports.
      * @type {string}
      * @memberof ReportDefinition
      */
     'bR_Report_ID'?: string | null;
     /**
-     * This will combine the results of a criteria window with multiple criteria.  Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
+     * 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.
      * @type {boolean}
      * @memberof ReportDefinition
      */
@@ -63,25 +63,25 @@ export interface ReportDefinition {
      */
     'entry_User'?: string | null;
     /**
-     * Flag indicating if the adjustment category should be excluded from the report  Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
+     * 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.
      * @type {boolean}
      * @memberof ReportDefinition
      */
     'exclude_Adjustment_Category': boolean;
     /**
-     * Flag indicating if the other category should be excluded from the report  Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
+     * 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.
      * @type {boolean}
      * @memberof ReportDefinition
      */
     'exclude_Other_Category': boolean;
     /**
-     * Flag indicating if the total category should be excluded from the report  Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
+     * 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.
      * @type {boolean}
      * @memberof ReportDefinition
      */
     'exclude_Total_Category': boolean;
     /**
-     * Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
+     * 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.
      * @type {boolean}
      * @memberof ReportDefinition
      */
@@ -105,7 +105,7 @@ export interface ReportDefinition {
      */
     'invoice_Category_Column_Count'?: number | null;
     /**
-     * Indicates that the report has navigation.  Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
+     * Indicates that the report has navigation. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof ReportDefinition
      */
@@ -159,19 +159,19 @@ export interface ReportDefinition {
      */
     'report_Object'?: string | null;
     /**
-     * Indicates that the report may be used with scheduling functionality.  Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
+     * 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.
      * @type {boolean}
      * @memberof ReportDefinition
      */
     'schedule_Report': boolean;
     /**
-     * Indicates that the report may be added to a report series.  Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
+     * 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.
      * @type {boolean}
      * @memberof ReportDefinition
      */
     'series_Report': boolean;
     /**
-     * Indicates that tracking functionality will be used for the report.  Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
+     * 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.
      * @type {boolean}
      * @memberof ReportDefinition
      */

package/models/report-queue-detail.ts

@@ -21,11 +21,23 @@
  */
 export interface ReportQueueDetail {
     /**
-     * ID of the report queue detail.
+     * ID of the report queue detail. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof ReportQueueDetail
      */
     'reportQueueDetail_Key': number;
+    /**
+     * Date record was first added to the system
+     * @type {string}
+     * @memberof ReportQueueDetail
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system
+     * @type {string}
+     * @memberof ReportQueueDetail
+     */
+    'entry_User'?: string | null;
     /**
      * File Name of the file to export.
      * @type {string}
@@ -69,7 +81,7 @@ export interface ReportQueueDetail {
      */
     'reportDefinition_Key'?: number | null;
     /**
-     * ID of the report queue.
+     * ID of the report queue. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof ReportQueueDetail
      */
@@ -98,6 +110,18 @@ export interface ReportQueueDetail {
      * @memberof ReportQueueDetail
      */
     'report_Save_Type'?: string | null;
+    /**
+     * Date the record was last updated in the system
+     * @type {string}
+     * @memberof ReportQueueDetail
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system
+     * @type {string}
+     * @memberof ReportQueueDetail
+     */
+    'update_User'?: string | null;
     /**
      * Identifies which category the document belongs to.
      * @type {string}

package/models/report-queue.ts

@@ -21,11 +21,23 @@
  */
 export interface ReportQueue {
     /**
-     * ID of the report queue.
+     * ID of the report queue. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof ReportQueue
      */
     'reportQueue_Key': number;
+    /**
+     * Date record was first added to the system
+     * @type {string}
+     * @memberof ReportQueue
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system
+     * @type {string}
+     * @memberof ReportQueue
+     */
+    'entry_User'?: string | null;
     /**
      * Date of the Queue.
      * @type {string}
@@ -74,5 +86,17 @@ export interface ReportQueue {
      * @memberof ReportQueue
      */
     'queue_User'?: string | null;
+    /**
+     * Date the record was last updated in the system
+     * @type {string}
+     * @memberof ReportQueue
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system
+     * @type {string}
+     * @memberof ReportQueue
+     */
+    'update_User'?: string | null;
 }
 

package/models/report-series-process-arg.ts

@@ -21,7 +21,7 @@
  */
 export interface ReportSeriesProcessArg {
     /**
-     * ID of the report series process to which the argument is related.
+     * ID of the report series process to which the argument is related. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof ReportSeriesProcessArg
      */
@@ -38,11 +38,35 @@ export interface ReportSeriesProcessArg {
      * @memberof ReportSeriesProcessArg
      */
     'argument_Description'?: string | null;
+    /**
+     * Date record was first added to the system
+     * @type {string}
+     * @memberof ReportSeriesProcessArg
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system
+     * @type {string}
+     * @memberof ReportSeriesProcessArg
+     */
+    'entry_User'?: string | null;
     /**
      * Optional field for storing any additional notes about the report series process argument
      * @type {number}
      * @memberof ReportSeriesProcessArg
      */
     'note_Column'?: number | null;
+    /**
+     * Date the record was last updated in the system
+     * @type {string}
+     * @memberof ReportSeriesProcessArg
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system
+     * @type {string}
+     * @memberof ReportSeriesProcessArg
+     */
+    'update_User'?: string | null;
 }
 

package/models/report-series-process.ts

@@ -21,55 +21,61 @@
  */
 export interface ReportSeriesProcess {
     /**
-     * 
+     * ID of the report series process. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof ReportSeriesProcess
      */
     'reportSeriesProcess_Key': number;
     /**
-     * 
+     * Description of the report series process.
      * @type {string}
      * @memberof ReportSeriesProcess
      */
     'description'?: string | null;
     /**
-     * 
+     * Date record was first added to the system
      * @type {string}
      * @memberof ReportSeriesProcess
      */
     'entry_Date'?: string;
     /**
-     * 
+     * User that first added the record to the system
      * @type {string}
      * @memberof ReportSeriesProcess
      */
     'entry_User'?: string | null;
     /**
-     * 
+     * Indicates which category notes for this report series will be assigned.
      * @type {string}
      * @memberof ReportSeriesProcess
      */
     'note_Category'?: string | null;
     /**
-     * 
+     * Name of the stored procedure that corresponds to the Report Series used in VBAReport.
+     * @type {string}
+     * @memberof ReportSeriesProcess
+     */
+    'pA_Stored_Proc'?: string | null;
+    /**
+     * Description of how the report series will trigger.
      * @type {string}
      * @memberof ReportSeriesProcess
      */
     'trigger_Description'?: string | null;
     /**
-     * 
+     * This flag enables an option used by Process Automation.
      * @type {string}
      * @memberof ReportSeriesProcess
      */
     'trigger_Option'?: string | null;
     /**
-     * 
+     * Date the record was last updated in the system
      * @type {string}
      * @memberof ReportSeriesProcess
      */
     'update_Date'?: string;
     /**
-     * 
+     * User that last updated the record in the system
      * @type {string}
      * @memberof ReportSeriesProcess
      */

package/models/report-series-step.ts

@@ -21,7 +21,7 @@
  */
 export interface ReportSeriesStep {
     /**
-     * ID of the report series step.  Note: The database will apply a default value of `0` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
+     * ID of the report series step. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof ReportSeriesStep
      */
@@ -129,7 +129,7 @@ export interface ReportSeriesStep {
      */
     'frequency_Factor'?: number | null;
     /**
-     * Indicates that the event should occur on this day of the week.  Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
+     * Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof ReportSeriesStep
      */
@@ -141,7 +141,7 @@ export interface ReportSeriesStep {
      */
     'interval_Option'?: number | null;
     /**
-     * Indicates that the event should occur on this day of the week.  Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
+     * Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof ReportSeriesStep
      */
@@ -171,13 +171,13 @@ export interface ReportSeriesStep {
      */
     'relative_Frequency'?: number | null;
     /**
-     * Unique identifier for the report for which this step refers.
+     * ID of the report definition utilized in this step.
      * @type {number}
      * @memberof ReportSeriesStep
      */
     'reportDefinition_Key'?: number | null;
     /**
-     * ID of the report series to which the step belongs.  Note: The database will apply a default value of `0` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
+     * ID of the report series to which the step belongs. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof ReportSeriesStep
      */
@@ -213,13 +213,13 @@ export interface ReportSeriesStep {
      */
     'report_Save_Location'?: string | null;
     /**
-     * Retry of the Retry.
+     * Retry of the Retry. Note: The database will apply a default value of `0` for this field if a value is not provided.
      * @type {number}
      * @memberof ReportSeriesStep
      */
     'retry'?: number | null;
     /**
-     * Indicates that the event should occur on this day of the week.  Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
+     * Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof ReportSeriesStep
      */
@@ -279,7 +279,7 @@ export interface ReportSeriesStep {
      */
     'step_MetaData'?: string | null;
     /**
-     * Identifies the sequence number assigned to the step. This number dictates which order the report series steps will occur (ascending order).  Note: The database will apply a default value of `0` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
+     * Identifies the sequence number assigned to the step. This number dictates which order the report series steps will occur (ascending order). Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof ReportSeriesStep
      */
@@ -291,13 +291,13 @@ export interface ReportSeriesStep {
      */
     'step_Type'?: string | null;
     /**
-     * Indicates that the event should occur on this day of the week.  Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
+     * Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof ReportSeriesStep
      */
     'sunday': boolean;
     /**
-     * Indicates that the event should occur on this day of the week.  Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
+     * Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof ReportSeriesStep
      */
@@ -309,7 +309,7 @@ export interface ReportSeriesStep {
      */
     'total_Occurrences'?: number | null;
     /**
-     * Indicates that the event should occur on this day of the week.  Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
+     * Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof ReportSeriesStep
      */
@@ -429,7 +429,7 @@ export interface ReportSeriesStep {
      */
     'vbaGateway_UserID'?: string | null;
     /**
-     * Indicates that the event should occur on this day of the week.  Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
+     * Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof ReportSeriesStep
      */

package/models/report-series.ts

@@ -21,11 +21,23 @@
  */
 export interface ReportSeries {
     /**
-     * ID of the report series.
+     * ID of the report series. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof ReportSeries
      */
     'reportSeries_Key': number;
+    /**
+     * Date record was first added to the system
+     * @type {string}
+     * @memberof ReportSeries
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system
+     * @type {string}
+     * @memberof ReportSeries
+     */
+    'entry_User'?: string | null;
     /**
      * Date when the automation will begin/began.
      * @type {string}
@@ -56,5 +68,17 @@ export interface ReportSeries {
      * @memberof ReportSeries
      */
     'series_User'?: string | null;
+    /**
+     * Date the record was last updated in the system
+     * @type {string}
+     * @memberof ReportSeries
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system
+     * @type {string}
+     * @memberof ReportSeries
+     */
+    'update_User'?: string | null;
 }
 

package/models/report-track-priority.ts

@@ -21,7 +21,7 @@
  */
 export interface ReportTrackPriority {
     /**
-     * ID of the report definition.
+     * ID of the report definition. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof ReportTrackPriority
      */
@@ -39,10 +39,34 @@ export interface ReportTrackPriority {
      */
     'description'?: string | null;
     /**
-     * Indicates that this priority will be chosen by default for new reports.
+     * Date record was first added to the system
+     * @type {string}
+     * @memberof ReportTrackPriority
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system
+     * @type {string}
+     * @memberof ReportTrackPriority
+     */
+    'entry_User'?: string | null;
+    /**
+     * Indicates that this priority will be chosen by default for new reports. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof ReportTrackPriority
      */
     'priority_Default': boolean;
+    /**
+     * Date the record was last updated in the system
+     * @type {string}
+     * @memberof ReportTrackPriority
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system
+     * @type {string}
+     * @memberof ReportTrackPriority
+     */
+    'update_User'?: string | null;
 }
 

package/models/report-track-received-status.ts

@@ -21,7 +21,7 @@
  */
 export interface ReportTrackReceivedStatus {
     /**
-     * ID of the report definition.
+     * ID of the report definition. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof ReportTrackReceivedStatus
      */
@@ -39,10 +39,34 @@ export interface ReportTrackReceivedStatus {
      */
     'description'?: string | null;
     /**
-     * Indicates that this status will be chosen by default for new reports.
+     * Date record was first added to the system
+     * @type {string}
+     * @memberof ReportTrackReceivedStatus
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system
+     * @type {string}
+     * @memberof ReportTrackReceivedStatus
+     */
+    'entry_User'?: string | null;
+    /**
+     * Indicates that this status will be chosen by default for new reports. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof ReportTrackReceivedStatus
      */
     'status_Default': boolean;
+    /**
+     * Date the record was last updated in the system
+     * @type {string}
+     * @memberof ReportTrackReceivedStatus
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system
+     * @type {string}
+     * @memberof ReportTrackReceivedStatus
+     */
+    'update_User'?: string | null;
 }
 

package/models/report-track-sent-status.ts

@@ -21,7 +21,7 @@
  */
 export interface ReportTrackSentStatus {
     /**
-     * ID of the report definition.
+     * ID of the report definition. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof ReportTrackSentStatus
      */
@@ -39,10 +39,34 @@ export interface ReportTrackSentStatus {
      */
     'description'?: string | null;
     /**
-     * Indicates that this status will be chosen by default for new reports.
+     * Date record was first added to the system
+     * @type {string}
+     * @memberof ReportTrackSentStatus
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system
+     * @type {string}
+     * @memberof ReportTrackSentStatus
+     */
+    'entry_User'?: string | null;
+    /**
+     * Indicates that this status will be chosen by default for new reports. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof ReportTrackSentStatus
      */
     'status_Default': boolean;
+    /**
+     * Date the record was last updated in the system
+     * @type {string}
+     * @memberof ReportTrackSentStatus
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system
+     * @type {string}
+     * @memberof ReportTrackSentStatus
+     */
+    'update_User'?: string | null;
 }
 

package/models/report-track-sent-to.ts

@@ -21,7 +21,7 @@
  */
 export interface ReportTrackSentTo {
     /**
-     * ID of the report definition.
+     * ID of the report definition. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof ReportTrackSentTo
      */
@@ -39,10 +39,34 @@ export interface ReportTrackSentTo {
      */
     'description'?: string | null;
     /**
-     * Indicates that this \'Sent To\' subject will be chosen by default for new reports.
+     * Date record was first added to the system
+     * @type {string}
+     * @memberof ReportTrackSentTo
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system
+     * @type {string}
+     * @memberof ReportTrackSentTo
+     */
+    'entry_User'?: string | null;
+    /**
+     * Indicates that this \'Sent To\' subject will be chosen by default for new reports. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof ReportTrackSentTo
      */
     'sent_To_Default': boolean;
+    /**
+     * Date the record was last updated in the system
+     * @type {string}
+     * @memberof ReportTrackSentTo
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system
+     * @type {string}
+     * @memberof ReportTrackSentTo
+     */
+    'update_User'?: string | null;
 }