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

 

Home > Aria Crescendo core api > create_acct_complete_m

create_acct_complete_m

This API creates multiple accounts within a parent-child account hierarchy and assigns multiple master plans and, optionally, multiple supplemental plans to each account in the parent-child account hierarchy for Aria clients.

All of the following information can be assigned to the account as it is created using this API.

  • User ID and related login information: User ID, password and secret question information for the account.
  • Contact information: Account, billing and statement contact information, including name, address, email and phone number.
  • Statement information: Specify the statement notification method and format, such as HTML or PDF, and the associated template used to generate a statement for this account.
  • Parent and child plan assignment: Specify which plans on this account are parent plans or child plans and the relationships between them. You can also assign standard and custom rate schedules to plans on the account.
  • Collection, dunning and functional account group assignment: Specify the collection, dunning or functional account groups to which this account is assigned.
  • Payment method/term and taxation status: Specify if the account payment method is a credit card, direct debit, or a payment term, an whether the account is tax-exempt.
  • Invoicing/billing information: Specify proration policy and account or billing start/end dates.
  • Surcharges: Specify the type and amount of surcharges applied to the account.
  • Usage: Specify whether unbilled usage is invoiced and if usage pooling is enabled for the account,
  • Coupons and promotions: Specify coupons and promotions to be applied to the account.
  • Revenue recognition: Specify the revenue recognition profile assigned to this account.
For information on error messages generated by this API, see create_acct_complete_m error messages.

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.
  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
  client_receipt_id string 50 Client-defined unique identifier used to track related system actions
  acct_row array   Defines all information about the top-level account, including contact information, assigned client plans, and payment configuration
  acct array   Defines the child accounts. Zero or more child accounts can be created under the top-level account. Each child account contains the same set of fields as the top-level account, including their own child accounts. This supports the creation of an account hierarchy within a single call to create_acct_complete_m.
  client_acct_id string 50 Client-defined account identifier.
  userid string 32 The user's unique identifier. Every account must have a userid. If the client parameters are not configured to generate this value, the userid must be provided in this API request.
  status_cd long 8 The status of the account after it is created.   Allowable Values
  notify_method long 2 How the client communicates with the account holder. If a notification method is not provided, this value defaults to "1" (HTML email).   Allowable Values
  password string 100 Password for the given user
  secret_question string 300 User's secret question recorded to recover a password
  secret_question_answer string 300 Response to a user's secret_question
  acct_contact_idx long 32 For non-persistent referencing of a contact in the contacts array within the API request. If an idx value is specified, inputs provided for other account contact fields will be ignored.
  first_name string 32 First name of the contact
  mi string 2 Middle initial of the contact
  last_name string 32 Last name of the contact
  company_name string 100 Company name of the contact
  address1 string 300 First address line of the contact.
  address2 string 300 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 300 The third line of the address
  city string 32 City of the contact
  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.
  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 as 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 15 Postal/Zip code for the contact's address
  phone string 25 Phone number for the contact
  phone_ext string 10 Extension for the contact's phone number
  cell_phone string 20 Cell phone number for the contact
  work_phone string 25 Work phone number for the contact
  work_phone_ext string 10 Extension for the contact work phone
  fax string 25 Fax phone number for the contact
  email string 320 Email for the contact.
  birthdate string 10 Birthdate of the contact in yyyy-mm-dd format.
  senior_acct_no long 22 Unique account number for the parent account. It is used to establish parent-child billing relationships. This field, or senior_acct_userid, or client_senior_acct_userid, is required if you are using the current API call to create a child account.
  OR      
  senior_acct_userid string 32 User ID of the parent account
  OR      
  client_senior_acct_id string 50 Client-account ID of the parent account
  legal_entity_no long 22 Aria-assigned legal entity identification number.
  OR      
  client_legal_entity_id string 50 Client-assigned unique identifier for the legal entity.
  invoicing_option long 1 Indicator for performing full invoicing, prorated invoicing or client-defined configuration setting on this account as part of this call.   Allowable Values
  alt_start_date string 10 Alternative start date, in yyyy-mm-dd format, for the master plan instance being assigned on the account. This date can be used to delay providing services to the account holder (for example: until they have been email validated), and must be within one billing interval of the plan being assigned.
  alt_bill_day long 2 Number specifying a day of the month to use as an alternate bill day. You can enter a bill date other than the anniversary date in this field. The invoice_mode must be set to 0 or must be blank to enter a date in this field, it cannot be set to 1.
  retroactive_start_date string 10 Date, in yyyy-mm-dd format, to set for retroactive start.
  override_bill_thru_date string 10 Applicable only for master plan assignment. When provided, this date is used as the bill thru date for the master plan instance. The alt_start_date or retroactive_start_date input is honored with override_bill_thru_date, but invoicing_option must be set to Perform Prorated Invoicing. The date provided must be in the future, must be after the alt_start_date (if provided), and cannot exceed one recurring billing interval. This parameter cannot be used with alt_bill_day or status_until_alt_start (defaults to Inactive). A prorated invoice is generated for recurring services from the effective start date of the plan instance through the override_bill_thru_date provided. If the plan being assigned has no usage services, the next_bill_date (aka anniversary date) is the override_bill_thru_date + 1 day. If the plan has usage services, then the next_bill_date is calculated based on the usage interval to be the earliest date in the future that ensures usage and recurring services are invoiced together on the override_bill_thru_date + 1 day.
  functional_acct_group_row array   Array of functional account groups
  functional_acct_group_no long   The Aria-assigned identifier of the functional account group in which to place this account. A functional account group allows you to categorize your customers based on some common element such as geography, product, or channel.
  OR      
  client_functional_acct_group_id string   Client-defined functional account group ID to which to assign this account
  collection_acct_group_row array   Array for collection account groups.
  collections_acct_group_no long   Group ID for the collections account groups in which to place this account. You can create collections account groups to specify that financial transactions conducted with specific groups of accounts are completed with a specific payment gateway or combination of payment gateways and merchant accounts.

