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



 

Home > Aria Crescendo core api > create_acct_complete_m

create_acct_complete_m

Table of contents
  1. Input Arguments
  2. Allowable values for do_write
  3. Allowable values for status_cd
  4. Allowable values for notify_method
  5. Allowable values for invoicing_option
  6. Allowable values for test_acct_ind
  7. Allowable values for tax_exemption_level
  8. Allowable values for list_start_master_file
  9. Allowable values for invoice_approval_required
  10. Allowable values for create_session
  11. Allowable values for pay_method_type
  12. Allowable values for cc_id
  13. Allowable values for notify_method
  14. Allowable values for payment_option
  15. Allowable values for list_start_master_file
  16. Allowable values for contract_type_no
  17. Allowable values for cascade_action
  18. Allowable values for fulfillment_directive
  19. Allowable values for plan_unit_inst_directive
  20. Allowable values for plan_instance_status
  21. Allowable values for resp_level_cd
  22. Allowable values for status_until_alt_start
  23. Allowable values for nso_bill_immediately
  24. Allowable values for usage_accumulation_reset_months_ renewal_option
  25. Allowable values for usage_pooling
  26. Allowable values for usage_threshold_applicability
  27. Allowable values for fulfillment_directive
  28. Allowable values for plan_unit_inst_directive
  29. Allowable values for usage_accumulation_reset_months_ renewal_option
  30. Allowable values for usage_pooling
  31. Allowable values for usage_threshold_applicability
  32. Allowable values for consumer_acct_ind
  33. Allowable values for combine_invoices
  34. Allowable values for fraud_filter
  35. Allowable values for fraud_filtering_enabled
  36. Allowable values for change_status_on_fraud_filtering_failure
  37. Allowable values for change_status_on_fraud_filtering_review
  38. Allowable values for change_mp_status_on_fraud_filtering_cc_prefix_failure
  39. Allowable values for change_mp_status_on_fraud_filtering_cc_number_failure
  40. Allowable values for change_mp_status_on_fraud_filtering_cc_issuing_country_failure
  41. Allowable values for change_mp_status_on_fraud_filtering_cc_issuing_country_suspect
  42. Allowable values for recurring_processing_model_ind
  43. Allowable values for include_plan_instance_queue
  44. Output Arguments
  45. Allowable values for queue_type_ind
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 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.

Note: Inputs passed to this API call will override any fraud options that you specified in your payment gateway, collection group, or Direct Post settings, unless stated otherwise below.

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
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png 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
  auto_assign_mandatory_supp_plans string 5

Governs the behavior of mandatory supplemental plans. If set to true, it will include all the mandatory supplemental plans belonging to the parent plan without having to explicitly set them. If set to false, you must enter each of those mandatory supplemental plans. Defaults to 'False'. This will override the "Included by Default" setting in the Product Catalog for a given supplemental plan.   Allowable Values

 

Start of acct array
  acct array   A list of parameters that define a single account. Zero or more child accounts can be created under a top-level account within nested <acct> arrays. This supports the creation of an account hierarchy within a single call to create_acct_complete_m.
  Field Name Field Type Max Length Description
  brd_arrow.gifacct array 50

An array of parameters that define one or more child accounts of this parent-level account. The fields in this array are identical to the <acct> array of which it is a member, and can be invoked recursively to create an account hierarchy of n levels and/or members.

For more information about how to format a call that utilizes this option, see Calling create_acct_complete_m: Advanced Topics and Best Practices.

  brd_arrow.gifclient_acct_id string 50 Client-defined account identifier.
  brd_arrow.gifuserid 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.
  brd_arrow.gifstatus_cd long 8 The status of the account after it is created.   Allowable Values
  brd_arrow.gifnotify_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
  brd_arrow.gifpassword string 100 Password for the given user
  brd_arrow.gifsecret_question string 300 User's secret question recorded to recover a password
  brd_arrow.gifsecret_question_answer string 300 Response to a user's secret_question
  brd_arrow.gifacct_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.
  brd_arrow.giffirst_name string 32 First name of the contact
  brd_arrow.gifmi string 2 Middle initial of the contact
  brd_arrow.giflast_name string 32 Last name of the contact
  brd_arrow.gifcompany_name string 100 Company name of the contact
  brd_arrow.gifaddress1 string 300 First address line of the contact.
  brd_arrow.gifaddress2 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.
  brd_arrow.gifaddress3 string 300 The third line of the address
  brd_arrow.gifcity string 32 City of the contact
  brd_arrow.giflocality string 32

Locality of the contact. Use this field instead of the <state_prov> field to identify 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 addresses in the United States, Australia, and Canada.

  brd_arrow.gifstate_prov string 10

State or province of the contact. The official postal-service code for any state, province, or territory in the United States, Australia, or Canada. This field does not support states, provinces, or territories in other countries.

This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <locality> field for addresses in those countries.

  brd_arrow.gifcountry 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.
  brd_arrow.gifpostal_cd string 15 Postal/Zip code for the contact's address
  brd_arrow.gifphone string 25 Phone number for the contact
  brd_arrow.gifphone_ext string 10 Extension for the contact's phone number
  brd_arrow.gifcell_phone string 20 Cell phone number for the contact
  brd_arrow.gifwork_phone string 25 Work phone number for the contact
  brd_arrow.gifwork_phone_ext string 10 Extension for the contact work phone
  brd_arrow.giffax string 25 Fax phone number for the contact
  brd_arrow.gifemail string 320 Email for the contact.
  brd_arrow.gifstmt_email_list_cc string 3000 Comma-delimited list of email addresses to which the account holder's statements should be cc'd (carbon copied)
 
brd_arrow.gifstmt_email_list_bcc
string 3000 Comma-delimited list of email addresses to which the account holder's statements should be bcc'd (blind carbon copied)
  brd_arrow.gifbirthdate string 10 Birthdate of the contact in yyyy-mm-dd format.
  brd_arrow.gifsenior_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      
  brd_arrow.gifsenior_acct_userid string 32 User ID of the parent account
  OR      
  brd_arrow.gifclient_senior_acct_id string 50 Client-account ID of the parent account
  brd_arrow.giflegal_entity_no long 22 Aria-assigned legal entity identification number.
  OR      
  brd_arrow.gifclient_legal_entity_id string 50 Client-assigned unique identifier for the legal entity.
  brd_arrow.gifinvoicing_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
  brd_arrow.gifalt_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.
  brd_arrow.gifalt_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.
  brd_arrow.gifretroactive_start_date string 10 Date, in yyyy-mm-dd format, to set for retroactive start.
  brd_arrow.gifoverride_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.
Start of functional_acct_group array
  brd_arrow.giffunctional_acct_group array   Array of functional account groups
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.giffunctional_acct_group_no long 22 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      
  brd_arrow.gifbrd_arrow.gifclient_functional_acct_group_id string 100 Client-defined functional account group ID to which to assign this account
