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

 

Home > Aria Crescendo core api > create_advanced_service_credit_m

create_advanced_service_credit_m

This API creates service credit in advance on an account or master plan instance.

Input Arguments

Req Field Name Field Type Max Length Description
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_acct_id string   This is the client-assigned identifier for the account.
  master_plan_instance_no long 22 The Master Subscription plan instance number.
  OR      
  client_master_plan_instance_id string 100 Client-defined Master plan Subscription plan instance ID.
  amount double 12 The amount of service credit to create on the account.
  reason_code long   The reason a given credt was/is to be applied to the account.   Allowable Values
  comments string 300 Free form optional text up to 300 characters. For display within AdminTools when viewing all credit records on an account.
  eligible_plan_no long   Eligible plan no or client eligible plan id if the master plan instance number is passed. If the master plan instance no / client master plan instance id parameter is not passed, this field is ignored. If the master plan instance no/client master plan instance id is ignored, this field will be ignored. This parameter will be deprecated in the future.
  OR      
  client_eligible_plan_id string 100 Eligible plan no or client eligible plan id if the master plan instance number is passed. If the master plan instance no / client master plan instance id parameter is not passed, this field is ignored. If the master plan instance no/client master plan instance id is ignored, this field will be ignored. This parameter will be deprecated in the future.
  eligible_service_no long 22 Eligible service no or client eligible service id if eligible plan no or client eligible plan id is passed. If the eligible plan no/client eligible plan id is not passed, or is passed but is ignored, then this field will also be ignored. This parameter will be deprecated in the future.
  OR      
  client_eligible_service_id string 100 Eligible service no or client eligible service id if eligible plan no or client eligible plan id is passed. If the eligible plan no/client eligible plan id is not passed, or is passed but is ignored, then this field will also be ignored. This parameter will be deprecated in the future.
  alt_service_no_to_apply long 22 Under default conditions, when a service credit on an account is consumed (resulting in negative line items attached to account invoices) the service_no value used by Aria on those invoice line items is the "universal" Aria service_no for service credits, specifically "0". This results in financial reports which group charges by service_no putting all consumed service credits into the same service_no 0 "bucket". If the client wishes for this credit, once consumed, to go into any other service_no "bucket", that service_no must be supplied in this field. Any Aria-standard or custom-to-client service number may be used. A common (but not required) use of this field is in conjunction with the eligible_plan_no/eligible_service_no fields described above, e.g.: Client offers plan_no XXXX with a recurring fee of service_no YYYY. A credit is attached to an account (which has plan XXXX) specifying these two values in the "eligible_" fields described above, which means that the credit will be consumed as an offset against and plan XXXX/service YYYY charges incurred by the account holder. Additionally, the client provides value YYYY in this field, which means that when the service credit is consumed the negative line item it creates on the account holder's invoice will use the same service no as the charge it offsets. If the amount of the recurring fee for plan XXXX/service YYYY is $10 (resulting in a positive line item of $10 with service YYYY on their invoice), and if the amount of the credit line item is $5 (resulting in a negative line item of -$2 with service YYYY on their invoice) the net result in any financial report that groups by service_no will be $8 (as opposed to $10 in service YYYY and -$2 in service 0).
  OR      
  client_alt_service_id_to_apply string 100 Client-defined unique alternate service ID that is to be applied
  frequency_no long 8 Number of times the service credit should be applied to the account
  frequency_interval_months long 8 Deprecated(Deprecated) Number of months between application of service credit to the account
  initial_credit_date string 14 Date on which the recurring service credit should start to be applied
  percent_amount double 12 The percent amount of the credit to be created for the account. For example if the account is to to receive a10% discount.
  percent_eval_plan_no long 22 The plan number against which to apply the percent discount.
  OR      
  client_percent_eval_plan_id string 100 The client-defined unique plan ID against which to apply the percent discount.
  percent_eval_service_no long   The service to which the percent discount is to be applied.
  OR      
  client_percent_eval_service_id string 100 The service to which the percent discount is to be applied.
  eligible_service_types string array 2 Service type code for which the credit is applicable.   Allowable Values
  credit_expiry_type_ind string 1 Indicator which determines the expiry is based on months or till Specific Date.
  credit_expiry_months long 2 Total Months after which service credit expires.
  credit_expiry_date string 10 The date on which credit expires. The date is in the format yyyy-mm-dd.
  eligible_service_plans array    
  plan_no long   If used, specifies the plan(s) to which the credit is applied. If the credit is to be applied as an offset to ANY charge incurred by the account holder, leave this field empty. If the credit is to be applied to offset a specific type of charge, then this field and either the eligible_service_no or client_eligible_service_id field must be valued.
  service_no long   If used, specifies the service(s) to which the credit is applied. If you value this field, you must also value either the corresponding plan_no field. If the credit to be created is to be applied to offset a specific type of charge, then that specific plan_no and service_no combination referencing that type of charge must be supplied in these two fields.

If you use this array to enter multiple service numbers, you must enter the same number of plans in the plan_no array, and the plan number and its corresponding service number must appear in the same sequence in each array, or the API call fails.

  client_eligible_service_plan_ids array    
  client_plan_id string 100 If used, specifies the plan(s) to which the credit is applied. If the credit is to be applied as an offset to ANY charge incurred by the account holder, leave this field empty. If the credit is to be applied to offset a specific type of charge, then this field and the client_service_id field must be valued.
  client_service_id string 100 If used, specifies the service to which the credit is applied. If you value this field, you must also value either the client_plan_id field. If the credit to be created is to be applied to offset a specific type of charge, then that specific client_plan_id and client_service_id combination referencing that type of charge must be supplied in these two fields.

If you use this array to enter multiple service numbers, you must enter the same number of plans in the client_plan_id array, and the client_plan_id and its corresponding client_service_id must appear in the same sequence in each array, or the API call fails.

  frequency_interval_type long 1 The unit of time associated with the frequency. 1= monthly, 2 = bi-monthly, 3 = quarterly, 4 semi-annually, 5 = annually.
  eligible_plan_instances array    
  plan_instance_no long   Plan instance number.
  plan_instance_service_no long   If used must be used in conjunction with field plan_instance_no. If the credit(s) to be created are to be applied as offsets to ANY charge incurred by the account holder, leave both of these fields empty. If the credit(s) to be created are to be applied as offsets to a specific type of charge, then that specific plan_instance_no and service_no combination referencing that charge are to be supplied in these two fields.
  client_eligible_plan_instances array    
  client_plan_instance_id string   Client-defined unique eligible plan IDs.
  client_plan_instance_service_id string   Client-defined unique eligible service ids.
  alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  qualifier_name string 100 Name of the field you want to associate with this API call.
  qualifier_value string 100 Corresponding value of the field you want to associate with this API call.
  application_id string 300 The application identifier in which the API is being used in. (Example: “Sales Force”)
  application_date string 300 The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API.

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.

You must to post a comment.
Last modified
14:39, 2 Feb 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.