Commission Rate Cluster Rates

Create CommissionRateClusterRate

Creates a new CommissionRateClusterRate

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
rateCluster
required
string

Rate Cluster

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
rate_Cluster
required
string [ 1 .. 32 ] characters
commissionRate_Key
required
integer <int32>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/commission-rate-clusters/{rateCluster}/commission-rates
Request samples
{
  • "rate_Cluster": "string",
  • "commissionRate_Key": 0,
  • "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 CommissionRateClusterRate

Lists all CommissionRateClusterRate for the given rateCluster

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
rateCluster
required
string

Rate Cluster

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-rate-clusters/{rateCluster}/commission-rates
Request samples
Response samples
No sample

Get CommissionRateClusterRate

Gets CommissionRateClusterRate

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
rateCluster
required
string

Rate Cluster

commRateKey
required
integer <int32>

CommissionRate Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/commission-rate-clusters/{rateCluster}/commission-rates/{commRateKey}
Request samples
Response samples
No sample

Update CommissionRateClusterRate

Updates a specific CommissionRateClusterRate.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
rateCluster
required
string

Rate Cluster

commRateKey
required
integer <int32>

CommissionRate Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
rate_Cluster
required
string [ 1 .. 32 ] characters
commissionRate_Key
required
integer <int32>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

put/commission-rate-clusters/{rateCluster}/commission-rates/{commRateKey}
Request samples
{
  • "rate_Cluster": "string",
  • "commissionRate_Key": 0,
  • "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 CommissionRateClusterRate

Deletes an CommissionRateClusterRate

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
rateCluster
required
string

Rate Cluster

commRateKey
required
integer <int32>

CommissionRate Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/commission-rate-clusters/{rateCluster}/commission-rates/{commRateKey}
Request samples

Create or Update Batch CommissionRateClusterRate

Create or Update multiple CommissionRateClusterRate 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
rateCluster
required
string

Rate Cluster

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
Array
rate_Cluster
required
string [ 1 .. 32 ] characters
commissionRate_Key
required
integer <int32>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
207

Success

401

Unauthorized

put/commission-rate-clusters/{rateCluster}/commission-rates-batch
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}