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

 

Home > Aria6 core api > create_order_with_plans

create_order_with_plans

This API allows the creation of order and plan changes on a single invoice.

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.
acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
order_line_items_list array
client_sku string 100 The client-defined product identifier
units double 38 The number of this item being purchased
amount double 38 The subtotal of this line
unit_discount_amount double 38 The discount per unit applied and included in the amount
line_comments string 3000 Any available client-supplied comments for this line
rate_schedule_no long Aria-assigned unique identifier for the rate schedule.
OR
client_defined_rate_schedule_id string 3000 Client-defined unique identifier for the rate schedule. If both are not specified, the default rate schedule for the account's currency is chosen.
cart_supp_plans array
supp_plan_no long The supplemental plan number.
OR
client_supp_plan_ids string 100 The client-defined supplemental plan number.
supp_plan_units long 38 Number of units for the supplemental plan
assignment_directive long 8 Rule to apply to this assignment/de-assignment request, specifying: the date the assignment takes place (immediately or on the account's anniversary date), and the proration rule to apply (per client's default rules for proration, that is, prorate on plan assignment or force proration on or off for each request). Default is to assign plan on the anniversary date, resulting in no proration effect.   Allowable Values
client_order_id string 38 This is the client-assigned order identifier.
coupon_code string 30 (DEPRECATED) This parameter is deprecated as of Release 6.21 and replaced with coupon_codes. The code of the coupon to which to apply the discount. If code is not valid for any reason, an appropriate error code is returned and the entire transaction (including the supp plan assignment and any possible invoice creation) is rolled back.
comments string 3000 Additional explanatory text relating to this API call.
do_write string 1000 Boolean indicator informing Aria whether or not to actually perform the requested plan assignment/de-assignment. If 'false' is passed in this field Aria will, if applicable, calculate any potential proration effect that would result from this call and return that value in the output field 'proration_result_amount' described below without actually performing the requested operation or charging/crediting the account. This is useful to interfaces that wish to present the user with a 'confirmation page' informing of the would-be effects of the requested operation prior to actually performing it. Do_write defaults to 'true'   Allowable Values
client_receipt_id string 50 Client-defined unique identifier used to track related system actions
bill_seq long 22 The billing sequence number
alt_pay_method long 38 If you wish to use the account's current form of payment, leave this value empty. If you wish to use an alternate credit card, enter '1' for this value.
cc_number string 24 Credit card number.
cc_expire_mm long Expiration month for the credit card payment instrument.
cc_expire_yyyy long Expiration year for the credit card payment instrument.
bank_routing_num string 9 The ABA routing number for the bank holding 'bank_acct_num'
bank_acct_num string 19 The bank account number.
bill_company_name string 100 Company name of the billing contact
bill_first_name string 300 First name of the billing contact
bill_middle_initial string 2 Middle Initial of the billing contact
bill_last_name string 300 Last name of the billing contact
bill_address1 string 300 First address line of the billing contact
bill_address2 string 300 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 300 Locality of the billing contact
bill_state_prov string 10 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 15 Zip Code of the billing contact
bill_country string 25 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 Phone of the billing contact
bill_phone_extension string Phone extension of the billing contact
bill_cell_phone string Cell phone of the billing contact
bill_work_phone string Work phone of the billing contact
bill_work_phone_extension string Work phone extenstion of the billing contact
cvv string 1000 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.
bank_acct_type string The type of bank account being used.   Allowable Values
bill_address3 string 300 The third line of the billing address
track_data1 string 1000 Raw "track 1" data from a swiped credit card used in a card-present transaction to initiate this request
track_data2 string 1000 Raw "track 2" data from a swiped credit card used in a card-present transaction to initiate this request
soft_descriptor string Transaction description shown on the buyer's statement that displays a Merchant Name or Item Description typically. This field will be ignored if not supported/certified by the payment processor.
soft_descriptor_customer_service string Transaction description shown on the buyer's statement that displays a City for Card Present transactions or a Phone Number for Card Not Present transactions. This field will be ignored if not supported/certified by the payment processor.
alt_inv_template_no long The invoice template number to use for this order, if different from the default template
OR
client_alt_inv_template_id string 100 The client alternate invoice template number to use for this order, if different from the default template
sync_mstr_bill_dates_override long 4 Overrides the client-level setting that determines whether or not master plan billing dates should be reset when assigning a new supplemental plan. If this value is left empty, the client-level setting will take effect.   Allowable Values
coupon_codes string array 30 associate multiple coupons.
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). 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 authorise 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.
statement_message string 1000 Alternate contact details for orders.
order_comments string 3000 Comments for this order
existing_pay_method_cvv string 6 Sends the CVV value of the current credit card on file.
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
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.
order_no long The unique identifier for an order in the context of an client_no and account_no.
invoice_no long The unique identifier of a given invoice.
invoice_line_items_list hash
line_no long The invoice line number associated with the current record.
service_no long Aria-assigned unique service identifier
service_name string The name corresponding to this line item's service code.
service_is_tax_ind long A boolean value indicating the service is actually a tax. (true/1=yes, false/0=no)  Allowable Values
line_units double Number of units for the specified invoice line.
rate_per_unit double The monetary rate per unit of service.
line_amount double The total line amount for this invoice line.
description string Description of the invoice line item.
date_range_start string The beginning date of the date range
date_range_end string The ending date of the date range
usage_type_no long The usage type of the usage units specified.
plan_no long The plan number associated with the usage asserted in this invoice.
plan_name string The name of the plan for the specified plan_no.
client_service_id string Client-defined service identifier.
usage_type_cd string The usage type code of the usage type specified.
client_plan_id string Client-defined Plan ID associated with the usage asserted in this invoice.
ref_charge_line_no long The reference charge line number to indicate the item to which the discount applies.
schedule_name string Name for the rate schedule to be created
client_rate_schedule_id string Client-defined unique identifier
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'
collection_error_code long If a collection is attempted, returns the error code associated with the collection.
collection_error_msg string The error message associated with collection_error_code.
statement_error_code long The error code generated by Aria when Aria attempted to generate a statement
statement_error_msg string The text message associated with 'statement_error_code'
transaction_id long The unique identifier for a given transaction
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
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

Tags

This page has no custom tags.

Classifications

This page has no classifications.