 |
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 |
long |
22 |
Aria-assigned account identifier. This value is unique across all Aria managed accounts. |
|
OR |
|
|
|
|
user_id |
string |
32 |
Account's user ID. Alternative to using acct_no. |
|
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 |
14 |
Specifies the start-date of the given date range. The date is in the format yyyy-mm-dd. |
|
date_filter_start_time |
string |
14 |
Specifies the start-time of the given time range. The time is in the format hh24:mi:ss. |
|
date_filter_end_date |
string |
14 |
Specifies the end-date of the given date range. The date is in the format yyyy-mm-dd. |
|
date_filter_end_time |
string |
14 |
Specifies the start-time of the given time range. The time is in the format hh24:mi:ss. |
|
billed_filter |
long |
1 |
Specifies billed records or unbilled records
Allowable values for billed_filter
Values |
Description |
0 |
Return both billed and unbilled usage records |
1 |
Billed usage records only |
2 |
Unbilled usage records only |
|
|
billing_period_flag |
long |
1 |
Specifies whether to select records of current billing cycle
Allowable values for billing_period_flag
Values |
Description |
0 |
0 |
1 |
current billing cycle only |
|
|
usage_qualifier_1 |
string array |
1000 |
Optional list of filters to apply against usage qualifier number 1, stored in the Aria system |
|
usage_qualifier_2 |
string array |
1000 |
Optional list of filters to apply against usage qualifier number 2, stored in the Aria system |
|
usage_qualifier_3 |
string array |
1000 |
Optional list of filters to apply against usage qualifier number 3, stored in the Aria system |
|
usage_qualifier_4 |
string array |
|
Optional list of filters to apply against usage qualifier number 4, stored in the Aria system |
|
retrieve_excluded_usage |
string |
8 |
Use this field to include usage records that have been permanently excluded from billing
Allowable values for retrieve_excluded_usage
Values |
Description |
true |
Discarded usage records will be included |
false |
Discarded usage records will not be included |
|
|
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. |