Group Flex Schedules

Create GroupFlexSchedule

Creates a new GroupFlexSchedule

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
groupFlexSchedule_Key
required
integer <int32>

The unique identifier for the flex schedule. Note: This field is marked as NOT NULL in the database and therefore required by the API.

calendar_Year
required
string [ 1 .. 4 ] characters

References GroupFlex.Calendar_Year value on the parent record.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

group_ID
required
string [ 1 .. 20 ] characters

References GroupFlex.Group_ID value on the parent record.

plan_ID
required
string [ 1 .. 20 ] characters

References GroupFlex.Plan_ID value on the parent record.

schedule_Date
required
string <date-time>

The scheduled date of the flex payment. Note: This field is marked as NOT NULL in the database and therefore required by the API.

schedule_Type
required
string [ 1 .. 16 ] characters

The type of schedule to apply for payments. If this value is CUSTOM, the user defines the value by hand for "Schedule_Date". For all other types the "Schedule_Date" is calculated and populated.

update_Date
string <date-time>

Date when 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/groups/{groupID}/flex-schedules
Request samples
{
  • "groupFlexSchedule_Key": 0,
  • "calendar_Year": "stri",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "plan_ID": "string",
  • "schedule_Date": "2019-08-24T14:15:22Z",
  • "schedule_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupFlexSchedule

Lists all GroupFlexSchedule for the given groupID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

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/groups/{groupID}/flex-schedules
Request samples 
Response samples 
No sample
Get GroupFlexSchedule
Gets GroupFlexSchedule


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
groupFlexScheduleKey
required
integer <int32> 
GroupFlexSchedule Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}/flex-schedules/{groupFlexScheduleKey}
Request samples 
Response samples 
No sample
Update GroupFlexSchedule
Updates a specific GroupFlexSchedule.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
groupFlexScheduleKey
required
integer <int32> 
GroupFlexSchedule Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
groupFlexSchedule_Key
required
integer <int32> 
The unique identifier for the flex schedule. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
calendar_Year
required
string  [ 1 .. 4 ] characters 
References GroupFlex.Calendar_Year value on the parent record.


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


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


 
group_ID
required
string  [ 1 .. 20 ] characters 
References GroupFlex.Group_ID value on the parent record.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
References GroupFlex.Plan_ID value on the parent record.


 
schedule_Date
required
string <date-time> 
The scheduled date of the flex payment. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
schedule_Type
required
string  [ 1 .. 16 ] characters 
The type of schedule to apply for payments. If this value is CUSTOM, the user defines the value by hand for "Schedule_Date". For all other types the "Schedule_Date" is calculated and populated.


 
update_Date
string <date-time> 
Date when 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/groups/{groupID}/flex-schedules/{groupFlexScheduleKey}
Request samples 
{
  • "groupFlexSchedule_Key": 0,
  • "calendar_Year": "stri",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "plan_ID": "string",
  • "schedule_Date": "2019-08-24T14:15:22Z",
  • "schedule_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete GroupFlexSchedule
Deletes an GroupFlexSchedule


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
groupFlexScheduleKey
required
integer <int32> 
GroupFlexSchedule Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{groupID}/flex-schedules/{groupFlexScheduleKey}
Request samples 
Create or Update Batch GroupFlexSchedule
Create or Update multiple GroupFlexSchedule at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
groupFlexSchedule_Key
required
integer <int32> 
The unique identifier for the flex schedule. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
calendar_Year
required
string  [ 1 .. 4 ] characters 
References GroupFlex.Calendar_Year value on the parent record.


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


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


 
group_ID
required
string  [ 1 .. 20 ] characters 
References GroupFlex.Group_ID value on the parent record.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
References GroupFlex.Plan_ID value on the parent record.


 
schedule_Date
required
string <date-time> 
The scheduled date of the flex payment. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
schedule_Type
required
string  [ 1 .. 16 ] characters 
The type of schedule to apply for payments. If this value is CUSTOM, the user defines the value by hand for "Schedule_Date". For all other types the "Schedule_Date" is calculated and populated.


 
update_Date
string <date-time> 
Date when 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/groups/{groupID}/flex-schedules-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}