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



 

Home > Tech Writers Hub > 2020 Search Improvement Deleted Pages > apidocs > 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.

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   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
  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-assigned identifier for the account.
  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 object in question for the current API call.   Allowable Values
  notify_method long   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 Users secret question recorded to recover a password.
  secret_question_answer string 300 Response to a user's secret_question.
  first_name string 32 Contact First name.
  mi string 1 Middle Initial of the contact.
  last_name string 32 Contact last name.
  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.
  address3 string 300 Third address line of the contact.
  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.
  postal_cd string 15 Postal/Zip code for the contact address.
  phone string 25 Phone number of the contact.
  phone_ext string 10 Extension for the contact phone.
  cell_phone string 20 Contact cell phone.
  work_phone string 25 Work phone number of the contact.
  work_phone_ext string 10 Extension for the contact work phone.
  fax string 25 FAX phone number for the contact.
  email string 500 Email of the contact.
  birthdate string 14 Contact date of birth.
  senior_acct_no long 22 Unique account number for the parent account. It is used in establishing parent-child billing relationships.
  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.
  invoicing_option long   Indicator for performing full invoicing, and Perform Prorated Invoicing or client-defined on this account as part of this call.   Allowable Values
  alt_start_date string 14 Alternative start date for the account. This date can be used to delay providing services to the account holder (for example: until they have been email validated).
  alt_bill_day long 14 Alternate bill day.
  retroactive_start_date string 14 Date to set for retroactive start.
  functional_acct_group_row array    
  functional_acct_group_no long   Array of functional account groups.
  OR      
  client_functional_acct_group_id string   Functional account group ID to which this account should be assigned.
  collection_acct_group_row array    
  collections_acct_group_no long   Group ID for the collections account groups in which to place this account.
  OR      
  client_collections_acct_group_id string   Collections account group ID to which this account should be assigned.
  supp_field_row array   Assigns one or more supplemental field values to the account.
  supp_field_name string   Name of the supplemental field.
  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.   Allowable Values
  acct_start_date string 14 Date 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 in the context of this API method.
  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 System-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.   Allowable Values
  list_start_master_file long   Indicates whether or not 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   Boolean indicator to override client's default configured behaviour for creating Pending/Real invoice.   Allowable Values
  create_session string   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   Surcharge number to be attached to the account.
  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 Method_id corresponding to a payment method such as credit card, Electronic Check, Pre-Paid, Net Terms, etc.   Allowable Values
  pay_method_name string   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.
  first_name string 32 First name of the billing contact.
  mi string 1 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 billing contact.
  address2 string 100 Second address line of the billing contact.
  address3 string 100 Third address line of the billing contact.
  city string 32 City of the billing contact.
  locality string 32 Locality of the billing 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 billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  postal_cd string 14 Postal code for the billing contact address.
  phone string 25 Phone of the billing contact.
  phone_ext string 10 Billing contacts extension for the phone given.
  cell_phone string 20 Cell phone of the billing contact.
  work_phone string 25 Work phone of the billing contact.
  work_phone_ext string 100 Extension for the billing contact work phone.
  fax string 25 FAX phone number for the billing contact.
  email string 500 Email of the billing contact.
  birthdate string 14 Billing contact date of birth.
  cc_num 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_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   ABA (American Banking Association) unique identifier for the financial institution.
  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.
  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
  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 Enables 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 A standard format of Bank Identifier Codes (BIC). Used for the Direct Debit payment method. It consists of 8 or 11 alphanumeric characters. Only hyphens and spaces 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 50 35 characters alphanumeric. 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 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 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 8 Non-persistent billing group identifier. This numeric identifier (that is., 1 for the first billing group, 2 for the second, and so on) 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   If notification method is not provided, value defaults to 1 (HTML email).   Allowable Values
  notify_template_group long 32 Notify template No.
  statement_template long 32 Statement template No.
  credit_note_template long 32 Credit note template No.
  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 32 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.
  first_name string 32 First name of the statement contact.
  mi string 1 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 statement contact.
  address2 string 100 Second address line of the statement contact.
  address3 string 100 Third address line of the statement contact.
  city string 32 City of the statement contact.
  locality string 32 Locality of the statement 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 statement contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  postal_cd string 14 Postal code for the statement contact address.
  phone string 25 Phone of the statement contact.
  phone_ext string 10 This is the statement contacts extension for the phone given.
  cell_phone string 20 Cell phone of the statement contact.
  work_phone string 25 Work phone of the statement contact.
  work_phone_ext string 100 This is the work phone extension for the statement contact work phone.
  fax string 25 Specifies the FAX phone number for the statement contact.
  email string 500 Email of the statement contact.
  birthdate string 14 Statement contact date of birth.
  list_start_master_file long 8 When value=1, account shall be sorted at the top of the master file when generated.   Allowable Values
  payment_terms_no long   Payment terms number assigned to the account.
  payment_terms_name string 50 Payment terms name assigned to the account.
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 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 8 Non-persistent dunning group identifier. This numeric identifier (that is., 1 for the first dunning group, 2 for the second, and so on) 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.   Allowable Values
  contract_length_months long   Number of months this contract should remain on the account.
  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   Date 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.
  contract_plans_row array    
  plan_instance_idx long 22 List of plan instance(s) to be associated with the contract.
  OR      
  client_plan_instance_id string 100 List of client defined plan instance(s) 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   Allow multiple master plans subscription for an account.
