Skip to main content
Aria Knowledge Central

update_acct_plan_m Guide

This API updates in the context of an account's plan instance that plan's rates, number of units, associated coupons, status, plan instance description, plan instance fields, usage management tracking, and/or service location.

API Specification: update_acct_plan_m
Required Fields:
  • <client_no>
  • <auth_key>
  • <acct_no> or <client_acct_id>
  • <plan_instance_no> or <client_plan_instance_id>

Additional Guidance

Input Fields
Field Name Notes
<dunning_state>
  • If you set this field to 1 (in progress), then you can specify one or more of the following dunning options available in these fields:
    • <degrade_date>;
    • <new_dunning_step>;
    • <config_dunning_late_fee_option>; and/or
    • <config_dunning_email_option>.
  • When you change the <dunning_state> to 0 (none), you should also pass in your chosen<plan_status> for the Master Plan Instance.

    Example: you may want to change the Master Plan Instance's status from -1 (suspended) to 1 (active).
  • If you set this field to 1 (in progress)but the Master Plan Instance does not have a balance due, then Aria will move the Master Plan Instance out of dunning on the date on which the next dunning step begins.

    This applies to Master Plan Instances associated with either payment type: net terms or electronic.
  • In addition to self-pay Master Plan Instances, dunning input arguments can now also now be used for parent-pay Master Plan Instances. Also note that when self-pay Master Plan Instance manually enters dunning via this API, all of their parent-pay Master Plan Instances will enter dunning. This is only applicable when entering the dunning. During this special process of entering parent-pay Master Plan Instance, the “config_dunning_late_fee_option and config_dunning_email_option” will only be applicable for self-pay Master Plan Instances and NOT to the parent-pay Master Plan Instance.
<assignment_directive>
Allowable Values
Values Description
1 (Default) Perform the requested plan change on the account's next scheduled billing anniversary date. The account does receive service under this plan (for plan assignments) or have it removed (for de-assignments) until that date. If a plan is being assigned, initial billing for a full period of the given plan is performed on the account's next scheduled anniversary date. No charge or credit proration effect. No new recurring charges or credits are generated when no proration occurs.
2 Perform the requested plan change immediately, 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. (default)
3 Perform the requested plan change immediately, 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.
4 Perform the requested plan change immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION.
5 Perform the requested plan change immediately, 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 supplemental plans.
6 Perform the requested plan change immediately, 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 supplemental plans.
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.
<do_write>
Allowable Values
Values Description
true true
false false
<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.
<dunning_state>
Allowable Values
Values Description
0 None
1 In Progress
<resp_level_cd>
Allowable Values
Values Description
1 Standard Self-Pay: default
2 Parent Pay: Usage accrues under self, invoices are generated per self's plan rules BUT are presented for payment against parent account'
3 Parent Usage & Pay: Usage accrues under parent and applied only to parent's plan rules and presented to parent for payment'
<usage_pooling>
Allowable Values
Values Description
true Usage pooling is enabled for this plan instance.
false (default) Usage pooling is not enabled for this plan instance.
<usage_threshold_applicability>
Allowable Values
Values Description
UT Usage Type
UP Usage Pool
<mp_surcharge_directive>
Allowable Values
Values Description
1 Apply surcharge to account
2 Remove surcharge from account
<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.
<plan_instance_supp_field_update_only>
Allowable Values
Values Description
  This input will not allow plan instance fields to be update for plans that are in a non-provisioned status
