Skip to main content
Aria Knowledge Central

bulk_cancel_order_m Guide

Cancels one or more account holder's order(s) and stops all billing related to the order(s) if the following are true: The order(s) has not yet been billed and the order has not already been canceled. Please note that save/commit of cancelled orders will be at the bulk_input_idx level.

API Specification:

bulk_cancel_order_m

Required Fields:
  • <client_no>
  • <auth_key>
  • <bulk_input_idx>
  • <acct_no> or <client_acct_id>

Error Codes:

Error Code/Description Associated Inputs

1001: unexpected error


 

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>

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


<acct_no>, <order_status_directive>

3016: could not cancel order - order already cancelled or succesffuly billed


 

3032: Invalid Order Number


 

3104: No eligible or matching orders found to cancel

Associated Inputs: account_order[]


<account_order>

3105: Invalid Client Order Identifier

Associated Inputs: account_order > client_order_id


<account_order>, <client_order_id>

14053: Invalid Master Plan Instance number

Associated Inputs: master_plan_instance_no


<master_plan_instance_no>

14054: Invalid client Master Plan Instance identifier

Associated Inputs: client_master_plan_instance_id


<client_master_plan_instance_id>

Additional Guidance:

Input Fields

Field Name: Notes:
<order_status_directive>

Defines the eligible orders for cancellation based on status.

Allowable values:

Values Description
0 All Eligible
1 Order Held
2 Order Placed
3 Order Filled
4 Order Held and Order Placed only (default)
5 Order Held and Order Filled only
6 Order Placed and Order Filled only
  • Was this article helpful?