# Update Commission Updates a specific Commission. Endpoint: PUT /commission-transactions/{commTransKey}/commissions/{commKey} Version: v1 Security: apiKeyAuth, bearerAuth ## Header parameters: - `vbasoftware-database` (string, required) Target database ## Path parameters: - `commTransKey` (integer, required) CommissionTransaction Key - `commKey` (integer, required) Commission Key ## Request fields (application/json): - `commission_Key` (integer, required) Unique identifier for the Commission table Note: This field is marked as NOT NULL in the database and therefore required by the API. - `account_Key` (integer,null) Unique identifier for the Account - `adjustment_Amount` (number,null) Adjustment Amounts to this Commission - `adjustment_Amount_Received` (number,null) Adjustment Amounts Received to this Commission - `calculated_Commission_Amount` (number,null) Commission Amount after previous amounts - `calculated_Premium_Amount` (number,null) Premium Amount after previous amounts - `calculated_Premium_Amount_Received` (number,null) Premium Amount Received after previous amounts - `check_Batch` (integer,null) Check Batch for this Commission - `check_ID` (integer,null) Check for this Commission - `comm_Rate` (number,null) Decimal value that defines the base rate - `comm_Rate_Max` (number,null) Maximum the rate will be regardless of the calculation - `comm_Rate_Min` (number,null) Minimum the rate will be regardless of the calculation - `comm_Rate_Variable1` (number,null) First variable used in calculating the rate based on the type - `comm_Rate_Variable2` (number,null) Second variable used in calculating the rate based on the type - `comm_Rate_Variable3` (number,null) Third variable used in calculating the rate based on the type - `comm_Scale_From` (number,null) Beginning range of the amount used for scaling - `comm_Scale_Thru` (number,null) Ending range of the amount used for scaling - `comm_Scale_Timeframe` (string,null) Used to detemine what date to begin the range for scaling - `comm_Scale_Type` (string,null) Determines what amount the scale is based off of - `comm_Term_Range_From` (integer,null) Beginning range of a number of Days, Months, or Years - `comm_Term_Range_Thru` (integer,null) Ending range of a number of Days, Months, or Years - `comm_Term_Range_Type` (string,null) Determines if Term Range is Days, Months, or Years - `commissionAgencyRepRate_Key` (integer,null) Unique identifier for the CommissionAgencyRepRate table - `commissionAgencyRep_Key` (integer,null) - `commissionRate_Key` (integer,null) - `commissionTransaction_Key` (integer,null) Unique identifier for the CommissionTransaction table - `commission_Amount` (number,null) Full Commission Amount without adjusting for previous amounts - `commission_Basis` (string,null) Basis of the Commission - `commission_Cycle` (string,null) Cycle of the Commission - `commission_Date` (string,null) Date the Commission was calculated for - `dependent_Count` (integer,null) Number of Dependents used for this Commission - `division_ID` (string,null) Division for this Commission - `entry_Date` (string) Date record was first added to the system - `entry_User` (string,null) User that first added the record to the system - `group_ID` (string,null) Group for this Commission - `invoiceAdjustment_Key` (integer,null) Unique identifier for the InvoiceAdjustment table - `invoice_Key` (integer,null) Unique identifier for the PremInvoice table - `license_Number` (string,null) Not used - `license_State` (string,null) Not used - `license_Type` (string,null) Not used - `member_Count` (integer,null) Number of Members used for this Commission - `new_CommissionAgencyRep_Key` (integer,null) Not used - `original_CommissionAgencyRep_Key` (integer,null) Not used - `payor_ID` (string,null) Unique identifier for the Payor - `plan_ID` (string,null) Plan for this Commission - `premRate_Key` (integer,null) PremRate for this Commission - `premium_Amount` (number,null) Full Premium Amount without adjusting for previous amounts - `premium_Amount_Received` (number,null) Full Premium Amount Received without adjusting for previous amounts - `rep_Split` (number,null) The amount or percentage of the split - `rep_Split_Max` (number,null) Maximum amount of the split - `rep_Split_Min` (number,null) Minimum amount of the split - `rep_Split_Priority` (integer,null) Priority of the split - `rep_Split_Type` (string,null) Determines if split is percent or flat amount - `subscriber_Count` (integer,null) Number of Subscribers used for this Commission - `subscriber_ID` (string,null) Subscriber for this Commission - `update_Date` (string) Date the record was last updated in the system - `update_User` (string,null) User that last updated the record in the system ## Response 200 fields (text/plain): - `data` (object) - `data.commission_Key` (integer, required) Unique identifier for the Commission table Note: This field is marked as NOT NULL in the database and therefore required by the API. - `data.account_Key` (integer,null) Unique identifier for the Account - `data.adjustment_Amount` (number,null) Adjustment Amounts to this Commission - `data.adjustment_Amount_Received` (number,null) Adjustment Amounts Received to this Commission - `data.calculated_Commission_Amount` (number,null) Commission Amount after previous amounts - `data.calculated_Premium_Amount` (number,null) Premium Amount after previous amounts - `data.calculated_Premium_Amount_Received` (number,null) Premium Amount Received after previous amounts - `data.check_Batch` (integer,null) Check Batch for this Commission - `data.check_ID` (integer,null) Check for this Commission - `data.comm_Rate` (number,null) Decimal value that defines the base rate - `data.comm_Rate_Max` (number,null) Maximum the rate will be regardless of the calculation - `data.comm_Rate_Min` (number,null) Minimum the rate will be regardless of the calculation - `data.comm_Rate_Variable1` (number,null) First variable used in calculating the rate based on the type - `data.comm_Rate_Variable2` (number,null) Second variable used in calculating the rate based on the type - `data.comm_Rate_Variable3` (number,null) Third variable used in calculating the rate based on the type - `data.comm_Scale_From` (number,null) Beginning range of the amount used for scaling - `data.comm_Scale_Thru` (number,null) Ending range of the amount used for scaling - `data.comm_Scale_Timeframe` (string,null) Used to detemine what date to begin the range for scaling - `data.comm_Scale_Type` (string,null) Determines what amount the scale is based off of - `data.comm_Term_Range_From` (integer,null) Beginning range of a number of Days, Months, or Years - `data.comm_Term_Range_Thru` (integer,null) Ending range of a number of Days, Months, or Years - `data.comm_Term_Range_Type` (string,null) Determines if Term Range is Days, Months, or Years - `data.commissionAgencyRepRate_Key` (integer,null) Unique identifier for the CommissionAgencyRepRate table - `data.commissionAgencyRep_Key` (integer,null) - `data.commissionRate_Key` (integer,null) - `data.commissionTransaction_Key` (integer,null) Unique identifier for the CommissionTransaction table - `data.commission_Amount` (number,null) Full Commission Amount without adjusting for previous amounts - `data.commission_Basis` (string,null) Basis of the Commission - `data.commission_Cycle` (string,null) Cycle of the Commission - `data.commission_Date` (string,null) Date the Commission was calculated for - `data.dependent_Count` (integer,null) Number of Dependents used for this Commission - `data.division_ID` (string,null) Division for this Commission - `data.entry_Date` (string) Date record was first added to the system - `data.entry_User` (string,null) User that first added the record to the system - `data.group_ID` (string,null) Group for this Commission - `data.invoiceAdjustment_Key` (integer,null) Unique identifier for the InvoiceAdjustment table - `data.invoice_Key` (integer,null) Unique identifier for the PremInvoice table - `data.license_Number` (string,null) Not used - `data.license_State` (string,null) Not used - `data.license_Type` (string,null) Not used - `data.member_Count` (integer,null) Number of Members used for this Commission - `data.new_CommissionAgencyRep_Key` (integer,null) Not used - `data.original_CommissionAgencyRep_Key` (integer,null) Not used - `data.payor_ID` (string,null) Unique identifier for the Payor - `data.plan_ID` (string,null) Plan for this Commission - `data.premRate_Key` (integer,null) PremRate for this Commission - `data.premium_Amount` (number,null) Full Premium Amount without adjusting for previous amounts - `data.premium_Amount_Received` (number,null) Full Premium Amount Received without adjusting for previous amounts - `data.rep_Split` (number,null) The amount or percentage of the split - `data.rep_Split_Max` (number,null) Maximum amount of the split - `data.rep_Split_Min` (number,null) Minimum amount of the split - `data.rep_Split_Priority` (integer,null) Priority of the split - `data.rep_Split_Type` (string,null) Determines if split is percent or flat amount - `data.subscriber_Count` (integer,null) Number of Subscribers used for this Commission - `data.subscriber_ID` (string,null) Subscriber for this Commission - `data.update_Date` (string) Date the record was last updated in the system - `data.update_User` (string,null) User that last updated the record in the system - `error` (object) - `error.detail` (string,null) A human-readable explanation specific to this occurrence of the problem. - `error.instance` (string,null) A URI reference that identifies the specific occurrence of the problem.It may or may not yield further information if dereferenced. - `error.status` (integer) The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. - `error.title` (string,null) A short, human-readable summary of the problem type.It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization(e.g., using proactive content negotiation; see[RFC7231], Section 3.4). - `error.type` (string,null) A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank". - `debug` (object) - `debug.activityID` (string, required) ## Response 401 fields