Commission Agency Reps

Create CommissionAgencyRep

Creates a new CommissionAgencyRep

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
commissionAgencyRep_Key
required
integer <int32>

Unique identifier for the CommissionAgencyRep table Note: This field is marked as NOT NULL in the database and therefore required by the API.

agent_Number
string or null <= 32 characters

Unique identifier for the Agent

cluster_Level
string or null <= 32 characters
commissionAgency_Key
required
integer <int32>

Unique identifier for the CommissionAgency table Note: This field is marked as NOT NULL in the database and therefore required by the API.

commissionRep_Key
required
integer <int32>

Unique identifier for the CommissionRep table Note: This field is marked as NOT NULL in the database and therefore required by the API.

eO_Coverage_Deductible
number or null <double>

Informational

eO_Coverage_End
string or null <date-time>

Informational

eO_Coverage_Level
string or null <= 128 characters

Informational

eO_Coverage_Name
string or null <= 128 characters

Informational

eO_Coverage_Start
string or null <date-time>

Informational

effective_Date
string or null <date-time>

Beginning date range the Agent represents the Agency

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

payee_ID
string or null <= 20 characters

Payee of the Agent

send_Check_To
string or null <= 2 characters

Determine if the Payee, Agnecy, or Agent is paid

term_Date
string or null <date-time>

Ending date range the Agent represents the Agency

update_Date
string <date-time>

Date 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-agency-reps
Request samples
{
  • "commissionAgencyRep_Key": 0,
  • "agent_Number": "string",
  • "cluster_Level": "string",
  • "commissionAgency_Key": 0,
  • "commissionRep_Key": 0,
  • "eO_Coverage_Deductible": 0.1,
  • "eO_Coverage_End": "2019-08-24T14:15:22Z",
  • "eO_Coverage_Level": "string",
  • "eO_Coverage_Name": "string",
  • "eO_Coverage_Start": "2019-08-24T14:15:22Z",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "payee_ID": "string",
  • "send_Check_To": "st",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Commission Agency Representatives

Lists all Commission Agency Representatives for the optional Commission Agency key, with pagination.

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
commAgencyKey
integer <int32>

CommissionAgency Key

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/commission-agency-reps
Request samples 
Response samples 
No sample
Get CommissionAgencyRep
Gets CommissionAgencyRep


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commAgencyRepKey
required
integer <int32> 
CommissionAgencyRep Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/commission-agency-reps/{commAgencyRepKey}
Request samples 
Response samples 
No sample
Update CommissionAgencyRep
Updates a specific CommissionAgencyRep.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commAgencyRepKey
required
integer <int32> 
CommissionAgencyRep Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
commissionAgencyRep_Key
required
integer <int32> 
Unique identifier for the CommissionAgencyRep table Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
agent_Number
string or null  <= 32 characters 
Unique identifier for the Agent


 
cluster_Level
string or null  <= 32 characters 
 
commissionAgency_Key
required
integer <int32> 
Unique identifier for the CommissionAgency table Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
commissionRep_Key
required
integer <int32> 
Unique identifier for the CommissionRep table Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
eO_Coverage_Deductible
number or null <double> 
Informational


 
eO_Coverage_End
string or null <date-time> 
Informational


 
eO_Coverage_Level
string or null  <= 128 characters 
Informational


 
eO_Coverage_Name
string or null  <= 128 characters 
Informational


 
eO_Coverage_Start
string or null <date-time> 
Informational


 
effective_Date
string or null <date-time> 
Beginning date range the Agent represents the Agency


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
payee_ID
string or null  <= 20 characters 
Payee of the Agent


 
send_Check_To
string or null  <= 2 characters 
Determine if the Payee, Agnecy, or Agent is paid


 
term_Date
string or null <date-time> 
Ending date range the Agent represents the Agency


 
update_Date
string <date-time> 
Date 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-agency-reps/{commAgencyRepKey}
Request samples 
{
  • "commissionAgencyRep_Key": 0,
  • "agent_Number": "string",
  • "cluster_Level": "string",
  • "commissionAgency_Key": 0,
  • "commissionRep_Key": 0,
  • "eO_Coverage_Deductible": 0.1,
  • "eO_Coverage_End": "2019-08-24T14:15:22Z",
  • "eO_Coverage_Level": "string",
  • "eO_Coverage_Name": "string",
  • "eO_Coverage_Start": "2019-08-24T14:15:22Z",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "payee_ID": "string",
  • "send_Check_To": "st",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CommissionAgencyRep
Deletes an CommissionAgencyRep


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commAgencyRepKey
required
integer <int32> 
CommissionAgencyRep Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/commission-agency-reps/{commAgencyRepKey}
Request samples 
Create or Update Batch CommissionAgencyRep
Create or Update multiple CommissionAgencyRep 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 
commissionAgencyRep_Key
required
integer <int32> 
Unique identifier for the CommissionAgencyRep table Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
agent_Number
string or null  <= 32 characters 
Unique identifier for the Agent


 
cluster_Level
string or null  <= 32 characters 
 
commissionAgency_Key
required
integer <int32> 
Unique identifier for the CommissionAgency table Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
commissionRep_Key
required
integer <int32> 
Unique identifier for the CommissionRep table Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
eO_Coverage_Deductible
number or null <double> 
Informational


 
eO_Coverage_End
string or null <date-time> 
Informational


 
eO_Coverage_Level
string or null  <= 128 characters 
Informational


 
eO_Coverage_Name
string or null  <= 128 characters 
Informational


 
eO_Coverage_Start
string or null <date-time> 
Informational


 
effective_Date
string or null <date-time> 
Beginning date range the Agent represents the Agency


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
payee_ID
string or null  <= 20 characters 
Payee of the Agent


 
send_Check_To
string or null  <= 2 characters 
Determine if the Payee, Agnecy, or Agent is paid


 
term_Date
string or null <date-time> 
Ending date range the Agent represents the Agency


 
update_Date
string <date-time> 
Date 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-agency-reps-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}