create_acct_universal_contract_m Guide

Last updated
Save as PDF

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>

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
9	Renew existing contract automatically with different duration.

<renewal_duration_type>

Indicates whether the contract renewal duration in length is based on months, weeks or days.

Allowable Values

Values	Description
1	Days
2	Weeks
3	Months

<duration_type>

Indicates whether the contract <duration_length> is based on months, weeks, or days.

Allowable Values

Values	Description
1	Days
2	Weeks
3	Months (default)

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>
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.	<start_date>, <end_date>, <length_months>, <renewal_duration_type>, <renewal_duration_length>
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>
16018: Universal contract cannot be created because all Plan statuses on this account are Suspended, Pending Cancellation, Cancelled or Terminated.
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).
16035: The renewal_end_date should not be on or before the initial contract period’s end date.	<renewal_end_date>
16036: When creating an auto renewal with a different duration (type 9), then please supply either the new renewal_end_date, or both the new renewal_duration_length and renewal_duration_type.	<type_no>
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.