Group Payor Account Settings

Create GroupPayorAccount

Creates a new GroupPayorAccount

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
group_ID
required
string [ 1 .. 20 ] characters

References Groups.Group_ID value on the parent record.

setting_ID
required
string [ 1 .. 32 ] characters

Unique identifier for each payor/account setting.

account_Key
integer or null <int32>

The Account_Key to be assigned on the claim if subsequent criteria values match the claim.

check_Incurred
required
boolean

Indiciates if Service_Date should be interrogated for this setting. If so, use Incurred_From and Incurred_Thru values. Note: This field is marked as NOT NULL in the database and therefore required by the API.

check_Received
required
boolean

Indiciates if Received_Date should be interrogated for this setting. If so, use Received_From and Received_Thru values. Note: This field is marked as NOT NULL in the database and therefore required by the API.

currency_ID
string or null <= 16 characters

If this payor/account setting should be applied only to specific currency, you would note that currency here.

description
string or null <= 512 characters

A brief description of this payor/account setting for reporting and admin purposes.

division_ID
string or null <= 20 characters

Optionally, set the Division_ID (reference GroupDivision.Division_ID) if this setting is Division level.

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.

ex_Code
string or null <= 6 characters

If an Ex_Code should be placed on the claim when this setting is hit during adjudication, you would assign that Ex_Code here.

incurred_From
string or null <date-time>

The date range for this setting if Check_Incurred is flagged.

incurred_Thru
string or null <date-time>

The date range for this setting if Check_Incurred is flagged.

payor_ID
string or null <= 20 characters

The Payor_ID to be assigned on the claim if subsequent criteria values match the claim.

received_From
string or null <date-time>

The date range for this setting if Check_Received is flagged.

received_Thru
string or null <date-time>

The date range for this setting if Check_Received is flagged.

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/groups/{groupID}/payor-account-settings
Request samples
{
  • "group_ID": "string",
  • "setting_ID": "string",
  • "account_Key": 0,
  • "check_Incurred": true,
  • "check_Received": true,
  • "currency_ID": "string",
  • "description": "string",
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "incurred_From": "2019-08-24T14:15:22Z",
  • "incurred_Thru": "2019-08-24T14:15:22Z",
  • "payor_ID": "string",
  • "received_From": "2019-08-24T14:15:22Z",
  • "received_Thru": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupPayorAccount

Lists all GroupPayorAccount for the given groupID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group 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/groups/{groupID}/payor-account-settings
Request samples 
Response samples 
No sample
Get GroupPayorAccount
Gets GroupPayorAccount


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
settingID
required
string
Setting ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}/payor-account-settings/{settingID}
Request samples 
Response samples 
No sample
Update GroupPayorAccount
Updates a specific GroupPayorAccount.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
settingID
required
string
Setting ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
group_ID
required
string  [ 1 .. 20 ] characters 
References Groups.Group_ID value on the parent record.


 
setting_ID
required
string  [ 1 .. 32 ] characters 
Unique identifier for each payor/account setting.


 
account_Key
integer or null <int32> 
The Account_Key to be assigned on the claim if subsequent criteria values match the claim.


 
check_Incurred
required
boolean
Indiciates if Service_Date should be interrogated for this setting. If so, use Incurred_From and Incurred_Thru values. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
check_Received
required
boolean
Indiciates if Received_Date should be interrogated for this setting. If so, use Received_From and Received_Thru values. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
currency_ID
string or null  <= 16 characters 
If this payor/account setting should be applied only to specific currency, you would note that currency here.


 
description
string or null  <= 512 characters 
A brief description of this payor/account setting for reporting and admin purposes.


 
division_ID
string or null  <= 20 characters 
Optionally, set the Division_ID (reference GroupDivision.Division_ID) if this setting is Division level.


 
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.


 
ex_Code
string or null  <= 6 characters 
If an Ex_Code should be placed on the claim when this setting is hit during adjudication, you would assign that Ex_Code here.


 
incurred_From
string or null <date-time> 
The date range for this setting if Check_Incurred is flagged.


 
incurred_Thru
string or null <date-time> 
The date range for this setting if Check_Incurred is flagged.


 
payor_ID
string or null  <= 20 characters 
The Payor_ID to be assigned on the claim if subsequent criteria values match the claim.


 
received_From
string or null <date-time> 
The date range for this setting if Check_Received is flagged.


 
received_Thru
string or null <date-time> 
The date range for this setting if Check_Received is flagged.


 
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/groups/{groupID}/payor-account-settings/{settingID}
Request samples 
{
  • "group_ID": "string",
  • "setting_ID": "string",
  • "account_Key": 0,
  • "check_Incurred": true,
  • "check_Received": true,
  • "currency_ID": "string",
  • "description": "string",
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "incurred_From": "2019-08-24T14:15:22Z",
  • "incurred_Thru": "2019-08-24T14:15:22Z",
  • "payor_ID": "string",
  • "received_From": "2019-08-24T14:15:22Z",
  • "received_Thru": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete GroupPayorAccount
Deletes an GroupPayorAccount


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
settingID
required
string
Setting ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{groupID}/payor-account-settings/{settingID}
Request samples 
Create or Update Batch GroupPayorAccount
Create or Update multiple GroupPayorAccount 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
groupID
required
string
Group ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
group_ID
required
string  [ 1 .. 20 ] characters 
References Groups.Group_ID value on the parent record.


 
setting_ID
required
string  [ 1 .. 32 ] characters 
Unique identifier for each payor/account setting.


 
account_Key
integer or null <int32> 
The Account_Key to be assigned on the claim if subsequent criteria values match the claim.


 
check_Incurred
required
boolean
Indiciates if Service_Date should be interrogated for this setting. If so, use Incurred_From and Incurred_Thru values. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
check_Received
required
boolean
Indiciates if Received_Date should be interrogated for this setting. If so, use Received_From and Received_Thru values. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
currency_ID
string or null  <= 16 characters 
If this payor/account setting should be applied only to specific currency, you would note that currency here.


 
description
string or null  <= 512 characters 
A brief description of this payor/account setting for reporting and admin purposes.


 
division_ID
string or null  <= 20 characters 
Optionally, set the Division_ID (reference GroupDivision.Division_ID) if this setting is Division level.


 
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.


 
ex_Code
string or null  <= 6 characters 
If an Ex_Code should be placed on the claim when this setting is hit during adjudication, you would assign that Ex_Code here.


 
incurred_From
string or null <date-time> 
The date range for this setting if Check_Incurred is flagged.


 
incurred_Thru
string or null <date-time> 
The date range for this setting if Check_Incurred is flagged.


 
payor_ID
string or null  <= 20 characters 
The Payor_ID to be assigned on the claim if subsequent criteria values match the claim.


 
received_From
string or null <date-time> 
The date range for this setting if Check_Received is flagged.


 
received_Thru
string or null <date-time> 
The date range for this setting if Check_Received is flagged.


 
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/groups/{groupID}/payor-account-settings-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}