Home > Aria Crescendo Documentation > Aria Crescendo core api > get_unbilled_usage_summary_m

get_unbilled_usage_summary_m

Returns all information related to summary value of unbilled usage on the account.

For error messages generated by this API, see get_unbilled_usage_summary_m Error Messages.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png 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.
required-icon.png master_plan_instance_id long 22 The Master Subscription plan instance number.
  OR      
  client_master_plan_instance_id string 100 Client-defined Master plan Subscription plan instance ID.
  plan_instance_no long 22 The Aria-assigned unique identifier of the plan instance (can be either a master or supplemental plan).
  OR      
  plan_no long 22 The unique plan identifier.
  OR      
  client_plan_instance_id string 100 The client-defined identifier of the plan instance (can be either a master or supplemental plan).
  usage_details_flag string 5 Flag when false will suppress the unbilled usage detail records. 

Allowable values for usage_details_flag

Values Description
true true
false (Default) false (Default)
  include_all_usage_unit_thresholds string 5 Flag decides whether to return values of all plans/usage types or not.  

Allowable values for include_all_usage_unit_thresholds

Values Description
true true
false (Default) false (Default)
  usage_type_no long 22 The Aria-assigned usage type number to set the threshold unit amount per specific usage type.
  OR      
  usage_type_cd string 22 Client-assigned identifier for the type to set the threshold unit amount per specific usage type. Either this field OR "usage_type_no" must be passed into the API to denote which usage type to set the threshold unit.
  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

Values Description
true Discarded usage records will be included
false (Default) Discarded usage records will not be included
  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.
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif 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.
currency_cd string The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
currency_name string Human-readable currency name, in English.
acct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
client_acct_id string Client-defined account identifier.
master_plan_instance_id long The Master Subscription plan instance number.
client_master_plan_instance_id string Client-defined Master plan Subscription plan instance ID.
plan_instance_no long The Aria-assigned unique identifier of the plan instance (can be either a master or supplemental plan).
mpi_mtd_threshold_amount double The month-to-date threshold amount which, when crossed over or under by the account's running month-to-date unbilled usage balance, triggers an email notification of such to the account holder (if client is configured for such notices).
mpi_ptd_threshold_amount double The billing-period-to-date threshold amount which, when crossed over or under by the account's running billing-period-to-date unbilled usage balance, triggers an email notification of such to the account holder (if client is configured for such notices).
client_mtd_threshold_amount double The month-to-date threshold amount which, when crossed over or under by the account's running month-to-date unbilled usage balance, triggers provisioning event notification of such to the client (if client is configured for receipt of such events).
client_ptd_threshold_amount double The billing-period-to-date threshold amount which, when crossed over or under by the account's running billing-period-to-date unbilled usage balance, triggers provisioning event notification of such to the client (if client is configured for receipt of such events).
mtd_balance_amount double The account's current month-to-date unbilled usage currency value.
ptd_balance_amount double The account's current billing-period-to-date unbilled usage currency value.
mpi_mtd_delta_sign string A symbolic indicator as to whether the value in parameter "mpi_mtd_delta_amount" is above, below, or equal to its associated threshold value.  

Allowable values for mpi_mtd_delta_sign

Values Description
+ The associated "_delta_amount" is OVER the associated "_threshold_amount".
- The associated "_delta_amount" is UNDER the associated "_threshold_amount".
= The associated "_delta_amount" is EQUAL TO the associated "_threshold_amount".
mpi_mtd_delta_amount double A symbolic indicator as to whether the value in parameter "mpi_mtd_delta_amount" is above, below, or equal to its associated threshold value.
mpi_ptd_delta_sign string A symbolic indicator as to whether the value in parameter "mpi_ptd_delta_amount" is above, below, or equal to its associated threshold value.  

Allowable values for mpi_ptd_delta_sign

Values Description
+ The associated "_delta_amount" is OVER the associated "_threshold_amount".
- The associated "_delta_amount" is UNDER the associated "_threshold_amount".
= The associated "_delta_amount" is EQUAL TO the associated "_threshold_amount".
mpi_ptd_delta_amount double A symbolic indicator as to whether the value in parameter "mpi_mtd_delta_amount" is above, below, or equal to its associated threshold.
client_mtd_delta_sign string A symbolic indicator as to whether the value in parameter "client_mtd_delta_amount" is above, below, or equal to its associated threshold value.  

Allowable values for client_mtd_delta_sign