End of functional_acct_group array
 
Start of collection_acct_group array
  brd_arrow.gifcollection_acct_group array   Array for collection account groups.
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifcollections_acct_group_no long 22 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      
  brd_arrow.gifbrd_arrow.gifclient_collections_acct_group_id string 100 Client-defined collections account group ID to assign to this account
End of collection_acct_group array
 
Start of supp_field array
  brd_arrow.gifsupp_field array   Assigns one or more supplemental field values to the account
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifsupp_field_name string 100 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.
  brd_arrow.gifbrd_arrow.gifsupp_field_value string 300 Value for the supplemental field
End of supp_field array
 
  brd_arrow.giftest_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
  brd_arrow.gifacct_start_date string 10 Date, in yyyy-mm-dd format, on which the account was first created outside of Aria
  brd_arrow.gifacct_currency string 3 3-character ISO-compliant currency code in lowercase for monetary values used for this account
  brd_arrow.gifseq_func_group_no long 22 Functional account group number specifically designated for statement sequence number assignment
  OR      
  brd_arrow.gifclient_seq_func_group_id string 100 Client-defined functional account group number specifically designated for statement sequence number assignment
  brd_arrow.giftaxpayer_id string 32 Taxpayer identification number
  brd_arrow.giftax_exemption_level long 1 Provides the Tax Exemption Level for the account. This field only applies to the Aria internal tax engine.   Allowable Values
  brd_arrow.giflist_start_master_file long 1 Indicates whether the account is listed at the start of a master file.   Allowable Values
  brd_arrow.gifalt_msg_template_no long 22 Email template number assigned to this account
  OR      
  brd_arrow.gifclient_alt_msg_template_id string 100 Client-defined email template ID assigned to this account
  brd_arrow.gifcn_alt_msg_template_no long 22 Alternate email template number to use for this account
  OR      
  brd_arrow.gifclient_cn_alt_msg_template_id long 100 Client-defined alternate email template ID to use for this account
  brd_arrow.gifinvoice_approval_required string 5 Boolean indicator to override client's default configured behavior for creating Pending/Real invoice.   Allowable Values
  brd_arrow.gifcreate_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
Start of acct_surcharges array
  brd_arrow.gifacct_surcharges array    
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifacct_surcharge_no long 22 Surcharge number to be attached to the account
  brd_arrow.gifbrd_arrow.gifclient_surcharge_id string 100 Note that only those surcharges with Surcharge Applicablity Scope of Account or Account and Master Plan Instance should be accepted.
  brd_arrow.gifbrd_arrow.gifacct_rate_schedule_no long 22  
End of acct_surcharges array
  brd_arrow.gifcoupon_codes string array 30 Coupon codes to assign to this account, if any
Start of payment_method array
  brd_arrow.gifpayment_method array    
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifpay_method_type long 8 ID corresponding to a payment method such as card, electronic check, prepaid, etc. You must specify a payment method when creating billing information.   Allowable Values
  brd_arrow.gifbrd_arrow.gifpay_method_name string 100 Human-readable name of the payment method
  brd_arrow.gifbrd_arrow.gifpay_method_description string 1000 Description for the plan method
  brd_arrow.gifbrd_arrow.gifclient_pay_method_cdid string 100 System-defined statement payment method ID
  brd_arrow.gifbrd_arrow.gifpayment_method_idx long 8 For non-persistent referencing of a payment method within the API request
  brd_arrow.gifbrd_arrow.gifbill_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.
  brd_arrow.gifbrd_arrow.giffirst_name string 32 First name of the billing contact
  brd_arrow.gifbrd_arrow.gifmi string 2 Middle initial of the billing contact
  brd_arrow.gifbrd_arrow.giflast_name string 32 Last name of the billing contact
  brd_arrow.gifbrd_arrow.gifcompany_name string 100 Company name of the billing contact
  brd_arrow.gifbrd_arrow.gifaddress1 string 100 First address line of the contact.
  brd_arrow.gifbrd_arrow.gifaddress2 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.
  brd_arrow.gifbrd_arrow.gifaddress3 string 100 The third line of the address
  brd_arrow.gifbrd_arrow.gifcity string 32 City of the billing contact
  brd_arrow.gifbrd_arrow.giflocality string 32

Locality of the billing contact. 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 addresses in the United States, Australia, and Canada.

  brd_arrow.gifbrd_arrow.gifstate_prov string 10

State or province of the billing contact. The official postal-service code for any state, province, or territory in the United States, Australia, or Canada.

This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <locality> field for addresses in those countries.

  brd_arrow.gifbrd_arrow.gifcountry string 2 Country of the billing contact as the ISO-compliant 2-character country code abbreviation in uppercase.
  brd_arrow.gifbrd_arrow.gifpostal_cd string 14 Postal/Zip code for the billing contact's address
  brd_arrow.gifbrd_arrow.gifphone string 25 Phone number for the billing contact
  brd_arrow.gifbrd_arrow.gifphone_ext string 10 Extension for the billing contact's phone number
  brd_arrow.gifbrd_arrow.gifcell_phone string 20 Cell phone number for the billing contact
  brd_arrow.gifbrd_arrow.gifwork_phone string 25 Work phone for the billing contact.
  brd_arrow.gifbrd_arrow.gifwork_phone_ext string 10 Extension for the billing contact's work phone
  brd_arrow.gifbrd_arrow.giffax string 25 Fax phone number for the billing contact
  brd_arrow.gifbrd_arrow.gifemail string 320 Email for the billing contact
  brd_arrow.gifbrd_arrow.gifbirthdate string 10 Birthdate of the contact in yyyy-mm-dd format.
  brd_arrow.gifbrd_arrow.gifcc_num string 20 Card number
  brd_arrow.gifbrd_arrow.gifcc_expire_mm long 2 Expiration month for the card payment instrument
  brd_arrow.gifbrd_arrow.gifcc_expire_yyyy long 4 Expiration year for the card payment instrument
  brd_arrow.gifbrd_arrow.gifbank_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.
  brd_arrow.gifbrd_arrow.gifbank_routing_no string 9 ABA (American Banking Association) unique identifier for the financial institution
  brd_arrow.gifbrd_arrow.gifcvv 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 card
  brd_arrow.gifbrd_arrow.giftrack_data1 string 300 Raw "track 1" data from a swiped card used in a card-present transaction to initiate this request
  brd_arrow.gifbrd_arrow.giftrack_data2 string 300 Raw "track 2" data from a swiped card used in a card-present transaction to initiate this request
  brd_arrow.gifbrd_arrow.giftaxpayer_id string 32 Taxpayer identification number
  brd_arrow.gifbrd_arrow.gifbill_agreement_id string 32 Unique ID of the bill agreement (also referred to as a token).
  brd_arrow.gifbrd_arrow.gifiban 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.
  brd_arrow.gifbrd_arrow.gifbank_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.
  brd_arrow.gifbrd_arrow.gifbank_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.
  brd_arrow.gifbrd_arrow.gifbank_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.
  brd_arrow.gifbrd_arrow.gifmandate_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.
  brd_arrow.gifbrd_arrow.gifbank_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.
  brd_arrow.gifbrd_arrow.gifbank_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.
  brd_arrow.gifbrd_arrow.gifcc_id long 2 A numeric code indicating the type of card.   Allowable Values
