Member Payments

Create MemberPayment

Creates a new MemberPayment

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
memberPayment_Key
required
integer <int32>

Unique Identifier for this payment for the member. Note: This field is marked as NOT NULL in the database and therefore required by the API.

division_ID
required
string [ 1 .. 20 ] characters

References Subenrollment.Division_ID 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_Coverage_Start
required
string <date-time>

References Subenrollment.Group_Coverage_Start value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.

group_ID
required
string [ 1 .. 20 ] characters

References Subenrollment.Group_ID value on the parent record.

member_Seq
required
string [ 1 .. 2 ] characters

References Members.Member_Seq 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 associated payment was processed.

payment_ID
string or null <= 20 characters

Unique identifier assigned to the associated payment.

payment_Type
string or null <= 32 characters

Identifies the type associated with the payment.

start_Date
required
string <date-time>

References Subenrollment.Start_Date value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.

subscriber_ID
required
string [ 1 .. 9 ] characters

References Members.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}/members/{memberSeq}/payments
Request samples
{
  • "memberPayment_Key": 0,
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_Coverage_Start": "2019-08-24T14:15:22Z",
  • "group_ID": "string",
  • "member_Seq": "st",
  • "payment_Amount": 0.1,
  • "payment_Date": "2019-08-24T14:15:22Z",
  • "payment_ID": "string",
  • "payment_Type": "string",
  • "start_Date": "2019-08-24T14:15:22Z",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List MemberPayment

Lists all MemberPayment for the given subscriberID and memberSeq

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

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}/members/{memberSeq}/payments
Request samples 
Response samples 
No sample
List MemberPayments Filtered
Lists all MemberPayment for the given Subscriber ID, Member Seq, Group ID, Division ID, Group Coverage Start and Start Date


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
query Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
groupCoverageStart
required
string <date-time> 
Group Coverage Start


 
startDate
required
string <date-time> 
Start Date


 
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}/members/{memberSeq}/payments-filtered
Request samples 
Response samples 
No sample
Get MemberPayment
Gets MemberPayment


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberPaymentKey
required
integer <int32> 
MemberPayment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/members/{memberSeq}/payments/{memberPaymentKey}
Request samples 
Response samples 
No sample
Update MemberPayment
Updates a specific MemberPayment.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberPaymentKey
required
integer <int32> 
MemberPayment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
memberPayment_Key
required
integer <int32> 
Unique Identifier for this payment for the member. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
division_ID
required
string  [ 1 .. 20 ] characters 
References Subenrollment.Division_ID 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_Coverage_Start
required
string <date-time> 
References Subenrollment.Group_Coverage_Start value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


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


 
member_Seq
required
string  [ 1 .. 2 ] characters 
References Members.Member_Seq 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 associated payment was processed.


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


 
payment_Type
string or null  <= 32 characters 
Identifies the type associated with the payment.


 
start_Date
required
string <date-time> 
References Subenrollment.Start_Date value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Members.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}/members/{memberSeq}/payments/{memberPaymentKey}
Request samples 
{
  • "memberPayment_Key": 0,
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_Coverage_Start": "2019-08-24T14:15:22Z",
  • "group_ID": "string",
  • "member_Seq": "st",
  • "payment_Amount": 0.1,
  • "payment_Date": "2019-08-24T14:15:22Z",
  • "payment_ID": "string",
  • "payment_Type": "string",
  • "start_Date": "2019-08-24T14:15:22Z",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete MemberPayment
Deletes an MemberPayment


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberPaymentKey
required
integer <int32> 
MemberPayment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/members/{memberSeq}/payments/{memberPaymentKey}
Request samples 
Create or Update Batch MemberPayment
Create or Update multiple MemberPayment 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


 
memberSeq
required
string
Member Seq


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
memberPayment_Key
required
integer <int32> 
Unique Identifier for this payment for the member. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
division_ID
required
string  [ 1 .. 20 ] characters 
References Subenrollment.Division_ID 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_Coverage_Start
required
string <date-time> 
References Subenrollment.Group_Coverage_Start value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


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


 
member_Seq
required
string  [ 1 .. 2 ] characters 
References Members.Member_Seq 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 associated payment was processed.


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


 
payment_Type
string or null  <= 32 characters 
Identifies the type associated with the payment.


 
start_Date
required
string <date-time> 
References Subenrollment.Start_Date value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Members.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}/members/{memberSeq}/payments-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}