If you created a collections group for a specific payment gateway, be sure to add the account to that collections group during the account registration process or soon afterward. This ensures that collections for accounts in that collections group are completed successfully.

  OR      
  client_collections_acct_group_id string   Client-defined collections account group ID to assign to this account
  supp_field_row array   Assigns one or more supplemental field values to the account
  supp_field_name string   Name of the supplemental field. This value is required if you want to assign supplemental fields. For example, if you have any accounts that are tax-exempt or international, you must set up corresponding account supplemental fields prior to your tax provider configuration. Create fields for the tax exemption number and for the VAT ID used by the tax provider.
  supp_field_value string   Value for the supplemental field
  test_acct_ind long 1 Indicates that the account is a test account and is treated as such in the system. The default value is 0.   Allowable Values
  acct_start_date string 10 Date, in yyyy-mm-dd format, on which the account was first created outside of Aria
  acct_currency string   3-character ISO-compliant currency code in lowercase for monetary values used for this account
  seq_func_group_no long 22 Functional account group number specifically designated for statement sequence number assignment
  OR      
  client_seq_func_group_id string 100 Client-defined functional account group number specifically designated for statement sequence number assignment
  taxpayer_id string 32 Taxpayer identification number
  tax_exemption_level long 1 Provides the Tax Exemption Level for the account. This field only applies to the Aria internal tax engine.   Allowable Values
  list_start_master_file long 1 Indicates whether the account is listed at the start of a master file.   Allowable Values
  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
  cn_alt_msg_template_no long   Alternate email template number to use for this account
  OR      
  client_cn_alt_msg_template_id long 100 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
  acct_surcharges_row array    
  acct_surcharge_no long 22 Surcharge number to be attached to the account
  client_surcharge_id string 100 Note that only those surcharges with Surcharge Applicablity Scope of Account or Account and Master Plan Instance should be accepted.
  acct_rate_schedule_no long 22  
  coupon_codes string array   Coupon codes to assign to this account, if any
  payment_method_row array    
  pay_method_type long 8 ID corresponding to a payment method such as credit card, electronic check, prepaid, etc. You must specify a payment method when creating billing information.   Allowable Values
  pay_method_name string 100 Human-readable name of the payment method
  pay_method_description string 1000 Description for the plan method
  client_pay_method_cdid string 100 System-defined statement payment method ID
  payment_method_idx long 8 For non-persistent referencing of a payment method within the API request
  bill_contact_idx long 32 For non-persistent referencing of a contact in the contacts array within the API request. If an idx value is specified, inputs provided for other account contact fields will be ignored.
  first_name string 32 First name of the billing contact
  mi string 2 Middle initial of the billing contact
  last_name string 32 Last name of the billing contact
  company_name string 100 Company name of the billing contact
  address1 string 100 First address line of the contact.
  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.
  address3 string 100 The third line of the address
  city string 32 City of the billing contact
  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.
  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 billing contact as the ISO-compliant 2-character country code abbreviation in uppercase.
  postal_cd string 14 Postal/Zip code for the billing contact's address
  phone string 25 Phone number for the billing contact
  phone_ext string 10 Extension for the billing contact's phone number
  cell_phone string 20 Cell phone number for the billing contact
  work_phone string 25 Work phone for the billing contact.
  work_phone_ext string 10 Extension for the billing contact's work phone
  fax string 25 Fax phone number for the billing contact
  email string 320 Email for the billing contact
  birthdate string 10 Birthdate of the contact in yyyy-mm-dd format.
  cc_num string 20 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_num string 19 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 9 ABA (American Banking Association) unique identifier for the financial institution
  cvv string 6 Card Verification Value, used to verify a transaction is being requested by the card holder since this value is physically printed on the credit card
  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
  taxpayer_id string 32 Taxpayer identification number
  bill_agreement_id string 32 Unique ID of the bill agreement (also referred to as a token).
  iban string 50 International Bank Account Number(IBAN). Used for the Direct Debit payment method. It consists of 16 to 34 alphanumeric characters. Only hyphens and spaces 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 15 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 15 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.
  cc_id long 2 A numeric code indicating the type of credit card.   Allowable Values
  billing_group_row array   This array contains information about the account's billing groups. A billing group defines the statement configuration, primary payment method, and/or backup payment method for one or more master plan instances.
  billing_group_name string 32 Billing group name.
  billing_group_description string 1000 Billing group description.
  client_billing_group_id string 38 Client-defined billing group ID. This value must be unique across all client accounts. This field can also be used as a reference to assign this billing group to one or more master plan instances within this API request. Either the client_billing_group_id or billing_group_idx must be defined if the billing group is used by one or more master plans within the API request.
  billing_group_idx long 22 Non-persistent billing group identifier. This numeric identifier (1 for the first billing group, 2 for the second, and etc.) allows the billing group to be assigned to one or more Master Plan Instances within this API request. Either the client_billing_group_id or billing_group_idx must be defined if the billing group is used by one or more master plans within the API request.
  notify_method long 2 How the client communicates with the account holder. If a notification method is not provided, this value defaults to "1" (HTML email).   Allowable Values
  notify_template_group long 32 Notify template number
  statement_template long 32 Statement template number
  credit_note_template long 32 Credit note template number
  payment_option string 7 This allows you to select either payment methods (such as a credit card or other electronic form of payment) or payment terms (such as a physical check) when creating or modifying a billing group'   Allowable Values
  primary_client_payment_method_id string 32 Client-defined identifier for the billing group's primary payment method.
  OR      
  primary_payment_method_idx long 32 Non-persistent identifier for the billing group's primary payment method.
  backup_client_payment_method_id string 100 Client-defined identifier for the billing group's backup payment method.
  OR      
  backup_payment_method_idx long 100 Non-persistent identifier for the billing group's backup payment method.
  stmt_contact_idx long 32 For non-persistent referencing of a contact in the contacts array within the API request. If an idx value is specified, inputs provided for other account contact fields will be ignored.
  first_name string 32 First name of the statement contact
  mi string 2 Middle initial of the statement contact
  last_name string 32 Last name of the statement contact
  company_name string 100 Company name of the statement contact
  address1 string 100 First address line of the contact.
  address2 string 100 Second address line of the statement 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 City of the statement contact
  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.
  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 statement contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  postal_cd string 14 Postal/Zip code for the statement contact's address
  phone string 25 Phone number of the statement contact
  phone_ext string 10 Extension for the statement contact's phone number.
  cell_phone string 20 Cell phone number of the statement contact
  work_phone string 25 Work phone number of the statement contact
  work_phone_ext string 10 Extension for the statement contact's work phone.
  fax string 25 Fax phone number for the statement contact
  email string 320 Email for the statement contact
  birthdate string 10 Birthdate of the contact in yyyy-mm-dd format.
  list_start_master_file long 1 Indicates whether the account is listed at the start of a master file.   Allowable Values
  payment_terms_no long 22 Payment terms number assigned to the account.
  payment_terms_name string 50 Payment terms name assigned to the account.
  client_payment_term_id string 32 Client-defined identifier for the billing group's payment term
  ean_gln_num string 50 'This is the European Article Number or Global Location Number that is a required field if a payment option is terms AND client payment term ID matches a term in which the payment term type equals EAN/GLN. This number is provided by Aria's client's customers and is unique to each customer (account).'
  ean_gln_requisition_num string 50 'This is the European Article Number requisition number or Global Location Number requisition number that is a required field if a payment option is terms AND client payment term ID matches a term in which the payment term type equals EAN/GLN. This number is provided by Aria's client's customers and is used to track their individual projects similarly to a purchase order. This number is generated by the individual customer (account) and is not provided by any other party'
  credit_memo_template long 22 Credit template no.
  rebill_template long 22 Rebill template no.
