Group UC Percent Settings

Create GroupUCPercent

Creates a new GroupUCPercent

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
groupUCPercent_Key
required
integer <int32>

Unique identifier for each UC Percent configuration for this Group. Note: This field is marked as NOT NULL in the database and therefore required by the API.

claim_Type
required
string [ 1 .. 20 ] characters

Claim type that the UC percent settings will be applied to.

custom_Percent
number or null <double>

Identifies the custom percentage that will be applied by the UC percent settings.

custom_Percent_Claim_Type
string or null <= 20 characters

When using a custom percent, this applies a claim type restriction to the rule limiting which claim types can have UC applied.

effective_Date
string or null <date-time>

Date when the UC percent settings become/became effective.

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.

fee_Sched
string or null <= 8 characters

When a fee schedule is used as the rate structure than the UC tables.

group_ID
required
string [ 1 .. 20 ] characters

References the Groups.Group_ID value on the parent record.

term_Date
string or null <date-time>

Date when the UC percent settings expire/expired.

uC_Percent
string or null <= 8 characters

Allows the User to select a default percentage that will be applied by the UC percent settings.

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.

use_Custom_Percent
required
boolean

Allows the User to build a custom percentage for the UC percent settings instead of using one of the default percentages. Note: This field is marked as NOT NULL in the database and therefore required by the API.

Responses
200

Success

401

Unauthorized

post/groups/{groupID}/uc-percent-settings
Request samples
{
  • "groupUCPercent_Key": 0,
  • "claim_Type": "string",
  • "custom_Percent": 0.1,
  • "custom_Percent_Claim_Type": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "fee_Sched": "string",
  • "group_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "uC_Percent": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Custom_Percent": true
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupUCPercent

Lists all GroupUCPercent 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}/uc-percent-settings
Request samples 
Response samples 
No sample
Get GroupUCPercent
Gets GroupUCPercent


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
groupUCPercentKey
required
integer <int32> 
GroupUCPercent Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}/uc-percent-settings/{groupUCPercentKey}
Request samples 
Response samples 
No sample
Update GroupUCPercent
Updates a specific GroupUCPercent.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
groupUCPercentKey
required
integer <int32> 
GroupUCPercent Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
groupUCPercent_Key
required
integer <int32> 
Unique identifier for each UC Percent configuration for this Group. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
claim_Type
required
string  [ 1 .. 20 ] characters 
Claim type that the UC percent settings will be applied to.


 
custom_Percent
number or null <double> 
Identifies the custom percentage that will be applied by the UC percent settings.


 
custom_Percent_Claim_Type
string or null  <= 20 characters 
When using a custom percent, this applies a claim type restriction to the rule limiting which claim types can have UC applied.


 
effective_Date
string or null <date-time> 
Date when the UC percent settings become/became effective.


 
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.


 
fee_Sched
string or null  <= 8 characters 
When a fee schedule is used as the rate structure than the UC tables.


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


 
term_Date
string or null <date-time> 
Date when the UC percent settings expire/expired.


 
uC_Percent
string or null  <= 8 characters 
Allows the User to select a default percentage that will be applied by the UC percent settings.


 
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.


 
use_Custom_Percent
required
boolean
Allows the User to build a custom percentage for the UC percent settings instead of using one of the default percentages. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
200
Success


401
Unauthorized


put/groups/{groupID}/uc-percent-settings/{groupUCPercentKey}
Request samples 
{
  • "groupUCPercent_Key": 0,
  • "claim_Type": "string",
  • "custom_Percent": 0.1,
  • "custom_Percent_Claim_Type": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "fee_Sched": "string",
  • "group_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "uC_Percent": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Custom_Percent": true
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete GroupUCPercent
Deletes an GroupUCPercent


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
groupUCPercentKey
required
integer <int32> 
GroupUCPercent Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{groupID}/uc-percent-settings/{groupUCPercentKey}
Request samples 
Create or Update Batch GroupUCPercent
Create or Update multiple GroupUCPercent 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 
groupUCPercent_Key
required
integer <int32> 
Unique identifier for each UC Percent configuration for this Group. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
claim_Type
required
string  [ 1 .. 20 ] characters 
Claim type that the UC percent settings will be applied to.


 
custom_Percent
number or null <double> 
Identifies the custom percentage that will be applied by the UC percent settings.


 
custom_Percent_Claim_Type
string or null  <= 20 characters 
When using a custom percent, this applies a claim type restriction to the rule limiting which claim types can have UC applied.


 
effective_Date
string or null <date-time> 
Date when the UC percent settings become/became effective.


 
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.


 
fee_Sched
string or null  <= 8 characters 
When a fee schedule is used as the rate structure than the UC tables.


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


 
term_Date
string or null <date-time> 
Date when the UC percent settings expire/expired.


 
uC_Percent
string or null  <= 8 characters 
Allows the User to select a default percentage that will be applied by the UC percent settings.


 
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.


 
use_Custom_Percent
required
boolean
Allows the User to build a custom percentage for the UC percent settings instead of using one of the default percentages. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
207
Success


401
Unauthorized


put/groups/{groupID}/uc-percent-settings-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}