0 This input will not allow plan instance fields to be update for plans that are in a non-provisioned status
1 This input will allow plan instance fields to be update for plans that are in a non-provisioned status
<force_bill_date_reset>
Allowable Values
Values Description
  Reset the billing dates when the status changes from non-billable to billable depending on client parameter 'AUTO_RESET_MASTER_PLAN_BILLING_DATES_ON_NON_BILLABLE_TO_BILLABLE_MASTER_PLAN_STATUS_CHANGE' setting.
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.
<force_currency_change>
Allowable Values
Values Description
true When the plan being updated has a rate schedule with a different currency or the supplied alternate rate schedule has rates defined in different currency, a 'true' value will allow the currency change provided that there are no transactions (or only $0 transaction present) for that account and the new plan/alt rate schedule has the rates defined in the target currency.
false When the plan being updated has a rate schedule with a different currency the supplied alternate rate schedule has rates defined in different currency, a 'false' value will not allow the currency change.
<remove_pi_custom_rates>
Allowable Values
Values Description
true Remove the custom rates and use the default rates of the new rate schedule that you assigned.
false (default) Keep the custom rates currently assigned to the plan instance.
<config_dunning_late_fee_option>
Allowable Values
Values Description
1 Use dunning process configuration settings (default).
0 Do not use dunning process configuration/do not charge late fee.
<config_dunning_email_option>
Allowable Values
Values Description
1 Use dunning process configuration settings (default).
0 Do not use dunning process configuration/do not send email notification.
<recurring_processing_model_ind>
Allowable Values
Values Description
0 Cardholder-Initiated Transaction – Credentials on File: a credit card transaction initiated by the cardholder for a new order or a plan upgrade that uses a credit card that is currently stored in Aria. (Default)
1 Cardholder-Initiated Transaction: a credit card transaction initiated by the cardholder for a new account or creating an order that uses an alternate credit card that is not currently stored in Aria.
2 Merchant-Initiated Transaction – Standing Instruction – Recurring: a credit card transaction initiated by Aria’s clients for a recurring charge that uses a credit card that is currently stored in Aria.
3 Merchant-Initiated Transaction – Unscheduled Credentials on File: a credit card transaction initiated by Aria’s clients for a non-recurring charge (one-time order or plan upgrade) that uses a credit card that is currently stored in Aria.
<usage_accumulation_reset_months_renewal_option>
Allowable Values
Values Description
NULL or 1 Recurring / Auto Renew.(Default)
2 Single Use.
<include_plan_instance_queue>
Allowable Values
Values Description
false Scheduled plan changes will not be returned in the plan_instance_queue array (default).
true Scheduled plan changes will be returned in the plan_instance_queue array.
<transaction_type>
Allowable Values
Values Description
-1 Use client configuration settings for "Send Transaction Type as Recurring for Initial Request Where Possible" or "Send Transaction Type as Recurring for Subsequent Request" as applicable. (default)
1 (Chase) Single transaction mail/telephone order (MOTO) - Designates a transaction where the accountholder is not present at a merchant location and completes the sale over the phone or through the mail. The transaction is not for recurring services or products and does not include sales that are processed via an installment plan.
2 (Chase) Recurring Transaction - Designates a transaction that represents an arrangement between an accountholder and the merchant where transactions are going to occur on a periodic basis.
3 (Chase) Installment Transaction - Designates a group of transactions that originated from a single purchase where the merchant agrees to bill the accountholder in installments.
4 (Chase) Deferred Transaction - Designates a transaction that represents an order with a payment delayed for a specified amount of time.
5 (Chase) Secure Electronic Commerce Transaction - Designates a transaction completed via the Internet at a 3-D Secure capable merchant and in which the accountholder was fully authenticated. (examples: 3-D Secure includes Verified by Visa, Mastercard Identity Check, American Express SafeKey and Discover ProtectBuy.)
6 (Chase) Non-Authenticated Electronic Commerce Transaction - Designates a transaction completed via the Internet at a 3-D Secure capable merchant that attempted to authenticate the accountholder using 3-D Secure (examples: 3-D Secure includes Verified by Visa and Mastercard Identity Check.) Verified by Visa, Mastercard Identity Check, American Express SafeKey and Discover ProtectBuy transactions in the event of: * A non-participating issuer * A non-participating accountholder of a participating issuer * A participating issuer, but the authentication server is not available
7 (Chase) Channel Encrypted Transaction - Designates a transaction between an accountholder and a merchant completed via the Internet where the transaction includes the use of transaction encryption such as SSL (Secure Sockets Layer), but authentication was not performed. The accountholder payment data was protected with a form of Internet security, such as SSL, but authentication was not performed. For Discover, indicates an e-commerce Card Transaction with data protection in which ProtectBuy for Cardholder authentication was not used.
8 (Chase) Non-Secure Electronic Commerce Transaction - Designates a transaction between an accountholder and a merchant completed via the Internet where: * The transaction does not include the use of any transaction encryption such as SSL * Authentication is not performed * An accountholder certificate is not managed.
I (Chase) IVR Transaction (PINless Debit only) - Designates a transaction where the accountholder completes the sale via an interactive voice response (IVR) system.
R (Chase) Retail Transaction - Designates a transaction where the accountholder was present at a merchant location.
telephone (Vantiv) The transaction is for a single telephone order.
mailorder (Vantiv) The transaction is for a single mail order transaction.

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