dunning_group_row array   This array contains information about the account's dunning groups. A dunning group defines the process followed for delinquent payments associated with one or more master plan instances. Each account must have at least one master plan instance, and each master plan instance must have a dunning group. Therefore, you must define at least one dunning group for each account in the API request.
  dunning_group_name string 100 Name of the dunning group
  dunning_group_description string 1000 Description of the dunning group
  client_dunning_group_id string 100 Client-defined dunning group ID. This value must be unique across all client accounts. This field can also be used as a reference to assign this dunning group to one or more master plan instances within this API request. Either the client_dunning_group_id or dunning_group_idx must be defined if the dunning group is used by one or more master plans within the API request.
  dunning_group_idx long 22 Non-persistent dunning group identifier. This numeric identifier (1 for the first dunning group, 2 for the second, and etc.) allows the dunning group to be assigned to one or more Master Plan Instances within this API request. Either the client_dunning_group_id or dunning_group_idx must be defined if the dunning group is used by one or more master plans within the API request.
  dunning_process_no long 22 Dunning process.
  OR      
  client_dunning_process_id string 100 Client-defined dunning process identifier.
  contracts_row array    
  client_contract_id string 100 Client-assigned unique contract identifier
  contract_type_no long 8 Type ID of this contract. Placing a value in this field indicates that you are assigning a contract to this account.   Allowable Values
  contract_length_months long 4 Number of months this contract remains on the account. This field must be blank if you specify values in the contract_end_date field.'
  contract_cancel_fee double   Fee charged to the account for prematurely ending this contract
  contract_comments string   Any client-defined comments stored on this contract at the account level
  contract_start_date string 10 Date, in yyyy-mm-dd format, on which this contract takes effect. If contract_length_months is blank, and this field is blank, but client_contract_id is specified, then the start date for the contract defaults to today's date.
  contract_end_date string 10 Date, in YYYY-MM-DD format, on which this contract ends. If the contract_length_months field is valued, this field must be blank. If the contract_start_date field has a value, and the contract_length_months field is blank, then this field must have a value that falls after the value in the contract_start_date field.
  contract_plans_row array   List of plan instance(s) to be associated with the contract.
  plan_instance_idx long 22 If you enter a value in this field, the contract you specify in the client_contract_id field is applied to the plan(s) you specify here. Otherwise, the contract is assigned at the account level.
  OR      
  client_plan_instance_id string 100 Client-defined plan instance to be associated with the contract
  cascade_action string 5 Determines whether to include all child plan instances of the plan instance specified at the time of contract assignment in the contract   Allowable Values
