Events

List of Claim Invoice Statuses

List of Claim Invoice Statuses

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/claim-invoice-statuses
Request samples 
Response samples 
No sample
Create Event
Creates a new Event


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


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


 
claim_Audit_Event
required
boolean
Flag to indicate if the event triggers a Claim Audit. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
completion_Date
string or null <date-time> 
Date the Event was Completed.


 
completion_Percent
number or null <double> 
Current Percentage that the Event has Completed


 
due_Date
string or null <date-time> 
Due Date of the Event


 
end_Date
string or null <date-time> 
End Date of the Event


 
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


 
event_Processor
string or null  <= 64 characters 
Object used when processing the event


 
event_Type
string or null  <= 32 characters 
Identifier for the type of event


 
meta_Data
string or null  <= 512 characters 
Meta data pertaining to the overall event


 
next_Scheduled_Date
string or null <date-time> 
Date when the 'Assigned User' will receive the next event reminder.


 
next_Scheduled_Time
string or null <date-time> 
Date when the event is due.


 
priority
string or null  <= 32 characters 
Indicates the level of priority being assigned to the event.


 
process_Automation_Event
required
boolean
Flag to indicate if the event triggers a Report Series. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
reminder
required
boolean
Indicates that the 'Assigned User' should receive a reminder regarding the event. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
reminder_Event_ID
integer or null <int32> 
Event ID of the Reminder


 
reportSeries_Key
integer or null <int32> 
The key of the Report Series this Event trigger.


 
start_Date
string or null <date-time> 
Start Date of the Event


 
status
string or null  <= 32 characters 
Identifies the current status of the event.


 
subject
string or null  <= 256 characters 
Description of the event subject.


 
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


 
userGroup_Key
integer or null <int32> 
Key value identifying the User Group to whom the event is assigned


 
user_ID
string or null  <= 16 characters 
ID of the User to whom the event is assigned.


 
Responses 
200
Success


401
Unauthorized


