Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > Aria Crescendo core api > update_order_m

update_order_m

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.

Input Arguments

Req Field Name Field Type Max Length Description
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
account_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
order_no long   The unique identifier for an order in the context of an client_no and account_no.
  bill_immediately long 1 Indicates whether to bill the account holder immediately or, if not set bill on next billing anniversary date.   Allowable Values
  alt_pay_method long 1 If you want to use the account's current form of payment, leave this field empty. If you want to use an alternate credit card, enter '1' in this field.
  cc_number string 24 Credit card number.
  cc_expire_mm long 2 Expiration month for the credit card payment instrument.
  cc_expire_yyyy long 4 Expiration year for the credit card payment instrument.
  bank_routing_num string 22 The American Banking Association (ABA) routing number for the financial institution.
  bank_acct_num string 32 The bank account number.
  bill_company_name string 100 Company name of the billing contact.
  bill_first_name string 32 First name of the billing contact.
  bill_middle_initial string 1 Middle initial of the billing contact.
  bill_last_name string 32 Last name of the billing contact.
  bill_address1 string 100 First address line of the billing contact.
  bill_address2 string 100 Second address line of the billing contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  bill_city string 32 City of the billing contact.
  bill_locality string 32 Use this field instead of the state_prov field to designate the state, province or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all United States, Australia and Canada addresses.
  bill_state_prov string 2 State or Province of the billing contact. The official postal-service codes for all United States, Australia and Canada states, provinces, and territories. This field does not support states, provinces or territories from other countries. Use the locality field for other countries.
  bill_zip string 16 Zip Code of the billing contact
  bill_country string 3 Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  bill_email string 320 Email of the billing contact.
  bill_phone string 25 Phone number of the billing contact.
  bill_work_phone string 25 Work phone number of the billing contact.
  bill_work_phone_extension string 20 Work phone extenstion of the billing contact
  cvv string 6 Card Verification Value, used to help verify a transaction is being requested by the card holder since this value is physically printed on the credit card.
  bill_address3 string 300 The third line of the billing address.
  do_write string 5 Boolean indicator that specifies whether to actually perform the requested operation. If 'false' is passed in this field, Aria calculates, if applicable, any potential effects from this call such as proration, plan assignments, etc. and return all relevant data without actually performing the requested operation or making any changes to the account. This is useful to interfaces that want to present the user with a 'confirmation page' informing them of the potential effects of the requested operation prior to actually performing it. Do_write defaults to 'true'   Allowable Values
  alt_client_acct_group_id string 100 One-time collections account group to use for this specific call. Default collections group on the account is not changed.
  track_data1 string 300 Raw "track 1" data from a swiped credit card used in a card-present transaction to initiate this request
  track_data2 string 300 Raw "track 2" data from a swiped credit card used in a card-present transaction to initiate this request
  alt_inv_template_no long   The statement template to use when generating a statement for this order
  iban string 50 International Bank Account Number(IBAN). Used for the Direct Debit payment method. It consists of 16 to 34 alphanumeric characters. Only hyphen and space are allowed to format the IBAN.
  bank_check_digit long 2 Bank check digits enable a sanity check of the bank account number to confirm its integrity before submitting a transaction. Used for the Direct Debit payment method.
  bank_swift_cd string 15 SWIFT code is a standard format of Bank Identifier Codes (BIC). It is used for the Direct Debit payment method. It consists of 8 or 11 alphanumeric characters. Only hyphen and space are allowed to format the SWIFT code. It is required for IBAN.
  bank_country_cd string 2 Country of the bank. The ISO-compliant 2-character country code abbreviation in uppercase. Used for the Direct Debit payment method. It is required for IBAN and BBAN.
  mandate_id string 35 Used for the Direct Debit payment method. A mandate is signed by the debtor to authorize the creditor to collect a payment and to instruct the bank of the debtor to pay those collections.
  bank_id_cd string 10 Up to 10 digit numeric bank identifier code. Used for the Direct Debit payment method. Used in Europe. Only hyphen and space are allowed to format the bank ID code. It is required for BBAN.
  bank_branch_cd string 10 Up to 10 digit numeric bank branch code. Used for the Direct Debit payment method. Used in Europe. Only hyphen and space are allowed to format the bank branch code.
  fulfilled_date string   Date on which order is fulfilled.
  alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  qualifier_name string 100 Name of the field you want to associate with this API call.
  qualifier_value string 100 Corresponding value of the field you want to associate with this API call.
  application_id string 300 The application identifier in which the API is being used in. (Example: “Sales Force”)
  application_date string 300 The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API.

Output Arguments

Field Name Field Type Description
transaction_id long The unique identifier for a given transaction
invoicing_error_code long The error code generated by Aria when Aria attempted to generate a invoice
invoicing_error_msg string The text message associated with 'invoicing_error_code'
statement_error_cd long Error code produced when statement generation has failed.
statement_error_msg string The text message associated with 'statement_error_code'
proc_cvv_response string The processor return code from CVV validation.
proc_avs_response string Processor return code from address validation
proc_cavv_response string The processors return code for security validation.
proc_status_code string The processor status code
proc_status_text string The processors status description
proc_payment_id string The processor payment ID
proc_auth_code string Authorization code provided by the issuing bank
proc_merch_comments string Additional information passed to payment processor
invoice_no long The unique identifier of a given invoice.
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
total_charges_before_tax double Total charges on this invoice before taxes are applied
total_tax_charges double Total amount of taxes charged
total_charges_after_tax double Subtotal combining the total pre-tax charges and the total taxes charged
total_credit double Sum of all the credits on the invoice
cart_invoice_line_items hash All of the items on this order. If do_write was FALSE, these are the line items which would be on the eventual invoice
line_no long Sequential line item
service_no long Service number shown on the invoice
service_name string Service name shown on the invoice
service_is_tax_ind long Whether or not this line item represents a tax charge
line_units double Number of units of the service this line item represents
rate_per_unit double Charge per unit
line_amount double Subtotal for this particular line
description string Long description of this line
date_range_start string (Deprecated) The starting date range for this line item
date_range_end string (Deprecated) The ending date range for this line item
usage_type_no long If this line represents a usage-based charge, the client-defined usage type number this line represents
plan_no long The unique plan ID associated with this line
plan_name string The name of the plan associated with this line
client_service_id string The client-defined Service ID shown in the invoice.
usage_type_cd string An array containing usage_type_cd(s) to denote which usage type(s) to record.
client_plan_id string Client-defined Plan ID associated with this invoice.
ref_charge_line_no long The reference charge line number to indicate the item to which the discount applies.
po_num string Purchase order number assigned to the plan instance.
third_party_errors hash Errors from third-party systems like taxation engines are returned here. Aria-generated error codes are returned in the error_code and error_msg fields at the root level of the API return.
error_class string Type of error code being represented, such as taxation
error_code string Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.

You must to post a comment.
Last modified
10:40, 9 May 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.