Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!



 

Home > Aria Crescendo admintools api > get_surcharges_m

get_surcharges_m

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
 

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

Tags

This page has no custom tags.

Classifications

This page has no classifications.