Home > Aria6 User Documentation > Aria6 admintools api > create_surcharge

create_surcharge

Creates 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
Asterisk_0807a.jpg client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
Asterisk_0807a.jpg auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
Asterisk_0807a.jpg surcharge_name string 100 Specifies Surcharge Name. Translatable.
Asterisk_0807a.jpg description string 1000 Specifies description for the Surcharge. Translatable
Asterisk_0807a.jpg ext_description string 1000 Specifies description that can be added to statment and is visible to the user. Translatable.
Asterisk_0807a.jpg currency_cd string 3 Specifies the currency code of the surcharge
Asterisk_0807a.jpg surcharge_type_cd string 1 Specifies whether the discount is going to be fixed or percentage based.  

Allowable values for surcharge_type_cd

Values Description
F Fixed discount
V Volume percentage (Volume Discount)
S Standard percentage
Asterisk_0807a.jpg inline_offset_ind string 1 Specifies how the discount will be displayed in the invoice.  

Allowable values for inline_offset_ind

Values Description
I Includes with original line item(s)
O Adds a separate surcharge line item
Asterisk_0807a.jpg apply_b4_or_after_discount_cd string 1 Specifies whether the surcharge should consider item totals before or after discounts are applied  

Allowable values for apply_b4_or_after_discount_cd

Values Description
B Before the discount
A After the discount
Asterisk_0807a.jpg scope_no int 2 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
Asterisk_0807a.jpg surcharge_tier array    
Asterisk_0807a.jpg brd_arrow.giffrom int 10 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.
  brd_arrow.gifto int 10 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
Asterisk_0807a.jpg brd_arrow.gifrate float 12 REST input arrays should be passed in the following format: surcharge_tier[0][rate][0]=3&surcharge_tier[0][rate][1]=4 etc.
  brd_arrow.gifdescription string 50 This field is used to display custom rate tier description. REST input arrays should be passed in the following format: surcharge_tier[1][description]=Custom description&surcharge_tier[1][description]=custom description etc. Index [tier][0] specifies the first tier and [tier][1] specifies the second tier and so on. Translatable.
  client_surcharge_id string 100 Specifies client defined id for Surcharge
  apply_to_zero_invoice_ind int 8 DeprecatedSpecifies whether the minimum surcharge should apply to zero dollar invoice or not.
  tax_group int 8 Specifies the tax group to be used while calculating surcharge.
  gl_cd string 30 Specifies the revenue account chart of access code
  ar_gl_cd string 30 Specifies the account recievable chart of access code
  brd_arrow.gifplan_no int array 12 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
  brd_arrow.gifclient_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
  brd_arrow.gifservice_no int array 12 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
  brd_arrow.gifclient_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
  brd_arrow.gifitem_no int array 12 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
  brd_arrow.gifclient_sku string array 100 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: client_sku[0]=1002&client_sku[1]=103
  schedule array    
Asterisk_0807a.jpg brd_arrow.gifschedule_name string 10 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
Asterisk_0807a.jpg brd_arrow.gifcurrency_cd string 3 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.
  brd_arrow.gifis_default boolean 5 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
  brd_arrow.gifmin_surcharge_to_apply float 5 Minimum surchage to apply. REST input arrays should be passed in the following format: schedule[0][min_surcharge_to_apply]=10 etc
  brd_arrow.gifinclude_zero int 1 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 1 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.
 

Output Arguments

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
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®