get_recurring_credit_info_m Guide
- Last updated
-
-
Save as PDF
This API returns a list of recurring credits associated with a specified account or master plan instance.
Additional Guidance
Output Fields
| Field Name |
Notes |
| <credit_type_ind> |
Allowable values
| Values |
Description |
| M |
Months |
| W |
Weeks |
| D |
Days |
|
| <credit_status_cd> |
Allowable values
| 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). |
|
| <credit_reason_cd> |
Allowable values
| 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 |
|
| <eligible_service_types> |
Allowable values
| 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 |
|
Error Codes
| Error Code/Description |
Associated Inputs |
|
|
|
1004: authentication error
Associated Inputs: auth_key, client_id, client_no
|
<auth_key>, <client_no> |
1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id)
Associated Inputs: acct_no, account_no, client_acct_id, user_id, userid, parent_acct_no
|
<acct_no>, <client_acct_id> |
14046: If you passed in an invalid plan_instance_no, this message will appear: "Invalid Plan instance number". If you passed in an invalid master_plan_instance_id, this message will appear: "Invalid master_plan_instance_id".
Associated Inputs: plan_instance_no, master_plan_instance_id, filter_plan_instance_no, percent_eval_plan_instance_no, client_plan_instance_id
Additional Comments: The plan_instance_no or master_plan_instance_id must belong to the account, or it is invalid. The percent_eval_plan_instance_no must belong to the account and also to the MPI given in input.
|
<plan_instance_no>, <master_plan_instance_id>, <client_plan_instance_id> |
14047: If you passed in an invalid client_plan_instance_id, this message will appear: "Invalid client Plan instance identifier". If you passed in an invalid client_master_plan_instance_id , this message will appear: "Invalid client_master_plan_instance_id".
Associated Inputs: client_plan_instance_id, client_master_plan_instance_id, client_percent_eval_plan_instance_id
|
<client_plan_instance_id>, <client_master_plan_instance_id> |
