Home > Aria Crescendo core api > get_usage_summary_by_type_m
get_usage_summary_by_type_m
get_usage_summary_by_type_m
Returns the usage records associated with a specified account for a particular date range.
Input Arguments
| Req | Field Name | Field Type | Max Length | Description | |
|---|---|---|---|---|---|
 |
client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. | |
|
auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. | |
|
acct_no
OR
user_id
OR
client_acct_id |
long
string
string |
22
32
50 |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
Client-defined account identifier. |
|
|
master_plan_instance_no | long | 22 | The master plan instance number. | |
| OR | |||||
| client_master_plan_instance_id | string | 100 | Client-defined master plan instance ID. | ||
| usage_type_filter | long | 8 | The Aria-assigned usage type number used to search for usage history records. | ||
| OR | |||||
| usage_type_cd_filter | string | 100 | The client assigned usage type code used to search for usage history records. | ||
| date_filter_start_date | string | 10 |
Specifies the start-date of the given date range. The date is in the format yyyy-mm-dd.
|
||
| date_filter_start_time | string | 8 | Specifies the start-time of the given time range. The time is in the format hh24:mi:ss and will default to 00:00:00 hrs. | ||
| date_filter_end_date | string | 10 | Specifies the end-date of the given date range. The date is in the format yyyy-mm-dd. | ||
| date_filter_end_time | string | 8 | Specifies the start-time of the given time range. The time is in the format hh24:mi:ss and will default to 23:59:59 hrs. | ||
| billed_filter | long | 1 | Specifies billed records or unbilled records Allowable Values | ||
| billing_period_flag | long | 1 |
Specifies whether to select records of current billing cycle Allowable Values
|
||
| usage_qualifier_1 | string array | 300 | Optional list of filters to apply against usage qualifier number 1, stored in the Aria system | ||
| usage_qualifier_2 | string array | 300 | Optional list of filters to apply against usage qualifier number 2, stored in the Aria system | ||
| usage_qualifier_3 | string array | 300 | Optional list of filters to apply against usage qualifier number 3, stored in the Aria system | ||
| usage_qualifier_4 | string array | 300 | Optional list of filters to apply against usage qualifier number 4, stored in the Aria system | ||
| retrieve_excluded_usage | string | 5 | Use this field to include usage records that have been permanently excluded from billing Allowable Values | ||
| locale_no | long | 22 | Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients. | ||
| OR | |||||
| locale_name | string | 50 | Name of the locale. | ||
| alt_caller_id | string | 30 | Person or process that submitted the API call. This can be someone's user ID, or the name of an application. | ||
| optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | |||
 qualifier_name |
string | 100 | Name of the field you want to associate with this API call. | ||
| qualifier_value |
string | 100 | Corresponding value of the field you want to associate with this API call. |
Output Arguments
| Field Name | Field Type | Description |
|---|---|---|
| error_code | long | Aria-assigned error identifier. 0 indicates no error. |
| error_msg | string | Description of any error that occurred. "OK" if there was no error. |
| start_date | string | The start-date of the given date range |
| start_time | string | The start-time of the given time range |
| end_date | string | The end-date of the given date range |
| end_time | string | The end-time of the given time range |
| usage_summary_recs | hash | Usage summary records of the account (and optional specified usage type) for given date range |
| out_acct_no |
long | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. |
| out_client_acct_id |
string | This is the client-assigned identifier for the account. |
| out_plan_instance_no |
long | The master plan instance number. |
| out_plan_instance_cdid |
string | Client-defined master plan instance ID. |
| usage_type_no |
long | Aria-assigned unique identifier representing the type of usage that is being recorded. |
| usage_type_label |
string | Aria-assigned the label to representing the usage type |
| billed_ind |
long | Specifies billed records or unbilled records |
| total_units |
double | The total number of usage units |
| total_value_amount |
double | The total amount of the usage |
| total_value_currency_code |
string | The currency code for the usage |
| last_usage_date |
string | The last date when usage is loaded |
| usage_type_cd |
string | An array containing usage_type_cd(s) to denote which usage type(s) to record. |
| acct_locale_no | long | Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts. |
| acct_locale_name | string | Name of the account level locale. |
- © Copyright 2019 Aria Developer Central