Home > Aria Crescendo Documentation > Aria Crescendo core api > get_usage_history_m
get_usage_history_m
get_usage_history_m
This API returns usage records for an account, and can be filtered by date range, usage type, invoice, exclude status, and qualifiers. Using limit and offset inputs, results can be paginated. The fields "locale_no" and "locale_name" can be specified to translate output fields for which translations have been assigned to locales configured in Aria.
For information on error messages generated by this API, see get_usage_history_m Error Messages.
For information on error messages generated by this API, see get_usage_history_m Error Messages.
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 | long | 22 | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. | ||||||||
| OR | ||||||||||||
| client_acct_id | string | 50 | Client-defined account identifier. | |||||||||
|
master_plan_instance_no | long | 22 |
You can:
|
||||||||
| OR | ||||||||||||
| client_master_plan_instance_id | string | 100 | Client-defined master plan instance ID. | |||||||||
| specified_usage_type_no | long | 8 |
The Aria-assigned usage type number to use when searching for usage history records. You can pass in:
|
|||||||||
| OR | ||||||||||||
| specified_usage_type_code | string | 30 |
Optional client-defined usage type code. You can pass in:
|
|||||||||
| date_range_start | string | 19 |
The start-date of the given date range in yyyy-mm-dd hh24:mi:ss format. Timestamp is optional and will default to 00:00 hrs.
|
|||||||||
| date_range_end | string | 19 | The end-date of the given date range in yyyy-mm-dd hh24:mi:ss format. Timestamp is optional and will default to 23:59:59 hrs. | |||||||||
| 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 | |||||||||
| limit | long | 10 | Limits the number of records returned by the API. | |||||||||
| offset | long | 10 | The number of records to skip. | |||||||||
| invoice_no | long | 22 |
The Aria-assigned identifier for the invoice for which you are retrieving data. You can pass in:
|
|||||||||
| invoice_line_item | long | 22 |
Returns all of the usage records with a usage type that matches that of the invoice line item specified.
|
|||||||||
| retrieve_excluded_usage | string | 5 | Use this field to include usage records that have been permanently excluded from billing
Allowable values for retrieve_excluded_usage
|
|||||||||
| 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. | |||||||||
| Start of <optional_transaction_qualifiers> array | ||||||||||||
| 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. | |||||||||
| End of <optional_transaction_qualifiers> array | ||||||||||||
| client_record_id | string | 100 | Client-defined identifier for a usage record. | |||||||||
| billed_filter | long | 1 |
Specifies billed records or unbilled records Allowable values for billed_filter:
|
|||||||||
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. | ||||||
| usage_history_recs | hash | A multidimensional array of usage history records attached to the account (and optional specified usage type) for given date range | ||||||
| billable_acct_no |
long | Aria-assigned unique account identifier of the account who was billed the usage | ||||||
| incurring_acct_no |
long | Aria-assigned unique account identifier of the account that incurred the usage. | ||||||
| client_billable_acct_id |
string | This is the client-assigned identifier of the account who was billed the usage | ||||||
| client_incurring_acct_id |
string | This is the client-assigned identifier of the account that incurred the usage. | ||||||
| plan_instance_id |
long | The Subscription plan instance number. | ||||||
| client_plan_instance_id |
string | Client-defined plan Subscription plan instance ID. | ||||||
| usage_type_no |
long | Aria-assigned unique identifier representing the type of usage that is being recorded. | ||||||
| usage_type_description |
string | The name of this usage type used on all reports, account statements, etc., E.g. International Call Minutes | ||||||
| usage_date |
string | The date on which the given usage was incurred. | ||||||
| usage_time |
string | The time on which the given usage was incurred. | ||||||
| units |
double | The number of units incurred by the account holder. | ||||||
| units_description |
string | The name used for the unit type with which this usage type is metered, E.g. minutes | ||||||
| usage_units_description |
string | The name used for the unit type with which this usage type is metered, E.g. minutes | ||||||
| invoice_no |
long | The Aria-assigned ID corresponding to the invoice upon which this usage record was billed to the account holder. | ||||||
| telco_to |
string | The unconstrained string identifying the "sender" of the message represented by this usage record. Intended for usage records that represent a telecom-based form of usage whereby the sender/originator and the recipient/terminator of the message/usage record are desired to be recorded as notational-only elements (e.g. a phone call whereby the "from" telephone number and the "to" telephone number are desired as notational elements). | ||||||
| telco_from |
string | The unconstrained string identifying the "recipient" of the message represented by this usage record. Intended for usage records that represent a telecom-based form of usage whereby the sender/originator and the recipient/terminator of the message/usage record are desired to be recorded as notational-only elements (e.g. a phone call whereby the "from" telephone number and the "to" telephone number are desired as notational elements). | ||||||
| specific_record_charge_amount |
double | If the usage record was supplied to Aria in a pre-rated form, i.e. with a specified currency value already associated with it, the value originally supplied. NOTE: Most usage records are subject to end-of-period aggregate value determination and will not have a value here. | ||||||
| is_excluded |
string | Specifies whether or not the given usage record was entirely and permanently excluded from any billing (invoicing) process.
Allowable values for is_excluded
|
||||||
| exclusion_comments |
string | Comments entered to explain why the record was excluded from billing. Only recorded if is_excluded is true. | ||||||
| comments |
string | Comments entered while recording usage | ||||||
| pre_rated_rate |
double | Rate entered while recording usage | ||||||
| qualifier_1 |
string | The value of client-defined usage qualifier 1 for this usage record | ||||||
| qualifier_2 |
string | The value of client-defined usage qualifier 3 for this usage record | ||||||
| qualifier_3 |
string | The value of client-defined usage qualifier 3 for this usage record | ||||||
| qualifier_4 |
string | The value of client-defined usage qualifier 4 for this usage record | ||||||
| recorded_units |
double | The number of units recorded by the account holder. | ||||||
| usage_rec_no |
long | Aria-assigned usage record identifier. | ||||||
| usage_parent_rec_no |
long | Aria-assigned usage parent record identifier. | ||||||
| usage_type_code |
string | The usage type code of this record | ||||||
| client_record_id |
string | If available, the client-defined usage code for this usage record | ||||||
| exclude_reason_cd |
long | The reason why this usage record has been excluded from billing
Allowable values for exclude_reason_cd
|
||||||
| master_plan_instance_no |
long | The Master Subscription plan instance number. | ||||||
| client_master_plan_instance_id |
string | The client-defined identifier of the Master plan instance. | ||||||
| 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. | ||||||
| filtered_usage_count | long | Total count of filtered usage records. |
- © Copyright 2023 Aria Developer Central