master_plans_detail_row array   Allows multiple master plans subscription for an account
plan_no long 22 System-defined master subscription plan number. This is the plan number you are assigning to the account. You must assign at least one plan to the account.
  OR      
  client_plan_id string 100 Client-defined master plan subscription plan ID.
  plan_instance_description string 1000 Description for each assigned master plan
  client_plan_instance_id string 100 Unique client-defined ID for each assigned master plan
  plan_instance_idx long 22 For non-persistent referencing of a plan instance within the API request
  promo_cd string 30 Code provided by 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
  plan_instance_units long 8 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
  plan_unit_instances_row array   Array of plan unit instances
  client_plan_unit_inst_id string 100 Client-assigned identifier for the plan unit instance. If valued, creates a plan unit instance for the plan you are assigning to this account.
  plan_unit_instance_services_row array   Array of plan unit instance services
  service_no long 100 Specifies the Aria-assigned unique service identifier against which fulfillment details must be captured and stored.
  OR      
  client_service_id string 100 Client-assigned identifier for the service (only for fulfillment based service)
  service_fulfillment_date string 10 Fulfilment completion date. Can be a past, current or future date. This field is required if the fulfillment_directive field is set to "2".
  fulfillment_directive long 8 Derives whether the fulfillment date is assigned/modified or removed from the fulfillment based service on the plan unit instance   Allowable Values
  plan_unit_inst_fields_row array   Array of client-defined plan unit instance fields
  field_name string 300 Field name of plan unit instance field. Entering a value in this field creates a field if it does not exist, or assigns it if it does exist.
  field_value string 1000 Value stored under this field
  plan_unit_inst_directive long 8 Directive is mandatory if field name/value pair are specified   Allowable Values
  plan_instance_status long 8 Status of the object in question for the current API call   Allowable Values
  resp_level_cd long 1 Responsibility level code. This determines how the usage, invoicing, statement generation, and payment processing are managed under this master plan instance.

