Home > Aria6 User Documentation > Aria6 admintools api > create_credit_template



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 credit_template_name string    
required-icon.png discount_type int   Specifies discount type. Valid values are [1 or 2]. 1 - Indicates flat rate, 2 - Indicates percentage.
required-icon.png discount_amt float    
  eligible_plan_no int 8 Eligible service plan number. If eligible_plan_no is present then eligible_service_no is also set and vice-versa. This means that coupon can only be applied against a specific type of charge. But If both values are null then it means that coupon can be applied against any change.
  eligible_client_plan_id string 100 Specifies Client defined unique id
  eligible_service_no int 12 Eligible service number
  eligible_client_service_id string 100 Specifies Client defined unique id
  brd_arrow.gifeligible_service_types string array 2 Service type code for which the credit is applicable  

Allowable values for eligible_service_type

  no_of_credits int    
  credit_interval_months int    
  percentage_plan_no int    
  percentage_client_plan_id string 100 Specifies Client defined unique id
  percentage_service_no int    
  percentage_client_service_id string 100 Specifies Client defined unique id
  alt_service_no int    
  alt_client_service_id string 100 Specifies Client defined unique id
  client_credit_template_id string 100 Client defined unique id
  currency_cd string 3 Specifies the currency code of template
  coupon array    
  brd_arrow.gifcoupon_cd string 30 Specifies Coupon Code
  brd_arrow.gifcoupon_desc string 200 Specifies Coupon description
  brd_arrow.gifcoupon_msg string 300 Specifies Coupon Message
  brd_arrow.gifstatus_ind int 1 Specifies Coupon status. Valid values are [0, 1]. 1 indicates coupon is Active. 0 indicates coupon Inactive.
  brd_arrow.gifno_of_uses int 8 Specifies number of uses after which coupon get expires. Related to coupon expiry detail.
  brd_arrow.gifstart_date string   Specifies start date. The date is in the format "yyyy-mm-dd"Related to coupon expiry detail
  brd_arrow.gifend_date string   Specifies start date. The date is in the format "yyyy-mm-dd"Related to coupon expiry detail
  brd_arrow.gifcoupon_scope int 1 Specifies the coupon application. The parameter is required for EOM Clients

Allowable values for coupon_scope

  brd_arrow.gifexisting_coupon int array    

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.
credit_template_no string  
Last modified


This page has no custom tags.


This page has no classifications.