Skip to main content
Aria Knowledge Central

update_acct_complete_m Guide

This API allows you to update a broad range of information associated with an account. This information includes:

  • User ID and related login information: Add or change user ID, password and secret question information for the account.
  • Contact information: Add or change account, billing and statement contact information, including name, address, email and phone number.
  • Statement information: Specify the statement notification method and format, such as HTML or PDF, and the associated template used to generate a statement for this account.
  • Parent and child plan assignment: Specify which plans on this account are parent plans or child plans
  • and the relationships between them. You can also assign standard and custom rate schedules to plans on the account.
  • Collection, dunning and functional account group assignment: Specify the collection, dunning or functional account groups to which this account is assigned.
  • Payment method/term and taxation status: Specify if the account payment method is a credit card, direct debit, or a payment term, an whether the account is tax-exempt.
  • Invoicing/billing information: Specify proration policy and account or billing start/end dates.
  • Surcharges: Specify the type and amount of surcharges applied to the account.
  • Usage: Specify whether unbilled usage is invoiced and if usage pooling is enabled for the account,
  • Coupons and promotions: Specify coupons and promotions to be applied to the account.
  • Revenue recognition: Specify the revenue recognition profile assigned to this account.

Any field on an account can be updated. You can clear the value in any field with a type of "string", provided that the field is nullable for an account, by entering a '~' in that field.

API Specification: update_acct_complete_m
Required Fields:
  • <client_no>
  • <auth_key>
  • <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


 

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


 

1010: missing required parameters, Missing input: (object-name) is required with assignment_directive ($AriaNo)

Associated Inputs: all required inputs, typically one of the following: custom_rate_per_unit, custom_rate_seq_no, status_cd, dunning_state, userid, acct_no, client_acct_id, assignment_directive, billing_group_no, client_billing_group_id, threshold_billing_rule_no, client_threshold_billing_rule_id

Alternate Message Output

1010: username is required
1010: first name is required
1010: last name is required
1010: email is required
1010: roles are required

Associated APIs: create_user_m, get_user_details_m, delete_user_m, update_user_m

Associated Inputs: username, first_name, last_name, email, role_no


 

1012: invalid input format

Associated Inputs: client_receipt_id

Additional Comments: This value must be unique for a client and must be alphanumeric. A previously used client_receipt_id can be reused if all those previous calls have failed (with an error_code other than 0/OK), if the client parameter NEVER_ALLOW_USED_RECEIPT_ID = FALSE.

Alternate Message Output

1012: email is invalid
1012: include_archived_user is invalid
1012: status is invalid

Associated APIs: create_user_m, get_users_m, update_user_m

Associated Inputs: email, include_archived_user, status


 

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


 

1017: invalid password

Associated Inputs: password

Additional Comments: The password does not meet the parameters set by the client.


 

1023: userid is missing or invalid

Associated Inputs: user_id

Additional Comments: You must enter a user_id if the client is not enabled to automatically generate them.


 

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.


 

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


 

1034: there is no data to be modified


 

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

Associated Inputs: master_plan_assign_directive, assignment_directive


 

1037: invalid account group directive

Associated Inputs: collection_acct_grp_directive, functional_acct_grp_directive


 

1046: invalid tax exemption level code

Associated Inputs: tax_exemption_level

Additional Comments: Note that tax_exemption_level is only used with Aria's internal tax engine.


 

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

Associated Inputs: N/A

Additional Comments: This message indicates a processing problem.


 

1064: Invalid surcharge directive

Associated Inputs: surcharge_directive


 

1066: Locale name does not exist in the system.

Associated Inputs: locale_name


 

1067: Locale no does not exist in the system.

Associated Inputs: locale_no, master_plan_instance_no


 

1101: Credit-only proration is not valid in this case because there is a mandatory child Supplemental Plan that will be assigned and result in charges on the account.

Associated Inputs: master_plan_assign_directive


 

1108: Invalid billing group, collection group directive.


 

3003: could not create invoice

Additional Comments: Could not create a preview invoice due to account status, plan status, or other processing error. Please contact Aria Customer Support.


 

3017: pro-ration period cannot be greater than Plan billing interval


 