End of payment_method array
 
Start of billing_group array
 
  brd_arrow.gifbilling_group 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.
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifbilling_group_name string 32 Billing group name.
  brd_arrow.gifbrd_arrow.gifbilling_group_description string 1000 Billing group description.
  brd_arrow.gifbrd_arrow.gifclient_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.
  brd_arrow.gifbrd_arrow.gifbilling_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.
  brd_arrow.gifbrd_arrow.gifnotify_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
  brd_arrow.gifbrd_arrow.gifnotify_template_group long 22 Notify template number
  brd_arrow.gifbrd_arrow.gifstatement_template long 22 Statement template number
  brd_arrow.gifbrd_arrow.gifcredit_note_template long 22 Credit note template number
  brd_arrow.gifbrd_arrow.gifpayment_option string 7 This allows you to select either payment methods (such as a card or other electronic form of payment) or payment terms (such as a physical check) when creating or modifying a billing group'   Allowable Values
  brd_arrow.gifbrd_arrow.gifprimary_client_payment_method_id string 100 Client-defined identifier for the billing group's primary payment method.
  OR      
  brd_arrow.gifbrd_arrow.gifprimary_payment_method_idx long 32 Non-persistent identifier for the billing group's primary payment method.
  brd_arrow.gifbrd_arrow.gifbackup_client_payment_method_id string 100 Client-defined identifier for the billing group's backup payment method.
  OR      
  brd_arrow.gifbrd_arrow.gifbackup_payment_method_idx long 32 Non-persistent identifier for the billing group's backup payment method.
  brd_arrow.gifbrd_arrow.gifstmt_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.
  brd_arrow.gifbrd_arrow.giffirst_name string 32 First name of the statement contact
  brd_arrow.gifbrd_arrow.gifmi string 2 Middle initial of the statement contact
  brd_arrow.gifbrd_arrow.giflast_name string 32 Last name of the statement contact
  brd_arrow.gifbrd_arrow.gifcompany_name string 100 Company name of the statement contact
  brd_arrow.gifbrd_arrow.gifaddress1 string 100 First address line of the contact.
  brd_arrow.gifbrd_arrow.gifaddress2 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.
  brd_arrow.gifbrd_arrow.gifaddress3 string 100 The third line of the address
  brd_arrow.gifbrd_arrow.gifcity string 32 City of the statement contact
  brd_arrow.gifbrd_arrow.giflocality string 32

Locality of the statement contact. 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 addresses in the United States, Australia, and Canada.

  brd_arrow.gifbrd_arrow.gifstate_prov string 10

State or province of the statement contact. The official postal-service code for any state, province, or territory in the United States, Australia, or Canada. This field does not support states, provinces, or territories in other countries.

This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <locality> field for addresses in those countries.

  brd_arrow.gifbrd_arrow.gifcountry string 2 Country of the statement contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  brd_arrow.gifbrd_arrow.gifpostal_cd string 14 Postal/Zip code for the statement contact's address
  brd_arrow.gifbrd_arrow.gifphone string 25 Phone number of the statement contact
  brd_arrow.gifbrd_arrow.gifphone_ext string 10 Extension for the statement contact's phone number.
  brd_arrow.gifbrd_arrow.gifcell_phone string 20 Cell phone number of the statement contact
  brd_arrow.gifbrd_arrow.gifwork_phone string 25 Work phone number of the statement contact
  brd_arrow.gifbrd_arrow.gifwork_phone_ext string 10 Extension for the statement contact's work phone.
  brd_arrow.gifbrd_arrow.giffax string 25 Fax phone number for the statement contact
  brd_arrow.gifbrd_arrow.gifemail string 320 Email for the statement contact
  brd_arrow.gifbrd_arrow.gifbirthdate string 10 Birthdate of the contact in yyyy-mm-dd format.
  brd_arrow.gifbrd_arrow.giflist_start_master_file long 1 Indicates whether the account is listed at the start of a master file.   Allowable Values
  brd_arrow.gifbrd_arrow.gifpayment_terms_no long 22 Payment terms number assigned to the account.
  brd_arrow.gifbrd_arrow.gifpayment_terms_name string 50 Payment terms name assigned to the account.
  brd_arrow.gifbrd_arrow.gifclient_payment_term_id string 100 Client-defined identifier for the billing group's payment term
  brd_arrow.gifbrd_arrow.gifean_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).'
  brd_arrow.gifbrd_arrow.gifean_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'
  brd_arrow.gifbrd_arrow.gifcredit_memo_template long 22 Credit template no.
  brd_arrow.gifbrd_arrow.gifrebill_template long 22 Rebill template no.
  brd_arrow.gifbrd_arrow.gifcollection_group_bg_row array  

Array of collection groups that should be assigned to the specified billing groups.

For cost savings or for other reasons, you may choose to have payments made with a particular payment method (associated with a billing group) processed by a specific payment gateway. To do so, you can assign a collection group to a billing group by passing values into the collection_group_bg_row array.

Notes:

  • Aria will use this order of precedence when selecting the payment gateway to use for processing a payment:
  1. Collection group assigned to the billing group associated with the master plan instance being invoiced;
  2. Collection group to which the customer is assigned at the account level.
  • Aria does not currently support using collection groups at the billing group level when the tokenized credit card payment method is used. For this payment method, Aria will make collections using the payment gateway associated with the collection group at the account level.
 

    brd_arrow.gifbrd_arrow.gifbrd_arrow.gifcollections_group_bg_no

 

 

OR

 

    brd_arrow.gifbrd_arrow.gifbrd_arrow.gifclient_collections_group_bg_id

 

 

 

long








string





 
22








100
Aria-assigned identifier of the collection group to assign to the specified billing group.






Client-defined identifier of the collection group to assign to the specified billing group.
End of billing_group array
 
Start of dunning_group array
required-icon.png brd_arrow.gifdunning_group 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.
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifdunning_group_name string 100 Name of the dunning group
  brd_arrow.gifbrd_arrow.gifdunning_group_description string 1000 Description of the dunning group
  brd_arrow.gifbrd_arrow.gifclient_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.
  brd_arrow.gifbrd_arrow.gifdunning_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.
  brd_arrow.gifbrd_arrow.gifdunning_process_no long 22 Dunning process.
  OR      
  brd_arrow.gifbrd_arrow.gifclient_dunning_process_id string 100 Client-defined dunning process identifier.
End of dunning_group array
 
