Home > Aria Crescendo Documentation > Aria Crescendo core api > get_credit_details_m
get_credit_details_m
get_credit_details_m
This API returns specific service credit, or cash credit details for an account, or master plan instance.
For information on error messages generated by this API, see get_credit_details_m error messages.
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 | 50 | Client-defined account identifier. | |
|
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 | 22 | Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients. | |
| OR | ||||
| locale_name | string | 50 | 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. | ||
 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.
Allowable values for credit_type
|
||||||||||||||||||||
| 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, weeks, days, or until a specific date.
Allowable values for credit_expiry_type_ind
|
||||||||||||||||||||
| 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_plan_instance_details | hash | |||||||||||||||||||||
| plan_instance_no |
long | The plan instance number that is eligible for this credit. | ||||||||||||||||||||
| client_plan_instance_id |
string | The client defined plan instance identifier. | ||||||||||||||||||||
| plan_instance_service_no |
long | The service number associated with the plan instance that is eligible for this credit. | ||||||||||||||||||||
| client_plan_instance_service_id |
string | The client-defined identifier for the service associated with this plan instance. | ||||||||||||||||||||
| eligible_service_plan_details | hash | |||||||||||||||||||||
| plan_no |
long | The plan numbers that are eligible for the 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 are eligible for the recurring credit. | ||||||||||||||||||||
| client_service_id |
string | The client-defined service IDs eligible for recurring credit | ||||||||||||||||||||
| eligible_service_types | hash | A list of eligible service types | ||||||||||||||||||||
| eligible_service_types |
string |
Service type code to which the credit is applicable.
Allowable values for eligible_service_types
|
||||||||||||||||||||
| out_acct_no | long | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. DEPRECATED | ||||||||||||||||||||
| out_acct_no_2 | 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. DEPRECATED | ||||||||||||||||||||
| out_master_plan_instance_no_2 | 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_no_2 | 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. | ||||||||||||||||||||
| credit_expiry_period | long | Expiration of the credit in days, weeks, or months. Allowable values are 1-999. | ||||||||||||||||||||
| cash_cr_origin | long | Array which will display cash credit origin related information. | ||||||||||||||||||||
| origin_master_plan_instance_no |
long | Master subscription plan instance number from which cash credit is originated. | ||||||||||||||||||||
| origin_client_mp_instance_id |
string | The client defined MPI identifier. | ||||||||||||||||||||
| origin_plan_instance_no |
long | Plan instance number from which cash credit is originated. | ||||||||||||||||||||
| origin_client_plan_instance_id |
string | The client defined plan instance identifier. | ||||||||||||||||||||
| origin_plan_name |
string | The name of the plan from which cash credit is originated. | ||||||||||||||||||||
| origin_proration_remaining_days |
string | Days of unconsumed period that resulted in cash credit. | ||||||||||||||||||||
| origin_adv_billing_period_total_days |
string | Proration period total days. | ||||||||||||||||||||
| origin_invoice_no |
long | Aria-assigned unique identifier of a given invoice from which cash credit is originated. | ||||||||||||||||||||
| origin_service_no |
long | Service number on an invoice from which cash credit is originated. | ||||||||||||||||||||
| origin_service_name |
string | The name of the service. This also includes taxe service. | ||||||||||||||||||||
| origin_client_service_id |
string | Client-defined unique identifier for service number. | ||||||||||||||||||||
| origin_plan_action_details |
string | Plan changes (status (active to cancelled) or units downgrade) that resulted in cash credits. |
- © Copyright 2022 Aria Developer Central