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

 

Home > Aria Crescendo core api > create_order_m

create_order_m

Creates an invoice 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.
  acct_no long 22 Account No
  client_acct_id string 50 Account ID
  client_plan_instance_id string 100 Plan Instance ID
  plan_instance_no long 22 Plan Instance No
  order_line_items array   This is an array of line items appearing on the order. The Array elements for this argument immediately follow and are indicated as elements with a right-arrow icon.
client_sku string 100 The client SKU for this line item
  units double 12 The number of units indicated for this SKU on the line item.
  amount double 12 The amount for this line item.
  unit_discount_amount double 12 The discount amount applied for the number of units indicated for the line item.
  line_comments string   Any client-defined comments, from a CSR or automated system, for this particular line item
  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.
  bill_immediately long 1 Indicates whether to bill the account holder immediately or, if not set, billing is determined by the AUTO_BILL_ON_SYS_GENERATED_ORDERS client setting which is set to TRUE (bill immediately) as a default client setting.   Allowable Values
  bill_seq long 22 The unique identifier of the bill sequence number.
  client_order_id string 32 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 1 If you wish to use the accounts 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 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 Locality of the billing contact.
  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 500 Email of the billing contact.
  bill_phone string 25 Phone number of the billing contact.
  bill_phone_extension string 20 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 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.
  bank_acct_type string 32 The type of bank account being used.   Allowable Values
  bill_address3 string   The third line of the billing address.
  do_write string   Boolean indicator informing Aria whether or not to actually perform the requested operation. If 'false' is passed in this field Aria will, if applicable, calculate any potential effects stemming 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 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
  coupon_cd string   A coupon code to apply to this order
  alt_client_acct_group_id string   The alternate collections account group to use with a passed alternate form of payment
  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.
  alt_inv_template_no long   The statement template to use when generating a statement for this order
  OR      
  client_alt_inv_template_id string 100 The client-defined 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 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.
  fulfilled_date string   Date on which order is fulfilled.
  order_comments string 3000 Comments for this order
  nso_po_num string 100 Purchase order number assigned to the one-time order.
  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 The 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 address line of the contact.
  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 500 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.
  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
order_no long The unique identifier for an order in the context of an client_no and account_no.
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 account or 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.
tax_details hash Array of Tax details for this invoice.
tax_detail_line long Line number associated with each tax detail record.
seq_num long The tax line on the invoice which includes the tax amount associated with this tax_detail_line.
taxed_seq_num long The invoice line item for which the tax for this tax_detail_line was calculated.
debit double Amount of tax applied for the given tax type.
tax_authority_level long Tax jurisdiction code: 0 = Federal, 1 = State / Province.
tax_rate double Rate at which tax is calculated for the tax type used by the tax engine.
orig_was_tax_inclusive long Indicates whether or not the invoice line amount was tax inclusive.
tax_srv_tax_type_id string Identifier of the tax type returned by the tax engine.
tax_srv_tax_type_desc string Description of the tax type returned by the tax engine.
tax_srv_cat_text string Category of the tax type returned by the tax engine
tax_srv_juris_nm string Jurisdiction name returned by the tax engine
tax_srv_tax_sum_text string Invoice summary text returned by the tax engine.
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
14:40, 2 Feb 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.