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

 

Home > Aria6 core api > create_acct_complete

create_acct_complete

Creates an account with an extensive set of data elements including the customer's contact information, billing information, master and supplemental plans, account groups, supplemental fields, and several other data elements. This call also allows you to specify alternate billing dates for a new account.

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.
master_plan_no long 22 The Master Subscription plan number.
  OR      
  client_master_plan_id string 100 Client-defined Master plan Subscription plan ID.
  alt_start_date string 14 This is an alternative start date, in yyyy-mm-dd format, for the account. This date can be used to delay providing services to the account holder (for example: until they have been email validated).
  client_acct_id string 50 The client-assigned identifier for the account.
  userid string 32 The unique user identifier. This field is required unless the Auto Gen Userid Rule is set to automatically generate a user ID when one is not provided upon account creation. This rule is located in Aria6, under Client Settings, Miscellaneous Settings.
  status_cd long 8 This is the status of the object in question for the current API call.   Allowable Values
  master_plan_units long 8 This is multiplier variable for the recurring rate on the plan. Generally this value is 1, indicating the face value of the plan's recurring fee is used.
  supp_plans long array 38 An array of supplemental plan numbers to assign to this account
  OR      
  client_supp_plan_ids string array 100 The array of client-defined supplemental plan IDs.
  supp_plan_units long array 38 The units of each plan in the above supp_plans array to assign to this account
  notify_method long 38 If notification method is not provided, value will default to 1 (HTML emal).   Allowable Values
  promo_cd string 30 This is the code provided the client and used by the account holder during registration or when executing a transaction. A promotion generally provides access to a custom set of reduced-rate plans.
  password string 100 Password for the given user. This field is required unless the New Acct Auto Gen Pw Rule is set to True, to automatically generate a password when one is not provided upon account creation. This rule is located in Aria6, under Client Settings, Miscellaneous Settings.
  secret_question string 300 The users secret question recorded to recover a password.
  secret_question_answer string 300 The response to a users 'secret_question
  first_name string 32 Contact first name
  mi string 1 The Middle Initial of the contact.
  last_name string 32 Contact last name
  company_name string 100 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.
  city string 32 City of the contact
  locality string 32 Locality of the contact
  state_prov string 2 State or Province of the 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.
  country string 2 Country of the contact. The ISO-compliant 2-character country code abbreviation in uppercase. If you enter contact address information, but leave this field blank, then this field defaults to "US". If no contact address information is entered, this field remains blank.
  postal_cd string 14 Postal/Zip code for the contact address.
  phone string 25 The phone number of the contact
  phone_ext string 10 The extension for the contact phone
  cell_phone string 20 The contact cell phone.
  work_phone string 25 Work phone number of the contact.
  work_phone_ext string 10 The extension for the contact work phone
  email string 500 Email of the contact
  birthdate string 14 Contact date of birth
  bill_first_name string 32 First name of the billing contact
  bill_mi string 1 Middle Initial of the billing contact
  bill_last_name string 32 Last name of the billing contact
  bill_company_name string 100 Company 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_country string 2 Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  bill_postal_cd string 14 This is the postal code for the billing contact address.
  bill_phone string 25 Phone of the billing contact
  bill_phone_ext string 10 This is the billing contacts extension for the bill_phone given.
  bill_cell_phone string 25 Cell phone of the billing contact
  bill_work_phone string 25 Work phone of the billing contact
  bill_work_phone_ext string 100 This is the work phone extension for the billing contact work phone.
  bill_email string 500 Email of the billing contact
  pay_method long 8 This is the method_id corresponding to a payment method such as credit card, Electronic Check, Pre-Paid, Net Terms, etc.   Allowable Values
  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_acct_no string 19 This is the bank account number of the account holder's payment method. Together with the (ABA) bank_routing_no, this value is used to execute electronic check or ACH transactions.
  bank_routing_no string   This is the ABA (American Banking Association) unique identifier for the financial institution.
  resp_level_cd long 8 The responsibility level code. These are values 1 through 4 as described in the legend for this argument.   Allowable Values
  senior_acct_no long 22 The senior_acct_no is the unique account number for the parent account and is used in establishing parent-child billing relationships.
  senior_acct_user_id string 32 The senior account user ID of the account.
  client_senior_acct_id string 50 The client senior account ID of the account.
  functional_acct_groups long array 38 Array of functional account groups.
  OR      
  client_func_acct_group_ids string array 38 The functional account group ID to which this account should be assigned
  collections_acct_groups long array 38 The group ID(s) for the collections account groups to assign to this account. An account cannot be assigned to two or more collections account groups for the same pay_method (regardless of whether they use different payment processors). However, accounts can be assigned to two or more collections account groups provided that each is for a different pay_method (for example, ACH vs. credit card).
  OR      
  client_coll_acct_group_ids string array 100 The collections account group ID to which this account should be assigned
  supp_field_names string array 100 The names of the supplemental fields for which values are to be stored for this account
  supp_field_values string array 300 The values for the supplemental field names given in supp_field_names
  test_acct_ind long 1 This argument indicates the account is a test account and is treated as such in the system.   Allowable Values
  status_until_alt_start long 8 The status of the account prior to alt_start_date or alt_bill_day. If the alt_start_date or alt_bill_day field is used, this field is required and defaults to 0 (inactive) if no value is provided. Other acceptable values for status_until_alt_start are any valid account statuses. If an alternate starting date or alternate bill day is passed in, the account remains in this status until its start date arrives. This only applies if a prorated invoice is not created. If a prorated invoice is created, this field is ignored.
  balance_forward double 12 A fixed amount, positive or negative, that the newly created account should owe (or be owed) immediately upon creation. Generally used when converting accounts from other systems into Aria.
  alt_bill_day long 2 The day of the month that will act in perpetuity as the account's billing anniversary day.
  do_full_invoicing string 5 Boolean indicator to override client's default configured behavior for performing full invoicing on this account as part of this call.   Allowable Values
  do_prorated_invoicing string 5 Prorate the invoice to the end of the billing cycle   Allowable Values
  master_plan_alt_rate_sched_no long 22 The alternate rate schedule number for the master subscription plan being considered.
  OR      
  client_mp_alt_rate_sched_id string 100 The client alternate rate schedule ID for the master subscription plan being considered.
  supp_plan_alt_rate_sched_no long array   The unique ID for the alternate rate schedules to assign to this account, by supplemental plan above
  client_receipt_id string 50 Client-defined unique identifier used to track related system actions
  currency_cd string 3 The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
  cvv string 5 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.
  taxpayer_id string 32 Taxpayer Identification number.
  bill_agreement_id string 32 Unique ID of the bill agreement (also referred to as a token).
  retroactive_start_date string 14 Date, in yyyy-mm-dd format, to set for retroactive start.
  coupon_codes string array 30 The coupon codes to assign to this account, if any
  new_acct_custom_rates array    
  custom_rate_plan_no long 22 The unique identifier for the plan to which this custom rate is to be applied for this account.
  OR      
  client_custom_rate_plan_id string 32 The unique identifier defined by client for the plan to which this custom rate is to be applied for this account.
  custom_rate_service_no long 22 The unique identifier for the service no, relative to the value provided in corresponding "custom_rate_plan_no", to which this custom rate is to be applied for this account.
  OR      
  client_custom_rate_service_id string 32 The unique identifier by client the service ID to determine which custom rate is to be applied for this account.
  custom_rate_seq_no long 22 The rate tier number, relative to the values provided in corresponding "custom_rate_plan_no" and "custom_rate_service_no", to which this custom rate is to be applied for this account.
  custom_rate_from_unit long 12 The unit starting point, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to which this custom rate is to be applied for this account. Defaults to 1.
  custom_rate_to_unit long 12 The unit ending point, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to which this custom rate is to be applied for this account. Defaults to infinity.
  custom_rate_per_unit double 12 The custom rate per unit, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to be applied for this account.
  alt_msg_template_no long 22 Email template number assigned to this account.
  OR      
  client_alt_msg_template_id string 100 Client-defined email template ID assigned to this account.
  seq_func_group_no long 22 Functional account group number specifically designated for statement sequence number assignment.
  OR      
  seq_func_group_id string 32 Unique Functional account group ID specifically designated for statement sequence number assignment.
  new_acct_plan_contracts array    
  contract_plan_no long   The unique identifier of this contract
  OR      
  client_contract_plan_id string 100 The client-defined unique ID for the plan to which this contract applies
  contract_type_no long   The type ID of this contract
  contract_alt_recur_fee double 38 If not using the contract default recurring fee, pass an alternate here
  contract_length_months long 4 The number of months this contract should remain on the account
  contract_cancel_fee double 38 The fee charged to the account for prematurely ending this contract
  contract_comments string 300 Any client-defined comments stored on this contract at the account level
  contract_start_date string   The date, in yyyy-mm-dd format, on which this contract takes effect
  contract_end_date string   Allows the caller to set a specific end date when creating or modifying plan contracts.
  bank_acct_type string 32 The type of bank account being used.   Allowable Values
  address3 string 300 The third line of the address
  bill_address3 string 300 The third line of the billing address
  usage_accumulation_config array   The array of plans for which to enable usage accumulation
  usage_accumulation_plan_no long   The plan ID for which to enable usage accumulation
  OR      
  client_usage_accumulation_plan_id string 32 The client-defined plan ID on which to activate usage accumulation for more than one billing period
  usage_accumulation_reset_months long 2 The number of reset months for each plan
  enable_usage_pooling_plan_no array    
  enable_usage_pooling_plan_no long   The plan ID for which to enable usage pooling
  OR      
  client_enable_usage_pool_plan_id string 32 The client-defined plan ID on which to enable usage pooling
  usage_threshold_applicability string 100 Usage tracking options on the plans in the account   Allowable Values
  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
  do_write string 1 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 pro-ration, 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
  tax_exemption_level long 1 To provide Tax Exemption Level for the account   Allowable Values
  cn_alt_msg_template_no long   The alternate email template number to use for this account
  OR      
  client_cn_alt_msg_template_no string 100 The client-defined alternate email template ID to use for this account
  invoice_approval_required string 5 Boolean indicator to override client's default configured behavior for creating Pending/Real invoice.   Allowable Values
  create_session string 5 Creates an Aria session for the newly created account. Within an Aria session, you can perform functions such as securely processing payment transactions or securely retrieving account information in registration or User Self Service applications.   Allowable Values
  client_sp_alt_rate_sched_ids string array 100 The client alternate rate schedule ID for the supplementary subscription plan being considered.
  surcharge_no array    
  surcharge_no long   The Surcharge number to be attached to the account
  rate_schedule_no long   The Schedule number for this surcharge
  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.
  bkup_bill_first_name string 32 First name of the secondary billing contact
  bkup_bill_mi string 1 Middle Initial of the secondary billing contact
  bkup_bill_last_name string 32 Last name of the secondary billing contact
  bkup_bill_company_name string 100 Company name of the secondary billing contact
  bkup_bill_address1 string 100 First address line of the secondary billing contact
  bkup_bill_address2 string 100 Second address line of the secondary billing contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  bkup_bill_address3 string 100 second address line of the secondary billing contact
  bkup_bill_city string 32 City of the secondary billing contact
  bkup_bill_locality string 32 Locality of the secondary billing contact
  bkup_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.
  bkup_bill_country string 2 Country of the secondary billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  bkup_bill_postal_cd string 14 This is the postal code for the secondary billing contact address.
  bkup_bill_phone string 25 Phone of the secondary billing contact
  bkup_bill_phone_ext string 10 This is the secondary billing contacts extension for the bill_phone given.
  bkup_bill_cell_phone string 25 Cell phone of the secondary billing contact
  bkup_bill_work_phone string 25 Work phone of the secondary billing contact
  bkup_bill_work_phone_ext string 100 This is the work phone extension for the secondary billing contact work phone.
  bkup_bill_email string 500 Email of the secondary billing contact
  bkup_pay_method long 8 This is the method_id corresponding to a secondary payment method such as credit card, Electronic Check, Pre-Paid, Net Terms, etc.   Allowable Values
  bkup_cc_number string 24 Credit card number.
  bkup_cc_expire_mm long 2 Expiration month for the credit card payment instrument.
  bkup_cc_expire_yyyy long 4 Expiration year for the credit card payment instrument.
  bkup_bank_acct_no string 19 This is the bank account number of the account holder's payment method. Together with the (ABA) bank_routing_no, this value is used to execute electronic check or ACH transactions.
  bkup_bank_routing_no string   This is the ABA (American Banking Association) unique identifier for the financial institution.
  bkup_bank_acct_type string 32 The type of bank account being used.   Allowable Values
  bkup_bill_agreement_id string 32 Unique ID of the secondary bill agreement (also referred to as a token).
  bkup_cvv string 5 Card Verification Value, used to help verify a transaction is being requested by the secondary card holder since this value is physically printed on the credit card.
  revrec_profile_id long 8 Profile ID of an existing Revenue Recognition Profile.
  OR      
  revrec_client_defined_id string 100 Client-defined identifier of an existing Revenue Recognition Profile. If this parameter is specified it will take precedence over revrec_profile_id.
  stmnt_email_list string 3000 Deprecated(Deprecated) An array containing the list of additional email addresses
  stmnt_email_list_cc string 3000 An array containing the list of additional cc email addresses
  stmnt_email_list_bcc string 3000 An array containing the list of additional bcc email addresses
  invoice_posting_method_cd long   This configuration specifies whether invoices for this Account need to be manually posted. This setting supersedes the standard client setting for this specific Account.   Allowable Values
  acct_start_date string 14 This is the date, in yyyy-mm-dd format, that this account was originally started.
  min_statement_threshold long   Use this field to specify the balance threshold amount under which a statement should not be sent to the customer. This applies to all customers regardless of payment method.
  max_statements_to_defer long   Use this field to specify the number of statements to skip sending to the customer. Applies only if min_statement_threshold is specified. If left blank, statements shall be suppressed indefinitely as long as the balance is below the threshold.
  defer_full_statements_only long   Use this field to only suppress anniversary statements if the balance is below the min_statement_threshold. If left blank, all generated statements, including mid-cycle statements, shall not be sent to the customer if the balance is below the min_statement_threshold. Applies only if a min_statement_threshold is specified.   Allowable Values
  cc_id long 2 A numeric code indicating the type of credit card.   Allowable Values
  bkup_cc_id long 2 A numeric code indicating the type of credit card.   Allowable Values
  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.
