ChargeRulesSetup

This component runs the Charge Rules (CHR) function.

It allows the user to create, amend and delete as well as query charge rules.

Note: This Help contains hyperlinks that are enabled when the Help is accessed within the application. However, if you have accessed this Help via the SunSystems Web portal, hyperlinks are not enabled.

Methods

CreateOrAmend: Driver type: SASI; Use this method to create or amend one or more charge rules. A charge rule is created if it does not exist, and amended if it does.
Delete: Driver type: SASI; Use this method to delete one or more charge rules from SunSystems.
Query: Driver type: Export; Use this method to extract charge rule data.

Mandatory fields

When creating a charge rule, the following must be supplied:

Charge Rule Code payload element <ChargeRuleCode>
Source payload element <SourceValueLabel.ShortHeading>
Target payload element <TargetValueLabel.ShortHeading>
Charge Factor payload element <ChargeFactorValueLabel>
Description or Short Heading payload element <description> or <ShortHeading>
Apportioned Ledger Interface Definition payload element <ApportionedLedgerInterfaceDefinition>
Suspended Ledger Interface Definition payload element <SuspendedLedgerInterfaceDefinition>

Note: At runtime the component validates the payload contents to ensure that the values supplied are correct. Various combinations of values may require other elements in the payload to be specified before the payload can be processed successfully.

Related data

None.