3018: invalid automatic offset months option


 

3098: Negative Charge Line Items are not allowed.


 

4006: invalid pay method or alternate pay method

Associated Inputs: alt_pay_method, pay_method_type, pay_method_type


 

4008: invalid expiration date

Associated Inputs: alt_pay_method, cc_expire_mm, cc_expire_yyyy, credit_expiry_date, pay_method_type

Additional Comments: Dates must be in yyyy-mm-dd format.


 

4009: invalid cc number

Associated Inputs: cc_number, alt_pay_method, cc_num, pay_method_type


 

4010: invalid bank draft info

Associated Inputs: bank_acct_no, bank_routing_no, alt_pay_method

Additional Comments:

  1. The client parameter BANK_DRAFT_INDICATOR must be enabled.
  2. Bank_acct_no and bank_routing_no are required.
  3. Valid bank_routing_no from Aria's ABA lookup in case of US address.
  4. Bank_routing_no must be numeric.
  5. For US, bank_routing_no should be 9 digits in length (left padded with zeros).
  6. Bank_routing_no must pass checksum validation.

 

4011: cc authorization failed

Associated Inputs: alt_pay_method, cc_number, cc_expire_mm, cc_expire_yyyy, pay_method_type

Additional Comments: $1 authorization has failed.


 

4017: duplicate payment method client defined id.

Associated Inputs: client_payment_method_id, new_client_payment_method_id

Additional Comments: This value must be unique at the client level.


 

4019: Invalid Bank Account Type.

Associated Inputs: alt_pay_method, bank_acct_type


 

4022: invalid cc id

Associated Inputs: pay_method_type, cc_id


 

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

Associated Inputs: do_collect


 

4032: cc_id is required.

Associated Inputs: cc_id, pay_method_type

Additional Comments: cc_id is required for this payment processor.


 

4044: Missing a required value. Please check that either bank_account_no, bank_routing_number or agreement_id is present.


 

5002: invalid account status code

Associated Inputs: status_cd


 

5003: invalid notify method

Associated Inputs: notify_method_no


 

5004: invalid responsibility level cd

Associated Inputs: resp_level_cd

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


 

5005: invalid parent account no

Associated Inputs: senior_acct_no


 

5008: invalid userid length

Associated Inputs: user_id

Additional Comments: This error is based on the client parameters MIN_USERID_LENGTH and MAX_USERID_LENGTH.


 

5009: userid contains illegal characters

Associated Inputs: user_id

Additional Comments: Only alphanumeric characters are allowed.


 

5010: userid is reserved

Associated Inputs: user_id

Additional Comments: You must select another user ID.


 

5011: userid is taken

Associated Inputs: user_id

Additional Comments: You must select another user ID.


 

5012: password is too short

Associated Inputs: password

Additional Comments: This error is based on the client parameter MIN_PASSWD_LENGTH.


 

5013: password is too long

Associated Inputs: password

Additional Comments: This error is based on the client parameter MAX_PASSWD_LENGTH.


 

5014: password contains invalid characters

Associated Inputs: password


 

5016: password not strong

Associated Inputs: password

Additional Comments: The password  must be at least eight characters in length and must contain at least one alphabetic and one numeric char.


 

5017: invalid iso country code

Associated Inputs country, bank_country_cd, bill_country


 

5018: account in uneditable status

Additional Comments: If the account is in an archived state, edit is not allowed.


 

5021: invalid test acct indicator

Associated Inputs: test_acct_ind


 

5024: number of supp field values exceeds maximum number of allowed values

Associated Inputs: supp_field_value

Additional Comments: The number of values given for a given field must meet the maximum values criteria set at configuration.


 

5026: supp field value already exists

Associated Inputs: supp_field_name

Additional Comments: The same name was provided more than once with the same value.


 

5030: Child account's Currency is not matching with Parent account's Currency

Associated Inputs: currency_cd


 

5031: Child account of this account cannot be set as its parent.

Associated Inputs: senior_acct_no

Additional  Comments: The given senior_acct_no must not be a child account.


 

5033: Invalid parent account user id.

Associated Inputs: senior_acct_user_id


 

