Skip to main content
Aria Knowledge Central

get_usage_summary_by_type_m Guide

Returns the usage records associated with a specified account for a particular date range.

API Specification: get_usage_summary_by_type_m
Required Fields:
  • <client_no>
  • <auth_key>
  • <acct_no> or <client_acct_id>
  • <master_plan_instance_no> or <client_master_plan_instance_id>

Additional Guidance:

Input Fields
 

Field Name:

Notes:

<date_filter_start_date> date_filter_start_date is required if billing_period_flag is not set to 1.
<billing_period_flag> date_filter_start_date is required if billing_period_flag is not set to 1.
<billed_filter>
Allowable Values
Values Description
0 Return both billed and unbilled usage records (default)
1 Billed usage records only
2 Unbilled usage records only
<billing_period_flag>
Allowable Values
Values Description
0 billing cycle starting with the date specified in the date_filter_start_date field (default)
1 current billing cycle only
<retrieve_excluded_usage>
Allowable Values
Values Description
true Discarded usage records will be included
false Discarded usage records will not be included (default)
  • Was this article helpful?