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

 

Home > Aria Crescendo core api > create_order_with_plan_m

create_order_with_plan_m

allows 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.
  OR      
  client_acct_id string 50 This is the client-assigned identifier for the account.
  order_line_items array    
  client_sku string 100 The client-defined product identifier
  units double   The number of this item being purchased
  amount double   The subtotal of this line
  unit_discount_amount double   The discount per unit applied and included in the amount
  line_comments string   Any available client-supplied comments for this line
  item_svc_location_no long   The Aria-assigned unique identifier for the origin location for the item (NSO) being purchased. Depending on taxation configuration, this address may be used for tax calculations. If both svc_location_no and client_svc_location_id are provided, svc_location_no will take precedence.
  client_item_svc_location_id string   The client-defined unique identifier for the origin location for the item (NSO) being purchased. Depending on taxation configuration, this address may be used for tax calculations. If both svc_location_no and client_svc_location_id are provided, svc_location_no will take precedence.
  item_dest_contact_no long   The Aria-assigned unique identifier for the destination contact for the item (NSO) being purchased. Depending on taxation configuration, this address may be used for tax calculations. If both item_dest_contact_idx and item_dest_contact_no are provided, item_dest_contact_no will take precedence.
  item_dest_contact_idx long   For non-persistent referencing of a destination contact in the contacts array within the API request. Depending on taxation configuration, the address associated with this destination contact may be used for tax calculations.
  parent_plan_instance_no long   Parent plan instance number to identify each supplemental plan and child supplemental plan heirarchy.
  client_parent_plan_instance_id string 100 Client parent plan instance ID to identify each supplemental plan and child supplemental plan heirarchy.
  supp_plan_instance_no long   Unique plan instance number for each assigned supplemental plan.
  client_plan_instance_id string   Client-defined plan instance ID for each assigned supplemental plan.
  supp_plan_no long   The Aria-assigned identifier for a supplemental service plan. Allowable values are limited to valid custom plan numbers for client.
  client_supp_plan_id string   Client-defined supplemental plan ID.
  supp_plan_units long   Number of units for the supplemental plan
  assignment_directive long 8 The scope rule to be applied to this immediate assignment request, governing the proration rule that should be applied. Default behavior is to assign plan to account or increment units on existing plan immediately based on client-defined default proration rule, resulting in appropriate prorated charge and credit.   Allowable Values
  bill_immediately long 1 Indicates whether to bill the account holder immediately or, if not set bill on next billing anniversary date.   Allowable Values
  bill_seq long 22 The billing sequence number
  client_order_id string   This is the client-assigned order identifier.
  client_receipt_id string 50 Client-defined unique identifier used to track related system actions
  alt_pay_method long   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   Expiration month for the credit card payment instrument.
  cc_expire_yyyy long   Expiration year for the credit card payment instrument.
  bank_routing_num string   The American Banking Association (ABA) routing number for the financial institution.
  bank_acct_num string   The bank account number.
  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.
  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.
  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.
  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.
  bill_company_name string 100 Company name of the billing contact.
  bill_first_name string   First name of the billing contact.
  bill_middle_initial string   Middle initial of the billing contact.
  bill_last_name string   Last name of the billing contact.
  bill_address1 string   First address line of the billing contact.
  bill_address2 string   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   Locality of the billing contact.
  bill_state_prov string   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   Zip Code of the billing contact
  bill_country string   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_phone_extension string   Phone extension of the billing contact.
  bill_cell_phone string 20 Cell phone number of the billing contact.
  bill_work_phone string 25 Work phone number of the billing contact.
  bill_work_phone_extension string   Work phone extenstion of the billing contact
  cvv string   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 32 The type of bank account being used.   Allowable Values
  bill_address3 string   The third line of the billing address.
  coupon_codes string array 30 associate multiple coupons.
  alt_client_acct_group_id string   One-time collections account group to use for this specific call. Default collections group on the account is not changed.
  client_alt_inv_template_id string 100 The client alternate invoice template number to use for this order, if different from the default template
  OR      
  alt_inv_template_no long   The invoice template number to use for this order, if different from the default template
  force_supp_bill_date_reset long   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
  statement_message string 1000 Alternate contact details for orders.
  track_data1 string   Raw "track 1" data from a swiped credit card used in a card-present transaction to initiate this request
  track_data2 string   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.
  do_write string   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
  order_comments string 3000 Comments for this order
  nso_po_num string 100 Purchase order number assigned to the one-time order.
  po_num string 100 Purchase order number assigned to the plan instance.
  plan_service_updates array   List of services associated with the plan being assigned or updated on the account.
  service_no long   The Aria-assigned unique identifier for the service associated with the plan.
  OR      
  client_service_id string 100 The client-defined identifier for the service associated with the plan.
  svc_location_no long   The Aria-assigned unique identifier for the origin location for the specified service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations. If both svc_location_no and client_svc_location_id are provided, svc_location_no will take precedence.
  client_svc_location_id string   The client-defined unique identifier for the origin location for the service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations. If both svc_location_no and client_svc_location_id are provided, svc_location_no will take precedence.
  dest_contact_no long 1 The Aria-assigned unique identifier for the destination contact for the specified service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations.
  dest_contact_idx long   For non-persistent referencing of a destination contact in the contacts array within the API request. Depending on taxation configuration, the address associated with this destination contact may be used for tax calculations.
  contacts array   List of contacts to be created on the account. Note that contacts not used as an account contact, billing contact, or statement contact will be saved on the account.
  contact_idx long   For non-persistent referencing of a contact within the API request.
  first_name string 32 The first name of the contact.
  middle_initial string 2 The middle initial of the contact.
  last_name string 32 The last name of the contact.
  company_name string 100 The company name of the contact.
  address1 string 100 First address line of the contact.
  address2 string 100 Second address line of the contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  address3 string 100 The third line of the address
  city string 32 The city of the contact.
  locality string 32 The locality of the contact.
  state_prov string 2 The state or province of the contact. Note that only the official postal-service codes for states, provinces, and territories in the United States, Australia and Canada are supported. Use the other_locality field for states, provinces, or territories in other countries.
  country string 2 The country of the contact. Provide the ISO-compliant 2-character country code abbreviation in uppercase.
  postal_cd string 14 The postal/zip code of the contact.
  phone string 25 The phone number of the contact.
  phone_ext string 10 The phone number extension of the contact.
  cell_phone string 20 The cell phone number of the contact.
  work_phone string 25 The work phone number of the contact.
  work_phone_ext string 100 The work phone number extension of the contact.
  fax string 25 The fax number of the contact.
  email string 320 The email address of the contact.
  birthdate string 14 The birthdate of the contact.
  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.

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.
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_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'
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
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_inv_line_items 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 starting date range for the item or plan on this line
date_range_end string If any, the ending date range for the item or plan on this line.
usage_type_no long The usage type of the usage units specified.
plan_instance_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_instance_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.
po_num string Purchase order number assigned to the plan instance.
bill_from_address_no long Address sent as the bill-from address to the tax engine for tax calculations. Depending on the taxation configuration, this parameter may return the Aria-assigned unique identifier of the service location for the invoice line item. Note that service locations can be associated with a service for a given plan instance on an account, with an item (NSO) purchased as part of a one-time order, or with a service as defined in the product catalog.
ship_from_address_no long Address sent as the ship-from address to the tax engine for tax calculations. Depending on the taxation configuration, this parameter may return the Aria-assigned unique identifier of the service location for the invoice line item. Note that service locations can be associated with a service for a given plan instance on an account, with an item (NSO) purchased as part of a one-time order, or with a service as defined in the product catalog.
bill_to_address_no long Address sent as the bill-to address to the tax engine for tax calculations. This parameter will return the Aria-assigned unique identifier of the contact on the account used as the bill-to address for the invoice line item.
ship_to_address_no long Address sent as the ship-to address to the tax engine for tax calculations. This parameter will return the Aria-assigned unique identifier of the contact on the account used as the ship-to address for the invoice line item.
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
17:07, 28 Mar 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.