Skip to content

Create CommissionAdjustment

Request

Creates a new CommissionAdjustment

Security
apiKeyAuth and bearerAuth
Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
commissionAdjustment_Keyinteger, (int32)required

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

account_Keyinteger or null, (int32)

Account for this Commission Adjustment

adjustment_Amountnumber or null, (double)

Amount of the adjustment

adjustment_Datestring or null, (date-time)

Date of the adjustment

check_Batchinteger or null, (int32)

Check Batch for this Commission Adjustment

check_IDinteger or null, (int32)

Check for this Commission Adjustment

commissionAgencyRepRate_Keyinteger or null, (int32)

Unique identifier for the CommissionAgencyRepRate table

commissionTransaction_Keyinteger or null, (int32)

Unique identifier for the CommissionTransaction table

commission_Adjustment_Reasonstring or null, <= 8 characters

Reason for the Commission Adjustment

commission_Adjustment_Typestring or null, <= 8 characters

Type of the Commission Adjustment

entry_Datestring, (date-time)

Date record was first added to the system

entry_Userstring or null, <= 20 characters

User that first added the record to the system

payor_IDstring or null, <= 20 characters

Payor for this Commission Adjustment

pre_Payment_Adjustmentbooleanrequired

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

update_Datestring, (date-time)

Date the record was last updated in the system

update_Userstring or null, <= 20 characters

User that last updated the record in the system

commissionAgencyRep_Keyinteger or null, (int32)
commissionRate_Keyinteger or null, (int32)
curl -i -X POST \
  https://vbapi.vbasoftware.com/vbasoftware/commission-adjustments \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "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
  }'

Responses

Success

Bodyapplication/json
dataobject
errorobject
debugobject
Response
{
  "data": { … },
  "error": { … },
  "debug": { … }
}