Home > Aria Crescendo Documentation > 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.

For information on error messages generated by this API, see get_unapplied_service_credits_m Error Messages.

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 acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_acct_id string 50 Client-defined account 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.
  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.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif 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
brd_arrow.gif credit_id long Aria-assigned unique identifier. DEPRECATED
brd_arrow.gif credit_id_2 long Aria-assigned unique identifier.
brd_arrow.gif create_date string Date the credit was created
brd_arrow.gif create_user string User who created the credit
brd_arrow.gif initial_amount double Full starting amount of the credit
brd_arrow.gif amount_left_to_apply double Amount remaining of the total credit to apply
brd_arrow.gif reason_cd long Reason code for why the credit was created  

Allowable values for reason_cd

Values Description
1 General Credit/Other
2 Inadequate Service Delivery
3 Billing / Pricing Issue
4 Service no longer desired
5 Customer Dissatisfaction
6 Installation Issue
9 Customer Return
11 System Testing
12 Prepay Code Redemption
21 Billing Issue
22 Demo/Partner Account
23 Duplicate Charge
24 Employee Account
25 Pricing Issue
26 Return (RMA) Broken
27 Return (RMA) Cancel
28 Return (RMA) Wrong Product
29 Service Issue
30 Shipping Credit
31 Test Account
32 Refer-a-Friend
95 Client-defined automatic "form of payment discount"
96 Order Item Unit Credit
97 New Service Plan Proration
98 Prepay Credit Reconciliation
99 Balance Forward Conversion
1004 Pricing
1005 Service Error
1006 Hardware Malfunction
1007 Goodwill
1008 Billing Error
1009 Development
1010 Shipping Error
1011 Promotion
1012 System Testing
1013 Sales Rep Error
1014 Commission
1015 Operations Error
9999 Coupon Application
brd_arrow.gif reason_text string Text description for why the credit was created
brd_arrow.gif comments string Comments from the create_user when the credit was created.
brd_arrow.gif currency_cd string The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
brd_arrow.gif service_no_to_apply long The service_no that will be used to represent the credit when it is applied.
brd_arrow.gif service_name_to_apply string The name/description for "/service_no_to_apply/".
brd_arrow.gif eligible_plan_no (DEPRECATED) long If non-null, the service credit will only be applied to invoice line items that match this plan_no.
brd_arrow.gif eligible_plan_name (DEPRECATED) string The plan name for "eligible_plan_no".
brd_arrow.gif eligible_service_no (DEPRECATED) long If non-null, the service credit will only be applied to invoice line items that match this service_no.
brd_arrow.gif eligible_service_name (DEPRECATED) string The service name/description for "eligible_service_no".
brd_arrow.gif client_service_id_to_apply string The client_service_id that will be used to represent the credit when it is applied.
brd_arrow.gif client_eligible_plan_id (DEPRECATED) string If non-null, the service credit will only be applied to invoice line items that match this client_plan_id.

brd_arrow.gif client_eligible_service_id (DEPRECATED)

 string If non-null, the service credit will only be applied to invoice line items that match this client_service_id.
brd_arrow.gif amount_reserved_for_anniversary long Amount reserved for anniversary invoice
eligible_plan_instance_details hash  
  brd_arrow.gif plan_instance_no long The plan instance number that is eligible for this credit.
  brd_arrow.gif client_plan_instance_id string The client defined plan instance identifier.
  brd_arrow.gif plan_instance_service_no long The service number associated with the plan instance that is eligible for this credit.
  brd_arrow.gif  client_plan_instance_service_id string The client-defined identifier for the service associated with this plan instance.
eligible_service_plan_details hash  
brd_arrow.gif plan_no long The plan numbers that are eligible for the recurring credit.
brd_arrow.gif plan_name string The name of the eligible plan number.
brd_arrow.gif service_no long The service numbers eligible for recurring credit
brd_arrow.gif service_name string The name of the eligible service.
brd_arrow.gif client_plan_id string The client-defined plan IDs that are eligible for the recurring credit.
brd_arrow.gif client_service_id string The client-defined service IDs eligible for recurring credit
eligible_service_types hash A list of eligible service types
brd_arrow.gif eligible_service_types string Service type code to which the credit is applicable.  

Allowable values for eligible_service_types

Values Description
RC Recurring Service
US Usage Service
TX Tax Service
AC Activation Service
CN Cancellation Service
OR Order Based Service
MN Minimum Fee Service
RA Recurring Arrears Service
SC Surcharge Service
brd_arrow.gif out_acct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
brd_arrow.gif out_master_plan_instance_no long The Master Subscription plan instance number.
brd_arrow.gif out_client_mp_instance_id string Client-defined Master plan Subscription plan instance ID.
svc_credit_source_invoice_no long The invoice number where the original charge (against which service credit is being created) was billed.
svc_credit_source_line_no long The sequence number of the original line item against which service credit is created.
svc_credit_source_trans_id long The transaction number of the original line item against which service credit is created.
svc_credit_source_service_type string The transaction type of the original line item against which service credit is created. This is to to indicate whether the original line was a tax line item or any other charge (e.g., recurring/ usage etc.) i.e  RC, TX etc.
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®