discard_usage_m
Summary
| API Name | discard_usage_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 6.9 |
Description
If usage recorded in the Aria system was incorrect in some way, this API allows that usage to be discarded. Records discarded with this API are retained within Aria, but are not billable and will return with excluded reason codes if those usage records are fetched. Fetching usage from Aria prior to calling this API is not required, as it accepts either Aria-defined usage codes or client-defined usage codes.
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. |
| Start of usage_record_nos object | ||||
| usage_record_nos | object | No | ||
| Name | Type | Length | Required | Description |
| ▶usage_record_no | long | 22 | No |
The system-defined usage record ID of the usage to be discarded |
| End of usage_record_nos object | ||||
| Start of client_record_ids object | ||||
| client_record_ids | object | No | ||
| Name | Type | Length | Required | Description |
| ▶client_record_id | string | 100 | No |
If the above is not available, the client-defined record ID for the usage to be discarded |
| End of client_record_ids object | ||||
| exclusion_reason_cd | long | 4 | No |
The exclude reason code, defining why these usage records are being removed |
| exclusion_comment | string | 300 | No |
Optional comment on the reason behind this API call |
| Start of combined_client_usage_ids object | ||||
| combined_client_usage_ids | object | No | ||
| Name | Type | Length | Required | Description |
| ▶combined_client_record_id | string | 100 | No |
If ENFORCE_USAGE_RECORD_UNIQUENESS is set as 2, both client_record_id and Usage_type_code fields are mandatory. |
| ▶combined_usage_type_code | string | 50 | No |
If ENFORCE_USAGE_RECORD_UNIQUENESS is set as 2, both client_record_id and Usage_type_code fields are mandatory. |
| End of combined_client_usage_ids object | ||||
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 failed_records object | ||||
| failed_records | object | No | ||
| Name | Type | Length | Required | Description |
| ▶usage_record_no | long | No |
The system-defined usage record ID of the usage which was excluded |
|
| ▶client_record_id | string | No |
The client-defined usage record ID of the usage which was excluded, if available |
|
| ▶record_error_code | long | No |
For each record, an error code may be returned to indicate the usage was not properly excluded |
|
| ▶record_error_msg | string | No |
For each record, an error message may be returned to indicate the usage was not properly excluded |
|
| End of failed_records object | ||||