Values Description
+ The associated "_delta_amount" is OVER the associated "_threshold_amount".
- The associated "_delta_amount" is UNDER the associated "_threshold_amount".
= The associated "_delta_amount" is EQUAL TO the associated "_threshold_amount".
client_mtd_delta_amount double The threshold amount of usage minus the unbilled amount of usage. Used in conjunction with the delta sign, which indicates if the value is above, below, or equal to the client's threshold amount for the month to date.
client_ptd_delta_sign string A symbolic indicator as to whether the value in parameter "client_mtd_delta_amount" is above, below, or equal to its associated threshold value.  

Allowable values for client_ptd_delta_sign

Values Description
+ The associated "_delta_amount" is OVER the associated "_threshold_amount".
- The associated "_delta_amount" is UNDER the associated "_threshold_amount".
= The associated "_delta_amount" is EQUAL TO the associated "_threshold_amount".
client_ptd_delta_amount double The threshold amount of usage minus the unbilled amount of usage. Used in conjunction with the delta sign, which indicates if the value is above, below, or equal to the client's threshold amount for the period to date.
unapp_svc_credit_bal_amount double The account's current unapplied usage currency value.
unapp_svc_credit_delta_sign string A symbolic indicator as to whether the value in parameter "unapp_svc_credit_delta_amount" is above, below, or equal to its initial value.  

Allowable values for unapp_svc_credit_delta_sign

Values Description
+ The associated "_delta_amount" is OVER the associated "_bal_amount".
- The associated "_delta_amount" is UNDER the associated "_bal_amount".
= The associated "_delta_amount" is EQUAL TO the associated "_bal_amount".
unapp_svc_credit_delta_amount double The amount of usage minus the amount of the service credit. Used in conjunction with the delta sign, which indicates if the value is above, below, or equal to the amount of the unapplied service credit.
unbilled_usage_rec hash  
brd_arrow.gif plan_instance_id long The Subscription plan instance number.
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 units double The number of units incurred by the account holder.
brd_arrow.gif specific_record_charge_amount double The rated monetary charge this record will be billed as
brd_arrow.gif pre_rated_rate double Rate entered while recording usage
brd_arrow.gif recorded_units double The number of units recorded by the account holder.
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 exclude_reason_cd long The reason why this usage record has been excluded from billing
brd_arrow.gif usage_rec_no long Aria-assigned usage record identifier.
brd_arrow.gif client_plan_instance_id string The client-defined identifier of the plan instance (can be either a master or supplemental plan).
unit_threshold_details hash  
brd_arrow.gif plan_no long Returns the number of plan no.
brd_arrow.gif usage_type_no long Returns the number of usage type.
brd_arrow.gif threshold_dest_type string Returns a string representing the threshold destination type either Account A or Client C.  

Allowable values for threshold_dest_type

Values Description
A It represents threshold destination type is Account.
C It represents threshold destination type is Client
brd_arrow.gif threshold_balance_type string Returns a string representing the threshold balance type either month-to-date or billing-period-to-date.  

Allowable values for threshold_balance_type

Values Description
MTD It represents threshold balance type is MTD.
PTD It represents threshold balance type is PTD.
brd_arrow.gif threshold_units double Returns the number of threshold units.
brd_arrow.gif usage_units_measured double Returns the number of usage units measured.
brd_arrow.gif plan_instance_no long The Aria defined unique identifier of the plan instance (can be either a master or supplemental plan).
brd_arrow.gif client_plan_instance_id string The client-defined identifier of the plan instance (can be either a master or supplemental plan).
brd_arrow.gif usage_type_cd string Client-assigned identifier for the type of usage being recorded.
brd_arrow.gif threshold_levels hash  
brd_arrow.gif level_no long Returns the threshold level for the threshold_units
brd_arrow.gif threshold_value double Returns the threshold percentage value against the level_no
brd_arrow.gif delta_usage_units_bal double Returns the delta usge units balance.
brd_arrow.gif delta_usage_units_sign string A symbolic indicator as to whether the value in parameter "delta_usage_units_bal" is above, below, or equal to its associated threshold value.  

Allowable values for delta_usage_units_sign

Values Description
+ The associated "_delta_amount" is OVER the associated "delta_usage_units_bal".
- The associated "_delta_amount" is UNDER the associated "delta_usage_units_bal".
= The associated "_delta_amount" is EQUAL TO the associated "delta_usage_units_bal".
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.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®