Skip to main content
Aria Knowledge Central

create_acct_universal_contract_m Guide

Creates a universal contract for a specified account holder.

API Specification:

create_acct_universal_contract_m

Required Fields:
  • <client_no>
  • <auth_key>
  • <act_no> or <client_acct_id>
  • <length_months> or <end_date>

Error Codes

Error Code/Description Additional Guidance

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>

25020: Illegal characters entered

Associated Inputs: All character field inputs like firstname lastname, dunning_group_name, comments, etc.


All character field inputs like <create_comments>, etc.

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


<start_date>, <end_date>, <length_months>

16018: Universal contract cannot be created because all Plan statuses on this account are Suspended, Pending Cancellation, Cancelled or Terminated.


 

16012: Contract end date is less than start date

Associated Inputs: date_range_start, date_range_end, start_date, end_date, length_months


<start_date>, <end_date>, <length_months>

16013: Unsupported contract type

Associated Inputs: contract_type_no, type_no


<type_no>

16029: The contract start date must be on or after the effective date of the account (account creation date, account start date or retroactive start date) covered by the contract.

Associated Inputs: contract_start_date, start_date


<start_date>

16031: duplicate client contract id.

Associated Input: client_contract_id, new client_contract_id


<client_contract_id>

16033: The contract end date cannot be earlier than today (whether provided as input or calculated based on the contract term and start date).


 

Additional Guidance:

Input Fields 
Field Name: Notes:
<type_no>
Allowable values
Values Description
2 Continue existing service without contract (default)
3 Renew existing contract automatically
6 Terminate service and billing
7 Terminate service and billing and prorate final invoice
  • Was this article helpful?