Skip to content

Create GroupFlexSchedule

Request

Creates a new GroupFlexSchedule

Security
apiKeyAuth and bearerAuth
Path
groupIDstringrequired

Group ID

Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
groupFlexSchedule_Keyinteger, (int32)required

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_Yearstring, [ 1 .. 4 ] charactersrequired

References GroupFlex.Calendar_Year value on the parent record.

entry_Datestring, (date-time)

Date when the record was first added to the system.

entry_Userstring or null, <= 20 characters

User that first added the record to the system.

group_IDstring, [ 1 .. 20 ] charactersrequired

References GroupFlex.Group_ID value on the parent record.

plan_IDstring, [ 1 .. 20 ] charactersrequired

References GroupFlex.Plan_ID value on the parent record.

schedule_Datestring, (date-time)required

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_Typestring, [ 1 .. 16 ] charactersrequired

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_Datestring, (date-time)

Date when the record was last updated in the system.

update_Userstring or null, <= 20 characters

User that last updated the record in the system.

curl -i -X POST \
  'https://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/flex-schedules' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "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"
  }'

Responses

Success

Bodyapplication/json
dataobject
errorobject
debugobject
Response
{
  "data": { … },
  "error": { … },
  "debug": { … }
}