get_cash_credits_details_m
Summary
| API Name | get_cash_credits_details_m |
|---|---|
| Class | account_services_m |
| Update Version | 34 |
Description
This API is used to return details of the cash credits on an account, or just for a given cash credit "transaction_id". This API also returns the charge details on which the cash credit is applied.
Inputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
| auth_key | string | 32 | Yes |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
| acct_no | long | 22 | Yes |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Alternative required field: client_acct_id |
| transaction_id | long | 22 | No |
Unique transaction identifier for the cash credit. |
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
|
| cash_credits | object | No |
Array that contains cash credits. |
cash_credits.applied_cash_credits fields
| Name | Type | Length | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| service_no | long | No |
The service number for the cash credit application. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| service_name | string | No |
The service name for the cash credit application. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| client_service_id | string | No |
The Client-defined service number for the cash credit application. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| transaction_type | long | 3 | No |
Transaction type to search account history for. Allowed values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| transaction_name | string | No |
The transaction type for account level application of the cash credit. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| applied_transaction_id | long | No |
The transaction number for account level application of the cash credit. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| applied_amount | double | No |
The amount of the cash credit applied to the above. |
cash_credits fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| credit_no | long | 22 | No |
the cash credit number |
| created_by | string | No |
User ID that created the transaction. |
|
| created_date | string | 32 | No |
Specifies the date that credit was created. |
| amount | double | 12 | No |
The amount of the cash credit. |
| reason_code | long | No |
Reason code for the cash credit. |
|
| reason_text | string | No |
Text description for the reason. |
|
| origin_master_plan_instance_no | long | No |
Master subscription plan instance number from which cash credit is originated. |
|
| origin_client_mp_instance_id | string | No |
The client defined MPI identifier. |
|
| origin_plan_instance_no | long | No |
Plan instance number from which cash credit is originated. |
|
| origin_client_plan_instance_id | string | No |
The client defined plan instance identifier. |
|
| origin_plan_name | string | No |
The name of the plan from which cash credit is originated. |
|
| origin_proration_remaining_days | string | No |
Days of unconsumed period that resulted in cash credit. |
|
| origin_adv_billing_period_total_days | string | No |
Proration period total days. |
|
| origin_invoice_no | long | No |
Aria-assigned unique identifier of a given invoice from which cash credit is originated. |
|
| origin_service_no | long | No |
Service number on an invoice from which cash credit is originated. |
|
| origin_service_name | string | No |
The name of the service. This also includes taxe service. |
|
| origin_client_service_id | string | No |
Client-defined unique identifier for service number. |
|
| origin_plan_action_details | string | No |
Plan changes (status (active to cancelled) or units downgrade) that resulted in cash credits. |
|
| applied_cash_credits | object | No |
Array that contains cash credit application details. |