Home > Aria6 User Documentation > Aria6 core api > get_unbilled_usage_summary
get_unbilled_usage_summary
get_unbilled_usage_summary
Table of contents
- Input Arguments
- Allowable values for include_all_usage_unit_thresholds
- Allowable values for retrieve_excluded_usage
- Output Arguments
- Allowable values for acct_mtd_delta_sign
- Allowable values for acct_ptd_delta_sign
- Allowable values for client_mtd_delta_sign
- Allowable values for client_ptd_delta_sign
- Allowable values for unapp_svc_credit_delta_sign
- Allowable values for threshold_dest_type
- Allowable values for threshold_balance_type
- Allowable values for delta_usage_units_sign
Returns all information related to summary value of unbilled usage on the account.
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. | ||||||
| usage_details_flag | string | 10 | Flag when false will suppress the unbilled usage detail records. | |||||||
| 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
|
|||||||
| plan_no | long | The unique plan identifier. | ||||||||
| usage_type_no | long | The Aria-assigned usage type number to set the threshold unit amount per specific usage type. | ||||||||
| OR | ||||||||||
| usage_type_code | 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 | 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. | ||||||||
| 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_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). | ||||||||
| acct_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. | ||||||||
| acct_mtd_delta_sign | string | A symbolic indicator as to whether the value in parameter "acct_mtd_delta_amount" is above, below, or equal to its associated threshold value.
Allowable values for acct_mtd_delta_sign
|
||||||||
| acct_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 account's threshold amount for the month to date. value. | ||||||||
| acct_ptd_delta_sign | string | A symbolic indicator as to whether the value in parameter "acct_ptd_delta_amount" is above, below, or equal to its associated threshold value.
Allowable values for acct_ptd_delta_sign
|
||||||||
| acct_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 account's threshold amount for the billing period to date. value. | ||||||||
| 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
|
||||||||
| 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
|
||||||||
| 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
|
||||||||
| 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_recs | hash | |||||||||
| 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. | ||||||||
| units |
double | The number of units incurred by the account holder. | ||||||||
| specific_record_charge_amount |
double | The rated monetary charge this record will be billed as | ||||||||
| pre_rated_rate |
double | Rate entered while recording usage | ||||||||
| recorded_units |
double | The number of units recorded by the account holder. | ||||||||
| usage_parent_rec_no |
long | Aria-assigned usage parent record identifier. | ||||||||
| usage_type_code |
string | The usage type code of this record | ||||||||
| exclude_reason_cd |
long | The reason why this usage record has been excluded from billing | ||||||||
| usage_rec_no |
long | Aria-assigned usage record identifier. | ||||||||
| unit_threshold_details | hash | |||||||||
| plan_no |
long | Returns the number of plan no. | ||||||||
| usage_type_no |
long | Returns the number of usage type. | ||||||||
| threshold_dest_type |
string | Returns a string representing the threshold destination type either Account A or Client C.
Allowable values for threshold_dest_type
|
||||||||
| 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
|
||||||||
| threshold_units |
double | Returns the number of threshold units. | ||||||||
| usage_units_measured |
double | Returns the number of usage units measured. | ||||||||
| threshold_levels |
hash | |||||||||
| level_no |
long | Returns the threshold level for the threshold_units | ||||||||
| threshold_value |
double | Returns the threshold value against the level_no | ||||||||
| delta_usage_units_bal |
double | Returns the delta usge units balance. | ||||||||
| 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
|
- © Copyright 2023 Aria Developer Central