Commission Cycles

Create CommissionCycle

Creates a new CommissionCycle

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
commission_Cycle
required
string [ 1 .. 8 ] characters

Unique identifier for the Commission Cycle

cycle_Frequency
integer or null <int32>

Fequency of the Cycle

cycle_Type
string or null <= 1 characters

Type of the Cycle

description
string or null <= 64 characters

Description of the Commission Cycle

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

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-cycles
Request samples
{
  • "commission_Cycle": "string",
  • "cycle_Frequency": 0,
  • "cycle_Type": "s",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CommissionCycle

Lists all CommissionCycle

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-cycles
Request samples 
Response samples 
No sample
Get CommissionCycle
Gets CommissionCycle


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commCycle
required
string
Commission Cycle


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/commission-cycles/{commCycle}
Request samples 
Response samples 
No sample
Update CommissionCycle
Updates a specific CommissionCycle.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commCycle
required
string
Commission Cycle


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
commission_Cycle
required
string  [ 1 .. 8 ] characters 
Unique identifier for the Commission Cycle


 
cycle_Frequency
integer or null <int32> 
Fequency of the Cycle


 
cycle_Type
string or null  <= 1 characters 
Type of the Cycle


 
description
string or null  <= 64 characters 
Description of the Commission Cycle


 
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


 
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-cycles/{commCycle}
Request samples 
{
  • "commission_Cycle": "string",
  • "cycle_Frequency": 0,
  • "cycle_Type": "s",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CommissionCycle
Deletes an CommissionCycle


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commCycle
required
string
Commission Cycle


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/commission-cycles/{commCycle}
Request samples 
Create or Update Batch CommissionCycle
Create or Update multiple CommissionCycle 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 
commission_Cycle
required
string  [ 1 .. 8 ] characters 
Unique identifier for the Commission Cycle


 
cycle_Frequency
integer or null <int32> 
Fequency of the Cycle


 
cycle_Type
string or null  <= 1 characters 
Type of the Cycle


 
description
string or null  <= 64 characters 
Description of the Commission Cycle


 
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


 
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-cycles-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}