Skip to main content
Aria Knowledge Central

edit_surcharge_m Guide

Edits a surcharge.

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:

edit_surcharge_m

Required Fields:
  • <client_no>
  • <auth_key>
  • <surcharge_no> or <client_surcharge_id>
  • <surcharge_name>
  • <description>
  • <ext_description>
  • <currency_cd>
  • <scope_no>
  • <sucharge_tier> (array)
    • <from>
    • <rate>
  • <schedule> (array)
    • <schedule_name>
    • <currency_cd>

Additional Guidance:

Input Fields
Field Name Notes
<scope_no>
Allowable Values
Values Description
1 All Charges
2 All Plan Charges, All Plans
3 All Plan Charges, Specified Plans
4 All Plans, Specified Service Charges
5 Specified Plan/Service Charges
6 All Recurring Service Charges
7 All Usage Service Charges
8 All Activation Service Charges
9 All Item Charges
10 Specified Item Charges
11 Payment Method
12 Payment Term
<is_default>
Allowable Values
Values Description
0 The rate schedule is taken as default for the currency
1 The rate schedule is not taken as default for the currency
<include_zero>
Allowable Values
Values Description
1 Include zero in rate tier
0 Ignore zero in rate tier
<surcharge_scope>
Allowable Values
Values Description
1 Surcharge can be applied to Account only.
2 Surcharge can be applied to Master plan instance only.
3 Surcharge can be applied to Account & Master plan instance.
  • Was this article helpful?