Home > Aria Crescendo Documentation > Aria Crescendo admintools api > get_discount_rules_m

get_discount_rules_m

Lists all the discount rules for the 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

 

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.
discount_rules hash  
brd_arrow.gif rule_no int Specifies the no for the discount rule.
brd_arrow.gif rule_id string Specifies client rule id for Discount Rule
brd_arrow.gif description string Specifies description for the Discount Rule
brd_arrow.gif ext_description string Specifies description that can be added to invoice/statment and is visible to account holder.
brd_arrow.gif discount_type string Specifies whether the discount is going to be flat or percentage based.
brd_arrow.gif amount float Specifies the amount of discount.
brd_arrow.gif discount_rule_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 rule_no int Specifies the no for the discount rule.
brd_arrow.gif description string Specifies description for the Discount Rule
brd_arrow.gif ext_description string Specifies description that can be added to invoice/statment and is visible to account holder.
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.