get_acct_credits_m
Summary
| API Name | get_acct_credits_m |
|---|---|
| Class | account_services_m |
| Update Version | 6.32 |
Description
Retrieves all service credits and cash credits applied to a specified account or master plan instance. Returns credit amounts, dates, reason codes, remaining balances, and whether each credit is a service credit or cash credit. Results can be limited by record count for pagination. Use this for credit history review, balance reconciliation, or displaying credit details to customers.
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 |
| limit_records | long | 22 | No |
An input to limit the number of records returning back. |
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. |
|
| all_credits | object | No |
all_credits fields
| Name | Type | Length | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| out_acct_no | long | 22 | No |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. |
||||||
| out_master_plan_instance_no | long | 22 | No |
The Master Subscription plan instance number. |
||||||
| out_client_mp_instance_id | string | 100 | No |
Client-defined Master plan Subscription plan instance ID. |
||||||
| credit_no | long | 22 | No |
Aria-assigned unique identifier. |
||||||
| 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. Allowed values:
|
|||||||
| 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. |
|||||||
| transaction_id | long | No |
Unique transaction ID for this cash credit. |
|||||||
| void_transaction_id | long | No |
Unique transaction ID if cash credit was voided. |