get_unbilled_usage_summary_m Guide
- Last updated
-
-
Save as PDF
Returns all information related to summary value of unbilled usage on the account.
|
API Specification:
|
get_unbilled_usage_summary_m |
|
Required Fields:
|
- <client_no>
- <auth_key>
- <acct_no> or <client_acct_id>
- <master_plan_instance_id> or client_master_plan_instance_id>
|
Additional Guidance
Input Fields
| Field Name |
Notes |
| <usage_details_flag> |
Allowable Values
| Values |
Description |
| true |
true |
| false (Default) |
false (Default) |
|
| <include_all_usage_unit_thresholds> |
Allowable Values
| Values |
Description |
| true |
true |
| false (Default) |
false (Default) |
|
| <retrieve_excluded_usage> |
Allowable Values
| Values |
Description |
| true |
Discarded usage records will be included |
| false (Default) |
Discarded usage records will not be included |
|
Output Fields
| Field Name |
Notes |
| <mpi_mtd_delta_sign> |
Allowable Values
| 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_sign> |
Allowable Values
| 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_sign> |
Allowable Values
| 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_sign> |
Allowable Values
| 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". |
|
| <unapp_svc_credit_delta_sign> |
Allowable Values
| 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". |
|
| <threshold_dest_type> |
Allowable Values
| Values |
Description |
| A |
It represents threshold destination type is Account. |
| C |
It represents threshold destination type is Client |
|
| <threshold_balance_type> |
Allowable Values
| Values |
Description |
| MTD |
It represents threshold balance type is MTD. |
| PTD |
It represents threshold balance type is PTD. |
|
| <delta_usage_units_sign> |
Allowable Values
| 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". |
|
|
<unbilled_usage_rec> (array)
- <usage_record_pre_taxed_ind>
|
Allowable Values
| Values |
Description |
| 1 |
Client calculated taxes provided as input to Aria. |
| 2 |
Aria calculated taxes using Aria's internal tax method. |
|
|
<unbilled_usage_rec> (array)
- <usage_record_tax_inclusive_ind>
|
Allowable Values
| Values |
Description |
| 0 |
Usage amount is Tax Exclusive. |
| 1 |
Usage amount is Tax Inclusive. |
|
|
<usage_record_tax_details> (array)
|
Allowable Values
| Values |
Description |
| 0 |
Federal |
| 1 |
State/Province |
| 2 |
County |
| 3 |
City |
| 4 |
Unincorporated Area |
| 5 |
District |
|
|
<usage_record_tax_details> (array)
|
Allowable Values
| Values |
Description |
| 0/null |
Tax record has not been excluded from billing. |
| 1 |
Tax record has been excluded from billing. |
|
Error Codes
| Error Code/Description |
Associated Inputs |
|
|
|
1004: authentication error
Associated Inputs: auth_key, client_id, client_no
|
<auth_key>, <client_no> |
1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id)
Associated Inputs: acct_no, account_no, client_acct_id, user_id, userid, parent_acct_no
|
<acct_no>, <client_acct_id> |
14046: If you passed in an invalid plan_instance_no, this message will appear: "Invalid Plan instance number". If you passed in an invalid master_plan_instance_id, this message will appear: "Invalid master_plan_instance_id".
Associated Inputs: plan_instance_no, master_plan_instance_id, filter_plan_instance_no, percent_eval_plan_instance_no, client_plan_instance_id
Additional Comments: The plan_instance_no or master_plan_instance_id must belong to the account, or it is invalid. The percent_eval_plan_instance_no must belong to the account and also to the MPI given in input.
|
<master_plan_instance_id>, <client_master_plan_instance_id>, <plan_instance_no>, <client_plan_instance_id> |
14047: If you passed in an invalid client_plan_instance_id, this message will appear: "Invalid client Plan instance identifier". If you passed in an invalid client_master_plan_instance_id , this message will appear: "Invalid client_master_plan_instance_id".
Associated Inputs: client_plan_instance_id, client_master_plan_instance_id, client_percent_eval_plan_instance_id
|
<master_plan_instance_id>, <client_master_plan_instance_id>, <plan_instance_no>, <client_plan_instance_id> |
1033: a parameter that represents a true or false value contains invalid input
Associated Inputs: alt_collect_on_approve, alt_send_statement_on_approve, cancel_orders_on_discard, cascade_action, do_auto_discard, do_collect, change_status_after_coll, reset_dates_after_status, disable_existing_on_update, do_write, exclude_terminated_plan_inst, include_all_rate_schedules, include_plan_hierarchy, retrieve_bundled_nso, retrieve_included_nso, include_translations, include_inactive_items, include_invoice_activity_eligibility, include_rs_summary, include_translations, include_service_supp_fields/include_product_fields/, include_plan_instance_fields/include_plan_services/, include_surcharges, include_void_transactions, include_voided, invoice_unbilled_usage, is_unlinked_refund, record_cc_on_auth_failure, retrieve_excluded_usage, send_email, usage_pooling, do_write
|
<usage_details_flag>, <include_all_usage_unit_thresholds>, <retrieve_excluded_usage> |
1067: Locale no does not exist in the system.
Associated Inputs: locale_no, master_plan_instance_no
|
<locale_no> |
1066: Locale name does not exist in the system.
Associated Inputs: locale_name
|
<locale_no> |
20004: Invalid Usage Type Code
Associated Inputs: specified_usage_type_code
|
<usage_type_cd> |
