get_acct_status_history_m
Summary
| API Name | get_acct_status_history_m |
|---|---|
| Class | account_services_m |
| Update Version | 35 |
Description
Returns the history of modifications to an account's status.
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 | No |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
| account_number | 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: account_number |
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. |
|
| Start of stat_hist object | ||||
| stat_hist | object | No |
An array of status history records for the account. |
|
| Name | Type | Length | Required | Description |
| ▶date_entered | string | No |
The date this status was entered |
|
| ▶acct_status | string | No |
The previous account status |
|
| ▶new_status | string | No |
The status the account was changed to. The "current" status for this line |
|
| ▶comments | string | No |
Any CSR comments which were entered when this status was changed |
|
| ▶client_receipt_id | string | 50 | No |
If an API call forces the change of an account status, the receipt ID for that call will be returned here |
| ▶changed_by | string | No |
User id of most recent party to update account status. In some cases, this may be a generic API call or batch process that updates this field. |
|
| End of stat_hist object | ||||