5034: Invalid parent client account id.

Associated Inputs: senior_client_acct_id


 

5036: Client Account ID is already assigned to other account

Associated Inputs: client_acct_id

Additional Comments: This validation occurs only when the client parameter CHECK_CLIENT_ACCT_ID_ALREADY_TAKEN is enabled for the client.


 

5038: Client Account ID has exceeded maximum size

Associated Inputs: client_acct_id

Additional Comments: Maximum allowable length is 50 characters.


 

5039: Invalid RevRec profile ID.

Associated Inputs: revrec_profile_id


 

5040: Invalid RevRec client-defined ID.

Associated Inputs: revrec_client_defined_id


 

5041: Invalid invoicing option provided

Associated Inputs: invoicing_option


 

5048: Responsible account number/identifier is mandatory when master_plan_instance's resp_level_cd is not self pay (does not equal 1). Alt: Missing senior account number/identifier. 

Associated Inputs: senior_acct_no, resp_level_cd

Additional Comments: Senior account number is mandatory when master_plan_instance.resp_level_cd is not equal to 1.


 

5051: The responsible Master Plan Instance number/identifier must be from an ancestor account. Alt: the responsible Master Plan Instance number/identifier is not associated with the senior account number; The responsible Master Plan Instance number/identifier must be from an ancestor account.

Associated Inputs: resp_master_plan_inst_no, parent_acct_master_plan_inst_id

Additional Comments: The responsible mpi_no must be from the senior/parent account.


 

5052: Product field is not mapped to the Plan you have specified. Alt: Invalid product field

Associated Inputs: plan_instance_fields_info.field_name, field_name

Additional Comments: The field is not mapped to the Plan.


 

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.


 

5055: The first name, middle initial and last name of account contact, billing contact and statement contact must be the same when consumer_acct_ind = 1. Alt: Updating multiple contacts with different names on a consumer account is not allowed.

Additional Comments: The first name, middle initial and last name of account contact, billing contact and statement contact must be same when consumer_acct_ind = 1.


 

5059: Invalid Product Field Value.

Associated Inputs: field_value

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


 

5060: Invalid Product Field Directive.

Associated Inputs: 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.


 

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.


 

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

Associated Inputs:  plan_instance_field_name


 

5070: Invalid Legal Entity no

Associated Inputs: legal_entity_no


 

5071: Invalid Client Legal Entity ID

Associated Inputs: client_legal_entity_id


 

5073: Once an account is set with a Legal Entity, it cannot be changed or removed.

Associated Inputs: legal_entity_no or client_legal_entity_id


 

5075: Only self-pay Master Plan Instances can be assigned to a Billing Group.


 

5077: This child account currently cannot be unassigned. One or more Master Plan Instances of this child account or its descendant accounts (child, grandchild, etc.) are using the Master Plan Instance from one of its ancestor accounts for payment responsibility.


 

6003: could not validate billing information

Associated Inputs: pay_method_type, cc_auth_amount

Additional Comments: There was an error during the $1 authorization attempt.


 

6004: validation not supported for this payment method

Associated Inputs: alt_pay_method, seq_no

Additional Comments: Only payment methods 1 and 13 are supported.


 

6005: invalid supplemental field

Associated Inputs: supp_field_name

Additional Comments: Unknown field name.


 

6007: CVV Declined

Associated Inputs: backend, related to payment_method.*

Additional Comments: $1 authorization has failed due to CVV.


 

6008: Address verification declined

Associated Inputs: backend, related to payment_method.*

Additional Comments: $1 authorization failed due to billing address.


 

6009: CVV timeout - retry

Associated Inputs: backend, related to payment_method.*

Additional Comments: $1 authorization failed due to CVV check timeout.


 

6010: Address verification timeout - retry

Associated Inputs: backend, related to payment_method.*

Additional Comments: $1 authorization failed due to billing address check timeout.


 

6021: Invalid state_prov entered

Associated Inputs: bill_state_prov, state_prov, stmt_state_prov, bill_state_prov


 

6022: invalid supp field value

Associated Inputs: supp_field_value

Additional Comments: Value is empty or not from the configured allowed values.


 

6023: billing information does not exist

