Home > Aria6 User Documentation > Aria6 core api > get_unapplied_service_credits
get_unapplied_service_credits
get_unapplied_service_credits
For a specified account, this call returns all service credits whose credit amounts have not yet been fully applied.
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. |
| 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| unapplied_service_credits | hash | A multidimensional array of service credit records for the given account | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| credit_id |
long | Aria-assigned unique identifier | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| create_date |
string | Date the credit was created | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| create_user |
string | User who created the credit | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| initial_amount |
double | Full starting amount of the credit | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| amount_left_to_apply |
double | Amount remaining of the total credit to apply | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| reason_cd |
long | Reason code for why the credit was created
Allowable values for reason_cd
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| reason_text |
string | Text description for why the credit was created | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| comments |
string | Comments from the create_user when the credit was created. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| currency_cd |
string | The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| service_no_to_apply |
long | The service_no that will be used to represent the credit when it is applied. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| service_name_to_apply |
string | The name/description for "/service_no_to_apply/". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| eligible_plan_no |
long | If non-null, the service credit will only be applied to invoice line items that match this plan_no. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| eligible_plan_name |
string | The plan name for "eligible_plan_no". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| eligible_service_no |
long | If non-null, the service credit will only be applied to invoice line items that match this service_no. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| eligible_service_name |
string | The service name/description for "eligible_service_no". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| client_service_id_to_apply |
string | The client_service_id that will be used to represent the credit when it is applied. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| client_eligible_plan_id |
string | If used, specifies the client-defined plan ID to which the credit is applied. The credit is applied to all services on this plan. If the credit is to be applied to offset ANY charge incurred by the account holder, leave this field empty. If the credit is to be applied to offset a specific type of charge, then this field and the client_eligible_service_id field must be valued. <p> If the eligible_plan_no field has a value in it, this field is ignored. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| client_eligible_service_id |
string | If used, specifies the client-defined service ID to which the credit is applied. The service must exist in the plan specified in the client_eligible_plan_id field. If you value this field, you must also value the client_eligible_plan_id field with the plan ID that contains this service. If the credit to be created is to be applied to offset a specific type of charge, then that specific plan_ID and service_ID combination referencing that type of charge must be supplied in these two fields. Entering a service ID in this field without entering its corresponding plan ID causes the API to fail. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| amount_reserved_for_anniversary |
long | Amount reserved for anniversary invoice | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| eligible_service_types |
hash | A list of eligible service types | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| eligible_service_types |
string | Service type code for which the credit is applicable.
Allowable values for eligible_service_types
|
- © Copyright 2023 Aria Developer Central