Payee Accounts

Create PayeeAccount

Creates a new PayeeAccount

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
payeeID
required
string

Payee ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
payeeAccount_Key
required
integer <int32>
account_Key
required
integer <int32>
effective_Date
string or null <date-time>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
payee_ID
required
string [ 1 .. 20 ] characters
term_Date
string or null <date-time>
update_Date
string <date-time>
update_User
string or null <= 20 characters
wire_Transfer
required
boolean
Responses
200

Success

401

Unauthorized

post/payees/{payeeID}/accounts
Request samples
{
  • "payeeAccount_Key": 0,
  • "account_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "payee_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "wire_Transfer": true
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PayeeAccount

Lists all PayeeAccount for the given payeeID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
payeeID
required
string

Payee 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/payees/{payeeID}/accounts
Request samples 
Response samples 
No sample
Get PayeeAccount
Gets PayeeAccount


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
payeeID
required
string
Payee ID


 
payeeAccountKey
required
integer <int32> 
PayeeAccount Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/payees/{payeeID}/accounts/{payeeAccountKey}
Request samples 
Response samples 
No sample
Update PayeeAccount
Updates a specific PayeeAccount.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
payeeID
required
string
Payee ID


 
payeeAccountKey
required
integer <int32> 
PayeeAccount Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
payeeAccount_Key
required
integer <int32> 
 
account_Key
required
integer <int32> 
 
effective_Date
string or null <date-time> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
payee_ID
required
string  [ 1 .. 20 ] characters 
 
term_Date
string or null <date-time> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
wire_Transfer
required
boolean
 
Responses 
200
Success


401
Unauthorized


put/payees/{payeeID}/accounts/{payeeAccountKey}
Request samples 
{
  • "payeeAccount_Key": 0,
  • "account_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "payee_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "wire_Transfer": true
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PayeeAccount
Deletes an PayeeAccount


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
payeeID
required
string
Payee ID


 
payeeAccountKey
required
integer <int32> 
PayeeAccount Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/payees/{payeeID}/accounts/{payeeAccountKey}
Request samples 
Create or Update Batch PayeeAccount
Create or Update multiple PayeeAccount 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
payeeID
required
string
Payee ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
payeeAccount_Key
required
integer <int32> 
 
account_Key
required
integer <int32> 
 
effective_Date
string or null <date-time> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
payee_ID
required
string  [ 1 .. 20 ] characters 
 
term_Date
string or null <date-time> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
wire_Transfer
required
boolean
 
Responses 
207
Success


401
Unauthorized


put/payees/{payeeID}/accounts-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}