Home > Aria6 User Documentation > Aria6 core api > get_usage_history
get_usage_history
get_usage_history
Returns the usage records associated with a specified account for a particular date range, invoice number or transaction ID.
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. | ||||||
| specified_usage_type_no | long | 8 | The Aria-assigned usage type number to use when searching for usage history records. | |||||||
| OR | ||||||||||
| specified_usage_type_code | string | 30 | Optional client-defined usage type code | |||||||
| date_range_start | string | 14 | The start-date of the given date range. If you do not specify a date range, you must specify invoice_no or transaction_id | |||||||
| date_range_end | string | 14 | The end-date of the given date range. If you do not specify a date range, you must specify invoice_no or transaction_id | |||||||
 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 | Limit the number of records returned by the API. | |||||||
| offset | long | 10 | The number of records to skip. | |||||||
| transaction_id | long | 22 | Aria-assigned unique number to identify and invoicing activity. If you do not value this field, you must value either invoice_no or both date_range_start and date_range_end. | |||||||
| invoice_no | long | 22 | Aria-assigned unique number for a given invoice. If you do not value this field, you must value either transaction_id or both date_range_start and date_range_end. | |||||||
| invoice_line_item | long | 22 | Line number appearing within an invoice. | |||||||
| 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
|
|||||||
| 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. |
| usage_history_records | 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. |
| 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_transaction_id |
long | The Aria-assigned financial transaction 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 and was either rated by Aria or was 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 | Dictates whether or not the given usage record was entirely and permanently excluded from inclusion in any billing (invoicing) process. |
| 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, or if Aria rates the record. |
| 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 |
- © Copyright 2023 Aria Developer Central