Skip to main content
Aria Knowledge Central

get_surcharges_m

  1. Last updated
  2. Save as PDF
Returns all surcharges for a client

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.
  locale_no int 38 Aria-assigned unique identifier of the locale used for translations.
  OR      
  locale_name string 32 Name of the locale to which the translations belong.
  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.
surcharges hash  
brd_arrow.gif surcharge_no int Surcharge Number
brd_arrow.gif client_surcharge_id string Client defined identifier for Surcharge.
brd_arrow.gif surcharge_name string Surcharge Name
brd_arrow.gif 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
brd_arrow.gif currency_cd string Currency for the surcharge.
brd_arrow.gif scope_label string Scope for the surcharge
brd_arrow.gif deleteable string Specifies if surcharge is deleteable or not. Y - Yes, N - No
brd_arrow.gif 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.
brd_arrow.gif installment_surcharge_ind int
Allowable values for surcharge_scope:
Values Description
0 Surcharge will not be spread over installment period.
1 Surcharge will be spread over installment period.
brd_arrow.gif surcharge_translations 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 Surcharge Number
brd_arrow.gif surcharge_name string Surcharge Name
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

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