Associated Inputs: auth_key, client_id, client_no

<client_no>, <auth_key>

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

<client_no>, <acct_no>, <plan_instance_no>, <alt_rate_schedule_no>, <plan_units>, <plan_status>, <plan_instance_field_directive assignment_directive>, <custom_rate_service_no>, <custom_rate_seq_no>, <custom_rate_from_unit>, <custom_rate_to_unit>, <custom_rate_per_unit offset_interval>, <force_master_bill_date_reset>, <dunning_state>, <resp_level_cd>, <usage_accumulation_reset_months>, <mp_surcharge_no>, <mp_surcharge_directive>, <mp_rate_schedule_no proration_invoice_timing>, <service_no>, <svc_location_no>, <dest_contact_no plan_instance_supp_field_update_only>, <force_bill_date_reset>, <recurring_processing_model_ind>, <usage_accumulation_reset_months_renewal_option>, <bill_lag_days>, <new_dunning_step>, <config_dunning_late_fee_option>, <config_dunning_email_option>, <resp_master_plan_instance_no>, <billing_group_no>, <offset_months>, <auto_offset_months_option>

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.

<effective_date>, <degrade_date>, <alt_proration_start_date>, <application_date>

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

<do_write>, <usage_pooling>, <force_currency_change>, <remove_pi_custom_rates>, <include_plan_instance_queue>

1035: invalid assignment directive, Invalid Assignment Directive: (assignment_directive)

Associated Inputs: master_plan_assign_directive, assignment_directive

<assignment_directive>

1064: Invalid surcharge directive

Associated Inputs: surcharge_directive

<mp_surcharge_directive>

4027: Changes for this Plan were not saved because the collection attempt associated with this change was unsuccessful.

Associated Inputs: do_collect

 

5004: invalid responsibility level cd

Associated Inputs: resp_level_cd

Additional Comments: Resp_level_cd=4 is not supported in Aria Billing Cloud.

<resp_level_cd>

5053: Missing values for required Plan instance field

Associated Inputs:   plan_instance_field_value

Additional Comments: This field is required, but did not have a value.

<plan_instance_field_value>

5059: Invalid Product Field Value.

Associated Inputs: field_value

Additional Comments: The value must be from the configured allowed values.

<plan_instance_field_value>

5060: Invalid Product Field Directive.

Associated Inputs: plan_instance_field_directive

<plan_instance_field_directive>

5061: Number of Product Field value exceeds maximum number of allowed values.

Associated Inputs: field_value

Additional Comments: The value must meet the configured maximum values.

<plan_instance_field_value>

5062: Number of Product Field values does not meet required minimum number of values.

Associated Inputs: field_value

Additional Comments: The value must meet the configured minimum values.

<plan_instance_field_value>

5063: Field cannot be added because it is not a Plan instance field.

Associated Inputs:  plan_instance_field_name

<plan_instance_field_name>

7034: invalid dunning state

Associated Inputs: dunning_state

<dunning_state>

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>

7038: A Billing Group is required for a Self-Pay Child Account's MPI.

 

14003: error assigning Supplemental Plan

Additional Comments: Unknown error while assigning a Supplemental Plan to an account. Contact Aria Customer support for assistance.

 

14012: Alternate rate schedule's currency does not match the account's currency.

Associated Inputs: alt_rate_schedule_no, client_alt_rate_schedule_id

Additional Comments: The alt_rate_schedule currency does not match the  account currency.

<alt_rate_schedule_no>, <client_alt_rate_schedule_id>

14019: usage_accumulation_reset_months must be from 0 to 99  Alt: invalid usage accumulation reset months value

Associated Inputs: usage_accumulation_reset_months

Additional Comments: The accumulation months is not between 0 and 99.

<usage_accumulation_reset_months>

14023: Offset Interval must be greater than zero

Associated Inputs: offset_interval

<offset_interval>

14024: Invalid Offset Interval and Assignment Directive combination.

Associated Inputs: offset_interval, assignment_directive

Additional Comments: Offset_interval only applies to the anniverary date.

<offset_interval>, <assignment_directive>

