Skip to main content
Aria Knowledge Central

update_order_m Guide

Update an Order for one or more inventory items ordered by a specified account holder. This call also has the ability to collect a payment for the invoice by specifying "true" (1) in the bill_immediately field.

API Specification: update_order_m
Required Fields:
  • <client_no>
  • <auth_key>
  • <acct_no> or <client_acct_id>
  • <order_no>

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>

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>

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.

<fulfilled_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>, <change_mp_status_on_fraud_filtering_cc_prefix_failure>, <change_mp_status_on_fraud_filtering_cc_number_failure>, <change_mp_status_on_fraud_filtering_cc_issuing_country_failure>, <change_mp_status_on_fraud_filtering_cc_issuing_country_suspect>

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.

 

3029: This order cannot be fulfilled due to its current account and/or Plan status

 

3032: Invalid Order Number

 

3034: Invalid Bill immediate option

 

3035: could not update order - order is not in pending status

 

3041: Invalid date format for fulfilled_date.

Associated Input: fulfilled_date

<fulfilled_date>

3042: Order should be in placed or billed status in order to update the fulfilled date.

 

4006: invalid pay method or alternate pay method

Associated Inputs: alt_pay_method, pay_method_type, pay_method_type

<alt_pay_method>

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.

<cc_expire_mm>, <cc_expire_yyyy>

4009: invalid cc number

Associated Inputs: cc_number, alt_pay_method, cc_num, pay_method_type

<cc_number>

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.
<bank_routing_num>, <bank_acct_num>

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.

<cc_number>, <cc_expire_mm>, <cc_expire_yyyy>

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

 

5017: invalid iso country code

Associated Inputs country, bank_country_cd, bill_country

<bill_country>, <bank_country_cd>

5054: The Account Contact name, Billing Contact name, and Statement Contact name must be the same for consumer accounts.

Additional Comments: 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.

 

6021: Invalid state_prov entered

Associated Inputs: bill_state_prov, state_prov, stmt_state_prov, bill_state_prov

<bill_state_prov>

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

Associated Inputs:  iban, alt_pay_method_iban

<iban>

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

Associated Inputs: bank_swift_cd, alt_pay_method

<bank_swift_cd>

6031: BBAN is numeric and up to 16 digits

Associated Inputs: alt_payment_method, bank_acct_no

<bank_acct_num>

6032: Bank ID code is numeric and up to 10 digits

 

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

Associated Inputs: bank_branch_cd

<bank_branch_cd>

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

Associated Inputs: iban, bank_acct_no

<iban>, <bank_acct_num>

6053:Either IBAN or Agreement ID is required for this payment method. 

Associated Inputs: iban, bill_agreement_id, pay_method_type, alt_pay_method

<iban>, <alt_pay_method>

7012: Single order billing not allowed because account status prevents it.

 

7032: Single order billing not allowed because Plan instance status prevents it

Associated Inputs: plan_instance_status

Additional Comments: This error occurs in the following situations:

  1. The Plan instance status code allows billability and the invoice option is "NONE".
  2. If the Plan instance status does not allow billability.
 

12010: Client account group does not exist

Associated Inputs: collections_acct_group_no, client_acct_group_id, alt_client_acct_group_id

<alt_client_acct_group_id>

18005: Invalid Template number

Associated Inputs: alt_msg_template_no, cn_alt_msg_template_no, alt_inv_template_no, alt_stmt_template_no

<alt_inv_template_no>

20005: Invalid set of values for do_write and bill_immediately

Associated Inputs: bill_immediately, do_write

Additional Comments: Do_write can be ture only when bill_immediately is 1.

<do_write>, <bill_immediately>

25020: Illegal characters entered

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

<auth_key>, <cc_number>, <bank_routing_num>, <bank_acct_num>, <bill_company_name>, <bill_first_name>, <bill_middle_initial>, <bill_last_name>, <bill_address1>, <bill_address2>, <bill_city>, <bill_locality>, <bill_state_prov>, <bill_zip>, <bill_country>, <bill_email>, <bill_phone>, <bill_work_phone>, <bill_work_phone_extension>, <cvv>, <bill_address3>, <do_write>, <alt_client_acct_group_id>, <track_data1>, <track_data2>, <iban>, <bank_swift_cd>, <bank_country_cd>, <mandate_id>, <bank_id_cd>, <bank_branch_cd>, <fulfilled_date>, <fraud_control_field_name>, <fraud_control_field_value client_acct_id>, <bank_name>, <bank_city>, <bank_acct_type>, <bank_acct_holder_type>, <application_id>, <application_date>, <alt_caller_id>, <attach_qualifier_option>, <qualifier_name>, <qualifier_value>

25045: One or more fraud control fields are missing or invalid fraud control field name

 

25046: One or more fraud control fields values are missing or invalid fraud control value

 

Additional Guidance

Input Fields
Field Name Notes
<fraud_filter>

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

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.

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

<bill_immediately>
Allowable Values
Values Description
0 No. Do not bill immediately.
1 Yes. Bill immediately.
2 Order Held. This places the billing for the newly created order in a pending state labeled Order Held. The billing status can be updated using the update_order_m API, or through the interface.
3 Bill on the next anniversary bill after the fulfillment date.
4 Bill on the fulfillment date.
5 Bill on the next anniversary bill that bills arrears services through the fulfillment date.
   
<do_write>
Allowable Values
Values Description
true true
false false
   
<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_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
   
<bill_immediately>
Allowable Values
   
   
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
<transaction_id> Deprecated
  • Was this article helpful?