If the value is "1" (Standard Self Pay), the Master Plan Instance must have a billing group, which you assign using either client_billing_group_id or billing_group_idx.

If the value is "2" (Parent Pay) or "3" (Parent Usage & Pay), the Master Plan Instance does not need a billing group, but must have a responsible Master Plan Instance, which you assign using either resp_master_plan_inst_no, client_resp_master_plan_inst_id, or resp_master_plan_inst_idx. The responsible Master Plan Instance must be owned by another account that is a parent or ancestor of the account you are creating.   Allowable Values

resp_master_plan_inst_no long 100 System-defined identifier for the master plan instance in a parent account that is responsible for payment and/or usage tracking of this master plan. The responsible master plan instance must exist before this API request is executed. Either this field, client_resp_master_plan_inst_id, or resp_master_plan_inst_idx must be valued if the resp_level_cd is set to either "2" or "3". Otherwise, it must be blank.
  OR      
  client_resp_master_plan_inst_id string 100 Client-defined identifier for the master plan instance in a parent account that is responsible for payment and/or usage tracking of this master plan. The responsible master plan instance must either exist before this API request is executed, or is created within this API request. Either this field, resp_master_plan_inst_id, or resp_master_plan_inst_idx must be valued if the resp_level_cd is set to either "2" or "3". Otherwise, it must be blank.
  OR      
  resp_master_plan_inst_idx long 22 Non-persistent identifier for the master plan instance in a parent account that is responsible for payment and/or usage tracking of this master plan instance. The responsible master plan instance must be created within this API request. Either this field, client_resp_master_plan_inst_id, or resp_master_plan_inst_no must be valued if the resp_level_cd is set to either "2" or "3". Otherwise, it must be blank.
  OR      
  client_billing_group_id string 100 Client-defined identifier for the billing group to which this master plan instance belongs. Either this field, or billing_group_idx must be valued if the resp_level_cd is set to "1". Otherwise, it must be blank.
  OR      
  billing_group_idx long 22 Non-persistent identifier for the billing group to which this master plan instance belongs. Either this field, or client_billing_group_id must be valued if the resp_level_cd is set to "1". Otherwise, it must be blank.