Additional Comments: Taxable address does not contain country or state info. The tax credit calculation during proration does this validation.


 

6027: IBAN is alphanumeric and is 16 to 34 characters in length

Associated Inputs:  iban, alt_pay_method_iban


 

6029: Bank swift code is alphanumeric and is 8 or 11 characters in length

Associated Inputs: bank_swift_cd, alt_pay_method


 

6031: BBAN is numeric and up to 16 digits

Associated Inputs: alt_payment_method, bank_acct_no


 

6033: Bank branch code is numeric and up to 10 digits

Associated Inputs: bank_branch_cd


 

6034: Basic bank account number or IBAN is required for Direct Debit

Associated Inputs: iban, bank_acct_no


 

6045: Account can have only one active NETS payment method.

Associated Inputs: payment_method_type


 

7028: duplicate billing group client defined id.

Associated Inputs: client_billing_group_id, new_client_billing_group_id

Additional Comments: This value must be unique at the client level.


 

12001: Account group does not exist

Associated Inputs: group_no, acct_group_id

Additional Comments: An invalid seq_function group_id was entered.


 

12002: Account group is collections based

Associated Inputs: functional_acct_group_no or client_functional_acct_group_id


 

12003: Account group is not collections based

Associated Inputs: collection_acct_group_no or client_collection_acct_group_id


 

12004: Account already assigned to this group

Associated Inputs: collection_acct_group_no or client_collection_acct_group_id


 

12010: Client account group does not exist

Associated Inputs: collections_acct_group_no, client_acct_group_id, alt_client_acct_group_id


 

12011: A collection account group must be provided in order to add or remove it from this account

Associated Inputs: collection_acct_grp_directive, collection_acct_group_no, client_collection_acct_group_id


 

12012: Collection group does not exist


 

12013: Collection group identifier does not exist


 

12018: Billing group already assigned to this group


 

14001: invalid Master Plan no

Associated Inputs: plan_no


 

14005: invalid Plan service combination

Associated Inputs: custom_rate_service_no, custom_rate_service_id

Additional Comments: The given Plan number and service number combination for master and Supplemental Plans is not valid.


 

14006: invalid rate schedule no

Associated Inputs: acct_rate_schedule_no, mpi_rate_schedule_no, master_plans_detail, alt_rate_schedule_no, supp_plan.alt_rate_schedule_no


 

14008: account has Supplemental Plans that are not eligible under this Master Plan

Additional Comments: The Supplemental Plan is not linked to the Master Plan.


 

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.


 

14013: New Plan does not have a rate schedule with a currency matching the account's currency.

Associated Inputs: alt_rate_schedule_no, acct_currency

Additional Comments: The given rate schedule currency does not match the account's currency.


 

14014: When entering custom rates, the end sequence number of one tier must immediately precede the start sequence number of the next tier. Alt: invalid rate tier structure

Associate Inputs: custom_rate_to_unit, custom_rate_seq_no

Additional Comments:

When entering custom rates, the tiers must be continuous, that is, the end sequence number of one tier must immediately precede the start sequence number of the next tier. In addition, the rate schedule must have the same number of units in each tier, and the same number of tiers, as the schedule on which it is based. From_units must be greater than - and less than to_units.


 

14015: The custom rates for services other than usage and recurring types can have only one tier with rate_seq_no set to 1, the from_unit set to 1 and to_unit left empty. Alt: custom from and to units not supported for given service_no

Associated Inputs: custom_rate_from_unit, custom_rate_to_unit

Additional Comments: For the custom rate sequence, the "from" unit in one tier is not immediately after the end unit in the previous tier. Tiers are not allowed for other than recurring and usage services.


 

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.


 

14023: Offset Interval must be greater than zero

Associated Inputs: 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.


 

14027: The end units of final rate tier is not infinity

Associated Inputs: custom_rate_to_unit

Additional Comments: The custom rates final unit must be infinity.


 

14033: Invalid Promo Code

Associated Inputs: promo_cd


 

14035: Invalid client Plan id

Associated Inputs: client_plan_id, custom_rate_client_plan_instance_id


 

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


 

14039: Invalid client rate schedule id