Start of contracts array
  brd_arrow.gifcontracts array    
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifclient_contract_id string 100 Client-assigned unique contract identifier
  brd_arrow.gifbrd_arrow.gifcontract_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
  brd_arrow.gifbrd_arrow.gifcontract_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.'
  brd_arrow.gifbrd_arrow.gifcontract_cancel_fee double 12 Fee charged to the account for prematurely ending this contract
  brd_arrow.gifbrd_arrow.gifcontract_comments string 300 Any client-defined comments stored on this contract at the account level
  brd_arrow.gifbrd_arrow.gifcontract_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.
  brd_arrow.gifbrd_arrow.gifcontract_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.
Start of contract_plans array
  brd_arrow.gifbrd_arrow.gifcontract_plans array   List of plan instance(s) to be associated with the contract.
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifplan_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      
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifclient_plan_instance_id string 100 Client-defined plan instance to be associated with the contract
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifcascade_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
End of contract_plans array
End of contracts array
 
Start of master_plans_detail array
required-icon.png brd_arrow.gifmaster_plans_detail array   Allows multiple master plans subscription for an account
  Field Name Field Type Max Length Description
required-icon.png brd_arrow.gifbrd_arrow.gifplan_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      
  brd_arrow.gifbrd_arrow.gifclient_plan_id string 100 Client-defined master plan subscription plan ID.
  brd_arrow.gifbrd_arrow.gifplan_instance_description string 1000 Description for each assigned master plan
  brd_arrow.gifbrd_arrow.gifclient_plan_instance_id string 100 Unique client-defined ID for each assigned master plan
  brd_arrow.gifbrd_arrow.gifplan_instance_idx long 22 For non-persistent referencing of a plan instance within the API request
  brd_arrow.gifbrd_arrow.gifpromo_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
  brd_arrow.gifbrd_arrow.gifplan_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
  brd_arrow.gifbrd_arrow.gifbill_lag_days long 10

Bill lag days refer to the number of days prior to (negative) or after (positive) an account billing date at which an invoice should be generated for your specified master plan instance. 

Negative bill lag days are typically used for subscription-based services (often subscription-based services paid using net terms), for which you would like to send out invoices to your customers well in advance of the real invoice date. This gives your customers time to receive a paper or email invoice (statement) and send a payment before the actual invoice date.

Positive bill lag days typically apply to usage-based services. 

Examples:

  • If you want an invoice to be generated 14 days before the billing date, pass -14 into this field.
  • If you want an invoice to be generated 10 days after the billing date, pass 10 into this field.

By default, bill lag days are restricted to +/- the (minimum number of days in a recurring billing period – 1 day). However, if your  Allow Negative Bill Lag Days to Extend Beyond One Bill Cycle parameter is set to True (in the Aria application under Configuration > Billing> Invoice Settings), then the negative value can go beyond a single billing period.

Aria will set the bill lag days for plans using this order of precedence:

  1. Master plan instance (for a given account)
  2. Collection group setting
  3. Payment terms/payment method setting
  4. Client setting (Configuration > Billing > Bill Lag Days)

Notes:

  • You cannot pass a value into the <bill_lag_days> field by itself. You must also pass in a value to update the plan units, plan status, and/or alternate rate schedule.
  • <bill_lag_days> cannot be passed in as part of an API call used to schedule changes that will take place on a customer's anniversary date. You must set the <bill_lag_days> to go into effect on a date other than the anniversary date.

    Example: If you have an MPI replacement scheduled for a customer's anniversary date, you should not set <bill_lag_days> in the API used for the MPI replacement. If you do, Aria will ignore the <bill_lag_days>.
Start of plan_unit_instances array
  brd_arrow.gifbrd_arrow.gifplan_unit_instances array   Array of plan unit instances
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifclient_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.
Start of plan_unit_instance_services array
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifplan_unit_instance_services array   Array of plan unit instance services
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifservice_no long 22 Specifies the Aria-assigned unique service identifier against which fulfillment details must be captured and stored.
  OR      
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifclient_service_id string 100 Client-assigned identifier for the service (only for fulfillment based service)
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifservice_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".
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.giffulfillment_directive long 1 Derives whether the fulfillment date is assigned/modified or removed from the fulfillment based service on the plan unit instance   Allowable Values
End of plan_unit_instance_services array
 
Start of plan_unit_inst_fields array
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifplan_unit_inst_fields array   Array of client-defined plan unit instance fields
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.giffield_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.
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.giffield_value string 1000 Value stored under this field
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifplan_unit_inst_directive long 1 Directive is mandatory if field name/value pair are specified   Allowable Values
End of plan_unit_inst_fields array
End of plan_unit_instances array
 
  brd_arrow.gifbrd_arrow.gifplan_instance_status long 8 Status of the object in question for the current API call   Allowable Values
  brd_arrow.gifbrd_arrow.gifresp_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

required-icon.png brd_arrow.gifbrd_arrow.gifresp_master_plan_inst_no long 22 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      
  brd_arrow.gifbrd_arrow.gifclient_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      
  brd_arrow.gifbrd_arrow.gifresp_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      
  brd_arrow.gifbrd_arrow.gifclient_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      
  brd_arrow.gifbrd_arrow.gifbilling_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.
required-icon.png brd_arrow.gifbrd_arrow.gifclient_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      
  brd_arrow.gifbrd_arrow.gifdunning_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.
  brd_arrow.gifbrd_arrow.gifstatus_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
  brd_arrow.gifbrd_arrow.gifbalance_forward double 12 balance forward
  brd_arrow.gifbrd_arrow.gifcoupon_codes string array 30 Coupon codes to assign to this plan instance, if any
Start of mpi_surcharges array
  brd_arrow.gifbrd_arrow.gifmpi_surcharges array   Surcharge for master plan.
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifmpi_surcharge_no long 22  
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifmpi_rate_schedule_no long 22  
End of mpi_surcharges array
 
  brd_arrow.gifbrd_arrow.gifnso_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
Start of master_plan_services array
  brd_arrow.gifbrd_arrow.gifmaster_plan_services array   List of services associated with the master plan being assigned on the account
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifservice_no long 22 Multidimensional array of services for this plan
  OR      
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifclient_service_id string 100 Multidimensional array of client-defined service ID for this plan
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifsvc_location_no long 22 Aria-assigned unique location identifier
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifclient_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.
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifdest_contact_idx long 32 The Aria-assigned address sequence number
End of master_plan_services array
 
Start of master_plan_nso_list array
  brd_arrow.gifbrd_arrow.gifmaster_plan_nso_list array   Non-Subscription Offerings that are purchased with the plan
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifclient_sku string 100 Client SKU of NSO/Inventory item. Entering a value in this field includes this SKU in the order being created.
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifitem_units long 22 NSO quantity that is purchased along with plan.
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifitem_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.
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifclient_item_svc_location_id string 100 Client-defined unique identifier for the origin location for the item (NSO) being purchased
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifitem_dest_contact_idx long 32 Aria-assigned address sequence number
End of master_plan_nso_list array
 
  brd_arrow.gifbrd_arrow.gifnso_po_num string 100 Purchase order number assigned to the one-time order
