Member Accounts

Create MemberAccount

Creates a new MemberAccount

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
memberAccount_Key
required
integer <int32>

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

account_Key
integer or null <int32>

References FundingAccount.Account_Key for this account on this Member.

effective_From
string or null <date-time>

Date when the Member account becomes/became effective.

effective_Thru
string or null <date-time>

Date when the Member account becomes/became terminated.

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.

member_Seq
string or null <= 2 characters

References Members.Member_Seq value on the parent record.

preNote_Sent
required
boolean

Custom value used for accounting system integrations. Note: This field is marked as NOT NULL in the database and therefore required by the API.

preNote_SentDate
string or null <date-time>

Custom value used for accounting system integrations.

subscriber_ID
string or null <= 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.

wire_Transfer
required
boolean

Indicates that the Member account is setup for direct deposit. Checking this box will activate the ACH option within Subscriber Information. Note: This field is marked as NOT NULL in the database and therefore required by the API.

Responses
200

Success

401

Unauthorized

post/subscribers/{subscriberID}/members/{memberSeq}/accounts
Request samples
{
  • "memberAccount_Key": 0,
  • "account_Key": 0,
  • "effective_From": "2019-08-24T14:15:22Z",
  • "effective_Thru": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "member_Seq": "st",
  • "preNote_Sent": true,
  • "preNote_SentDate": "2019-08-24T14:15:22Z",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "wire_Transfer": true
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List MemberAccount

Lists all MemberAccount for the given member

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}/accounts
Request samples 
Response samples 
No sample
Get MemberAccount
Gets MemberAccount


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberAccountKey
required
integer <int32> 
MemberAccount Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/members/{memberSeq}/accounts/{memberAccountKey}
Request samples 
Response samples 
No sample
Update MemberAccount
Updates a specific MemberAccount.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberAccountKey
required
integer <int32> 
MemberAccount Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
memberAccount_Key
required
integer <int32> 
Unique identifier for each Account on this member. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
account_Key
integer or null <int32> 
References FundingAccount.Account_Key for this account on this Member.


 
effective_From
string or null <date-time> 
Date when the Member account becomes/became effective.


 
effective_Thru
string or null <date-time> 
Date when the Member account becomes/became terminated.


 
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.


 
member_Seq
string or null  <= 2 characters 
References Members.Member_Seq value on the parent record.


 
preNote_Sent
required
boolean
Custom value used for accounting system integrations. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
preNote_SentDate
string or null <date-time> 
Custom value used for accounting system integrations.


 
subscriber_ID
string or null  <= 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.


 
wire_Transfer
required
boolean
Indicates that the Member account is setup for direct deposit. Checking this box will activate the ACH option within Subscriber Information. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
200
Success


401
Unauthorized


put/subscribers/{subscriberID}/members/{memberSeq}/accounts/{memberAccountKey}
Request samples 
{
  • "memberAccount_Key": 0,
  • "account_Key": 0,
  • "effective_From": "2019-08-24T14:15:22Z",
  • "effective_Thru": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "member_Seq": "st",
  • "preNote_Sent": true,
  • "preNote_SentDate": "2019-08-24T14:15:22Z",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "wire_Transfer": true
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete MemberAccount
Deletes an MemberAccount


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberAccountKey
required
integer <int32> 
MemberAccount Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/members/{memberSeq}/accounts/{memberAccountKey}
Request samples 
Create or Update Batch MemberAccount
Create or Update multiple MemberAccount 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 
memberAccount_Key
required
integer <int32> 
Unique identifier for each Account on this member. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
account_Key
integer or null <int32> 
References FundingAccount.Account_Key for this account on this Member.


 
effective_From
string or null <date-time> 
Date when the Member account becomes/became effective.


 
effective_Thru
string or null <date-time> 
Date when the Member account becomes/became terminated.


 
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.


 
member_Seq
string or null  <= 2 characters 
References Members.Member_Seq value on the parent record.


 
preNote_Sent
required
boolean
Custom value used for accounting system integrations. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
preNote_SentDate
string or null <date-time> 
Custom value used for accounting system integrations.


 
subscriber_ID
string or null  <= 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.


 
wire_Transfer
required
boolean
Indicates that the Member account is setup for direct deposit. Checking this box will activate the ACH option within Subscriber Information. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
207
Success


401
Unauthorized


put/subscribers/{subscriberID}/members/{memberSeq}/accounts-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}