Associated Inputs: client_alt_rate_schedule_id, rollover_client_rate_sched_id


 

14042: Promo Code Expired

Associated Inputs: promo-cd


 

14043: Invalid Plan instance rate_seq combination

Associated Inputs: custom_rate_from_unit, custom_rate_to_unit

Additional Comments: If the from/to units are not specified, the given rate_seq_no must be a valid rate_seq_no.


 

14045: Promo code's start date is in the future

Associated Inputs: promo_cd


 

14053: Invalid Master Plan Instance number

Associated Inputs: master_plan_instance_no


 

14054: Invalid client Master Plan Instance identifier

Associated Inputs: client_master_plan_instance_id


 

14055: Missing senior Master Plan Instance number/identifier

Associated Inputs: resp_master_plan_inst_no and client_resp_master_plan_inst_id, resp_lvl_cd, parent_acct_master_plan_inst_id

Additional Comments: If resp_level_cd is not 1 and no responsible Plan instance number or ID was entered.


 

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,


 

14060: Plan cannot be replaced because the Plan stauts of the existing lan does not allow the Plan to be replaced

Additional Comments: The current status of the MPI does not allow its Plan to be replaced


 

14063: duplicate Plan instance client defined id.

Associated Inputs:client_plan_instance_id, new_client_plan_inst_id


 

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.


 

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


 

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

Associated Inputs: plan_units


 

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


 

14098: Invalid proration invoice timing

Associated Inputs: mp_proration_invoice_timing, proration_invoice_timing


 

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.


 

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

Associated Input: force_currency_change


 

15001: invalid coupon code

Associated Inputs: coupon_codes


 

15002: coupon expired

Associated Inputs: coupon_codes, coupon_cd


 

15006: Duplicate surcharge number in input

Associated Inputs: acct_surcharges, mpi_surcharges, mp_surcharge_no


 

15008: Invalid surcharge rate schedule no

Associated Inputs: rate_schedule_no, mp_rate_schedule_no


 

15009: Invalid surcharge number

Associated Inputs: 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


 

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

Associated Inputs: 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


 

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


 

18005: Invalid Template number

Associated Inputs: alt_msg_template_no, cn_alt_msg_template_no, alt_inv_template_no, alt_stmt_template_no


 

18010: Invalid Credit Memo Template number

Associated Inputs: credit_memo_template

Additional Comments: The credit memo template must be mapped to the "CM" template class.


 

18011: Invalid Rebill Template number

Associated Inputs: rebill_template

Additional Comments: The rebill template must be mapped to "RB" template class.


 

20026: agreement id OR credit card info is required

Associated Inputs: pay_method_type, bill_agreement_id, cc_num

Additional Comments: The pay_method_type is "13", the bill_agreement_id is null and cc_num is null.


 

20031: agreement id is mandatory for this payment method

Associated Inputs: pay_method_type, bill_agreement_id

Additional Comments: The pay_method_type is "29" and the bill_agreement_id is null.


 

20287: The email address is not valid.

Associated Inputs: email, bill_email, stmt_email


 

23013: Invalid usage threshold applicability

Associated Inputs: usage_threshold_applicability

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


 

25020: Illegal characters entered

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


 

25022: Unsupported backup pay method provided

Associated Inputs: billing_groups_array.backup_payment_method_no/client_backup_payment_method_id


 

25023: Primary payment method is required.

Associated Inputs: pay_method_type, pay_method_name, client_pay_method_cdid,bill_agreement_id

Additinal Comments: There must be a primary pay method before setting up a secondary pay method. When the primary pay method is removed, then the secondary becomes primary.


 

25025: Backup pay method cannot be different than primary pay method

Associated Inputs: new pay_method_type, primary_payment_method_no, backup_payment_method_no, client_primary_payment_method_id, client_backup_payment_method_id


 

25026: Primary pay method cannot be different than backup pay method

Associated Inputs: new pay_method_type, primary_payment_method_no, backup_payment_method_no, client_primary_payment_method_id, client_backup_payment_method_id


 

25027: Provided payment method is not a credit card

Associated Inputs:cc_expire_yyyy, cc_expire_mm, pay_method_type

