get_credit_details_m
Summary
| API Name | get_credit_details_m |
|---|---|
| Class | account_services_m |
| Update Version | 23 |
Description
This API returns a particular service credit details for an account or master plan instance.
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 |
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no |
| master_plan_instance_no | long | 22 | No |
The Master Subscription plan instance number. Alternative field: client_master_plan_instance_id |
| client_master_plan_instance_id | string | 100 | No |
Client-defined Master plan Subscription plan instance ID. Alternative field: master_plan_instance_no |
| credit_no | long | 22 | Yes |
Aria-assigned unique identifier |
| locale_no | long | 30 | No |
Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients. Alternative field: locale_name |
| locale_name | string | 100 | No |
Name of the locale. Alternative field: locale_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. |
|||||||||||
| created_by | string | No |
Specifies the user ID that created the transaction. |
|||||||||||
| created_date | string | 32 | No |
Specifies the date the credit was created. |
||||||||||
| amount | double | 12 | No |
The amount of service credit to create on the account. |
||||||||||
| credit_type | string | No |
The type of credit: e.g. service or cash. |
|||||||||||
| applied_amount | double | 12 | No |
The amount of credit to be applied to the account. |
||||||||||
| unapplied_amount | double | 12 | No |
Amount remaining of the total credit to apply to account. |
||||||||||
| reason_code | long | No |
Reason code for why the credit was created. |
|||||||||||
| reason_text | string | No |
The text description of the credit reason code. |
|||||||||||
| comments | string | No |
Additional explanatory text relating to this API call. |
|||||||||||
| transaction_id | long | No |
Unique transaction ID for this credit. |
|||||||||||
| void_transaction_id | long | No |
Unique transaction ID if cash credit was voided. |
|||||||||||
| credit_expiry_type_ind | string | 1 | No |
Indicator which determines the expiry is based on months or till Specific Date. Allowed values:
|
||||||||||
| credit_expiry_months | long | 2 | No |
Total Months after which service credit expires. |
||||||||||
| credit_expiry_date | string | 10 | No |
The date on which credit expires. The date is in the format yyyy-mm-dd. |
||||||||||
| eligible_service_plan_details | object | No | ||||||||||||
| out_acct_no | long | 22 | No |
Note: This field is deprecated. Aria no longer supports out_acct_no. |
||||||||||
| out_master_plan_instance_no | long | 22 | No |
Note: This field is deprecated. Aria no longer supports out_master_plan_instance_no. |
||||||||||
| out_client_mp_instance_id | string | 100 | No |
Client-defined Master plan Subscription plan instance ID. |
||||||||||
| acct_locale_no | long | 30 | No |
Note: This field is deprecated. Aria no longer supports acct_locale_no. |
||||||||||
| acct_locale_name | string | 100 | No |
Name of the account level locale. |
||||||||||
| out_acct_no_2 | long | 22 | No |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. |
||||||||||
| out_master_plan_instance_no_2 | long | 22 | No |
The Master Subscription plan instance number. |
||||||||||
| acct_locale_no_2 | long | 30 | No |
Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts. |
||||||||||
| eligible_plan_instance_details | object | No | ||||||||||||
| eligible_service_types | object | No |
A list of eligible service types |
|||||||||||
| credit_expiry_period | long | 3 | No |
The value of this field will define the max length of applicable service credits that supports daily, weekly and monthly (exclude: specific date). And should be used with credit_expiry_type_ind. |
||||||||||
| cash_cr_origin | object | No |
Array which will display cash credit origin related informatio. |
eligible_service_plan_details fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| plan_no | long | 22 | No |
The plan numbers that is eligible to apply this credit. |
| plan_name | string | 100 | No |
The name of the eligible plan. |
| service_no | long | 22 | No |
The service number associated with the plan that is eligible to apply this credit |
| service_name | string | 100 | No |
The name of the eligible service. |
| client_plan_id | string | 100 | No |
The client defined plan identifier. |
| client_service_id | string | 100 | No |
The client defined identifier for the service associated with this plan |
eligible_plan_instance_details fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| plan_instance_no | long | 22 | No |
The plan instance number that is eligible to apply this credit. |
| client_plan_instance_id | string | 100 | No |
The client defined plan instance identifier. |
| plan_instance_service_no | long | 22 | No |
The service number associated with the plan instance that is eligible to apply this credit. |
| client_plan_instance_service_id | string | 100 | No |
The client defined identifier for the service associated with this plan instance. |
eligible_service_types fields
| Name | Type | Length | Required | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| eligible_service_types | string | 2 | No |
Service type code for which the credit is applicable. Allowed values:
|
cash_cr_origin fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| 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. |