Commission Rate Cluster Agency Rep

Create CommissionRateClusterAgencyRep

Creates a new CommissionRateClusterAgencyRep

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
commissionRateClusterAgencyRep_Key
required
integer <int32>

Unique identifer for the Commission Rate Cluster Agency Rep Note: This field is marked as NOT NULL in the database and therefore required by the API.

commissionAgencyRep_Key
integer or null <int32>

Unique identifier for the CommissionAgencyRep

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.

parent_CommissionAgencyRep_Key
integer or null <int32>

Parent key for the CommissionAgencyRep record this is a child of

rate_Cluster
string or null <= 32 characters

Unique identifer for the Rate Cluster

split
number or null <double>

The amount or percentage of the split

split_Max
number or null <double>

Maximum amount of the split

split_Min
number or null <double>

Minimum amount of the split

split_Priority
integer or null <int32>

Priority of the split

split_Type
string or null <= 16 characters

Determines if split is percent or flat amount

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/commission-rate-cluster-agency-reps
Request samples
{
  • "commissionRateClusterAgencyRep_Key": 0,
  • "commissionAgencyRep_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "parent_CommissionAgencyRep_Key": 0,
  • "rate_Cluster": "string",
  • "split": 0.1,
  • "split_Max": 0.1,
  • "split_Min": 0.1,
  • "split_Priority": 0,
  • "split_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CommissionRateClusterAgencyRep

Lists all CommissionRateClusterAgencyRep

SecurityapiKeyAuth and bearerAuth
Request
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/commission-rate-cluster-agency-reps
Request samples 
Response samples 
No sample
Get CommissionRateClusterAgencyRep
Gets CommissionRateClusterAgencyRep


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
CommissionRateClusterAgencyRep_Key
required
integer <int32> 
CommissionRateClusterAgencyRep Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/commission-rate-cluster-agency-reps/{CommissionRateClusterAgencyRep_Key}
Request samples 
Response samples 
No sample
Update CommissionRateClusterAgencyRep
Updates a specific CommissionRateClusterAgencyRep.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
CommissionRateClusterAgencyRep_Key
required
integer <int32> 
CommissionRateClusterAgencyRep Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
commissionRateClusterAgencyRep_Key
required
integer <int32> 
Unique identifer for the Commission Rate Cluster Agency Rep Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
commissionAgencyRep_Key
integer or null <int32> 
Unique identifier for the CommissionAgencyRep


 
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.


 
parent_CommissionAgencyRep_Key
integer or null <int32> 
Parent key for the CommissionAgencyRep record this is a child of


 
rate_Cluster
string or null  <= 32 characters 
Unique identifer for the Rate Cluster


 
split
number or null <double> 
The amount or percentage of the split


 
split_Max
number or null <double> 
Maximum amount of the split


 
split_Min
number or null <double> 
Minimum amount of the split


 
split_Priority
integer or null <int32> 
Priority of the split


 
split_Type
string or null  <= 16 characters 
Determines if split is percent or flat amount


 
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/commission-rate-cluster-agency-reps/{CommissionRateClusterAgencyRep_Key}
Request samples 
{
  • "commissionRateClusterAgencyRep_Key": 0,
  • "commissionAgencyRep_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "parent_CommissionAgencyRep_Key": 0,
  • "rate_Cluster": "string",
  • "split": 0.1,
  • "split_Max": 0.1,
  • "split_Min": 0.1,
  • "split_Priority": 0,
  • "split_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CommissionRateClusterAgencyRep
Deletes an CommissionRateClusterAgencyRep


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
CommissionRateClusterAgencyRep_Key
required
integer <int32> 
CommissionRateClusterAgencyRep Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/commission-rate-cluster-agency-reps/{CommissionRateClusterAgencyRep_Key}
Request samples 
Create or Update Batch CommissionRateClusterAgencyRep
Create or Update multiple CommissionRateClusterAgencyRep at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


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


 
Request Body schema: 
required
 Array 
commissionRateClusterAgencyRep_Key
required
integer <int32> 
Unique identifer for the Commission Rate Cluster Agency Rep Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
commissionAgencyRep_Key
integer or null <int32> 
Unique identifier for the CommissionAgencyRep


 
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.


 
parent_CommissionAgencyRep_Key
integer or null <int32> 
Parent key for the CommissionAgencyRep record this is a child of


 
rate_Cluster
string or null  <= 32 characters 
Unique identifer for the Rate Cluster


 
split
number or null <double> 
The amount or percentage of the split


 
split_Max
number or null <double> 
Maximum amount of the split


 
split_Min
number or null <double> 
Minimum amount of the split


 
split_Priority
integer or null <int32> 
Priority of the split


 
split_Type
string or null  <= 16 characters 
Determines if split is percent or flat amount


 
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/commission-rate-cluster-agency-reps-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}