Start of plan_instance_fields_info array
  brd_arrow.gifbrd_arrow.gifplan_instance_fields_info array    
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifbrd_arrow.giffield_no long 22 Product field number
  OR      
  brd_arrow.gifbrd_arrow.gifbrd_arrow.giffield_name string 100 Product field name
  brd_arrow.gifbrd_arrow.gifbrd_arrow.giffield_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.
End of plan_instance_fields_info
 
  brd_arrow.gifbrd_arrow.gifalt_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      
  brd_arrow.gifbrd_arrow.gifclient_alt_rate_schedule_id string 100 Client-defined alternate rate schedule ID
  brd_arrow.gifbrd_arrow.gifusage_accumulation_reset_months long 4 Number of reset months for each plan.
  brd_arrow.gifbrd_arrow.gifusage_accumulation_reset_months_renewal_option long 1 Determines whether the usage accumulation reset months will automatically reset to same value at the end of the current period or will expire at end of current period.   Allowable Values
  brd_arrow.gifbrd_arrow.gifusage_pooling string 5 Indicates whether usage pooling is enabled for this plan instance. Allowable values are 'true' and 'false'.   Allowable Values
  brd_arrow.gifbrd_arrow.gifusage_threshold_applicability string 2 Usage tracking options on the plans in the account.   Allowable Values
Start of custom_rates array
  brd_arrow.gifbrd_arrow.gifcustom_rates array   Array of custom rates for the services provided in the master plan
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifcustom_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      
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifcustom_rate_client_service_id string 100 Client-defined identifier for the service
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifcustom_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.
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifcustom_rate_from_unit long 22 Unit starting point for the specified rate tier number
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifcustom_rate_to_unit long 22 Unit-end point for the specified rate tier number
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifcustom_rate_per_unit double 22 Custom rate per unit for the specified service and rate tier number
End of custom_rates array
 
  brd_arrow.gifbrd_arrow.gifpo_num string 100 Purchase order number assigned to the plan instance
Start of supp_plan array
  brd_arrow.gifbrd_arrow.gifsupp_plan array  

Supplemental plan assigned under the master plan, defined as a subset of the master_plans_detail. You can define more than one supplemental plan array to support a master plan with more than one supplemental plan in a plan hierarchy.

  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifsupp_plan array  

An array of parameters that define one or more child Supplemental Plans of this parent-level Supplemental Plan. The fields in this array are identical to the <supp_plan> array of which it is a member, and can be invoked recursively to create a Supplemental Plan hierarchy of n levels and/or members.

For more information about how to format a call that utilizes this option, see Calling create_acct_complete_m: Advanced Topics and Best Practices.

  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifplan_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      
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifclient_plan_id string 100 Client-defined supplemental plan ID
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifplan_instance_description string 1000 Description for each assigned master plan
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifclient_plan_instance_id string 100 Unique client-defined ID for each assigned master plan
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifplan_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.
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifplan_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.
Start of supp_plan_services array
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifsupp_plan_services array   List of services associated with the master plan being assigned on the account
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifservice_no long 22 A multidimensional array of Services for this plan
  OR      
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifclient_service_id string 100 Multidimensional array of client-defined service ID for this plan
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifsvc_location_no long 22 Aria-assigned unique location identifier.
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifclient_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.
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifdest_contact_idx long 32 Aria-assigned address sequence number
End of supp_plan_services array
 
Start of plan_unit_instances array
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifplan_unit_instances array   Array of plan unit instances
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifclient_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.
Start of plan_unit_instance_services array
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifplan_unit_instance_services array   Array of plan unit instance services
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifservice_no long 22 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      
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifclient_service_id string 100 Client-assigned identifier for the service (only for fulfillment based service)
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifservice_fulfillment_date string 10 Fulfillment completion date. Can be in past, today or future date.
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.giffulfillment_directive long 1 Derives whether the fulfillment date is assigned/modified or removed from the fulfillment based service on the plan unit instance.   Allowable Values
End of plan_unit_instance_services array
 
Start of plan_unit_inst_fields array
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifplan_unit_inst_fields array   Array of client-defined plan unit instance fields
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.giffield_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.
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.giffield_value string 1000 The value stored under this field
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifplan_unit_inst_directive long 1 Directive is mandatory if field name/value pair are specified.   Allowable Values
End of plan_unit_inst_fields array
End of plan_unit_instances array
 
Start of supp_plan_nso_list array
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifsupp_plan_nso_list array   Non-Subscription offerings that are purchased with the plan
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifclient_sku string 100 Client SKU of the NSO/Inventory item. Entering a value in this field includes the item in the order being created.
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifitem_units long 22 NSO quantity that is purchased along with plan
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifitem_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.
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifclient_item_svc_location_id string 100 Client-defined unique identifier for the origin location for the item (NSO) being purchased
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifitem_dest_contact_idx long 32 Aria-assigned address sequence number
End of supp_plan_nso_list array
 
Start of plan_instance_fields_info array
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifplan_instance_fields_info array    
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.giffield_no long 22 Product field number. Entering a value in this field creates a plan instance field for the supplemental plan.
  OR      
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.giffield_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.
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.giffield_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.
End of plan_instance_fields_info array
 
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifalt_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      
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifclient_alt_rate_schedule_id string 100 Client-defined alternate rate schedule ID
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifusage_accumulation_reset_months long 4 Number of reset months for each plan
 

brd_arrow.gifbrd_arrow.gifbrd_arrow.gifusage_accumulation_reset_months_renewal_option

long 1 Determines whether the usage accumulation reset months will automatically reset to same value at the end of the current period or will expire at end of current period.   Allowable Values
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifusage_pooling string 5 Indicates whether usage pooling is enabled for this plan instance. Allowable values are 'true' and 'false'.   Allowable Values
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifusage_threshold_applicability string 2 Usage tracking options on the plans in the account   Allowable Values
Start of custom_rates array
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifcustom_rates array   Array of custom rates for the services provided in the supplemental plan
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifcustom_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      
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifcustom_rate_client_service_id string 100 Client-defined identifier for the service.
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifcustom_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.
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifcustom_rate_from_unit long 22 Unit starting point for the specified rate tier number
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifcustom_rate_to_unit long 22 Unit ending point for the specified rate tier number
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifcustom_rate_per_unit double 22 Custom rate per unit for the specified service and rate tier number
End of custom_rates array
 
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifpo_num string 100 Purchase order number assigned to the plan instance
End of supp_plan array
End of master_plans_detail array
 
  brd_arrow.gifconsumer_acct_ind string 5 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
  brd_arrow.gifrevrec_profile_no long 8 Profile ID of an existing revenue recognition profile
  OR      
  brd_arrow.gifclient_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.
  brd_arrow.gifpo_num string 100 Purchase order number assigned to the account.
  brd_arrow.giflocale_no long 22 Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients.
  OR      
  brd_arrow.giflocale_name string 50 Name of the locale.
