update_acct_plan_unit_instance_m Guide

Last updated
Save as PDF

The update_acct_plan_unit_instance_m API can be used to either update fulfillment, or the supplemental field(s) on the unit instances of a plan.

API Specification:	update_acct_plan_unit_instance_m
Required Fields:	<client_no> <auth_key> <acct_no> or <client_acct_id> <plan_unit_inst_no> or <client_plan_unit_inst_id>

Additional Guidance

Input Fields

Field Name

Notes

<fulfillment_directive>

Allowable Values

Values	Description
1	Complete fulfillment with immediate affect. This would be accomplished by specifying fulfillment date in past or today or without any fulfillment date. (default)
2	Complete fulfillment with effective date specified in future. A user must specify service_fulfillment_date with this directive.
3	Remove the already assigned fulfillment date.

<plan_unit_inst_directive>

Allowable Values

Values	Description
1	Add Value
2	Replace Value
3	Remove Value

<do_write>

Allowable Values

Values	Description
true	true
false	false

<proration_invoice_timing>

Allowable Values

Values	Description
Null(default)	Honor Proration Invoice Timing configuration saved with the plan in the product catalog.
0	Indicates to generate the invoice immediately for the pro-rated charges.
1	Indicates to generate the invoice to the next anniversary date for the pro-rated charges.

Note: When a <proration_invoice_timing> input is not provided via API, the <proration_invoice_timing> value is set at the Product catalog level for that particular plan.

Output Fields

Field Name

Notes

<line_type>

Allowable Values

Values	Description
1	Recurring charge
2	Tax charge
3	Service credit
4	Coupon Credit
5	Activation Charge
6	Usage Charge
7	Recurring arrears charge
8	Order charge
9	Surcharge

Error Codes

Error Code/Description	Associated Inputs
1001: unexpected error
1004: authentication error	<client_no>, <auth_key>
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.	<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)	<acct_no>, <client_acct_id>
27003: invalid Plan unit instance	<plan_unit_inst_no>
27004: invalid Plan unit instance id	<client_plan_unit_inst_id>, <new_client_plan_unit_inst_id>
27012: Inactive Plan unit instance	<plan_unit_inst_no>
27013: Inactive Plan unit instance id	<client_plan_unit_inst_id>
27004: invalid Plan unit instance id	<client_plan_unit_inst_id>, <new_client_plan_unit_inst_id>
1033: a parameter that represents a true or false value contains invalid input	<do_write>
27017: Eligible service no/service id is required when Eligible fulfillment date/fulfillment directive is specified. Additional Comments: Service_fulfillment_date and fulfillment_directive were entered and the client_service_id or service_no was not entered.	<service_no>, <client_service_id>, <service_fulfillment_date>, <fulfillment_directive>
14036: Invalid client service id	<client_service_id>
1049: Billing or Plan changes not allowed due to the account status, Cannot add assignment for account with status code -99, Cannot add assignment for account with status code 0 Additional Comments: This message indicates a processing problem.
14077: Account status not support Plan provisioning. Additional Comment: The current status of the account does not allow provisioning.
14078: Master Plan Instance status not support Plan provisioning. Additional Comments: The current status of the Master Plan does not allow provisioning.
14079: Supplemental Plan instance status not support Plan provisioning.
5056: Invalid Plan unit instance directive	<fulfillment_directive>
5052: Product field is not mapped to the Plan you have specified. Alt: Invalid product field Additional Comments: The field is not mapped to the Plan.	<field_name>
5059: Invalid Product Field Value. Additional Comments: The value must be from the configured allowed values.	<field_value>
5064: product field is required and cannot be removed	<field_name>
5061: Number of Product Field value exceeds maximum number of allowed values. Additional Comments: The value must meet the configured maximum values.	<field_value>
5062: Number of Product Field values does not meet required minimum number of values. Additional Comments: The value must meet the configured minimum values.	<field_value>
27005: The service provided is not a fulfillment based service. Additional Comments: The entered service_no must be a a fulfillment based service.	<service_no>
27002: The fulfilment service provided is already invoiced.	<service_no>, <client_service_id>
1024: invalid date format Additional Comments: All date inputs must be in yyyy-mm-dd format.	<service_fulfillment_date>, <application_date>
27001: Invalid fulfilment directive	<fulfillment_directive>
27006:The fulfillment date should not be provided in the future for the immediate fulfillment directive	<service_fulfillment_date>
27007: The fulfillment date should not be provided before account creation date Additional Comments: The fulfillment_directive is immediate and service_fulfillment_date is before the acct.created date.	<service_fulfillment_date>, <fulfillment_directive>
27008: The fulfilment date should not be provided beyond billing period. The fulfillment date must not be outside the current billing	<service_fulfillment_date>
27010: The fulfilment date should be provided when fulfilment directive provided as futureThe fulfillment date cannot be blank when the fulfillment directive indicates a future fulfillment date	<service_fulfillment_date>, <fulfillment_directive>
27009: The fulfilment date should not be provided in past when fulfillment directive provided as future	<service_fulfillment_date>, <fulfillment_directive>
4027: Changes for this Plan were not saved because the collection attempt associated with this change was unsuccessful.