Member Alternate Payee

Create MemberAlternatePayee

Creates a new MemberAlternatePayee

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
subscriber_ID
required
string [ 1 .. 9 ] characters
member_Seq
required
string [ 1 .. 2 ] characters
alternate_Payee_ID
required
string [ 1 .. 32 ] characters
address
string or null <= 128 characters
address2
string or null <= 128 characters
check_Memo
string or null <= 64 characters
city
string or null <= 32 characters
country_ID
string or null <= 8 characters
effective_Date
string or null <date-time>
entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

first_Name
string or null <= 32 characters
last_Name
string or null <= 32 characters
long_Name
string or null <= 512 characters
middle_Name
string or null <= 32 characters
relationship
string or null <= 8 characters
state
string or null <= 2 characters
term_Date
string or null <date-time>
update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

zip_Code
string or null <= 32 characters
Responses
200

Success

401

Unauthorized

post/subscribers/{subscriberId}/members/{memberSeq}/alternate-payees
Request samples
{
  • "subscriber_ID": "string",
  • "member_Seq": "st",
  • "alternate_Payee_ID": "string",
  • "address": "string",
  • "address2": "string",
  • "check_Memo": "string",
  • "city": "string",
  • "country_ID": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "first_Name": "string",
  • "last_Name": "string",
  • "long_Name": "string",
  • "middle_Name": "string",
  • "relationship": "string",
  • "state": "st",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "zip_Code": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List MemberAlternatePayee

Lists all MemberAlternatePayee for the given subscriberId and memberSeq

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberId
required
string

Subscriber ID

memberSeq
required
string

Member Seq

query Parameters
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.

page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/subscribers/{subscriberId}/members/{memberSeq}/alternate-payees
Request samples 
Response samples 
No sample
Get MemberAlternatePayee
Gets MemberAlternatePayee


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberId
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
altPayeeId
required
string
Alternate Payee ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberId}/members/{memberSeq}/alternate-payees/{altPayeeId}
Request samples 
Response samples 
No sample
Update MemberAlternatePayee
Updates a specific MemberAlternatePayee.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberId
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
altPayeeId
required
string
Alternate Payee ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
subscriber_ID
required
string  [ 1 .. 9 ] characters 
 
member_Seq
required
string  [ 1 .. 2 ] characters 
 
alternate_Payee_ID
required
string  [ 1 .. 32 ] characters 
 
address
string or null  <= 128 characters 
 
address2
string or null  <= 128 characters 
 
check_Memo
string or null  <= 64 characters 
 
city
string or null  <= 32 characters 
 
country_ID
string or null  <= 8 characters 
 
effective_Date
string or null <date-time> 
 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
first_Name
string or null  <= 32 characters 
 
last_Name
string or null  <= 32 characters 
 
long_Name
string or null  <= 512 characters 
 
middle_Name
string or null  <= 32 characters 
 
relationship
string or null  <= 8 characters 
 
state
string or null  <= 2 characters 
 
term_Date
string or null <date-time> 
 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
zip_Code
string or null  <= 32 characters 
 
Responses 
200
Success


401
Unauthorized


put/subscribers/{subscriberId}/members/{memberSeq}/alternate-payees/{altPayeeId}
Request samples 
{
  • "subscriber_ID": "string",
  • "member_Seq": "st",
  • "alternate_Payee_ID": "string",
  • "address": "string",
  • "address2": "string",
  • "check_Memo": "string",
  • "city": "string",
  • "country_ID": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "first_Name": "string",
  • "last_Name": "string",
  • "long_Name": "string",
  • "middle_Name": "string",
  • "relationship": "string",
  • "state": "st",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "zip_Code": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete MemberAlternatePayee
Deletes an MemberAlternatePayee


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberId
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
altPayeeId
required
string
Alternate Payee ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberId}/members/{memberSeq}/alternate-payees/{altPayeeId}
Request samples 
Create or Update Batch MemberAlternatePayee
Create or Update multiple MemberAlternatePayee 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
 
memberSeq
required
string
 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
 
member_Seq
required
string  [ 1 .. 2 ] characters 
 
alternate_Payee_ID
required
string  [ 1 .. 32 ] characters 
 
address
string or null  <= 128 characters 
 
address2
string or null  <= 128 characters 
 
check_Memo
string or null  <= 64 characters 
 
city
string or null  <= 32 characters 
 
country_ID
string or null  <= 8 characters 
 
effective_Date
string or null <date-time> 
 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
first_Name
string or null  <= 32 characters 
 
last_Name
string or null  <= 32 characters 
 
long_Name
string or null  <= 512 characters 
 
middle_Name
string or null  <= 32 characters 
 
relationship
string or null  <= 8 characters 
 
state
string or null  <= 2 characters 
 
term_Date
string or null <date-time> 
 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
zip_Code
string or null  <= 32 characters 
 
Responses 
207
Success


401
Unauthorized


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