Commission Rep Accounts

Create CommissionRepAccount

Creates a new CommissionRepAccount

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
commRepKey
required
integer <int32>

CommissionRep Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
commissionRepAccount_Key
required
integer <int32>
account_Key
required
integer <int32>
commissionRep_Key
required
integer <int32>
effective_Date
string or null <date-time>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
term_Date
string or null <date-time>
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/commission-reps/{commRepKey}/commission-rep-accounts
Request samples
{
  • "commissionRepAccount_Key": 0,
  • "account_Key": 0,
  • "commissionRep_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CommissionRepAccount

Lists all CommissionRepAccount for the given commRepKey

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
commRepKey
required
integer <int32>

CommissionRep Key

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/commission-reps/{commRepKey}/commission-rep-accounts
Request samples 
Response samples 
No sample
Get CommissionRepAccount
Gets CommissionRepAccount


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commRepKey
required
integer <int32> 
CommissionRep Key


 
commRepAccountKey
required
integer <int32> 
CommissionRepAccount Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/commission-reps/{commRepKey}/commission-rep-accounts/{commRepAccountKey}
Request samples 
Response samples 
No sample
Update CommissionRepAccount
Updates a specific CommissionRepAccount.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commRepKey
required
integer <int32> 
CommissionRep Key


 
commRepAccountKey
required
integer <int32> 
CommissionRepAccount Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
commissionRepAccount_Key
required
integer <int32> 
 
account_Key
required
integer <int32> 
 
commissionRep_Key
required
integer <int32> 
 
effective_Date
string or null <date-time> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
term_Date
string or null <date-time> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/commission-reps/{commRepKey}/commission-rep-accounts/{commRepAccountKey}
Request samples 
{
  • "commissionRepAccount_Key": 0,
  • "account_Key": 0,
  • "commissionRep_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CommissionRepAccount
Deletes an CommissionRepAccount


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commRepKey
required
integer <int32> 
CommissionRep Key


 
commRepAccountKey
required
integer <int32> 
CommissionRepAccount Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/commission-reps/{commRepKey}/commission-rep-accounts/{commRepAccountKey}
Request samples 
Create or Update Batch CommissionRepAccount
Create or Update multiple CommissionRepAccount 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
commRepKey
required
integer <int32> 
CommissionRep Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
commissionRepAccount_Key
required
integer <int32> 
 
account_Key
required
integer <int32> 
 
commissionRep_Key
required
integer <int32> 
 
effective_Date
string or null <date-time> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
term_Date
string or null <date-time> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


put/commission-reps/{commRepKey}/commission-rep-accounts-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}