Home > Aria Crescendo Documentation > Aria Crescendo core api > get_recurring_credit_info_m

get_recurring_credit_info_m

This API returns a list of recurring credits associated with a specified account or master plan instance.

For information on error messages generated by this API, see get_recurring_credit_info_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.
  filter_credit_no long 22 The recurring credit number to use in order to filter results.
  locale_no long 22 Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients.
  OR      
  locale_name string 100 Name of the locale.
  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.
recurring_credits_details hash  
brd_arrow.gif out_acct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts. DEPRECATED
brd_arrow.gif out_acct_no_2 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.
brd_arrow.gif recurring_credit_no long The identifier for the recurring credit. DEPRECATED
brd_arrow.gif recurring_credit_no_2 long The identifier for the recurring credit.
     
brd_arrow.gif create_date string The date the recurring credit record was created.
brd_arrow.gif create_user string The user who created the recurring credit record.
brd_arrow.gif update_date string The date the recurring credit record was last updated.
brd_arrow.gif update_user string The user who last updated the recurring credit record
brd_arrow.gif first_credit_date string The first date that recurring credit was applied to the account.
brd_arrow.gif last_credit_date string The last date that recurring credit will be applied to the account.
brd_arrow.gif next_credit_date string The next date that a recurring credit will be applied to the account (assuming the last_credit_date has not passed)
brd_arrow.gif credit_amount double The monetary amount of the credit to be applied for each iteration of the recurring credit sequence.
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 credits_completed long The number of credits that have been applied to the account
brd_arrow.gif credits_remaining long The number of remaining credits to apply to the account
brd_arrow.gif credit_interval_months long The interval (in months) between credits to the account
  brd_arrow.gif credit_interval_weeks int Number of weeks that should go by between each time that the credit is applied to a customer's invoice.
  brd_arrow.gif credit_interval_days int Number of days that should go by between each time that the credit is applied to a customer's invoice.
  brd_arrow.gif credit_type_ind int

Type of duration between credits.

Allowable values for credit_type_ind

Values Description
M Months
W Weeks
D Days
brd_arrow.gif eligible_plan_no long The plan number that is eligible to apply recurring credit. (Deprecated)
brd_arrow.gif eligible_plan_name string The name of the eligible plan number. (Deprecated)
brd_arrow.gif eligible_service_no long The service number eligible for recurring credit (Deprecated)
brd_arrow.gif eligible_service_name string The name of the eligible service. (Deprecated)
brd_arrow.gif service_no_to_apply long The service number to apply the recurring credit to.
brd_arrow.gif service_name_to_apply string The name of the service to apply the recurring credit to.
brd_arrow.gif credit_status_cd long The status code for the recurring credit.  

Allowable values for credit_status_cd

Values Description
1 Entered, No Credits Created (Recurring credit has been entered into the system but no credits based upon it have yet been created).
2 Credits Created, Incomplete (Some but not all of the specified number of credits specified by this recurring credit have been processed).
3 Credits Created, Complete (All of the specified number of credits specified by this recurring credit have been processed).
-1 Cancelled, No Credits Created (Recurring credit cancelled before any of the specified number of credits were processed).
-2 Cancelled, Some Credits Created (Recurring credit cancelled after some of the specified number of credits were processed but before all of the specified number of credits were processed).
brd_arrow.gif credit_status_label string The label for the recurring credit status code.
brd_arrow.gif credit_reason_cd long The reason code for the application of credit toward the account specified  

Allowable values for credit_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 credit_reason_text string The text description of the credit reason code.
brd_arrow.gif comments string Free-form comments for the credit applied to the specified account.
brd_arrow.gif cancel_date string The date the credit was cancelled (if any)
brd_arrow.gif cancel_user string The user who cancelled the credit.
brd_arrow.gif cancel_comments string Comments from the user who cancelled the credit
brd_arrow.gif client_eligible_plan_id string The client-defined plan ID that is eligible to apply recurring credit. (Deprecated)
brd_arrow.gif client_eligible_service_id string The client-defined service ID eligible for recurring credit (Deprecated)
brd_arrow.gif client_service_id_to_apply string The client-defined service ID to apply the recurring credit to.
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.
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
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.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.