Start of contacts array
  brd_arrow.gifcontacts array   List of contacts to be created on the account. Note that contacts not used as an account contact, billing contact, or statement contact will be saved on the account.
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifcontact_idx long 32 A caller-defined numeric value is required if you wish to add a new contact as an account contact, billing contact, statement contact, or destination contact. This value can then be used to reference this new contact within the context of this API request (and is not stored in Aria).
  brd_arrow.gifbrd_arrow.giffirst_name string 32 The first name of the contact.
  brd_arrow.gifbrd_arrow.gifmiddle_initial string 2 The middle initial of the contact.
  brd_arrow.gifbrd_arrow.giflast_name string 32 The last name of the contact.
  brd_arrow.gifbrd_arrow.gifcompany_name string 100 The company name of the contact.
  brd_arrow.gifbrd_arrow.gifaddress1 string 100 The first address line of the contact.
  brd_arrow.gifbrd_arrow.gifaddress2 string 100 The second address line of the contact.
  brd_arrow.gifbrd_arrow.gifaddress3 string 100 The third address line of the contact.
  brd_arrow.gifbrd_arrow.gifcity string 32 The city of the contact.
  brd_arrow.gifbrd_arrow.giflocality string 32

Locality of the contact. 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 addresses in the United States, Australia, and Canada.

  brd_arrow.gifbrd_arrow.gifstate_prov string 10

State or province of the contact. The official postal-service code for any state, province, or territory in the United States, Australia, or Canada. This field does not support states, provinces, or territories in other countries.

This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <locality> field for addresses in those countries.

  brd_arrow.gifbrd_arrow.gifcountry string 2 The country of the contact. Provide the ISO-compliant 2-character country code abbreviation in uppercase.
  brd_arrow.gifbrd_arrow.gifpostal_cd string 14 The postal/zip code of the contact.
  brd_arrow.gifbrd_arrow.gifphone string 25 The phone number of the contact.
  brd_arrow.gifbrd_arrow.gifphone_ext string 10 The phone number extension of the contact.
  brd_arrow.gifbrd_arrow.gifcell_phone string 20 The cell phone number of the contact.
  brd_arrow.gifbrd_arrow.gifwork_phone string 25 The work phone number of the contact.
  brd_arrow.gifbrd_arrow.gifwork_phone_ext string 10 The work phone number extension of the contact.
  brd_arrow.gifbrd_arrow.giffax string 25 The fax number of the contact.
  brd_arrow.gifbrd_arrow.gifemail string 320 The email address of the contact.
  brd_arrow.gifbrd_arrow.gifbirthdate string 10 Birthdate of the contact in yyyy-mm-dd format.
End of contacts array
 
  brd_arrow.gifcombine_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
  brd_arrow.giffraud_filter long 1

Enables or disables fraud filtering. If no value is provided, the system will default to 2.

To use fraud filtering, you must have it enabled and configured in your payment gateway. Contact your payment gateway representative for setup information and additional documentation.


Notes:

  • If you set this field to 0, then Aria will ignore all other fraud filtering fields.
  • If you set this field to 1, then Aria will apply the values that you specified in the other fraud filtering fields. However, if you pass -1 into any fraud filtering field, Aria will ignore that field.
  • If you set this field to 2, then Aria will apply the values that you specified in the other fraud filtering fields.
Allowable Values
Start of fraud_control_fields array
  brd_arrow.giffraud_control_fields array  

Your chosen fraud protection options passed as an array of fraud_control_field_name/fraud_control_field_value key-value pairs. This array allows you to specify your fraud filtering options.

To use fraud filtering, you must have fraud functionality enabled and configured in your payment gateway's portal. Contact your payment gateway representative for setup information and additional documentation.

The allowable fields and values for the key-value pairs are highlighted in blue below.

  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.giffraud_filtering_enabled string 100 Indicates whether to send a request to the processor for fraud filtering information. If you set it to 0 (disable), then Aria will ignore all other fraud filtering fields. Allowable Values
  brd_arrow.gifbrd_arrow.gifchange_status_on_fraud_filtering_failure string 100 Indicates whether to change the status of the account or master plan instance(s) if:
  • The fraud filtering request returns a failure response; and
  • fraud_filtering_enabled is set to 1 (enable).
Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. Allowable Values
  brd_arrow.gifbrd_arrow.gifstatus_on_fraud_filtering_failure string 100 If change_status _on_fraud_filtering_failure is set to true and the fraud filtering request returns a failure response, use this field to indicate the desired status of the master plan instance.
  brd_arrow.gifbrd_arrow.gifchange_status_on_fraud_filtering_review string 100 Indicates whether to change the status of the account or master plan instance(s) if fraud_filtering_enabled is set to 1 (enable). Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. Allowable Values
  brd_arrow.gifbrd_arrow.gifstatus_on_fraud_filtering_review string 100 If change_status _on_fraud_filtering_review is set to 1 (true), use this field to indicate the desired status of the master plan instance.
  brd_arrow.gifbrd_arrow.gifchange_mp_status_on_fraud_filtering_cc_prefix_failure string 100 Indicates whether to change the status of the master plan instance(s) if the purchase transaction failed the fraud filtering check for the credit card prefix. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post) Allowable Values
  brd_arrow.gifbrd_arrow.gifmp_status_on_fraud_filtering_cc_prefix_failure string 100 If change_mp_status_on_fraud_filtering_cc_prefix_failure is set to 1 (true), use this field to indicate the desired status of the master plan instance. (applies to Direct Post)
  brd_arrow.gifbrd_arrow.gifchange_mp_status_on_fraud_filtering_cc_number_failure string 100 Indicates whether to change the status of the master plan instance(s) if the purchase transaction failed the the fraud filtering check for the credit card number. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post) Allowable Values
  brd_arrow.gifbrd_arrow.gifmp_status_on_fraud_filtering_cc_number_failure string 100 If change_mp_status_on_fraud_filtering_cc_number_failure is set to 1 (true), use this field to indicate the desired status of the master plan instance. (applies to Direct Post)
  brd_arrow.gifbrd_arrow.gifchange_mp_status_on_fraud_filtering_cc_issuing_country_failure string 100 Indicates whether to change the status of the master plan instance(s) if the purchase transaction failed the fraud filtering check for the credit card issuing country. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post) Allowable Values
  brd_arrow.gifbrd_arrow.gifmp_status_on_fraud_filtering_cc_issuing_country_failure string 100 If change_mp_status_on_fraud_filtering_cc_issuing_country_failure is set to 1 (true), use this field to indicate the desired status of the master plan instance. (applies to Direct Post)
  brd_arrow.gifbrd_arrow.gifchange_mp_status_on_fraud_filtering_cc_issuing_country_suspect string 100 Indicates whether to change the status of the master plan instance(s) if the fraud filtering check for the credit card issuing country returned a "suspect" value. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post) Allowable Values
  brd_arrow.gifbrd_arrow.gifmp_status_on_fraud_filtering_cc_issuing_country_suspect string 100 If change_mp_status_on_fraud_filtering_cc_issuing_country_suspect is set to 1 (true), use this field to indicate the desired status of the master plan instance. (applies to Direct Post)