plan_no long 22 The system-defined Master Subscription plan number.
  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 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   Client-assigned identifier for the plan unit instance.
  plan_unit_instance_services_row array   Array of plan unit instance services.
  service_no long 100 Specifies the Aria-assigned unique service identifier.
  OR      
  client_service_id string   Client-assigned identifier for the service (only for fulfillment based service).
  service_fulfillment_date string   It is a Fulfillment completion date. It can be in past, today or future date.
  fulfillment_directive long 8 This derives whether the fulfillment date should be 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   Field name of plan unit instance field.
  field_value string   The value stored under this field.
  plan_unit_inst_directive long 8 The 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   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 8 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.
  OR      
  dunning_group_idx long 8 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. Other acceptable values for status_until_alt_start are any valid plan statuses. If an alternate starting date or alternate bill day is passed in, 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.
  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   Indicates whether to bill the NSO items immediately or, if not, to set bill on next billing anniversary date.   Allowable Values
  master_plan_nso_list_row array   Non-Subscription Offerings that are purchased with the plan.
  client_sku string   Client SKU of NSO/Inventory item.
  item_units long   NSO quantity that is purchased along with plan.
  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   Number of reset months for each plan.
  usage_pooling string 32 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
  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.
  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.
  custom_rate_from_unit long 12 Unit starting point for the specified rate tier number.
  custom_rate_to_unit long 12 Unit ending point for the specified rate tier number.
  custom_rate_per_unit double 12 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 client.
  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.
  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   Client-assigned identifier for the plan unit instance.
  plan_unit_instance_services_row array   Array of plan unit instance services.
  service_no long 100 Specifies the Aria-assigned unique service identifier.
  OR      
  client_service_id string   Client-assigned identifier for the service (only for fulfillment based service).
  service_fulfillment_date string   It is a Fulfillment completion date. It can be in past, today or future date.
  fulfillment_directive long 8 This derives whether the fulfillment date should be 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   Field name of plan unit instance field.
  field_value string   The value stored under this field.
  plan_unit_inst_directive long 8 The 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   The client sku of NSO/Inventory item
  item_units long   NSO quantity that is purchased along with plan.
  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 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   Number of reset months for each plan.
  usage_pooling string 32 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
  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.
  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.
  custom_rate_from_unit long 12 Unit starting point for the specified rate tier number.
  custom_rate_to_unit long 12 Unit ending point for the specified rate tier number.
  custom_rate_per_unit double 12 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 the SFDC Connector.   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 will take precedence over revrec_profile_no.
  po_num string 100 Purchase order number assigned to the account.
  alt_caller_id string 100  
  optional_transaction_qualifiers array    
  qualifier_name string 100  
  qualifier_value string 100  
  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 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.
client_acct_id string The client_acct_id of this account, if one was supplied by the client.
contract_details hash  
contract_no long The 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 be 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 The 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 The 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 The 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 identifer 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 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_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 The 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 The 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 will be 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 The predicted monthly recurring cost of the items and plans on this invoice.
expected_annual_rec_cost double The 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 The 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 The name of the plan this line represents
service_no long The unique ID for the service this line represents
client_service_id string The client-defined unique ID for the service this line represents
service_name string The name of the service this line represents
service_coa_id long The Chart of Accounts ID for the service this line represents
client_service_coa_code string The client-defined Chart of Accounts code for the service this line represents
units double The number of units of the item or plan on this line
rate_per_unit double The charge per unit of the item or plan on this line
line_amount double The subtotal amount of this line
line_description string The long description of this line, used when printing or otherwise displaying invoices
start_date_range string The starting date range for the item or plan on this line
end_date_range string If any, the ending date range for the item or plan on this line.
line_type long Specifies the type of charge or credit associated with this line item.
base_plan_units double Specifies the full, non-prorated number of units of the service code.
proration_factor double Specifies the percentage of the line_base_units billed.
proration_text string Specifies the 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 Specifies the coupon code applied to the invoice.
client_sku string The client-defined item identifier.
order_no long The unique identifier for an order in the context of an client_no and account_no.
item_no long The unique ID of the item being retrieved.
client_item_id string The 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.
tax_details hash  
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 string 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 double 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 string 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.
out_acct hash  

Input Parameters

Fill out the required input parameter to execute API Live. A Live call will be made against the URL you specify to give you actual results formatted.

Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by MindTouch ®