edit_surcharge_m

Last updated
Save as PDF

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.

Input Arguments

Req

Field Name

Field Type

Max Length

Description

client_no

long

Aria-assigned unique identifier indicating the Aria client providing service to this account.

auth_key

string

Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.

surcharge_no

string

100

Surcharge No

client_surcharge_id

string

100

Specifies client defined id for Surcharge

surcharge_name

string

100

Specifies Surcharge Name. Translatable.

description

string

1000

Specifies description for the Surcharge. Translatable.

ext_description

string

1000

Specifies description that can be added to statment and is visible to the user. Translatable.

currency_cd

string

Specifies the currency code of the surcharge

scope_no

int

Specifies the charges eligible for the discount.

Allowable values for scope_no:

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

surcharge_tier

array

from

int

REST input arrays should be passed in the following format: surcharge_tier[0][from]=1&surcharge_tier[1][from]=1 etc. Index 0 specifies the first tier and 1 specifies the second tier and so on.

int

REST input arrays should be passed in the following format: surcharge_tier[0][to]=3&surcharge_tier[1][to]=7 etc. Index 0 specifies the first tier and 1 specifies the second tier and so on. This is mandatory unless it is the last tier

rate

float

REST input arrays should be passed in the following format: surcharge_tier[0][rate][0]=3&surcharge_tier[0][rate][1]=4 etc.

description

string

This field is used to display custom rate tier description. REST input arrays should be passed in the following format: surcharge_tier[1][description][0]=Custom description&surcharge_tier[1][description][1]=custom description etc. Index [tier][0] specifies the first tier and [tier][1] specifies the second tier and so on. Translatable.

apply_to_zero_invoice_ind

int

DeprecatedSpecifies whether the minimum surcharge should apply to zero dollar invoice or not.

plan_no

int array

Specifies the plan that are eligible for the surcharge. This is mandatory for scope 3 and 5.REST input arrays should be passed in the following format: plan_no[0]=1002&plan_no[1]=1003 etc

client_plan_id

string array

100

Specifies the plan that are eligible for the surcharge. This is mandatory for scope 3 and 5.REST input arrays should be passed in the following format: client_plan_id[0]=1002&client_plan_id[1]=1003 etc

service_no

int array

Specifies the services that are eligible for the surcharge. This is mandatory for scope 4 and 5. REST input arrays should be passed in the following format: For scope 4 service_no[0]=1002&service_no[1]=1003 For scope 5 service_no[0][0]=10002&service_no[0][1]=1001&service_no[1][0]=100&service_no[1][1]=103

client_service_id

string array

100

Specifies the services that are eligible for the surcharge. This is mandatory for scope 4 and 5. REST input arrays should be passed in the following format: For scope 4 client_service_id[0]=1002&client_service_id[1]=1003 For scope 5 client_service_id[0][0]=10002

item_no

int array

Specifies the inventory items that are eligible for the surcharge. This is mandatory for scope 10. REST input arrays should be passed in the following format: item_no[0]=1002&item_no[1]=103

client_sku

string array

100

Client SKU of the NSO/Inventory Item

schedule

array

schedule_name

string

Specifies schedule name. REST input arrays should be passed in the following format: schedule[0][schedule_name]=TestSchedule1&schedule[1][schedule_name]=TestSchedule2 etc. Translatable.

currency_cd

string

Currency of the Rate Schedule. REST input arrays should be passed in the following format: schedule[0][currency_cd]=usd&schedule[1][currency_cd]=eur etc.

is_default

boolean

Specifies if the rate schedule is default for the currency. REST input arrays should be passed in the following format: schedule[0][is_default]=1&schedule[1][is_default]=1 etc.

Allowable values for is_default:

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

min_surcharge_to_apply

float

Minimum surchage to apply. REST input arrays should be passed in the following format: schedule[0][min_surcharge_to_apply]=10 etc

include_zero

int

Specifies how the discount will be displayed in the invoice.

Allowable values for include_zero:

Values	Description
1	Include zero in rate tier
0	Ignore zero in rate tier

surcharge_scope

int

Specifies the surcharge application. The parameter is available only for EOM Clients.

Allowable values for surcharge_scope:

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.

locale_name

string

Name of the locale to which the translations belong.

locale_no

int

Aria-assigned unique identifier of the locale used for translations.

Field Name	Field Type	Description
error_code	long	Aria-assigned error identifier. 0 indicates no error
error_msg	string	Textual description of any error that occurred. "OK" if there was no error.
surcharge_no	string	Surcharge No

Input Arguments

Allowable values for scope_no:

Allowable values for is_default:

Allowable values for include_zero:

Allowable values for surcharge_scope:

Output Arguments