Additional Comments: expiry date can be modified only for credit card.


 

25042: The expiration date for tokenized credit cards cannot be edited as that information is provided by the payment processor.

Associated Inputs: cc_expire_yyyy, cc_expire_mm, payment_method_no, client_payment_method_id


 

25043: Primary payment method does not support secondary pay method.

Associated Inputs: new pay_method_type, primary_payment_method_no, backup_payment_method_no, client_primary_payment_method_id, client_backup_payment_method_id, pay_method_type

Additional Comments: The primary_client_payment_method_id is not 1, 2, or 13) and the backup_client_payment_method_id is not null.


 

25044: Secondary payment method type must match the primary.

Associated Inputs: new pay_method_type, primary_payment_method_no, backup_payment_method_no, client_primary_payment_method_id, client_backup_payment_method_id

Additional Comments: The backup_client_payment_method_id is not 1, 2, or 13.


 

26003: The API execution is not supported because your client parameter Account_EOM_Enabled is set to False. Please contact Aria customer support with questions about the Account_EOM_Enabled client parameter.


 

26007: Provided client defined pay method ID does not exist for this account.

Associated Inputs: client_payment_method_id, client_primary_payment_method_id, client_backup_payment_method_id


 

26008: Provided payment_method_id does not exist for this account.

Associated Inputs: payment_method_no, payment_method_no, client_payment_method_id, primary_payment_method_no, backup_payment_method_no


 

26010: Invalid billing group number

Associated Inputs: billing_group_no


 

26012: Invalid client-defined billing group ID.

Associated Inputs: client_billing_group_id


 

26013: Invalid dunning group number

Associated Inputs: dunning_group_no


 

26014: Invalid client-defined dunning group ID.

Associated Inputs: client_dunning_group_id


 

26019: Provided primary payment method idx or primary payment method client defined id is invalid

Associated Inputs: primary_payment_method_idx, primary_client_payment_method_id


 

26020: Provided secondary payment method idx or secondary payment method client defined id is invalid

Associated Inputs: backup_client_payment_method_id, backup_payment_method_idx


 

26024: The account status provided is not supported when your client parameter Account_EOM_Enabled is set to True.

Associated Inputs: status_cd


 

26031: Client payment terms id not found.

Associated Inputs: client_payment_term_id


 

26032: Payment terms is not available for the account.

Associated Inputs: payment_terms_no, payment_terms_name, client_payment_term_id

Additional Comments: The payment_terms_no must be mapped to the acct_group_no.


 

26034: Payment terms not found.

Associated Inputs: payment_terms_no, payment_terms_name, client_payment_term_id


 

26037: EAN GLN number and EAN GLN requisition numbers are required for EAN GLN Payment Terms.

Associated Inputs: payment_terms_no, payment_terms_name, client_payment_term_id, ean_gln_num, ean_gln_requisition_num

Additional Comments: The payment_terms_no is valid and requires that ean_gln_num and ean_gln_requisition_num values are entered, but these values were not entered.


 

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.


 

29004: Provided contact idx is invalid.

Associated Inputs: contact_idx, bill_contact_idx, stmt_contact_idx, dest_contact_idx, item_dest_contact_idx

Additional Comments: When there is no matching map index available for acct_contact_idx, contact_idx, bill_contact_idx, stmt_contact_idx, dest_contact_idx, item_dest_contact_id, this error occurs.


 

29005: The contact number provided is invalid for the specified account.

Associated Inputs: acct_contact_no, bill_contact_no, stmt_contact_no


 

Additional Guidance

Input Fields
Field Name Notes
  • <primary_payment_method_no>
  • <client_primary_payment_method_id>
  • <backup_payment_method_no>
  • <client_backup_payment_method_id>
