The create_discount_rule_m API creates a discount rule.
Note: The previously existing input and/or output fields <client_item_id>, <client_item_id_out> and/or <filter_client_item_id> were removed from this API call in Release 47.
| API Specification: |
create_discount_rule_m |
| Required Fields: |
- <client_no>
- <auth_key>
- <label>
- <rule_id>
- <description>
- <ext_description>
- <flat_percent_ind>
- <amount>
- <currency>
- <duration_type_ind>
- <inline_offset_ind>
- <discount_behavior_type_ind>
- <service_code_to_use>
- <scope_no>
|
Additional Guidance
Input Fields
| Field Name |
Notes |
| <flat_percent_ind> |
Allowable values
| Values |
Description |
| P |
Percentage discount type |
| F |
Fixed discount type |
|
| <duration_type_ind> |
Allowable values
| Values |
Description |
| U |
Number of uses |
| M |
Duration in months |
| W |
Duration in weeks |
| D |
Duration in days |
| I |
Never expires |
|
| <scope_no> |
Allowable values
| Values |
Description |
| 0 |
All Charges |
| 10 |
All Plan Charges, All Plans |
| 11 |
All Plan Charges, Specified Plans |
| 12 |
All Plans, Specified Service Charges |
| 13 |
Specified Plan/Service Charges |
| 21 |
All Recurring Service Charges |
| 22 |
All Usage Service Charges |
| 23 |
All Activation Service Charges |
| 30 |
All Item Charges |
| 31 |
Specified Item Charges |
|
| <applicable_trans_scope> |
Allowable values
| Values |
Description |
| E |
Applies discount to each transaction on the invoice (current behavior) |
| M |
Applies discount to all the transaction on the invoice. Any remaining credit will be carried over to next month. |
|
| <use_all_or_nth_subs_rule> |
Allowable values
| Values |
Description |
| TRUE |
Apply discount when 'all' of the plans are under the account |
| FALSE |
Apply discount when 'some' of the plans are under the account |
|
| <remainder_discount_rule_indicator> |
When set as 1, it will prorate the discount applied on the initial invoice if the respective charge is prorated and then force the remaining proportion of the discount on its final application. In any of its application, if respective charge is prorated, then the discount also gets prorated. By default it's null. This parameter is applicable only for (a) duration_type_ind = M (months type duration) and (b) duration_type_ind = U (usage count type duration) with flat_percent_ind = F (fixed discount type).
Allowable Values
| Values |
Description |
| 1 |
Prorate the discount applied on the initial invoice if the respective charge is prorated and then force the remaining proportion of the discount on its final application. |
| NULL |
Do not prorate.
|
|