End of fraud_control_fields array
 
  brd_arrow.gifrecurring_processing_model_ind long 1 Defines a recurring payment type for Credit Card and Tokenized Credit Cards.  Allowable Values
End of acct array
 
Start of optional_transaction_qualifiers array
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  Field Name Field Type Max Length Description
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif qualifier_value string 100 Corresponding value of the field you want to associate with this API call.
End of optional_transaction_qualfiers array
 
  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.
  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.
  include_plan_instance_queue string 5

Use this field to obtain the list of plan changes that you scheduled using this API.

Allowable Values
 

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  
brd_arrow.gif acct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
brd_arrow.gif 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.
brd_arrow.gif client_acct_id string Client-defined account identifier.
brd_arrow.gif acct_locale_no long Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts.
brd_arrow.gif acct_locale_name string Name of the account level locale.
brd_arrow.gif acct_contact_no long The Aria-assigned unique identifier for the account contact saved on the account.
brd_arrow.gif billing_contact_details hash List of billing contacts saved on the account.
brd_arrow.gifbrd_arrow.gif payment_method_no long Aria-assigned sequence number for this payment method.
brd_arrow.gifbrd_arrow.gif 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.
brd_arrow.gif statement_contact_details hash List of statement contacts saved on the account.
brd_arrow.gifbrd_arrow.gif billing_group_no long Aria-assigned unique identifier for the billing group on the account
brd_arrow.gifbrd_arrow.gif stmt_contact_no long The Aria-assigned unique identifier for the statement contact associated with a billing group on the account.
brd_arrow.gif other_contact_details hash List of contacts saved on the account that are not used as an account, billing, or statement contact
brd_arrow.gifbrd_arrow.gif other_contact_no long Aria-assigned unique identifier for the contact saved on the account
brd_arrow.gifbrd_arrow.gif other_contact_idx long Value provided for the idx parameter in the API request
brd_arrow.gif contract_details hash  
brd_arrow.gifbrd_arrow.gif contract_no long Unique ID of the contract assigned to this account
brd_arrow.gifbrd_arrow.gif client_contract_id string Client-assigned unique contract identifier
brd_arrow.gifbrd_arrow.gif contract_plan_details hash  
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif plan_instance_no long List of plan instance(s) to be associated with the contract
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif client_plan_instance_id string List of client-defined plan instance(s) to associated with the contract
brd_arrow.gifbrd_arrow.gif contract_scope string Specifies the scope of plan subscription coverage enforced by the contract
brd_arrow.gif session_id string Returns the newly created cookie ID of the account
brd_arrow.gif billing_errors hash  
brd_arrow.gifbrd_arrow.gif 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
brd_arrow.gifbrd_arrow.gif invoicing_error_msg string The explanatory text corresponding to the value returned (if any) in output "invoicing_error_code"
brd_arrow.gifbrd_arrow.gif collection_error_code long If a collection is attempted, returns the error code associated with the collection
brd_arrow.gifbrd_arrow.gif collection_error_msg string The error message associated with collection_error_code
brd_arrow.gifbrd_arrow.gif statement_error_code long The error code if statement generation fails
brd_arrow.gifbrd_arrow.gif statement_error_msg string Text message associated with statement_error_code
brd_arrow.gifbrd_arrow.gif billing_group_no long The billing group number mapped against each master plan
brd_arrow.gifbrd_arrow.gif client_billing_group_id string Client-defined billing group ID
brd_arrow.gif master_plans_assigned hash  
brd_arrow.gifbrd_arrow.gif plan_instance_no long Unique plan-instance number for each assigned master plan
brd_arrow.gifbrd_arrow.gif client_plan_instance_id string Unique client-defined ID for each assigned master plan
brd_arrow.gifbrd_arrow.gif nso_order_no long Unique identifier for an order that is created for bundled NSOs
brd_arrow.gifbrd_arrow.gif nso_order_status_label string Status label for this order
brd_arrow.gifbrd_arrow.gif plan_unit_instance_details hash Array of plan unit instances
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif out_plan_unit_inst_no long Aria unique plan unit instance number
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif out_client_plan_unit_inst_id string Client-assigned identifier for the plan unit instance
brd_arrow.gifbrd_arrow.gif supp_plans_assigned hash  
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif supp_plan_instance_no long Unique plan-instance number for each assigned supplementary plan
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif client_plan_instance_id string Unique client-defined ID for each assigned supplementary plan
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif plan_unit_instance_details hash Array of plan unit instances
brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gif out_plan_unit_inst_no long Aria unique plan-unit instance number
brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gif out_client_plan_unit_inst_id string Client-assigned identifier for the plan unit instance
brd_arrow.gifbrd_arrow.gif out_contract hash  
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif contract_no long Unique ID of the contract assigned to this account
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif plan_instance_no long Unique plan-instance number for each assigned master plan
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif client_plan_instance_id string Unique client-defined ID for each assigned master plan
brd_arrow.gifbrd_arrow.gif 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.
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif error_class string The type of error code being represented, such as taxation
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif error_code string The error code returned by the third party system
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif error_msg string The error message returned by the third party system
brd_arrow.gif invoice_info hash  
brd_arrow.gifbrd_arrow.gif invoice_no long The unique identifier of the invoice, if any, created automatically by Aria in conjunction with this call
brd_arrow.gifbrd_arrow.gif billing_group_no long The billing group number mapped against each master plan
brd_arrow.gifbrd_arrow.gif plan_instance_id string Unique client-defined ID for each assigned master plan (DEPRECATED)
brd_arrow.gifbrd_arrow.gif client_billing_group_id string Client-defined billing group ID.
brd_arrow.gifbrd_arrow.gif proc_cvv_response string Processor return code from CVV validation
brd_arrow.gifbrd_arrow.gif proc_avs_response string Processor return code from address validation
brd_arrow.gifbrd_arrow.gif proc_cavv_response string Processor return code for security validation
brd_arrow.gifbrd_arrow.gif proc_status_code string Processor status code
brd_arrow.gifbrd_arrow.gif proc_status_text string Processors status description
brd_arrow.gifbrd_arrow.gif proc_payment_id string Processor payment ID
brd_arrow.gifbrd_arrow.gif proc_auth_code string Authorization code provided by the issuing bank
brd_arrow.gifbrd_arrow.gif proc_merch_comments string Additional information passed to payment processor
brd_arrow.gifbrd_arrow.gif proc_initial_auth_txn_id string Transaction ID from payment processor. If received as part of an auth request, it must be retained for future settlement and match the value from the auth response. It should also be used for future recurring transaction auths/settlement.
brd_arrow.gifbrd_arrow.gif proc_fraud_filter_response string The fraud filtering information provided by the payment processor in response to a fraud filtering request.
brd_arrow.gifbrd_arrow.gif invoice_charges_before_tax double Charges before tax on the initial invoice for this account
brd_arrow.gifbrd_arrow.gif invoice_tax_charges double Tax charges on the initial invoice for this account
brd_arrow.gifbrd_arrow.gif invoice_charges_after_tax double The sum of invoice_charges_before_tax and invoice_tax_charges
brd_arrow.gifbrd_arrow.gif invoice_credit_amount double The amount of credit on the initial invoice for this account
brd_arrow.gifbrd_arrow.gif invoice_total_amount double The total owed on the initial invoice for this account
brd_arrow.gifbrd_arrow.gif total_credit double Total amount of the credit to be applied to the account
brd_arrow.gifbrd_arrow.gif total_tax_credit double The tax amount of the credit to be applied
brd_arrow.gifbrd_arrow.gif total_credit_before_tax double The credit to be applied before tax is taken into account
brd_arrow.gifbrd_arrow.gif total double Grand total of this invoice
brd_arrow.gifbrd_arrow.gif 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.
brd_arrow.gifbrd_arrow.gif expected_monthly_rec_cost double Predicted monthly recurring cost of the items and plans on this invoice
brd_arrow.gifbrd_arrow.gif expected_annual_rec_cost double Predicted annual recurring cost of the items and plans on this invoice
brd_arrow.gifbrd_arrow.gif invoice_items hash  
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif invoice_line_no long The line number on the initial invoice
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif plan_no long The unique ID plan this line represents
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif client_plan_id string Client-defined unique ID for plan this line represents
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif plan_instance_no long Unique plan instance number for each assigned master plan
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif client_plan_instance_id string Unique client-defined ID for each assigned master plan
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif plan_name string Name of the plan this line represents
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif service_no long Unique ID for the service this line represents
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif client_service_id string Client-defined unique ID for the service this line represents
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif service_name string Name of the service this line represents
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif service_coa_id long Chart of Accounts ID for the service this line represents
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif client_service_coa_code string Client-defined Chart of Accounts code for the service this line represents
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif units double Number of units of the item or plan on this line
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif rate_per_unit double Charge per unit of the item or plan on this line
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif line_amount double Subtotal amount of this line
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif line_description string Long description of this line, used when printing or otherwise displaying invoices
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif start_date_range string Starting date range for the item or plan on this line
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif end_date_range string Ending date range for the item or plan on this line, if any
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif line_type long Type of charge or credit associated with this line item
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif base_plan_units double Full, non-prorated number of units of the service code
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif proration_factor double Percentage of the line_base_units billed
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif proration_text string Prorated days in total days
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif proration_remaining_days long Prorated days of period in this invoice
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif proration_description string Prorated invoice description
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif credit_coupon_code string Coupon code applied to the invoice
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif client_sku string Client SKU of the NSO/Inventory item.
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif order_no long Unique identifier for an order in the context of an client_no and account_no
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif item_no long Unique ID of the item being retrieved
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif client_item_id string Unique client-defined item ID being retrieved
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif adv_billing_period_total_days long Total days of period in this invoice
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif rate_schedule_no long Aria-assigned unique rate schedule number
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif rate_schedule_tier_no long Sequential number in the rate schedule for determining tiers
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif 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.
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif 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.
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif 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.
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif 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.
brd_arrow.gifbrd_arrow.gif tax_details hash  
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif tax_detail_line long Line number associated with each tax detail record
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif seq_num long Tax line on the invoice which includes the tax amount associated with this tax_detail_line
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif taxed_seq_num long Invoice line item for which the tax for this tax_detail_line was calculated.
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif debit double Amount of tax applied for the given tax type
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif tax_authority_level long Tax jurisdiction code: 0 = Federal, 1 = State / Province.
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif tax_rate double Rate at which tax is calculated for the tax type used by the tax engine
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif orig_was_tax_inclusive long Indicates whether the invoice line amount was tax inclusive
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif tax_srv_tax_type_id string Identifier of the tax type returned by the tax engine
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif tax_srv_tax_type_desc string Description of the tax type returned by the tax engine
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif tax_srv_cat_text string Category of the tax type returned by the tax engine
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif tax_srv_juris_nm string Jurisdiction name returned by the tax engine
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif tax_srv_tax_sum_text string Invoice summary text returned by the tax engine
brd_arrow.gifbrd_arrow.gifbrd_arrow.gif unrounded_tax_amt double

