As a warning, using hooks is an advanced feature. Only an admin with development experience should attempt modifications.

Hook Details

HookService.Commissions.DataSource.GetOrderNumberFromReference.Override

Description: If you do not use orderNumber in the GetSources for commission to display correctly.

Default Use: Gets the OrderNumber from the Order

Example: Commissions don’t go off Orders, they go off of payments, so this hook changes the display to Payment Number

Compatible with: HookService.Commissions.DataSource.OrderReferenceMap.Override and HookService.Commissions.DataSource.ReadInvoices.Override

HookService.Commissions.DataSource.OrderReferenceMap.Override

Description: If you do not use orderNumber in the GetSources for commission to display correctly.

Default Use: Displays the OrderNumber

Example: Commission don’t go off Orders but payments so this hook changes the display to Payment Number

Compatible with: HookService.Commissions.DataSource.GetOrderNumberFromReference.Override and HookService.Commissions.DataSource.ReadInvoices.Override

HookService.Commissions.DataSource.ReadInvoices.Override

Description: Change how Orders are read for commissions.

Default Use: Reads the ORD_Order Table looking at TotalQV, TotalCV, and TotalBonus

Example: Create a volume bucket for commission that does not come from Orders.

Compatible with: HookService.Commissions.DataSource.GetOrderNumberFromReference.Override and HookService.Commissions.DataSource.OrderReferenceMap.Override

HookService.Commissions.DataSource.ReadAssociates.Override

Description: Change how Associates are read for commissions.

Default Use: Reads CRM_Distributors, CRM_Address

HookService.Commissions.DataSource.ReadCoding.Override

Description: Change how Coding Tree is read for commissions.

Default Use: Reads CRM_CodingTree

HookService.Commissions.DataSource.ReadHitCountPeriods.Override

Description: Change how the system check what people have done on past commission periods.

Default Use: Reads CRM_CommissionAssociateValues_COV

HookService.Commissions.DataSource.ReadPendingVolume.Override

Description: Change how AutoShip Volume is read for commissions.

Default Use: Read CRM_AutoShip

HookService.Commissions.DataSource.ReadOverrides.Override

Description: Change how Commission Overrides are read for commissions.

Default Use: Reads CRM_Commission_Overrides

HookService.Commissions.Adjustments.AfterDelete.Override

HookService.Commissions.Adjustments.AfterSave.Override

HookService.Commissions.Adjustments.GetCustomData.Override

HookService.Commissions.Adjustments.GetCustomFields.Override

HookService.Commissions.Adjustments.ValidateCustomData.Override

HookService.Commissions.GetCompanyCheckingInformation.Override

Description: Used to set up Company Custom Check layout.

HookService.Commissions.DailyRun.Override

Description: Hook that is run every day.

Default Use: Runs all AutoShips and Retries AutoShip Orders.

Example: See this video for an example of how this hook is used. Understanding the Daily Hook

HookService.Commissions.LoadTemplates.Override

Description: Loads Client Templates if templates are in client DLL not in XML.

Default Use: Pulls in Example Clients Templates.

HookService.Commissions.GetClientTrees.Override

Description: Gets the Trees the client uses.

Default Use: Uses the UI.

HookService.Commissions.ValidateEnrollerBirthDate.Override

Description: Hook to change how old you must be to enroll.

Default Use: You must be 18 years or older.

HookService.Commissions.ShouldChargeAutoship.Override

Description: Hook to determine When an associate’s autoship should create an order.

Default Use: When autoship NextProcessDate is less then or equal to today.

Example: Change so autoships don’t get created on last day of the period. See this video for an example of how this hook is used, Understanding Hooks for Autoship Orders

Compatible with: HookService.Autoships. GetAutoshipBackupPayment.Override

HookService.Commissions.GetPlaceToAssociates.Override

Description: Get all associates that the sponsor can place someone under.

Example: Allow the sponsor to only place people on their first two levels.

Compatible with: HookService.Commissions. CanPlaceAssociate.Override and HookService.Associates.Enrollment. GetPlacementExperationDate.Override