client_dunning_group_id string 100 Client-defined identifier for the dunning group to which this master plan instance belongs. Each master plan instance must be assigned to one of the dunning groups defined in this API request, using either the client_dunning_group_id or dunning_group_idx.
  OR      
  dunning_group_idx long 22 Non-persistent identifier for the dunning group to which this master plan instance belongs. Each master plan instance must be assigned to one of the dunning groups defined in this API request, using either the client_dunning_group_id or dunning_group_idx.
  status_until_alt_start long 8 Status of the master plan instance 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. If an alternate starting date or alternate bill day is provided, the master plan instance 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. When a master plan is assigned with an alt_start_date and status_until_alt_start as pending activation (32), then the user will not have the option to delete the queued future plan changes for the master plan and supplemental plan. If the user needs to delete the queued future plan change, then select a status other than pending activation.   Allowable Values
  balance_forward double 12 balance forward
  coupon_codes string array   Coupon codes to assign to this plan instance, if any
  mpi_surcharges_row array   Surcharge for master plan.
  mpi_surcharge_no long 22  
  mpi_rate_schedule_no long 22  
  nso_bill_immediately long 1 Indicates whether to bill the NSO items immediately or, if not, to set bill on next billing anniversary date   Allowable Values
  master_plan_services_row array   List of services associated with the master plan being assigned on the account
  service_no long 22 Multidimensional array of services for this plan
  OR      
  client_service_id string 100 Multidimensional array of client-defined service ID for this plan
  svc_location_no long 22 Aria-assigned unique location identifier
  client_svc_location_id string 100 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 takes precedence.
  dest_contact_idx long 32 The Aria-assigned address sequence number
  master_plan_nso_list_row array   Non-Subscription Offerings that are purchased with the plan
  client_sku string 100 Client SKU of NSO/Inventory item. Entering a value in this field includes this SKU in the order being created.
  item_units long 22 NSO quantity that is purchased along with plan.
  item_svc_location_no long 22 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 takes precedence.
  client_item_svc_location_id string 100 Client-defined unique identifier for the origin location for the item (NSO) being purchased
  item_dest_contact_idx long 32 Aria-assigned address sequence number
  nso_po_num string 100 Purchase order number assigned to the one-time order
  plan_instance_fields_info_row array    
  field_no long 38 Product field number
  OR      
  field_name string 100 Product field name
  field_value string 1000 Value of the product field. Values for product fields that do not match what is expected based on product field configuration are ignored.
  alt_rate_schedule_no long 22 Aria-assigned identifier for an alternative rate schedule that is assigned to the master plan in place of the default rate schedule
  OR      
  client_alt_rate_schedule_id string 100 Client-defined alternate rate schedule ID
  usage_accumulation_reset_months long 4 Number of reset months for each plan.
  usage_pooling string 5 Indicates whether usage pooling is enabled for this plan instance. Allowable values are 'true' and 'false'.   Allowable Values
  usage_threshold_applicability string 2 Usage tracking options on the plans in the account.   Allowable Values
  custom_rates_row array   Array of custom rates for the services provided in the master plan
  custom_rate_service_no long 22 Aria-assigned identifier for the service. Entering a value in this field creates a custom rate for the plan instance you are assigning to the account.
  OR      
  custom_rate_client_service_id string 32 Client-defined identifier for the service
  custom_rate_seq_no long 22 Rate tier number, relative to the specified service, to which this custom rate is applied. This field is required if you are creating a custom rate for this plan instance.
  custom_rate_from_unit long 12 Unit starting point for the specified rate tier number
  custom_rate_to_unit long 12 Unit-end point for the specified rate tier number
  custom_rate_per_unit double 22 Custom rate per unit for the specified service and rate tier number
  po_num string 100 Purchase order number assigned to the plan instance
  supp_plan_row array   Supplemental plan instances assigned directly under a master plan instance
  supp_plan array   Supplemental plan instances assigned under another supplemental plan instance. This contains the same set of fields as the supplemental plan instances located directly under a master plan instance. This supports the creation of a master/supplemental plan structure, with a top-level master plan instance containing a hierarchy of supplemental plan instances.
  plan_no long 22 Aria-assigned identifier for a supplemental service plan. Allowable values are limited to valid custom plan numbers for a client. Entering a value in this field assigns a supplemental plan to a master plan instance on an account.
  OR      
  client_plan_id string 100 Client-defined supplemental plan ID
  plan_instance_description string 1000 Description for each assigned master plan
  client_plan_instance_id string 100 Unique client-defined ID for each assigned master plan
  plan_instance_idx long 22 Used for non-persistent referencing of a plan instance within the API request. Entering a value in this field is required to map the supplemental plan to its parent plan instance.
  plan_instance_units long 8 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_plan_services_row array   List of services associated with the master plan being assigned on the account
  service_no long 22 A multidimensional array of Services for this plan
  OR      
  client_service_id string 100 Multidimensional array of client-defined service ID for this plan
  svc_location_no long 22 Aria-assigned unique location identifier.
  client_svc_location_id string 100 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 takes precedence.
  dest_contact_idx long 32 Aria-assigned address sequence number
  plan_unit_instances_row array   Array of plan unit instances
  client_plan_unit_inst_id string 100 Client-assigned identifier for the plan unit instance. Entering a value in this field is required if you are creating a plan unit instance for a supplemental plan.
  plan_unit_instance_services_row array   Array of plan unit instance services
  service_no long 100 Specifies the Aria-assigned unique service identifier against which fulfillment details must be captured and stored. You must enter a value in this field if you are creating a plan_unit_instance for a supplemental plan.
  OR      
  client_service_id string 100 Client-assigned identifier for the service (only for fulfillment based service)
  service_fulfillment_date string   Fulfillment completion date. Can be in past, today or future date.
  fulfillment_directive long 8 Derives whether the fulfillment date is assigned/modified or removed from the fulfillment based service on the plan unit instance.   Allowable Values
  plan_unit_inst_fields_row array   Array of client-defined plan unit instance fields
  field_name string 300 Field name of plan unit instance field. Entering a value in this field creates a supplemental field for the plan unit instance.
  field_value string 1000 The value stored under this field
  plan_unit_inst_directive long 8 Directive is mandatory if field name/value pair are specified.   Allowable Values
  supp_plan_nso_list_row array   Non-Subscription offerings that are purchased with the plan
  client_sku string 100 Client SKU of the NSO/Inventory item. Entering a value in this field includes the item in the order being created.
  item_units long 22 NSO quantity that is purchased along with plan
  item_svc_location_no long 22 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 takes precedence.
  client_item_svc_location_id string 100 Client-defined unique identifier for the origin location for the item (NSO) being purchased
  item_dest_contact_idx long 32 Aria-assigned address sequence number
  plan_instance_fields_info_row array    
  field_no long 38 Product field number. Entering a value in this field creates a plan instance field for the supplemental plan.
  OR      
  field_name string 100 Field name of plan unit instance field. Entering a value in this field creates a field if it does not exist, or assigns it if it does exist.
  field_value string 1000 Value of the product field. Values for product fields that do not match what is expected based on product field configuration are ignored.
  alt_rate_schedule_no long 22 Aria-assigned identifier for an alternative rate schedule that is assigned to the supplemental plan in place of the default rate schedule
  OR      
  client_alt_rate_schedule_id string 100 Client-defined alternate rate schedule ID
  usage_accumulation_reset_months long 4 Number of reset months for each plan
  usage_pooling string 5 Indicates whether usage pooling is enabled for this plan instance. Allowable values are 'true' and 'false'.   Allowable Values
  usage_threshold_applicability string 2 Usage tracking options on the plans in the account   Allowable Values
  custom_rates_row array   Array of custom rates for the services provided in the supplemental plan
  custom_rate_service_no long 22 Aria-assigned identifier for the service. Entering a value in this field is required to create custom rates for the associated plan.
  OR      
  custom_rate_client_service_id string 32 Client-defined identifier for the service.
  custom_rate_seq_no long 22 Rate tier number, relative to the specified service, to which this custom rate is applied. Entering a value in this field is required to create custom rates for the associated plan.
  custom_rate_from_unit long 22 Unit starting point for the specified rate tier number
  custom_rate_to_unit long 22 Unit ending point for the specified rate tier number
  custom_rate_per_unit double 22 Custom rate per unit for the specified service and rate tier number
  po_num string 100 Purchase order number assigned to the plan instance
  consumer_acct_ind string   Indicates that the account represents a single individual, used primarily in Business-to-Consumer (B2C) business models. The primary purpose of this field is to support Person Accounts objects in Salesforce via Aria for Salesforce.   Allowable Values
  revrec_profile_no long 8 Profile ID of an existing revenue recognition profile
  OR      
  client_revrec_id string 100 Client-defined identifier of an existing revenue recognition profile. If this parameter is specified, it takes precedence over revrec_profile_no.
  po_num string 100 Purchase order number assigned to the account.
  locale_no long 22 Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients.
  OR      
  locale_name string 50 Name of the locale.
  contacts_row array   List of contacts to be created on the account. Note that contacts not used as an account contact, billing contact, or statement contact are saved on the account.
  contact_idx long 32 Aria-assigned address sequence number
  first_name string 32 First name of the contact
  middle_initial string 2 Middle initial of the contact
  last_name string 32 The last name of the contact
  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.
  address3 string 100 The third line of the address
  city string 32 City of the contact
  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.
  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 Country of the contact as the ISO-compliant 2-character country code abbreviation in uppercase
  postal_cd string 14 Postal/Zip code of the contact
  phone string 25 Phone number for the contact
  phone_ext string 10 Extension for the contact's phone number
  cell_phone string 20 Cell phone number for the contact
  work_phone string 25 Work phone number for the contact
  work_phone_ext string 10 Work phone number extension of the contact
  fax string 25 Fax number of the contact
  email string 320 Email address for the contact
  birthdate string 10 Birthdate of the contact in yyyy-mm-dd format.
  combine_invoices long 1 Indicator for combining invoices when retroactive start dates, negative bill lag days, or plan changes just prior to the next billing date would otherwise have generated multiple invoices. The allowable values are 1, 2, or 3.   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.
