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

 

Home > Aria Crescendo core api > get_credit_details_m

get_credit_details_m

This API returns a particular service credit details for 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.
credit_no long 22 Aria-assigned unique identifier
  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.
  locale_no long   Aria-assigned Locale identifier. This value is unique across all Aria-managed accounts.
  OR      
  locale_name string   Name of the locale to which the translations belong.
  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.

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.
created_by string Specifies the user ID that created the transaction.
created_date string Specifies the date the credit was created.
amount double The amount of service credit to create on the account.
credit_type string The type of credit: e.g. service or cash.
applied_amount double The amount of credit to be applied to the account.
unapplied_amount double Amount remaining of the total credit to apply to account.
reason_code long Reason code for why the credit was created.
reason_text string The text description of the credit reason code.
comments string Additional explanatory text relating to this API call.
transaction_id long Unique transaction ID for this credit.
void_transaction_id long Unique transaction ID if cash credit was voided.
credit_expiry_type_ind string Indicator which determines the expiry is based on months or till Specific Date.   Allowable Values
credit_expiry_months long Total Months after which service credit expires.
credit_expiry_date string The date on which credit expires. The date is in the format yyyy-mm-dd.
eligible_service_plan_details hash  
plan_no long The plan numbers that is eligible to apply recurring credit.
plan_name string The name of the eligible plan number.
service_no long The service numbers eligible for recurring credit
service_name string The name of the eligible service.
client_plan_id string The client-defined plan IDs that is eligible to apply recurring credit.
client_service_id string The client-defined service ids eligible for recurring credit
out_acct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
out_master_plan_instance_no long The Master Subscription plan instance number.
out_client_mp_instance_id string Client-defined Master plan Subscription plan instance ID.
acct_locale_no long Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts.
acct_locale_name string Name of the account level locale.

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.