acct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
out_userid string The user ID, unique among all accounts for this Aria client, assigned to the newly created account. If input parameter "user_id" was provided, the same value will be returned. If no "user_id" was provided as input and the client is configured within Aria for automatic generation of random user_id values OR is configured to use account email addresses as user_ids, the generated value will be returned.
invoicing_error_code long Aria-defined error code specific to any error encountered during any invoicing/billing processes performed inline as a result of this method call.
invoicing_error_msg string The explanatory text corresponding to the value returned (if any) in output "invoicing_error_code".
invoice_no long The unique identifier of the invoice, if any, created automatically by Aria in conjunction with this call.
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
out_new_acct_plan_contracts hash  
out_contract_no long The unique ID of the contract assigned to this account
out_contract_plan_no long The unique ID of the plan to which this contract applies
out_client_contract_plan_id string The client-defined unique ID for the plan to which this contract applies
invoice_charges_before_tax double Charges before tax on the initial invoice for this account
invoice_tax_charges double Tax charges on the initial invoice for this account
invoice_charges_after_tax double The sum of invoice_charges_before_tax and invoice_tax_charges
invoice_credit_amount double The amount of credit on the initial invoice for this account
invoice_total_amount double The total owed on the initial invoice for this account
new_acct_invoice_line_items hash  
invoice_line_no long The line number on the initial invoice
invoice_plan_no long The unique ID plan this line represents
invoice_plan_name string The name of the plan this line represents
invoice_service_no long The unique ID for the service this line represents
invoice_service_name string The name of the service this line represents
invoice_service_coa_id long The Chart of Accounts ID for the service this line represents
invoice_units double The number of units of the item or plan on this line
invoice_rate_per_unit double The charge per unit of the item or plan on this line
invoice_line_amount double The subtotal amount of this line
invoice_line_description string The long description of this line, used when printing or otherwise displaying invoices
invoice_start_date_range string The starting date range for the item or plan on this line
invoice_end_date_range string If any, the ending date range for the item or plan on this line.
client_invoice_plan_id string The client-defined unique ID for plan this line represents
client_invoice_service_id string The client-defined unique ID for the service this line represents
client_invoice_service_coa_code string The client-defined Chart of Accounts code for the service this line represents
third_party_errors hash Errors from third-party systems like taxation engines are returned here, whereas the 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 The type of error code being represented, such as taxation
error_code string The error code returned by the third party system
error_msg string The error message returned by the third party system
session_id string Returns the newly created Cookie ID of the account.

You must to post a comment.
Last modified
14:43, 2 Feb 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.