Member Account Plan Payments

Create MemberAccountPlanPayment

Creates a new MemberAccountPlanPayment

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

memberAccountKey
required
integer <int32>

MemberAccount Key

planID
required
string

Plan ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
payment_Key
required
integer <int32>

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

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.

memberAccount_Key
required
integer <int32>

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

plan_ID
required
string [ 1 .. 20 ] characters

References the SubenrollmentPlan.Plan_ID value for this members enrollment.

transaction_Amount
number or null <double>

Total amount of the transaction.

transaction_Date
string or null <date-time>

Date when the transaction occurred.

transaction_ID
string or null <= 20 characters

Identifier assigned to the associated transaction.

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}/accounts/{memberAccountKey}/plans/{planID}/payments
Request samples
{
  • "payment_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "memberAccount_Key": 0,
  • "plan_ID": "string",
  • "transaction_Amount": 0.1,
  • "transaction_Date": "2019-08-24T14:15:22Z",
  • "transaction_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List MemberAccountPlanPayment

Lists all MemberAccountPlanPayment for the given memberAccountKey and planID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

memberAccountKey
required
integer <int32>

MemberAccount Key

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}/members/{memberSeq}/accounts/{memberAccountKey}/plans/{planID}/payments
Request samples 
Response samples 
No sample
Get MemberAccountPlanPayment
Gets MemberAccountPlanPayment


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberAccountKey
required
integer <int32> 
MemberAccount Key


 
planID
required
string
Plan ID


 
paymentKey
required
integer <int32> 
Payment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/members/{memberSeq}/accounts/{memberAccountKey}/plans/{planID}/payments/{paymentKey}
Request samples 
Response samples 
No sample
Update MemberAccountPlanPayment
Updates a specific MemberAccountPlanPayment.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberAccountKey
required
integer <int32> 
MemberAccount Key


 
planID
required
string
Plan ID


 
paymentKey
required
integer <int32> 
Payment Key


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
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.


 
memberAccount_Key
required
integer <int32> 
References the MemberAccount.MemberAccount_Key value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
References the SubenrollmentPlan.Plan_ID value for this members enrollment.


 
transaction_Amount
number or null <double> 
Total amount of the transaction.


 
transaction_Date
string or null <date-time> 
Date when the transaction occurred.


 
transaction_ID
string or null  <= 20 characters 
Identifier assigned to the associated transaction.


 
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}/accounts/{memberAccountKey}/plans/{planID}/payments/{paymentKey}
Request samples 
{
  • "payment_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "memberAccount_Key": 0,
  • "plan_ID": "string",
  • "transaction_Amount": 0.1,
  • "transaction_Date": "2019-08-24T14:15:22Z",
  • "transaction_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete MemberAccountPlanPayment
Deletes an MemberAccountPlanPayment


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberAccountKey
required
integer <int32> 
MemberAccount Key


 
planID
required
string
Plan ID


 
paymentKey
required
integer <int32> 
Payment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/members/{memberSeq}/accounts/{memberAccountKey}/plans/{planID}/payments/{paymentKey}
Request samples 
Create or Update Batch MemberAccountPlanPayment
Create or Update multiple MemberAccountPlanPayment 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


 
memberAccountKey
required
integer <int32> 
MemberAccount Key


 
planID
required
string
Plan ID


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
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.


 
memberAccount_Key
required
integer <int32> 
References the MemberAccount.MemberAccount_Key value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
References the SubenrollmentPlan.Plan_ID value for this members enrollment.


 
transaction_Amount
number or null <double> 
Total amount of the transaction.


 
transaction_Date
string or null <date-time> 
Date when the transaction occurred.


 
transaction_ID
string or null  <= 20 characters 
Identifier assigned to the associated transaction.


 
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}/accounts/{memberAccountKey}/plans/{planID}/payments-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}