Skip to main content
Aria Knowledge Central

get_acct_plan_unit_instance_all_m Guide

Array of all Plan Unit Instances and related Plan Unit Instance fields for all the plans under the account.

API Specification: get_acct_plan_unit_instance_all_m
Required Fields:
  • <client_no>
  • <auth_key>
  • <acct_no> or <client_acct_id>

Additional Guidance

Input Fields
Field Name Notes
Allowable values
Values Description
0 All Statuses (default)
1 Null i.e. No Fulfillment Date
2 Queued i.e. Queued for Invoicing
3 Invoiced
Allowable values
Values Description
0 All Statuses (default)
1 Active
2 Inactive
3 Queued
Allowable values
Values Description
0 Default i.e. Output fulfillment based and non-fulfillment based services.
1 output only fulfillment based services.

Output Fields

Field Name Notes
Allowable values
Values Description
Q Contains Queued Unit Instances
A All Unit Instances are Assigned
Allowable values
Values Description
M Master
S Supplemental
Allowable values
Values Description
1 Null i.e. No Fulfillment Date
2 Queued i.e. Queued for Invoicing
3 Invoiced

Error Codes

Error Code/Description Associated Inputs

1001: unexpected error


1002: no data found


1004: authentication error

Associated Inputs: auth_key, client_id, client_no

<auth_key>, <client_no>

1016: invalid input, acct_no: (acct_no) is not a valid long, assignment_directive: (assignment_directive) is not a valid long, “billing_group_no: (billing_group_no) is not a valid long, threshold_billing_rule_no: (threshold_billing_rule_no) is not a valid long

Associated Inputs: alt_service_no_to_apply, assignment_directive, auto_skip_to_next_bill_date, client_billing_group_id, custom_rate_service_no/custom_rate_client_service_id, plan_instance_no, plan_instance_service_no, client_plan_instance_id, client_plan_instance_service_id, plan_instance_no, plan_instance_service_no, client_plan_instance_id, client_plan_instance_service_id, plan_instance_service_no, eligible_plan_no, eligible_service_no, email, force_master_bill_date_reset, fulfillment_only, include_master_plans, include_supp_plans, include_billing_groups, include_payment_methods, include_master_plans, include_supp_plans, include_billing_groups, include_payment_methods, invoice_no, length_months, end_date, limit, limit_records, modify_directive, contract_plan_instances_update, modify_directive, contract_plan_instances_update, offset, percent_amount, percent_eval_plan_instance_no, client_percent_eval_plan_instance_id, percent_eval_service_no, client_percent_eval_service_id, phone_ext, work_phone_ext, plan_unit_inst_status_cd, plan_units, reason_code, start_date, end_date, start_date, end_date, status_cd, acct_no, assignment_directive, billing_group_no, threshold_billing_rule_no

Additional Comments:  This error can be caused by the wrong type of input, for example, text in a numbers-only field, an  or specifying a value other than one of the documented allowable values.

  • For the get_order_m API, this is the error code returned when the user passes an invalid order value for the <status_filter_cd> input which is other than the allowed values (0/null, 1, 2, 3, 4 and 5).
  • For the bulk_cancel_order_m API, invalid input can occur with the <order_status_directive> argument. Allowed values are 0, 1, 2, 3, 4/null, 5 and 6.
  • For the get_acct_coupon_details_m API, invalid input can occur with the <include_all_active> input parameter (values are 0, 1 or NULL).

Alternate Message Output

1016: username cannot be longer than 30 characters
1016: first_name cannot be longer than 30 characters
1016: last_name cannot be longer than 30 characters

Associated APIs: create_user_m, update_user_m

Associated Inputs: username, first_name, last_name

<plan_instance_no>, <plan_instance_no>, <client_plan_instance_id>, <fulfillment_only>, <plan_unit_inst_status_cd>, <plan_units>, <acct_no>

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.

<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


27003: invalid Plan unit instance

Associated Inputs: plan_unit_inst_no


27004: invalid Plan unit instance id

Associated Inputs: client_plan_unit_inst_id, new client_plan_unit_inst_id


27011: The API is not supported because your client parameter Enable Plan Unit Instances is set to False. Please contact Aria Customer Support with questions about the Enable Plan Unit Instances client parameter.

Associated Input: client_no

  • Was this article helpful?