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

 

Home > Aria Crescendo core api > get_unapplied_service_credits_m

get_unapplied_service_credits_m

For a specified account or master plan instance, this call returns all service credits whose credit amounts have not yet been fully applied.

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.
  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.
unapplied_service_credits_details hash A multidimensional array of service credit records for the given account
credit_id long Aria-assigned unique identifier
create_date string Date the credit was created
create_user string User who created the credit
initial_amount double Full starting amount of the credit
amount_left_to_apply double Amount remaining of the total credit to apply
reason_cd long Reason code for why the credit was created   Allowable Values
reason_text string Text description for why the credit was created
comments string Comments from the create_user when the credit was created.
currency_cd string The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
service_no_to_apply long The service_no that will be used to represent the credit when it is applied.
service_name_to_apply string The name/description for "/service_no_to_apply/".
eligible_plan_no long If non-null, the service credit will only be applied to invoice line items that match this plan_no.
eligible_plan_name string The plan name for "eligible_plan_no".
eligible_service_no long If non-null, the service credit will only be applied to invoice line items that match this service_no.
eligible_service_name string The service name/description for "eligible_service_no".
client_service_id_to_apply string The client_service_id that will be used to represent the credit when it is applied.
client_eligible_plan_id string If non-null, the service credit will only be applied to invoice line items that match this client_plan_id.
client_eligible_service_id string If non-null, the service credit will only be applied to invoice line items that match this client_service_id.
amount_reserved_for_anniversary long Amount reserved for anniversary invoice
eligible_service_types hash A list of eligible service types
eligible_service_types string Service type code for which the credit is applicable.   Allowable Values
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.

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.