The same pay method sequence number cannot be used for the primary and secondary payment method.
<status_cd>
Allowable Values
Values Description
0 DEACTIVATED
1 ACTIVE
32 REGISTERED PENDING ACTIVATION
51 TEMPORARY SERVICE BAN
99 PERMANENT
-99 ARCHIVED
<notify_method>
Allowable Values
Values Description
0 None
1 HTML Email
2 Text Email
3 Text Email w/link to HTML
4 Data export
5 Printable (no Email) w/Surcharge
6 Printable & Text Email
7 Printable & HTML Email w/Surcharge
8 Printable (no Email)
9 PDF (Printing required, no Email)
10 PDF (delivered by Email)
11 PDF (Printing req & Email)w/surcharge
12 PDF (Printing req, no Email)w/surcharge
13 XML Master File
14 PDF Master File
15 XML Master File and HTML Email
16 XML Master File and Text Email
17 PDF Master File and HTML Email
<test_acct_ind>
Allowable Values
Values Description
1 test
0 live
<tax_exemption_level>
Allowable Values
Values Description
0 Account is not exempt from taxation (default).
1 Account is exempt from state/province taxation.
2 Account is exempt from federal/national taxation.
3 Account is exempt from both federal/national and state/province taxation.
<reset_dates_after_status>
Allowable Values
Values Description
true true
false false
<invoicing_option>
Allowable Values
Values Description
1 Perform full invoicing
2 Perform prorated invoicing
3 use client default
4 None
<functional_acct_grp_directive>
Allowable Values
Values Description
1 Assign the account to the group.
2 Remove the account from the group.
<collection_acct_grp_directive>
Allowable Values
Values Description
1 Assign the account to the group.
2 Remove the account from the group.
<acct_supp_field_directive>
Allowable Values
Values Description
1 Add the supplemental field and value to the account (default).
2 Replace all instances of the supplemental field with the given value.
3 Remove the supplemental field and value. If the supplemental field exists with values other than the one given, those will remain untouched.
4 Remove all instances of the supplemental field. Any given value is ignored.
<surcharge_directive>
Allowable Values
Values Description
1 Apply surcharge to account
2 Remove surcharge from account
<master_plan_instance_status>
Allowable Values
Values Description
-3 Terminated
-2 Cancelled
-1 Suspended
0 Inactive
1 Active
2 Pending Cancellation
3 Pending Termination
31 Pending Installation
32 Pending Activation
41 Trial
61 Active Non-billable
<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'
<master_plan_assign_directive>
Allowable Values
Values Description
1 (Default) Perform the requested plan update on the account's next scheduled billing anniversary date. The account will not receive service under this plan (for master plan number updates) until that date. Initial billing for a full period of the given plan update will be performed on the account's next scheduled anniversary date. No charge or credit proration effect.
2 Perform the requested plan update immediately, honoring the client's pre-configured universal rule for performing or not performing proration as a result of a mid-billing-period plan update.
3 Perform the requested plan update immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing NO PRORATION
4 Perform the requested plan update immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION.
5 Perform the requested plan update immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CHARGES ONLY.
6 Perform the requested plan update immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CREDITS ONLY.
7 Perform the requested plan assignment/de-assignment 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.
8 Perform the requested plan assignment/de-assignment on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing NO PRORATION.
9 Perform the requested plan assignment/de-assignment 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 assignment/de-assignment 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 calling the cancel_supp_plan API.
11 Perform the requested plan assignment/de-assignment 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 calling the assign_supp_plan API.
<invoice_unbilled_usage>
Allowable Values
Values Description
false Do not allow invoicing the unbilled usage during mid-term plan termination.
true Allow invoicing the unbilled usage during mid-term plan termination.
<invoice_approval_required>
Allowable Values
Values Description
true Attempts to create a pending invoice. Note: if client is configured for real invoices, passing "True" here overrides the client setting.
false Attempts to create a real invoice. Note: if client is configured for pending invoices, passing "False" here overrides the client setting.
null If NULL, defaults to the client configuration setting
<usage_pooling>
Allowable Values
Values Description
true Usage pooling is enabled for this plan instance.
false Usage pooling is not enabled for this plan instance. (default)
<usage_threshold_applicability>
Allowable Values
Values Description
UT Usage Type
UP Usage Pool
<plan_instance_field_directive>
Allowable Values
Values Description
1 Add name and value for a new plan instance field.'
2 Replace value of an existing plan instance field.
3 Remove the value of an existing plan instance field, note that if the plan instance field is required based on the field definition, the Replace directive should be used.
4 Remove the name and value of an existing plan instance field from the plan instance.
<mp_surcharge_directive>
Allowable Values
Values Description
1 Apply surcharge to account
2 Remove surcharge from account
<bg_notify_method>
Allowable Values
Values Description
0 None
1 HTML Email
2 Text Email
3 Text Email w/link to HTML
4 Data export
5 Printable (no Email) w/Surcharge
6 Printable & Text Email
7 Printable & HTML Email w/Surcharge
8 Printable (no Email)
9 PDF (Printing required, no Email)
10 PDF (delivered by Email)
11 PDF (Printing req & Email)w/surcharge
12 PDF (Printing req, no Email)w/surcharge
13 XML Master File
14 PDF Master File
<payment_option>
Allowable Values
Values Description
Methods Methods
Terms Terms
<bg_list_start_master_file>
Allowable Values
Values Description
0 0
1 When value=1, account is listed at the top of the master file when generated.
<collections_grp_directive>
Allowable Values
Values Description
1 Assign the collection group to the billing group.
2 Remove the collection group from the billing group.
<pay_method_type>
Allowable Values
Values Description
-1 External Payment
1 Credit card
2 Electronic Check (ACH)
3 Pre-paid
8 Click&Buy
10 PayByCash
11 PayPal Express Checkout
13 Tokenized Credit Card
14 Purchase Power
20 NETS
21 FIK
26 Direct Debit
37 Tokenized Direct Debit
40 Merchant-Specific Gift Card
48 Tokenized ACH
<bank_acct_type>
Allowable Values
Values Description
savings savings
checking checking
business business
<do_collect>
Allowable Values
Values Description
true true
false false
<change_status_after_coll>
Allowable Values
Values Description
0 Do not reset the MPI status to active
1 Reset the MPI status to active when its current status is any non-active status.
2 Reset the MPI status to active only when its current status "Suspended" (default).
3 Reset the MPI status to active only when its current is either "Suspended" or "Terminated"
<cc_id>
Allowable Values
Values Description
1 Visa
2 MasterCard
3 American Express
4 Discover
5 Diners Club/Carte Blanche
6 Maestro
7 JCB
8 Laser
9 Dankoort
<mp_proration_invoice_timing>
Allowable Values
Values Description
Null(default) Honor Proration Invoice Timing configuration saved with the plan in the product catalog.
0 Generate the invoice immediately for the pro-rated charges.
1 Generate the invoice on the next anniversary date for the pro-rated charges.
<list_start_master_file>
Allowable Values
Values Description
0 0
1 When value=1, account is listed at the top of the master file when generated.
<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
<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.
<fraud_filter>
Allowable Values
Values Description
0 false (disable)