HookService.Commissions.GetStatusChangeOptions.Override

Description: Get rules that you want to affect associates when their status changes.

Default Use: Uses the UI.

Example: Use the UI this hook was before the UI was around.

HookService.Commissions.GetPriceGroup.Override

Description: Takes an associate and associate type and return a price group for inventory pricing.

Default Use: Uses the UI; Returns AssociateTypes.

Example: Create different pricing by rank or special pricing for individuals.

Compatible with: HookService.Commissions.GetAssociateType.Override

HookService.Commissions.GetAssociateType.Override

Description: Takes base associate type and return derived types

Default Use: Use the UI return the base type.

Example: Change associate type temporarily for some reason.

Compatible with: HookService.Commissions.GetPriceGroup.Override

HookService.Commissions.CanPlaceAssociate.Override

Description: Gets all associates that I can moved in a given tree.

Example: You can only move someone in the first 15 days of their enrollment.

Compatible with: HookService.Commissions.GetPlaceToAssociates.Override and HookService.Associates.Enrollment.GetPlacementExperationDate.Override

HookService.Commissions.CustomPlaceHandler.Override

HookService.Commissions.GetCompressLeg.Override

HookService.Commissions.LogRealtimeRankAdvance.Override

Description: Turns on real time rank advancement so that.

Default Use: Adds record to CRM_CommissionRealtimeRankAdvancement so we know when they hit that rank throughout the period..

HookService.Commissions.ProcessQueueItems.Override

Description: Getting all the items queued for stats to update.

Default Use: Gets all items in UpdateAssociateQueue that have not been processed.

Example: Add an associate to the queue sometimes. See this video for an example of how this hook is used, Understanding how the Updating Stats Process Functions

HookService.Commissions.GetAssociateStats.Override

Description: Retrieves an associate’s stats for a period.

Default Use: If it is an open period it will get from CRM_Stats, CRM_Stats_StatValues, CRM_Stats_RankOptions. If period is already committed, gets from CRM_CommissionnAssociatesValues tables.

Example: Add a stat that you don’t want to be a part of the commission engine calculation. See this video for an example of how this hook is used,Understanding the Process to get Associate Stats

Compatible with: HookService.Commissions.GetAssociatesStats.Override

HookService.Commissions.GetAssociatesStats.Override

Description: Gets multiple associate stats for a period. Used for state machine.

Default Use: If it is an open period it will get from CRM_Stats, CRM_Stats_StatValues, CRM_Stats_RankOptions. If period is already committed gets from CRM_CommissionnAssociatesValues tables.

Compatible with: HookService.Commissions.GetAssociateStats.Override

HookService.Commissions.UpdateAssociateStats.Override

Description: Add Associates to the Stats Queue.

Default Use: Adds a record to UpdateAssociatesQueue and adds a reason.

Example: See this video for an example of how this hook is used, Understanding how the Updating Stats Process Functions

HookService.Commissions.PofileThreadCount.Override

Description: There is a variable for this. It says how many threads the commission can create.

Default Use: Use the Setting if no setting uses 0.

Example: Change how many threads the commissions uses at different times.

HookService.Commissions.GetSplitPayments.Override

Description: Allows a client to split commission between multiple accounts.

Example: When ID 2 gets money give 50% to ID 3 and 50% to ID 4.

HookService.Commissions.GetDefaultPlacement.Override

Description: Determines how Associates are placed.

Default Use: Uses the UI.

Example: Allows for Holding Tanks and things not supported by the UI.

HookService.Commissions.GetMatrixDepth.Override

HookService.Commissions.GetRetailAssociateTypes.Override

HookService.Commissions.GetCodingSettings.Override

Description: Sets client coding rules, like how high of a rank you sponsor must be to be coded to.

Default Use: Codes everyone to their sponsor.

Example: Only code if the person his rank 40..

HookService.Commissions.GetDefaultLegs.Override

Description: Setting to say what legs are available and what the name of them are. Left, right, Middle.

Default Use: Use the UI.

