Home > Aria Crescendo Documentation > Aria Crescendo object query api > get_usage_history_information_m

get_usage_history_information_m

Get usage records for an account.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
required-icon.png auth_key string 50 Client-defined account identifier.
  limit long 12 The maximum number of objects to be returned by this call. Note that Aria recommends a maximum limit of less than 1,000. Higher limits may take much longer to return data. If you do not specify a value, or specify a value of "0", this field defaults to 100. Specifying a value of "-1" returns a count of the number of matching records, but does not return any records.
  offset long 12 The number of records to skip. Note that both "0" and NULL will cause the interface not to skip any records.
  query_string string 1000

The criteria which all returned objects must match. Different objects have a different set of searchable criteria.

Fields marked with "*Query" in the returns section can be used as part of the query_string. Valid operations for the query string include "=", "!=", "<", "<=", ">=", ">", "IS NULL", "IS NOT NULL", "LIKE", and "NOT LIKE". You must leave a space before and after each operation. The first operand must always be a field name, and the second operand must always be a value (except for "IS NULL" and "IS NOT NULL", where the second operand is implicitly "NULL"). If the second operand contains a space, less than, greater than, or equals sign, then it must be enclosed in double quotes. The second operand may not contain double quotes. Multiple conditions must be joined with either "AND" or "OR". Additionally, any queryable field can also be used to order the results, by appending "ORDER BY" to the query, followed by a field name and either "ASC" or "DESC".

Querystring Keys

Key Name

Description

acct_no Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
client_acct_id Client-defined account identifier.
user_id Account's user ID. 
usage_type_no The Aria-assigned usage type number to set the threshold unit amount per specific usage type.
usage_type_code Client-assigned identifier for the type of usage being recorded.
usage_date The date on which the given usage was incurred.
usage_units The number of usage units that are being recorded.
usage_record_no The system-defined usage record ID.
exclude_from_billing A flag that specifies whether or not this usage record should be excluded from billing (neither generating a charge nor appearing on a statement).
qualifier_1 Client-defined string of any value meant for internal use and/or display to customers in statements.
qualifier_2 Client-defined string of any value meant for internal use and/or display to customers in statements.
qualifier_3 Client-defined string of any value meant for internal use and/or display to customers in statements.
qualifier_4 Client-defined string of any value meant for internal use and/or display to customers in statements.

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.
starting_record long The Aria generated credit memo number.
total_records string The user specified sequence ID created for the credit memo.
usage_history_information hash Usage record details for the specified account.
brd_arrow.gif acct_no long Aria-assigned unique account identifier of the account who was billed the usage.
brd_arrow.gif incurring_acct_no long Aria-assigned unique account identifier of the account that incurred the usage.
brd_arrow.gif client_acct_id string This is the client-assigned identifier of the account who was billed the usage.
brd_arrow.gif client_incurring_acct_id string This is the client-assigned identifier of the account that incurred the usage.
brd_arrow.gif plan_instance_id long The Subscription plan instance number.
brd_arrow.gif client_plan_instance_id string Client-defined plan Subscription plan instance ID.
brd_arrow.gif usage_type_no long Aria-assigned unique identifier representing the type of usage that is being recorded.
brd_arrow.gif usage_type_description string The name of this usage type used on all reports, account statements, etc., E.g. International Call Minutes.
brd_arrow.gif usage_date string The date on which the given usage was incurred.
brd_arrow.gif usage_time string The time on which the given usage was incurred.
brd_arrow.gif units double The number of units incurred by the account holder.
brd_arrow.gif usage_units_description string The name used for the unit type with which this usage type is metered, E.g. minutes
brd_arrow.gif invoice_no long The Aria assigned ID of the invoice.
brd_arrow.gif telco_to string  
brd_arrow.gif telco_from string  
brd_arrow.gif specific_record_charge_amount double If the usage record was supplied to Aria in a pre-rated form.
brd_arrow.gif is_excluded string Specifies whether or not the given usage record was entirely and permanently excluded from any billing (invoicing) process.
brd_arrow.gif exclusion_comments string Comments entered to explain why the record was excluded from billing. Only recorded if is_excluded is true.
brd_arrow.gif comments string Comments entered while recording usage.
brd_arrow.gif pre_rated_rate double Rate entered while recording usage.
brd_arrow.gif qualifier_1 string The value of client-defined usage qualifier 1 for this usage record.
brd_arrow.gif qualifier_2 string The value of client-defined usage qualifier 2 for this usage record.
brd_arrow.gif qualifier_3 string The value of client-defined usage qualifier 3 for this usage record.
brd_arrow.gif qualifier_4 string The value of client-defined usage qualifier 4 for this usage record.
brd_arrow.gif recorded_units double The number of units recorded by the account holder.
brd_arrow.gif usage_rec_no long Aria-assigned usage record identifier.
brd_arrow.gif usage_parent_rec_no long Aria-assigned usage parent record identifier.
brd_arrow.gif usage_type_code string The usage type code of this record.
brd_arrow.gif client_record_id string If available, the client-defined usage code for this usage record.
brd_arrow.gif exclude_reason_cd long The reason why this usage record has been excluded from billing.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.