Skip to main content
Knowledge Central
Aria Knowledge Central

get_surcharge_details_m

  1. Last updated
  2. Save as PDF

Returns the details of 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
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png surcharge_no int 100 Specifies Surcharge No
  OR      
  client_surcharge_id string 100 Specifies the client defined id for surcharge
  locale_name string 32 Name of the locale to which the translations belong.
  OR      
  locale_no int 38 Aria-assigned unique identifier of the locale used for translations.
  include_translations string 1 Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False.

Allowable values for include_translations:

 
Values Description
true Translated fields will be fetched in all the locales defined.
false Translation information will not be fetched.

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 int Specifies Surcharge No
surcharge_name string Specifies Surcharge Name
client_surcharge_id string Specifies client defined id for Surcharge
description string Specifies description for the Surcharge
ext_description string Specifies description that can be added to statement and is visible to the user.
currency_cd string Specifies the currency code of the surcharge
surcharge_type_cd string Specifies whether the discount is going to be fixed or percentage based.

Allowable values for surcharge_type_cd:

 
Values Description
F Fixed discount
S Standard percentage discount
V Volume percentage discount
inline_offset_ind string 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
tax_group int Specifies the tax group to be used while calculating surcharge.
gl_cd string Specifies the revenue account chart of access code
ar_gl_cd string Specifies the account recievable chart of access code
apply_b4_or_after_discount_cd string 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
apply_to_zero_invoice_ind int Deprecated specifies whether the minimum surcharge should apply to zero dollar invoice or not.
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 hash  
brd_arrow.gif from int Returned 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.gif to int Returned 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.
brd_arrow.gif rate float Returned in the following format: surcharge_tier[0][rate]=3&surcharge_tier[1][rate]=4 etc.
brd_arrow.gif description string Returned in the following format: surcharge_tier[0][description]=description&surcharge_tier[1][rate]=surcharge etc.
plan_no hash Aria-assigned unique plan identifier
brd_arrow.gif plan_nos int 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 hash  
brd_arrow.gif client_plan_ids string 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 hash  
brd_arrow.gif service_nos int 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 hash  
brd_arrow.gif client_service_ids string 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 hash  
brd_arrow.gif item_nos int 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 Client SKU of the NSO/Inventory item
plan_service hash  
brd_arrow.gif plan_no int Specifies the plans that are eligible for the surcharge.
brd_arrow.gif client_plan_id string  
brd_arrow.gif service_no hash  
brd_arrow.gif service_nos int Specifies the services that are eligible for the surcharge.
brd_arrow.gif client_service_id hash  
brd_arrow.gif client_service_ids string Specifies the client defined id for the services that are eligible for the surcharge.
surcharge_scope int Specifies the surcharge application. The value will be 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.
pay_method hash Payment method types on which this surcharge is applied to.
brd_arrow.gif payment_method_type string  
surcharge_translation_details hash Array that contains all the translated values for a given locale.
brd_arrow.gif locale_name string Name of the locale
brd_arrow.gif locale_no int Aria-assigned unique identifier of the locale used for translations.
brd_arrow.gif surcharge_no int Specifies Surcharge No
brd_arrow.gif surcharge_name string Specifies Surcharge Name
brd_arrow.gif description string Specifies description for the Surcharge
brd_arrow.gif ext_description string Specifies description that can be added to statement and is visible to the user.
brd_arrow.gif surcharge_tier_t hash  
brd_arrow.gif description string Returned in the following format: surcharge_tier[0][description]=description&surcharge_tier[1][rate]=surcharge etc.
tax_inclusive_ind int

This flag denotes if a surcharge is inclusive of taxes.

Allowable values for tax_inclusive_ind:

 
Values Description
0 False or indicates tax exclusive surcharge (default)
1 True or indicates surcharge is inclusive of taxes.
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    1. API Specification