post/events
Request samples 
{
  • "event_ID": 0,
  • "claim_Audit_Event": true,
  • "completion_Date": "2019-08-24T14:15:22Z",
  • "completion_Percent": 0.1,
  • "due_Date": "2019-08-24T14:15:22Z",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "event_Processor": "string",
  • "event_Type": "string",
  • "meta_Data": "string",
  • "next_Scheduled_Date": "2019-08-24T14:15:22Z",
  • "next_Scheduled_Time": "2019-08-24T14:15:22Z",
  • "priority": "string",
  • "process_Automation_Event": true,
  • "reminder": true,
  • "reminder_Event_ID": 0,
  • "reportSeries_Key": 0,
  • "start_Date": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "subject": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "userGroup_Key": 0,
  • "user_ID": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
List Event
Lists all Event


SecurityapiKeyAuth and bearerAuth 
Request 
query Parameters
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/events
Request samples 
Response samples 
No sample
List Schedule Intervals
List Schedule Intervals


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


 
Responses 
200
Success


401
Unauthorized


get/schedule-intervals
Request samples 
Response samples 
No sample
List Schedule Interval Options
List Schedule Interval Options


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


 
Responses 
200
Success


401
Unauthorized


get/schedule-interval-options
Request samples 
Response samples 
No sample
List Schedule Interval End Options
List Schedule Interval End Options


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


 
Responses 
200
Success


401
Unauthorized


get/schedule-interval-end-options
Request samples 
Response samples 
No sample
List Days Of Week
List Days Of Week


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


 
Responses 
200
Success


401
Unauthorized


get/days-of-week
Request samples 
Response samples 
No sample
List Months Of Year
List Months Of Year


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


 
Responses 
200
Success


401
Unauthorized


get/months-of-year
Request samples 
Response samples 
No sample
List Event Actions
List Event Actions


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


 
Responses 
200
Success


401
Unauthorized


get/event-actions
Request samples 
Response samples 
No sample
List Schedule Actions
List Schedule Actions


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


 
Responses 
200
Success


401
Unauthorized


get/schedule-actions
Request samples 
Response samples 
No sample
List Durations
List Durations


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


 
Responses 
200
Success


401
Unauthorized


get/durations
Request samples 
Response samples 
No sample
List Priorities
List Priorities


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


 
Responses 
200
Success


401
Unauthorized


get/priorities
Request samples 
Response samples 
No sample
List Snoozes
List Snoozes


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


 
Responses 
200
Success


401
Unauthorized


get/snoozes
Request samples 
Response samples 
No sample
List Active User Events
Retrieves a list of active Events for the specified User ID


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userId
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/users/{userId}/events
Request samples 
Response samples 
No sample
Get Event
Gets Event


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
eventID
required
integer <int32> 
Event ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/events/{eventID}
Request samples 
Response samples 
No sample
Update Event
Updates a specific Event.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
eventID
required
integer <int32> 
Event ID


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
claim_Audit_Event
required
boolean
Flag to indicate if the event triggers a Claim Audit. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
completion_Date
string or null <date-time> 
Date the Event was Completed.


 
completion_Percent
number or null <double> 
Current Percentage that the Event has Completed


 
due_Date
string or null <date-time> 
Due Date of the Event


 
end_Date
string or null <date-time> 
End Date of the Event


 
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


 
event_Processor
string or null  <= 64 characters 
Object used when processing the event


 
event_Type
string or null  <= 32 characters 
Identifier for the type of event


 
meta_Data
string or null  <= 512 characters 
Meta data pertaining to the overall event


 
next_Scheduled_Date
string or null <date-time> 
Date when the 'Assigned User' will receive the next event reminder.


 
next_Scheduled_Time
string or null <date-time> 
Date when the event is due.


 
priority
string or null  <= 32 characters 
Indicates the level of priority being assigned to the event.


 
process_Automation_Event
required
boolean
Flag to indicate if the event triggers a Report Series. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
reminder
required
boolean
Indicates that the 'Assigned User' should receive a reminder regarding the event. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
reminder_Event_ID
integer or null <int32> 
Event ID of the Reminder


 
reportSeries_Key
integer or null <int32> 
The key of the Report Series this Event trigger.


 
start_Date
string or null <date-time> 
Start Date of the Event


 
status
string or null  <= 32 characters 
Identifies the current status of the event.


 
subject
string or null  <= 256 characters 
Description of the event subject.


 
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


 
userGroup_Key
integer or null <int32> 
Key value identifying the User Group to whom the event is assigned


 
user_ID
string or null  <= 16 characters 
ID of the User to whom the event is assigned.


 
Responses 
200
Success


401
Unauthorized


put/events/{eventID}
Request samples 
{
  • "event_ID": 0,
  • "claim_Audit_Event": true,
  • "completion_Date": "2019-08-24T14:15:22Z",
  • "completion_Percent": 0.1,
  • "due_Date": "2019-08-24T14:15:22Z",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "event_Processor": "string",
  • "event_Type": "string",
  • "meta_Data": "string",
  • "next_Scheduled_Date": "2019-08-24T14:15:22Z",
  • "next_Scheduled_Time": "2019-08-24T14:15:22Z",
  • "priority": "string",
  • "process_Automation_Event": true,
  • "reminder": true,
  • "reminder_Event_ID": 0,
  • "reportSeries_Key": 0,
  • "start_Date": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "subject": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "userGroup_Key": 0,
  • "user_ID": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Event
Deletes an Event


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
eventID
required
integer <int32> 
Event ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/events/{eventID}
Request samples 
Create or Update Batch Event
Create or Update multiple Event 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 
event_ID
required
integer <int32> 
ID of the event. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
claim_Audit_Event
required
boolean
Flag to indicate if the event triggers a Claim Audit. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
completion_Date
string or null <date-time> 
Date the Event was Completed.


 
completion_Percent
number or null <double> 
Current Percentage that the Event has Completed


 
due_Date
string or null <date-time> 
Due Date of the Event


 
end_Date
string or null <date-time> 
End Date of the Event


 
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


 
event_Processor
string or null  <= 64 characters 
Object used when processing the event


 
event_Type
string or null  <= 32 characters 
Identifier for the type of event


 
meta_Data
string or null  <= 512 characters 
Meta data pertaining to the overall event


 
next_Scheduled_Date
string or null <date-time> 
Date when the 'Assigned User' will receive the next event reminder.


 
next_Scheduled_Time
string or null <date-time> 
Date when the event is due.


 
priority
string or null  <= 32 characters 
Indicates the level of priority being assigned to the event.


 
process_Automation_Event
required
boolean
Flag to indicate if the event triggers a Report Series. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
reminder
required
boolean
Indicates that the 'Assigned User' should receive a reminder regarding the event. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
reminder_Event_ID
integer or null <int32> 
Event ID of the Reminder


 
reportSeries_Key
integer or null <int32> 
The key of the Report Series this Event trigger.


 
start_Date
string or null <date-time> 
Start Date of the Event


 
status
string or null  <= 32 characters 
Identifies the current status of the event.


 
subject
string or null  <= 256 characters 
Description of the event subject.


 
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


 
userGroup_Key
integer or null <int32> 
Key value identifying the User Group to whom the event is assigned


 
user_ID
string or null  <= 16 characters 
ID of the User to whom the event is assigned.


 
Responses 
207
Success


401
Unauthorized


put/events-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
Reschedule Event
Reschedule Event


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
eventID
required
integer <int32> 
Event ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


post/events/{eventID}/reschedule
Request samples 
Response samples 
No sample
Next Scheduled Date
Move Event to the Next Scheduled Date. See ListEventSchedule to get all Schedule IDs for this Event.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
eventID
required
integer <int32> 
Event ID


 
scheduleId
required
integer <int32> 
Schedule ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


post/events/{eventID}/schedules/{scheduleId}/next
Request samples 
Response samples 
No sample
Snooze an Event
Snooze an Event for the specified duration. See ListSnoozes for available snooze durations. Default snooze duration is 15 minutes.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
eventID
required
integer <int32> 
Event ID


 
query Parameters
snoozeDuration
required
string
 Default:  "SNOOZE_15_MIN"
Snooze Duration


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


post/events/{eventID}/snooze
Request samples 
Response samples 
No sample
List Report Args
List Report Args


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


 
Responses 
200
Success


401
Unauthorized


get/report-args
Request samples 
Response samples 
No sample