Example: If UI can’t do what you want.

HookService.Commissions.RequireFIN.Override

Description: Validation for Tax Identification Number is required.

Default Use: Looks at ActiveCountries table and countries.

HookService.Commissions.MatchesRuleForVisualTree.Override

Description: Enables The Visual Tree in the back office to change associats color if this returns true for them.

Example: If an associate has a certain KPI/Stat, then they have a different color in visual tree.

HookService.Commissions.CanViewDownlineNode.Override

Description: A way to block an associate from seeing certain associates in their downline.

Default Use: Shows everyone in your downline.

HookService.Commissions.GetAvailableTreeRules.Override

Description: Order of how tree will build (left then Right).

Default Use: Use the UI.

HookService.Commissions.GetReEntryRules.Override

Description: How someone is reentered into a tree. So they are in the tree twice or more with different tree indexes.

HookService.Commissions.CanClawBackOrder.Override

Description: Does that system do clawbacks.

Default Use: Has a setting to turn on and clawback all orders is default.

Example: If you wanted to do clawback for some people or some types but not all.

HookService.API.V1.GetCommissionBonusDetailsAfter.Override

Description: Hook for displaying Commission Details to Web Office.

Default Use: Returns default commission objects.

Example: Add detail custom to client or cycles for binary or more details then provided.

Compatible with: HookService.API.V1.GetCommissionBonusDetails.Override, HookService.API.V1.GetCommissionDetails.Override, HookService.API.V1.GetBonusDetailData.Override, HookService.Associates.GetCommissionChecks.Override, and HookService.Associates.GetCommissionChecks.Override

HookService.API.V1.GetCommissionBonusDetails.Override

Description: Hook for displaying Commission Details to Web Office.

Default Use: Returns default commission objects.

Example: Add detail custom to client or cycles for binary or more details then provided.

Compatible with: HookService.API.V1.GetCommissionBonusDetailsAfter.Override, HookService.API.V1.GetCommissionDetails.Override, HookService.API.V1.GetBonusDetailData.Override, HookService.Associates.GetCommissionChecks.Override, and HookService.Associates.GetCommissionChecks.Override

HookService.API.V1.GetCommissionDetails.Override

Description: Display summarized Commission Detail.

Default Use: Returns default commission objects.

Example: Add detail custom to client or cycles for binary or more details then provided.

Compatible with: HookService.API.V1.GetCommissionBonusDetailsAfter.Override, HookService.API.V1.GetCommissionBonusDetails.Override, HookService.API.V1.GetBonusDetailData.Override, HookService.Associates.GetCommissionChecks.Override, and HookService.Associates.GetCommissionChecks.Override

HookService.API.V1.GetBonusDetailData.Override

Description: Hook for displaying Commission Details to Web Office.

Default Use: Returns default commission objects.

Example: Add detail custom to client or cycles for binary or more details then provided.

Compatible with: HookService.API.V1.GetCommissionBonusDetailsAfter.Override, HookService.API.V1.GetCommissionBonusDetails.Override,HookService.API.V1.GetCommissionDetails.Override, HookService.Associates.GetCommissionChecks.Override, and HookService.Associates.GetCommissionChecks.Override

HookService.API.V1.GetCustomWebsiteInfo.Override

Description: Hook to get associate’s Web site.

Default Use: Check on associateID and Web alias.

Example:Allows customer to check on username or email.

HookService.API.V2.GetUserNameByAlternateId.Override

Description: Hook to get Associate UserName.

Default Use: Uses the userName.

Example:Allows for Email address or other way to log in.

HookService.Autoships.GetAutoships.Override

Description: Way to retrieve Autoships.

Default Use: Gets all AutoShips but yearly renewals.

Example:Allows client to return all or certain types of Autoships.

HookService.Autoships.GetAutoshipBackupPayment.Override

Description: Way for the autoship system to find a payment method is there is not one on the AutoShip.

Default Use: Gets all on the associates and picks the last one in.

Example:Allows for a different order.

HookService.Autoships.CancelAutoship.Override

Description: Hook for cancel autoship.

