get_acct_comments_m
Summary
| API Name | get_acct_comments_m |
|---|---|
| Class | account_services_m |
| Update Version | 63 |
Description
Returns comments (notes) associated with an account within a specified date range. Account comments are free-text notes added by API integrations, customer service representatives, or automated processes to record interactions, decisions, or observations about the account. Use this API to retrieve a customer's comment history for customer service context, audit trails, or case management. To add a new comment to an account, use write_acct_comment_m.
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 |
| date_range_start | string | 10 | Yes |
The start-date of the given date range. |
| date_range_end | string | 10 | Yes |
The end-date of the given date range |
| do_url_encoding | string | 5 | No |
A boolean value that informs the API method to do MIME Encoding of the data to be returned (if any). |
| filter_application_id | string | 300 | No |
When provided, the search shall perform an exact equals to the input that is provided to fetch the relevant application ID and application date. |
| 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. |
|
| acct_comments | object | No |
acct_comments fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| comment_author | string | No |
User/Author of the comment. |
|
| comment_date_time | string | No |
Time/date stamp the comment was created |
|
| comment | string | No |
The body of the comment. |
|
| application_id | string | 300 | No |
The application identifier in which the API/UI is being used.(Example: Sales Force). |
| application_date | string | 300 | No |
The application date/timestamp, when the application is called from UI/API. |
| comment_no | long | No |
This provides a unique identifier per comment to identify possible duplicate entries. |