The amount multiplied by tax rate before rounding precision. Also referred to as "raw tax amount."

Note: Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice."

brd_arrow.gifbrd_arrow.gifbrd_arrow.gif carryover_from_prev_amt double

The amount carried over from previous <unrounded_tax_amt>. It is a remainder, and its value can be positive or negative (based on the previous remainder).

Note: Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice."

brd_arrow.gifbrd_arrow.gifbrd_arrow.gif before_round_adjusted_tax_amt double

The amount of adjusted tax before rounding precision, calculated as the sum of <unrounded_tax_amt> and <carryover_from_prev_amt>.

Note: Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice."

brd_arrow.gifbrd_arrow.gifbrd_arrow.gif carryover_from_current_amt double

The amount carried over from current <unrounded_tax_amt>. It is a remainder, and its value can be positive or negative based on the previous remainder.

Note: Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice."

brd_arrow.gif out_acct hash  
  brd_arrow.gif proc_fraud_filtering_info array The fraud filtering information provided by the payment processor as described below. (DEPRECATED)
    brd_arrow.gifbrd_arrow.gif proc_fraud_country_status string Fraud country status provided by the payment processor (DEPRECATED)
    brd_arrow.gifbrd_arrow.gif proc_fraud_country_code string Fraud country code provided by the payment processor. (DEPRECATED)
brd_arrow.gif bg_proc_fraud_filtering_info hash Fraud filtering response returned from the Payment Processor
    brd_arrow.gifbrd_arrow.gif proc_fraud_country_status string Fraud country status provided by the payment processor.
    brd_arrow.gifbrd_arrow.gif proc_fraud_country_code string Fraud country code provided by the payment processor.
plan_instance_queue array List of plan changes scheduled using this API call.
 brd_arrow.gifqueue_id long Unique identifier associated with a specific scheduled plan change.
 brd_arrow.gifqueue_type_ind long

This identifies the type of scheduled plan change.

Allowable Values
 brd_arrow.gifplan_instance_no long Aria plan instance number of the future plan scheduled to be assigned to the account. 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.