out_acct hash  
acct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
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 is 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 is returned.
client_acct_id string Client-defined account identifier.
acct_locale_no long Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts.
acct_locale_name string Name of the account level locale.
acct_contact_no long The Aria-assigned unique identifier for the account contact saved on the account.
billing_contact_details hash List of billing contacts saved on the account.
payment_method_no long Aria-assigned unique identifier for the payment method on the account
bill_contact_no long The Aria-assigned unique identifier for the contact on this account to be used as the billing contact for the payment method. If bill_contact_no is included in the API request, all other billing contact parameters are ignored.
statement_contact_details hash List of statement contacts saved on the account.
billing_group_no long Aria-assigned unique identifier for the billing group on the account
stmt_contact_no long The Aria-assigned unique identifier for the statement contact associated with a billing group on the account.
other_contact_details hash List of contacts saved on the account that are not used as an account, billing, or statement contact
other_contact_no long Aria-assigned unique identifier for the contact saved on the account
other_contact_idx long Value provided for the idx parameter in the API request
contract_details hash  
contract_no long Unique ID of the contract assigned to this account
client_contract_id string Client-assigned unique contract identifier
contract_plan_details hash  
plan_instance_no long List of plan instance(s) to be associated with the contract
client_plan_instance_id string List of client-defined plan instance(s) to associated with the contract
contract_scope string Specifies the scope of plan subscription coverage enforced by the contract
session_id string Returns the newly created cookie ID of the account
billing_errors hash  
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"
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 if statement generation fails
statement_error_msg string Text message associated with statement_error_code
billing_group_no long The billing group number mapped against each master plan
client_billing_group_id string Client-defined billing group ID
master_plans_assigned hash  
plan_instance_no long Unique plan-instance number for each assigned master plan
client_plan_instance_id string Unique client-defined ID for each assigned master plan
nso_order_no long Unique identifier for an order that is created for bundled NSOs
nso_order_status_label string Status label for this order
plan_unit_instance_details hash Array of plan unit instances
out_plan_unit_inst_no long Aria unique plan unit instance number
out_client_plan_unit_inst_id string Client-assigned identifier for the plan unit instance
supp_plans_assigned hash  
supp_plan_instance_no long Unique plan-instance number for each assigned supplementary plan
client_plan_instance_id string Unique client-defined ID for each assigned supplementary plan
plan_unit_instance_details hash Array of plan unit instances
out_plan_unit_inst_no long Aria unique plan-unit instance number
out_client_plan_unit_inst_id string Client-assigned identifier for the plan unit instance
out_contract hash  
contract_no long Unique ID of the contract assigned to this account
plan_instance_no long Unique plan-instance number for each assigned master plan
client_plan_instance_id string Unique client-defined ID for each assigned master plan
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
invoice_info hash  
invoice_no long The unique identifier of the invoice, if any, created automatically by Aria in conjunction with this call
billing_group_no long The billing group number mapped against each master plan
client_plan_instance_id string Unique client-defined ID for each assigned master plan
proc_cvv_response string Processor return code from CVV validation
proc_avs_response string Processor return code from address validation
proc_cavv_response string Processor return code for security validation
proc_status_code string Processor status code
proc_status_text string Processors status description
proc_payment_id string 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_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
total_credit double Total amount of the credit to be applied to the account
total_tax_credit double The tax amount of the credit to be applied
total_credit_before_tax double The credit to be applied before tax is taken into account
total double Grand total of this invoice
proration_result_amount double The currency amount of any resulting proration action performed as a result of the fulfillment based service unit assignment. When proration is performed the value returned in this field is a positive currency value (indicating a resulting charge to the account). If the value passed in field do_write is false then any positive value returned in this field is notational only, demonstrating what proration effect would be applied to the account if the requested fulfillment based plan unit instance were to be actually assigned.
expected_monthly_rec_cost double Predicted monthly recurring cost of the items and plans on this invoice
expected_annual_rec_cost double Predicted annual recurring cost of the items and plans on this invoice
invoice_items hash  
invoice_line_no long The line number on the initial invoice
plan_no long The unique ID plan this line represents
client_plan_id string Client-defined unique ID for plan this line represents
plan_instance_no long Unique plan instance number for each assigned master plan
client_plan_instance_id string Unique client-defined ID for each assigned master plan
plan_name string Name of the plan this line represents
service_no long Unique ID for the service this line represents
client_service_id string Client-defined unique ID for the service this line represents
service_name string Name of the service this line represents
service_coa_id long Chart of Accounts ID for the service this line represents
client_service_coa_code string Client-defined Chart of Accounts code for the service this line represents
units double Number of units of the item or plan on this line
rate_per_unit double Charge per unit of the item or plan on this line
line_amount double Subtotal amount of this line
line_description string Long description of this line, used when printing or otherwise displaying invoices
start_date_range string Starting date range for the item or plan on this line
end_date_range string Ending date range for the item or plan on this line, if any
line_type long Type of charge or credit associated with this line item
base_plan_units double Full, non-prorated number of units of the service code
proration_factor double Percentage of the line_base_units billed
proration_text string Prorated days in total days
proration_remaining_days long Prorated days of period in this invoice
proration_description string Prorated invoice description
credit_coupon_code string Coupon code applied to the invoice
client_sku string Client SKU of the NSO/Inventory item.
order_no long Unique identifier for an order in the context of an client_no and account_no
item_no long Unique ID of the item being retrieved
client_item_id string Unique client-defined item ID being retrieved
adv_billing_period_total_days long Total days of period in this invoice
rate_schedule_no long Aria-assigned unique rate schedule number
rate_schedule_tier_no long Sequential number in the rate schedule for determining tiers
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 returns 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 returns 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  
tax_detail_line long Line number associated with each tax detail record
seq_num long Tax line on the invoice which includes the tax amount associated with this tax_detail_line
taxed_seq_num long 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 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
out_acct hash  

You must to post a comment.
Last modified
09:46, 27 Jul 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.