14025: Invalid do_write and assignment directive combination for queuing Plan.

Associated Inputs: assignment_directive, do_write

Additional Comments: Preview cannot be done for queued anniversary date cases.

<assignment_directive>, <do_write>

14026: The Effective Date must be in the future, "YYYY-MM-DD" format, and a valid date.

Associated Inputs: effective_date

<effective_date>

14033: Invalid Promo Code

Associated Inputs: promo_cd

<promo_cd>

14036: Invalid client service id

Associated Inputs: client_service_id, client_plan_instance_service_id, client_percent_eval_service_id, custom_rate_client_service_id

<custom_rate_client_service_id>, <client_service_id>

14039: Invalid client rate schedule id

Associated Inputs: client_alt_rate_schedule_id, rollover_client_rate_sched_id

<client_alt_rate_schedule_id>

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.

<resp_master_plan_instance_no>, <resp_client_master_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

<resp_client_master_plan_instance_id>

14059: The senior Master Plan Instance cannot be responsible for another Plan instance because it is set to Parent Pay

Associated Inputs: resp_master_plan_inst_no and client_resp_master_plan_inst_id, parent_acct_master_plan_instance_no

Additional Comments: The responsible Plan instance is a child pay,

<resp_master_plan_instance_no>, <resp_client_master_plan_instance_id>

14063: duplicate Plan instance client defined id.

Associated Inputs:client_plan_instance_id, new_client_plan_inst_id

<resp_client_master_plan_instance_id>

14068: invalid parent account Master Plan Instance number

Associated Inputs: parent_acct_mp_inst_no, parent_acct_master_plan_inst_id

<resp_master_plan_instance_no>, <resp_client_master_plan_instance_id>

14074: Plan status cannot be updated because the status of the existing Plan does not allow it

Associated Inputs: plan_status_cd

<plan_status>

14077: Account status not support Plan provisioning.

Associated Inputs: status_cd

Additional Comment: The current status of the account does not allow provisioning.

 

14078: Master Plan Instance status not support Plan provisioning.

Associated Inputs: status_cd

Additional Comments: The current status of the Master Plan does not allow provisioning.

<plan_status>

14079: Supplemental Plan instance status not support Plan provisioning.

Associated Inputs: supp_plan.status_cd

<plan_status>

14084: Invalid rate schedule. Please verify start date and end date of provided rate schedule.

Associated Inputs: alt_rate_schedule_no, alt_rate_schedule_id

<alt_rate_schedule_no>, <client_alt_rate_schedule_id>

14086: Plan Units cannot be below the minimum required units for this child Plan.

Associated Inputs: plan_units

<plan_units>

14087: The maximum number of allowable units has been exceeded.

 

14094:Invalid Plan Instance Status CD.

Associated Inputs: plan_status_cd

<plan_status>

14098: Invalid proration invoice timing

Associated Inputs: mp_proration_invoice_timing, proration_invoice_timing

<proration_invoice_timing>

14112 Cannot update/replace/cancel any queued Plan instance which is in queued assignment

Associated Inputs: plan_instance_no, client_plan_instance_id

<plan_instance_no>, <client_plan_instance_id>

14108 Plan cannot be queued because parent Plan instance's status is non-provisioned

Associated Input: assignment_directive

<assignment_directive>

14109 Plan cannot be queued because Master Plan Instance is in dunning or has completed dunning(i.e., dunning state is 'In Progress' or 'Completed')

Associated Input: assignment_directive

<assignment_directive>

14133: Self-pay MPI cannot be converted to parent-pay as it is currently in dunning or completed dunning without exiting.

Additional Comments: MPIs that are in dunning or have completed dunning without exiting successfully are not displayed, because they cannot be converted from self-pay to parent-pay while in this state. The MPIs that are in dunning are NNNNN, NNNNN, NNNNN, etc.

 

14134: Please apply outstanding manually applicable payments before modifying payment responsibility..

 

14135: The Responsible Master Plan Instance provided is queued for assignment and not allowed to be used for payment responsibility.

 

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

 

14137: To permit usage pooling on plans the invoice settings parameter 'Allow MPI Level Usage Pooling' needs enabling.

 

14300: Cannot force currency change while account has Master Plan / Supplemental Plans that do not have an available rate schedule in the target currency

Associated Input: force_currency_change

<force_currency_change>

