Commission Activity

Create CommissionActivity

Creates a new CommissionActivity

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
commissionActivity_Key
required
integer <int32>

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

end_Date
string or null <date-time>

Date the activity was completed

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

machine_ID
string or null <= 128 characters

Unique identifier for the Machine

start_Date
string or null <date-time>

Date the activity began

undo_Date
string or null <date-time>

Date activity was undone

undo_User
string or null <= 20 characters

User who undid the activity

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

user_ID
string or null <= 16 characters

Unique identifier for the User

Responses
200

Success

401

Unauthorized

post/commission-activities
Request samples
{
  • "commissionActivity_Key": 0,
  • "end_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "machine_ID": "string",
  • "start_Date": "2019-08-24T14:15:22Z",
  • "undo_Date": "2019-08-24T14:15:22Z",
  • "undo_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "user_ID": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CommissionActivity

Lists all CommissionActivity

SecurityapiKeyAuth and bearerAuth
Request
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-activities
Request samples 
Response samples 
No sample
Get CommissionActivity
Gets CommissionActivity


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commActivityKey
required
integer <int32> 
CommissionActivity Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/commission-activities/{commActivityKey}
Request samples 
Response samples 
No sample
Update CommissionActivity
Updates a specific CommissionActivity.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commActivityKey
required
integer <int32> 
CommissionActivity Key


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
end_Date
string or null <date-time> 
Date the activity was completed


 
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


 
machine_ID
string or null  <= 128 characters 
Unique identifier for the Machine


 
start_Date
string or null <date-time> 
Date the activity began


 
undo_Date
string or null <date-time> 
Date activity was undone


 
undo_User
string or null  <= 20 characters 
User who undid the activity


 
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


 
user_ID
string or null  <= 16 characters 
Unique identifier for the User


 
Responses 
200
Success


401
Unauthorized


put/commission-activities/{commActivityKey}
Request samples 
{
  • "commissionActivity_Key": 0,
  • "end_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "machine_ID": "string",
  • "start_Date": "2019-08-24T14:15:22Z",
  • "undo_Date": "2019-08-24T14:15:22Z",
  • "undo_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "user_ID": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CommissionActivity
Deletes an CommissionActivity


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commActivityKey
required
integer <int32> 
CommissionActivity Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


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


 
end_Date
string or null <date-time> 
Date the activity was completed


 
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


 
machine_ID
string or null  <= 128 characters 
Unique identifier for the Machine


 
start_Date
string or null <date-time> 
Date the activity began


 
undo_Date
string or null <date-time> 
Date activity was undone


 
undo_User
string or null  <= 20 characters 
User who undid the activity


 
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


 
user_ID
string or null  <= 16 characters 
Unique identifier for the User


 
Responses 
207
Success


401
Unauthorized


put/commission-activities-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
Undo CommissionActivity Advanced API 
Undo Commissions by Commission Activity


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commActivityKey
required
integer <int32> 
CommissionActivity Key


 
query Parameters
undoUser
string
Undo User


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


post/commission-activities-undo/{commActivityKey}
Request samples 
Response samples 
No sample
Undo CommissionActivity by Rep or Group Advanced API 
Undo Commissions by Commission Activity based on the passed in optional parameters of commAgencyRep or groupId.  Group undo takes priory if passed in with a Rep Key.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commActivityKey
required
integer <int32> 
CommissionActivity Key


 
query Parameters
undoUser
string
Undo User


 
groupId
string
Group ID


 
commAgencyRepKey
integer <int32> 
Agency Rep Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


post/commission-activities-undo-by-rep/{commActivityKey}
Request samples 
Response samples 
No sample