Commission Adjustments

Create CommissionAdjustment

Creates a new CommissionAdjustment

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
commissionAdjustment_Key
required
integer <int32>

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

account_Key
integer or null <int32>

Account for this Commission Adjustment

adjustment_Amount
number or null <double>

Amount of the adjustment

adjustment_Date
string or null <date-time>

Date of the adjustment

check_Batch
integer or null <int32>

Check Batch for this Commission Adjustment

check_ID
integer or null <int32>

Check for this Commission Adjustment

commissionAgencyRepRate_Key
integer or null <int32>

Unique identifier for the CommissionAgencyRepRate table

commissionTransaction_Key
integer or null <int32>

Unique identifier for the CommissionTransaction table

commission_Adjustment_Reason
string or null <= 8 characters

Reason for the Commission Adjustment

commission_Adjustment_Type
string or null <= 8 characters

Type of the Commission Adjustment

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

payor_ID
string or null <= 20 characters

Payor for this Commission Adjustment

pre_Payment_Adjustment
required
boolean

TBD Note: This field is marked as NOT NULL in the database and therefore required by the API.

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

commissionAgencyRep_Key
integer or null <int32>
commissionRate_Key
integer or null <int32>
Responses
200

Success

401

Unauthorized

post/commission-adjustments
Request samples
{
  • "commissionAdjustment_Key": 0,
  • "account_Key": 0,
  • "adjustment_Amount": 0.1,
  • "adjustment_Date": "2019-08-24T14:15:22Z",
  • "check_Batch": 0,
  • "check_ID": 0,
  • "commissionAgencyRepRate_Key": 0,
  • "commissionTransaction_Key": 0,
  • "commission_Adjustment_Reason": "string",
  • "commission_Adjustment_Type": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "payor_ID": "string",
  • "pre_Payment_Adjustment": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "commissionAgencyRep_Key": 0,
  • "commissionRate_Key": 0
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CommissionAdjustment

Lists all CommissionAdjustment

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-adjustments
Request samples 
Response samples 
No sample
Get CommissionAdjustment
Gets CommissionAdjustment


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commAdjKey
required
integer <int32> 
CommissionAdjustment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/commission-adjustments/{commAdjKey}
Request samples 
Response samples 
No sample
Update CommissionAdjustment
Updates a specific CommissionAdjustment.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commAdjKey
required
integer <int32> 
CommissionAdjustment Key


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
account_Key
integer or null <int32> 
Account for this Commission Adjustment


 
adjustment_Amount
number or null <double> 
Amount of the adjustment


 
adjustment_Date
string or null <date-time> 
Date of the adjustment


 
check_Batch
integer or null <int32> 
Check Batch for this Commission Adjustment


 
check_ID
integer or null <int32> 
Check for this Commission Adjustment


 
commissionAgencyRepRate_Key
integer or null <int32> 
Unique identifier for the CommissionAgencyRepRate table


 
commissionTransaction_Key
integer or null <int32> 
Unique identifier for the CommissionTransaction table


 
commission_Adjustment_Reason
string or null  <= 8 characters 
Reason for the Commission Adjustment


 
commission_Adjustment_Type
string or null  <= 8 characters 
Type of the Commission Adjustment


 
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


 
payor_ID
string or null  <= 20 characters 
Payor for this Commission Adjustment


 
pre_Payment_Adjustment
required
boolean
TBD Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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


 
commissionAgencyRep_Key
integer or null <int32> 
 
commissionRate_Key
integer or null <int32> 
 
Responses 
200
Success


401
Unauthorized


put/commission-adjustments/{commAdjKey}
Request samples 
{
  • "commissionAdjustment_Key": 0,
  • "account_Key": 0,
  • "adjustment_Amount": 0.1,
  • "adjustment_Date": "2019-08-24T14:15:22Z",
  • "check_Batch": 0,
  • "check_ID": 0,
  • "commissionAgencyRepRate_Key": 0,
  • "commissionTransaction_Key": 0,
  • "commission_Adjustment_Reason": "string",
  • "commission_Adjustment_Type": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "payor_ID": "string",
  • "pre_Payment_Adjustment": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "commissionAgencyRep_Key": 0,
  • "commissionRate_Key": 0
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CommissionAdjustment
Deletes an CommissionAdjustment


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commAdjKey
required
integer <int32> 
CommissionAdjustment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/commission-adjustments/{commAdjKey}
Request samples 
Create or Update Batch CommissionAdjustment
Create or Update multiple CommissionAdjustment 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 
commissionAdjustment_Key
required
integer <int32> 
Unique identifier for the Commission Activity Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
account_Key
integer or null <int32> 
Account for this Commission Adjustment


 
adjustment_Amount
number or null <double> 
Amount of the adjustment


 
adjustment_Date
string or null <date-time> 
Date of the adjustment


 
check_Batch
integer or null <int32> 
Check Batch for this Commission Adjustment


 
check_ID
integer or null <int32> 
Check for this Commission Adjustment


 
commissionAgencyRepRate_Key
integer or null <int32> 
Unique identifier for the CommissionAgencyRepRate table


 
commissionTransaction_Key
integer or null <int32> 
Unique identifier for the CommissionTransaction table


 
commission_Adjustment_Reason
string or null  <= 8 characters 
Reason for the Commission Adjustment


 
commission_Adjustment_Type
string or null  <= 8 characters 
Type of the Commission Adjustment


 
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


 
payor_ID
string or null  <= 20 characters 
Payor for this Commission Adjustment


 
pre_Payment_Adjustment
required
boolean
TBD Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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


 
commissionAgencyRep_Key
integer or null <int32> 
 
commissionRate_Key
integer or null <int32> 
 
Responses 
207
Success


401
Unauthorized


put/commission-adjustments-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}