Default Use: Deletes Autoship and Notifies system it was deleted.

HookService.Autoships.ShouldRetryAutoshipOrder.Override

Description: Hook to tell the system how often and how long you should keep trying to charge an order from an autoship.

Default Use: The Day after and the next two days from that.

Example: Try every 5 days for the next two months. See this video for an example of how this hook is used, Understanding Hooks for Autoship Orders

HookService.Associates.Enrollment.GetNewBackOfficeId.Override

Description: Hook to set a custom back office ID.

Default Use: Use UI.

Example: 9 digit random BackOfficeID.

HookService.Associates.Enrollment.WriteApplication.Override

Description: Hook around the creation of an associate.

Default Use: Creates the Associate, places them, creates autoship, places order, creates webalias, creates login.

Example: A LOT can be done here do some thing before big process or after is the best. Change object coming in or do something after.

HookService.Associates.Enrollment.ValidateApplication.Override

Description: Validation for creating someone.

Default Use: Check a lot of standard things to make sure it is all filled out.

Example: Add or remove validation from default.

HookService.Associates.Enrollment.GetPlacementExperationDate.Override

Description: Hook for a sponsor to know how long they have until they must place some one.

Default Use: NOW.

Example: Tell sponsor they have 10 more days to place this person.

Compatible with: HookService.Commissions.GetPlaceToAssociates.Override, and HookService.Commissions.CanPlaceAssociate.Override

HookService.Associates.Enrollment.IsEmailAvailable.Override

Description: Hook to see if Email is still available.

Default Use: Check to see if email is in use.

HookService.Associates.Enrollment.IsTaxIdAvailable.Override

Description: Hook to see if Tax ID is still available.

Default Use: Check to see if tax id is in use.

HookService.Associates.Enrollment.UpdateAssociateBaseType.Override

Description: Hook for when you are changing associate base type.

Default Use: Validate if associate is in the system and is base type of 2.

Example: Allows client to change what associate types can be changed.

HookService.Associates.Enrollment.GetShouldSendNotification.Override

Description: Hook to enable or disable notifications.

Default Use: Notify for all.

Example: Only notify for some people or some groups.

HookService.Associates.GetSecondaryTitle.Override

Description: Shows on the Detail Page.

HookService.Associates.GetAssociateServiceAutoshipSettings.Override

Description: Hook to enable Service to auto create an autoship.

Default Use: Errors.

Example: Set default shipping method and allows you to change what item gets set on autoship.

HookService.Associates.OnNotificationEvent.Override

Description: Hook around the Log Notification Event that send Emails through the Corporate Office.

HookService.Associates.UpdateAssociate.Override

Description: Hook around editing an associate record.

Default Use: Validates, Updates record, and notifies the system of the change. DO NOT REMOVE * from Tax field.

HookService.Associates.GetTreeLabels.Override

Description: Hook around the Disco Associate Tree Labels and colors.

Default Use: Sets active, nonactive, retail and their colors.

Compatible with: HookService.Associates.GetAssociateTreeLabel.Override

HookService.Associates.GetAssociateTreeLabel.Override

Description: Hook around the Disco Associate Tree Labels and colors.

Default Use: Sets active, nonactive, retail.

Compatible with: HookService.Associates.GetTreeLabels.Override

HookService.Associates.GetCommissionChecks.Override

Description: Ablitiy to change how the commission summary looks.

Default Use: Defualt commission results.

Compatible with: HookService.API.V1.GetCommissionBonusDetails.Override, HookService.API.V1.GetCommissionDetails.Override, HookService.API.V1.GetBonusDetailData.Override, and HookService.Associates.GetCommissionChecks.Override

HookService.Associates.GetCommissionCheckDetails.Override

Description: Change how the commission details looks.

Default Use: Defualt commission results.

Compatible with: HookService.API.V1.GetCommissionBonusDetails.Override, HookService.API.V1.GetCommissionDetails.Override, HookService.API.V1.GetBonusDetailData.Override, and HookService.Associates.GetCommissionChecks.Override