Commission Transactions

Create CommissionTransaction

Creates a new CommissionTransaction

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
commissionTransaction_Key
required
integer <int32>
check_Batch
integer or null <int32>
comm_Date
string or null <date-time>
description
string or null <= 64 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
transaction_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-transactions
Request samples
{
  • "commissionTransaction_Key": 0,
  • "check_Batch": 0,
  • "comm_Date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "transaction_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CommissionTransaction

Lists all CommissionTransaction

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-transactions
Request samples
Response samples
No sample

Get CommissionTransaction

Gets CommissionTransaction

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

CommissionTransaction Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/commission-transactions/{commTransKey}
Request samples
Response samples
No sample

Update CommissionTransaction

Updates a specific CommissionTransaction.

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

CommissionTransaction Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
commissionTransaction_Key
required
integer <int32>
check_Batch
integer or null <int32>
comm_Date
string or null <date-time>
description
string or null <= 64 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
transaction_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-transactions/{commTransKey}
Request samples
{
  • "commissionTransaction_Key": 0,
  • "check_Batch": 0,
  • "comm_Date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "transaction_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete CommissionTransaction

Deletes an CommissionTransaction

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

CommissionTransaction Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/commission-transactions/{commTransKey}
Request samples

Create or Update Batch CommissionTransaction

Create or Update multiple CommissionTransaction 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
commissionTransaction_Key
required
integer <int32>
check_Batch
integer or null <int32>
comm_Date
string or null <date-time>
description
string or null <= 64 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
transaction_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-transactions-batch
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}