Payor Account Notifications

Create PayorAccountNotify

Creates a new PayorAccountNotify

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
payor_Account_Key
required
integer <int32>

Unique identifier for this notification setting.

user_ID
required
string [ 1 .. 16 ] characters

The User ID to be notified by this setting.

Responses
200

Success

401

Unauthorized

post/payor-account-notifications
Request samples
{
  • "payor_Account_Key": 0,
  • "user_ID": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PayorAccountNotify

Lists all PayorAccountNotify

SecurityapiKeyAuth and bearerAuth
Request
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/payor-account-notifications
Request samples 
Response samples 
No sample
Get PayorAccountNotify
Gets PayorAccountNotify


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
payorAccountKey
required
integer <int32> 
Payor Account Key


 
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/payor-account-notifications/{payorAccountKey}/{userID}
Request samples 
Response samples 
No sample
Delete PayorAccountNotify
Deletes an PayorAccountNotify


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
payorAccountKey
required
integer <int32> 
Payor Account Key


 
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/payor-account-notifications/{payorAccountKey}/{userID}
Request samples 
Create Batch PayorAccountNotify
Create or Update multiple PayorAccountNotify at once.  If the entity does not exist, it will be created.  Updates are not allowed. If the entity does exist, an error message will be returned with the resultset.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
payor_Account_Key
required
integer <int32> 
Unique identifier for this notification setting.


 
user_ID
required
string  [ 1 .. 16 ] characters 
The User ID to be notified by this setting.


 
Responses 
207
Success


401
Unauthorized


put/payor-account-notifications-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}