Subscriber Flex Payments

Create SubscriberFlexPayment

Creates a new SubscriberFlexPayment

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

groupID
required
string

Group ID

planID
required
string

Plan ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
subscriberFlexPayment_Key
required
integer <int32>

Unique identifier for each payment record on this flex account. Note: This field is marked as NOT NULL in the database and therefore required by the API.

calendar_Year
string or null <= 4 characters

References SubscriberFlex.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
string or null <= 20 characters

References SubscriberFlex.Group_ID value on the parent record.

payment_Amount
number or null <double>

Amount of the associated payment.

payment_Date
string or null <date-time>

Date when the payment was processed.

payment_Description
string or null <= 128 characters

A description area used to provider more detail about the payment.

payment_ID
string or null <= 32 characters

Unique identifier assigned to the associated payment.

payment_Source
string or null <= 16 characters

Indicates the source of funds for this payment. GROUP - Employer Contribution or SUBSCRIBER - Employee Payment

plan_ID
string or null <= 20 characters

References SubscriberFlex.Plan_ID value on the parent record.

subscriber_ID
string or null <= 9 characters

References SubscriberFlex.Subscriber_ID value on the parent record.

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/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flex-payments
Request samples
{
  • "subscriberFlexPayment_Key": 0,
  • "calendar_Year": "stri",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "payment_Amount": 0.1,
  • "payment_Date": "2019-08-24T14:15:22Z",
  • "payment_Description": "string",
  • "payment_ID": "string",
  • "payment_Source": "string",
  • "plan_ID": "string",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List SubscriberFlexPayment

Lists all SubscriberFlexPayment for the given subscriberID and groupID and planID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

groupID
required
string

Group ID

planID
required
string

Plan 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/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flex-payments
Request samples 
Response samples 
No sample
Get SubscriberFlexPayment
Gets SubscriberFlexPayment


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
groupID
required
string
Group ID


 
planID
required
string
Plan ID


 
subscriberFlexPaymentKey
required
integer <int32> 
SubscriberFlexPayment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flex-payments/{subscriberFlexPaymentKey}
Request samples 
Response samples 
No sample
Update SubscriberFlexPayment
Updates a specific SubscriberFlexPayment.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
groupID
required
string
Group ID


 
planID
required
string
Plan ID


 
subscriberFlexPaymentKey
required
integer <int32> 
SubscriberFlexPayment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
subscriberFlexPayment_Key
required
integer <int32> 
Unique identifier for each payment record on this flex account. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
calendar_Year
string or null  <= 4 characters 
References SubscriberFlex.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
string or null  <= 20 characters 
References SubscriberFlex.Group_ID value on the parent record.


 
payment_Amount
number or null <double> 
Amount of the associated payment.


 
payment_Date
string or null <date-time> 
Date when the payment was processed.


 
payment_Description
string or null  <= 128 characters 
A description area used to provider more detail about the payment.


 
payment_ID
string or null  <= 32 characters 
Unique identifier assigned to the associated payment.


 
payment_Source
string or null  <= 16 characters 
Indicates the source of funds for this payment. GROUP - Employer Contribution or SUBSCRIBER - Employee Payment


 
plan_ID
string or null  <= 20 characters 
References SubscriberFlex.Plan_ID value on the parent record.


 
subscriber_ID
string or null  <= 9 characters 
References SubscriberFlex.Subscriber_ID value on the parent record.


 
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/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flex-payments/{subscriberFlexPaymentKey}
Request samples 
{
  • "subscriberFlexPayment_Key": 0,
  • "calendar_Year": "stri",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "payment_Amount": 0.1,
  • "payment_Date": "2019-08-24T14:15:22Z",
  • "payment_Description": "string",
  • "payment_ID": "string",
  • "payment_Source": "string",
  • "plan_ID": "string",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete SubscriberFlexPayment
Deletes an SubscriberFlexPayment


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
groupID
required
string
Group ID


 
planID
required
string
Plan ID


 
subscriberFlexPaymentKey
required
integer <int32> 
SubscriberFlexPayment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flex-payments/{subscriberFlexPaymentKey}
Request samples 
Create or Update Batch SubscriberFlexPayment
Create or Update multiple SubscriberFlexPayment 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
subscriberID
required
string
Subscriber ID


 
groupID
required
string
Group ID


 
planID
required
string
Plan ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
subscriberFlexPayment_Key
required
integer <int32> 
Unique identifier for each payment record on this flex account. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
calendar_Year
string or null  <= 4 characters 
References SubscriberFlex.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
string or null  <= 20 characters 
References SubscriberFlex.Group_ID value on the parent record.


 
payment_Amount
number or null <double> 
Amount of the associated payment.


 
payment_Date
string or null <date-time> 
Date when the payment was processed.


 
payment_Description
string or null  <= 128 characters 
A description area used to provider more detail about the payment.


 
payment_ID
string or null  <= 32 characters 
Unique identifier assigned to the associated payment.


 
payment_Source
string or null  <= 16 characters 
Indicates the source of funds for this payment. GROUP - Employer Contribution or SUBSCRIBER - Employee Payment


 
plan_ID
string or null  <= 20 characters 
References SubscriberFlex.Plan_ID value on the parent record.


 
subscriber_ID
string or null  <= 9 characters 
References SubscriberFlex.Subscriber_ID value on the parent record.


 
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/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flex-payments-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}