Home > Aria6 User Documentation > Aria6 core api > get_acct_credit_details
get_acct_credit_details
get_acct_credit_details
This call returns a particular service credit for an account at a credit level.
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. |
|
credit_no | long | 22 | Aria-assigned unique identifier |
| 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. | ||||||
| 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 or till 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_service_plan_details | hash | |||||||
| plan_no |
long | The plan numbers that is eligible to apply 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 is eligible to apply recurring credit. | ||||||
| client_service_id |
string | The client-defined service ids eligible for recurring credit |
- © Copyright 2022 Aria Developer Central