Usage Monitoring Class Fields
This article lists the fields included in Usage Monitoring Class Event payloads.
This article lists the fields included in Usage Monitoring Class Event payloads.
| Field Name | Description |
|---|---|
| version | Aria-assigned version number of this provisioning request's document format. Value in this version of the XML document is fixed at "2.0". |
| sender | Identifies the sender of the provisioning request. Valid values are "A"=Aria or "C"=Client. Currently only outbound requests from Aria-to-clients are supported, so the value of this field is effectively currently fixed as "A". |
| transaction_id | Aria-assigned provisioning request ID. |
| action | Identifies which action caused the provisioning request. "A"=add, "M"=modify. |
| class | Identifies the type of data being sent. "A"=account and MPI, "O"=order, "T"=financial transaction, "N"=account and MPI notification, "U"=usage monitoring. |
| auth_key | Client-specific authentication key. |
| client_no | Aria-assigned client identifier. |
| acct_no | Aria-assigned account identifier. |
| client_acct_id | Client account identifier. |
| userid | User ID associated with the account. |
| senior_acct_no | Account’s parent account number, if applicable. |
| master_plan_instance_no | Master plan instance number. |
| client_plan_instance_id | Client-assigned plan instance ID. |
| resp_level_cd | Account’s payment responsibility level code. |
| resp_plan_instance_no | Responsible plan instance number. |
| currency_cd | The ISO-compliant, lower-case 3-character code representing the currency used by this account, and within which all monetary-related values in subsequent elements within this document are represented. |
| currency_label_english | The ISO-compliant English-language label associated with the value in element "currency_cd". |
| mtd_cli_threshold_amt | The billing month-to-date monetary threshold value, assigned by the Aria client to this account, against which the "measured" balance of unbilled usage is to be compared for purposes of firing unbilled usage summary events, such as when the account's balance crosses over the threshold and when it crosses under. |
| mtd_acct_bal_true | The TRUE billing month-to-date current monetary value of all recorded-but-unbilled usage records on this account. This value IS NOT used as a comparison against element "mtd_cli_threshold_amt" in order to trigger "threshold crossing" events, but is provided here for notational purposes. |
| mtd_acct_bal_measured | The MEASURED billing month-to-date current monetary value of all recorded-but-unbilled usage records on this account. This value IS used as a comparison against element "mtd_cli_threshold_amt" in order to trigger "threshold crossing" events. |
| mtd_cli_threshold_delta_true | The amount via which element "mtd_acct_bal_true" differs from element "mtd_cli_threshold_amt". |
| mtd_cli_threshold_delta_meas | The amount via which element "mtd_acct_bal_measured" differs from element "mtd_cli_threshold_amt". |
| ptd_cli_threshold_amt | The billing period-to-date monetary threshold value, assigned by the Aria client to this account, against which the "measured" balance of unbilled usage is to be compared for purposes of firing unbilled usage summary events, such as when the account's balance crosses over the threshold and when it crosses under. |
| ptd_acct_bal_true | The TRUE billing period-to-date current monetary value of all recorded-but-unbilled usage records on this account. This value IS NOT used as a comparison against element "ptd_cli_threshold_amt" in order to trigger "threshold crossing" events, but is provided here for notational purposes. |
| ptd_acct_bal_measured | The MEASURED billing period-to-date current monetary value of all recorded-but-unbilled usage records on this account. This value IS used as a comparison against element "ptd_cli_threshold_amt" in order to trigger "threshold crossing" events. |
| ptd_cli_threshold_delta_true | The amount via which element "ptd_acct_bal_true" differs from element "ptd_cli_threshold_amt". |
| ptd_cli_threshold_delta_meas | The amount via which element "ptd_acct_bal_measured" differs from element "ptd_cli_threshold_amt". |
| acct_unapp_svc_credit_bal | The current total value of all remaining unapplied service credit on file for the account. |
| acct_unapp_svc_credit_delta | The amount via which element "ptd_acct_bal_measured" differs from element "acct_unapp_svc_credit_bal". |
| unbilled_usage_cli_th_adj_pct | The unbilled usage warning threshold percentage. |
| plan_no | Plan number associated with the usage unit threshold. |
| usage_type | Usage type code for the usage unit threshold. |
| notice_dest_type | Destination type for the usage threshold notification. |
| notice_balance_type | Balance type for the usage threshold notification. |
| threshold_units | Threshold units for the usage unit threshold. |
| usage_bal_true | The true balance of usage units for the account. |
| usage_bal_measured | The measured balance of usage units for the account, used for threshold comparisons. |
| level_no | Level number for the threshold level. |
| threshold_value | Threshold value for the specific threshold level. |
| delta_amt_true | The amount via which the true usage balance differs from the threshold value. |
| delta_amt_measured | The amount via which the measured usage balance differs from the threshold value. |
| event_id | Event ID that triggered the provisioning record, if applicable. |
| event_label | Label for the event that triggered the provisioning record, if applicable. |