Upload Commission Rule

The upload Commission Rule module provides users with the convenient capability to create Commission Rules in bulk. Additionally, it also allows for the update of existing Commission Rules.

You can upload the commission rule using the steps mentioned below:

• Upload the latest CSV template.

• Copy the commission rule details into the template.

• Upload the template.

Uploading the template

• Go to the "Upload Commission Rule" module using the search menu.

• Click on the "Download Template" option.

Copying the information into the template

Once you’ve downloaded the template file, you can copy your data using any spreadsheet software. There are columns that you must complete and others that are optional. Mandatory fields are marked with a double asterisk (**) prefix.

Below are some points to be noted when entering the data into the template.

• The file must be a CSV (Comma-separated values) file. The name of your file must end with .csv.

• Make sure you don’t change any column headings from row 1 in the template; these are needed for the file to import correctly.

• All date fields will accept the MM-DD-YYYY format.

Upload Commission Rule Template Fields

Column	Data Type	Description
**HeaderIdentifierType	Text	This column specifies how commission rules are identified in the system. The following are the acceptable Header Identifier Types to be used when uploading commission rules: - "HeaderRefNumber" represents the creation of a new commission rule. - "Id" represents the updation of an existing commission rule.
**HeaderIdentifier	Numeric	If you are creating a new commission rule, enter the reference number here that acts as an identifier for the rule.
**CommissionRuleName	Text	Enter the name for the commission rule.
**CurrencyCode	Text	Enter the currency code in which the commission amount is denoted.
**Amount	Numeric	Enter the amount or percentage of commission payable.
**AmountType	Text	This field allows you to indicate how the commission rule is identified within the system. Use the keyword "Percentage" for giving a percentage type commission and "Flat" for giving a fixed amount.
PriceType	Text	This field allows you to specify the type of price the commission is calculated on.
CapAmount	Numeric	This field allows you to enter the maximum amount of commission that can be earned based on the commission rule.
CapAmountType	Text	This field allows you to indicate how the commission rule cap amount is identified within the system. Use the keyword "Percentage" for giving a percentage type commission and "Flat" for giving a fixed amount.
CapValueOfType	Text	Specify the base value used for calculating the cap amount, particularly when CapAmountType is set as a percentage.
Priority	Numeric	This field allows you to set the priority or precedence of the commission rule relative to other rules.
RevenueDeductionAmount	Numeric	This field allows you to enter the amount of revenue that is deducted before calculating commission. For example, if RevenueDeductionAmount is $200, then $200 will be subtracted from the total revenue before calculating the commission.
RevenueDeductionAmountType	Text	This field allows you to specify the type of revenue deduction amount, such as a fixed amount or a percentage.
CommissionOnPaidOnly	Text	Enter "Y" if the commission is to be calculated solely on transactions that have been fully paid.
ActiveFlag	Text	This field allows you to set the rule as "Active" or "Inactive". Enter "Y" to mark the rule as active and "N" to mark the rule as inactive.
ParentRule	Text	Enter the name of the parent rule for the commission rule.
ConditionTypeName	Text	This field allows you to specify the category or attribute that you want to apply the condition to.
OperatorText	Text	This field allows you to define the operation that will be performed on the chosen "ConditionTypeName".
Value	Numeric	This field allows you to define the value you want to match to trigger the rule.
DiscountMin	Numeric	If the commission rule is applied on a discount, this field represents the minimum discount (flat or percentage) that needs to be applied to a sale in order for a commission to be granted.
DiscountMax	Numeric	If the commission rule is applied on a discount, this field represents the maximum discount (flat or percentage) that needs to be applied to a sale in order for a commission to be granted.
DiscountPriceType	Text	This field allows you to specify the type of discount applied, such as a fixed amount or a percentage.
ImportError	Text	If there are any errors from an upload, they will be listed in this column.

Uploading the template

Once you have filled the CSV file with your data, you can follow the steps below to upload it into Xoro:

• Click Browse to select the saved CSV template file.

• After the file has been selected, click Upload to start importing.

• While the import is in progress, the summary of the progress will be displayed at the bottom of the screen with the progress bar. After the import has been completed, the result will be displayed with the message for success.

• Commission Rule will only get uploaded into the system if there are no errors in the file. If there are errors in the file, a pop-up will reflect the errors in the file. You can fix the errors in the original file, and upload it back into Xoro.