Skip to main content
Aria Knowledge Central

edit_acct_plan_queued_changes_m Guide

Use this API to modify all existing queued plan changes for an account, or to modify queued plan changes for a specific plan instance. If a plan instance or queue id is not specified, then the API will process all queued plan changes for the account. Supported actions include immediately executing a queued plan(s) change, deleting a queued plan(s) change, or modifying the effective date of a queued plan(s) change.

API Specification: edit_acct_plan_queued_changes_m
Required Fields:
  • <client_no>
  • <auth_key>
  • <acct_no> or <client_acct_id>
  • <edit_queued_changes> (array)
    • <queue_edit_directive>

Additional Guidance

Input Fields
Field Name Notes
<assignment_directive>

The rule to be applied to this assignment request, governing the proration rule is applied.

This applies to a Plan with a daily, weekly,monthly, or any other billing interval.

Default behavior is to make the Plan change (assign/deassign a plan to an account, change units on an existing plan, etc.) immediately based on client-defined default proration rule, resulting in appropriate prorated charge and credit. Not honored when queue_edit_directive = 0 (delete queue), or 1 (execute immediate)

Allowable Values
Values Description
7 Perform the requested plan change on the specified effective_date, honoring the client's pre-configured universal rule for performing or not performing proration as a result of a mid-billing-period plan assignment or de-assignment. No new recurring charges or credits are generated when no proration occurs.
8 Perform the requested plan change on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing NO PRORATION. No new recurring charges or credits are generated when no proration occurs.
9 Perform the requested plan change on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION.
10 Perform the requested plan change on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CHARGES ONLY. NOTE: This value is not permitted when cancelling a supplemental plan.
11 Perform the requested plan change on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CREDITS ONLY. NOTE: This value is not permitted when assigning a supplemental plan.
<queue_edit_directive>
Allowable Values
Values Description
0 Delete queued plan change
1 Execute queued plan change immediately
2 Change the effective date of the queued plan change
<invoice_unbilled_usage>
Allowable Values
Values Description
NULL (Default) This option takes value for client parameter (INVOICE_UNBILLED_USAGE_DURING_PRORATION).
false Do not allow invoicing the unbilled usage during mid-term plan termination.
true Allow invoicing the unbilled usage during mid-term plan termination.
<force_master_bill_date_reset>
Allowable Values
Values Description
  If this value is left empty, the client-level setting (Sync_mstr_bill_dates_on_1st_supp) will take effect.
1 Do not reset master plan billing dates.
2 Reset master plan billing dates if master plan is "free", the account has no "billable" supplemental plans, and the newly-assigned supplemental plan is "billable.
3 Reset master plan billing dates if master plan is "free" and the account has no active supplemental plans.
<force_bill_date_reset>
Allowable Values
Values Description
0 Do not reset the billing dates for this plan.
1 Reset the billing anniversary date to coincide with the status change date.
2 Reset the billing anniversary date to coincide with the current anniversary date.
3 Reset the billing anniversary date to coincide with next future anniversary date by offsetting with its billing interval.
<do_write>
Allowable Values
Values Description
true (Default) true (Default)
false false
Output Fields
Field Name Notes
<edit_queued_change_status_cd>
Allowable Values
Values Description
0 Deleted
1 Effective date modified
2 Executed successfully
3 Failed to execute
<line_type>
Allowable Values
Values Description
1 Recurring Charge
2 Tax Charge
3 Service Credit
4 Coupon Credit
5 Activation Charge
6 Usage Charge

Error Codes

Error Code/Description Associated Inputs

1001: unexpected error

 

1004: authentication error

Associated Inputs: auth_key, client_id, client_no

<auth_key>, <client_id>, <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>, <account_no>, <client_acct_id>, <user_id>, <userid>, <parent_acct_no>

1016: invalid input

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

 
<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>

1024: invalid date format

Associated Inputs: bill_birthdate, birthdate, degrade_date, initial_credit_date, invoice_line_reversing_date, service_fulfillment_date, queue_date, start_bill_date, end_bill_date, start_date, end_date, stmt_birthdate, bill_birthdate

Additional Comments: All date inputs must be in yyyy-mm-dd format.

<bill_birthdate>, <birthdate>, <degrade_date>, <initial_credit_date>, <invoice_line_reversing_date>, <service_fulfillment_date>, <queue_date>, <start_bill_date>, <end_bill_date>, <start_date>, <end_date>, <stmt_birthdate>, <bill_birthdate>

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

<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>

3108: The invoice for this account cannot be generated at this time, since there is another invoice in progress for the same billing group.

 

7035: The Plan selected for update is a Master Plan. The force_master_bill_date_reset input can only be used in conjunction with Supplemental Plans. Please clear the value of force_master_bill_date_reset or input a Supplemental Plan.

Associated Inputs: force_master_bill_date_reset

<force_master_bill_date_reset>

7036: The Plan selected for update is a Supplemental Plan. The force_bill_date_reset input can only be used in conjunction with Master Plans. Please clear the value of force_bill_date_reset or input a Master Plan.

Associated Inputs: force_bill_date_reset

<force_bill_date_reset>

7037: The Plan selected for update is a Supplemental Plan. The force_bill_date_reset input can only be used in conjunction with a status change associated with a Master Plan. Please clear the value of force_bill_date_reset or remove the Supplemental Plan status change from the queue.

Associated Inputs: force_bill_date_reset

<force_bill_date_reset>

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>, <master_plan_instance_id>, <filter_plan_instance_no>, <percent_eval_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

<client_plan_instance_id>, <client_master_plan_instance_id>, <client_percent_eval_plan_instance_id>

14122: The assignment_directive provided is not valid for the queue_edit_directive specified

 

14128: Supplemental Plan instance cannot be executed immediately or the date cannot be changed to before the effective date for the corresponding parent Plan instance

 

14136: Offset months must be greater than or equal to 0.

 

24011: Invalid Queue Edit Directive.

 

24012: Duplicate of Queue Id / Plan Instance No / Client Plan Instance Id found.

 

24014: Not a valid Queue Id.

 
  • Was this article helpful?