14302: Pending Invoices must be discarded prior to forcing a currency change.

Associated Input: force_currency_change

<force_currency_change>

14303: Surcharges must be discarded or voided prior to forcing a currency change.

Associated Input: force_currency_change

<force_currency_change>

14304: Rated but unbilled usage records must be discarded prior to forcing a currency change.

Associated Input: force_currency_change

<force_currency_change>

14305: Discounts (flat rate) or Coupons in an existing currency must be discarded or voided prior to forcing a currency change.

Associated Input: force_currency_change

<force_currency_change>

14306: Pending Orders in an existing currency must be discarded or voided prior to forcing a currency change.

Associated Input: force_currency_change

<force_currency_change>

14307: Force currency change not allowed with the supplied assignment directive.

Associated Input: force_currency_change

<force_currency_change>

14310: Enter a Bill Lag days between +/- Plan's Billing Interval.

Additional Comments: Invalid input: For bill lag days, Enter a number between +billing interval and - billing interval days.

<bill_lag_days>

14311: Enter a Bill Lag days less than/equal to Plan's Billing Interval.

Additional Comments: Invalid input: For bill lag days, Enter a number less than/equal to billing interval days.

<bill_lag_days>

14313: There are threshold billing rules attached to this account that will need to be removed prior to changing currency since they are not in the future currency.

Associated Input: force_currency_change

<force_currency_change>

14314: There is an active rollover contract for existing currency and it should be cancelled or terminated before proceeding.

Associated Input: force_currency_change

<force_currency_change>

14402: Usage Pooling is not allowed when the Rating Model rates usage on a ‘per record’ basis.

<force_currency_change>

15001: invalid coupon code

Associated Inputs: coupon_codes

<coupon_codes>

15002: coupon expired

Associated Inputs: coupon_codes, coupon_cd

<coupon_codes>

15006: Duplicate surcharge number in input

Associated Inputs: acct_surcharges, mpi_surcharges, mp_surcharge_no

<mp_surcharge_no>

15008: Invalid surcharge rate schedule no

Associated Inputs: rate_schedule_no, mp_rate_schedule_no

<mp_rate_schedule_no>

15009: Invalid surcharge number

Associated Inputs: surcharge_no, mp_surcharge_no

<mp_surcharge_no>

15011: The coupon code provided for this account or Master Plan does not match its specified Coupon Applicability Scope, which determines whether the coupon is available at the account level, the Master Plan Instance level, or both.

Associated Inputs: coupon_cd

<coupon_codes>

15012: Coupon code has already been applied and cannot be used again.

Associated Inputs: coupon_codes

<coupon_codes>

15013: The surcharge provided for this Account or Master Plan does not match its specified Surcharge Applicability Scope, which determines whether the surcharge is available at the account level, Master Plan Instance level or both.

Associated Inputs: mpi_surcharges, mp_surcharge_no

<mp_surcharge_no>

15014: Duplicate Surcharges found.

Associated Input: mp_surcharge_no

<mp_surcharge_no>

15015: Surcharge can't be assigned because its application scope is payment method

Associated Inputs: mpi_surcharges, mp_surcharge_no

<mp_surcharge_no>

16021: The currency for the contract completion rollover target rate schedule must match the currency on the account.

Associated Inputs: rollover_rate_sched_no/rollover_client_rate_sched_id

 

23013: Invalid usage threshold applicability

Associated Inputs: usage_threshold_applicability

Additional Comments: The usage_threshold_applicability is not in, "ut" or "up".

<usage_threshold_applicability>

26010: Invalid billing group number

Associated Inputs: billing_group_no

<billing_group_no>

26012: Invalid client-defined billing group ID.

Associated Inputs: client_billing_group_id

<client_billing_group_id>

26030: The dunning state of the Master Plan Instance cannot be updated to In Progress because no applicable dunning process was found. Please review the dunning processes defined for the appropriate dunning group, Plan, payment method, and/or the client-default to ensure a dunning process exists for this scenario.

Associated Inputs: dunning_state

<dunning_state>

26046: Invalid dunning step. The dunning step does not exist in the dunning process configuration.

 

26048: The Responsible Master Plan Instance cannot be changed for this Parent-pay Master Plan Instance since it is in dunning or has completed dunning without exiting successfully as a result of an unpaid balance transfer.

 
  • Was this article helpful?