Note: If you set this field to 0, then Aria will ignore all other fraud filtering fields.

1 true (enable)

Note: If you set this field to 1, then Aria will apply the values that you specified in the other fraud filtering fields. However, if you pass -1 into any fraud filtering field, Aria will ignore that field.

2 Use settings specified at the collection group or payment gateway level.

Note: If you set this field to 2, then Aria will apply the values that you specified in the other fraud filtering fields.

<fraud_filtering_enabled>
Allowable Values
Values Description
0 disable
1 enable
-1 Use settings specified at the collection group or payment gateway level.
<change_status_on_fraud_filtering_failure>
Allowable Values
Values Description
0 false
1 true
-1 Use settings specified at the collection group or payment gateway level.
<change_status_on_fraud_filtering_review>
Allowable Values
Values Description
0 false
1 true
-1 Use settings specified at the collection group or payment gateway level.
<change_mp_status_on_fraud_filtering_cc_prefix_failure>
Allowable Values
Values Description
0 false
1 true
<change_mp_status_on_fraud_filtering_cc_number_failure>
Allowable Values
Values Description
0 false
1 true
<change_mp_status_on_fraud_filtering_cc_issuing_country_failure>
Allowable Values
Values Description
0 false
1 true
<change_mp_status_on_fraud_filtering_cc_issuing_country_suspect>
Allowable Values
Values Description
0 false
1 true
<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.
<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.
  • Was this article helpful?