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

 

Home > Aria6 core api > get_acct_hierarchy_details

get_acct_hierarchy_details

Returns the account hierarchy details.

Input Arguments

Req Field Name Field Type Max Length Description
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
hierarchy_filter long 1 Specifies the filter which may be parent only, child only or complete hierarchy.   Allowable Values
include_current_acct long 1 Specifies the current account to be included or not.
alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
optional_transaction_qualifiers array Array of additional values you can associate with this API call.
qualifier_name string 100 Name of the field you want to associate with this API call.
qualifier_value string 100 Corresponding value of the field you want to associate with this API call.

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
acct_hierarchy_details hash An Array of account hierarchy details.
acct_no long Aria-assigned account number.
first_name string Specifies the contact First name.
mi string Specifies the middle initial of the contact.
last_name string Specifies the contact Last name.
userid string Specifies the users unique identifier.
birthdate string Specifies the contact date of birth.
job_title string Specifies the job title of the contact.
salutation string Specifies the contact's salutation (such as Mr., Ms., Dr., etc.)
senior_acct_no long Specifies the senior_acct_no is the unique account number for the parent account and is used in establishing parent-child billing relationships.
client_acct_id string Specifies the client-assigned identifier for the account.
resp_level_cd long The responsibility level code. These are values 1 through 4 as described in the legend for this argument.  Allowable Values
is_test_acct long Indicates whether the account is a test account or not.  Allowable Values
alt_email string Specifies alternate email address for contact.
address1 string Specifies the first address line of the contact.
address2 string Second address line of the contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
address3 string Specifies the third address line of the contact
city string Specifies the city of the contact.
state_prov string State or Province of the contact. The official postal-service codes for all United States, Australia and Canada states, provinces, and territories. This field does not support states, provinces or territories from other countries. Use the locality field for other countries.
locality string Specifies the locality of the contact.
postal_code string Specifies the postal/zip code for the contact address.
country string Specifies the country of the contact. The ISO-compliant 2-character country code abbreviation in uppercase.
company_name string Specifies the company name of the contact.
fax_phone string Specifies the FAX phone number for the contact.
phone string Specifies the phone number of the contact.
phone_ext string Specifies the extension for the contact's phone number.
cell_phone string Specifies the cell phone number of the contact.
work_phone string Specifies the work phone number of the contact.
work_phone_ext string Specifies the extension for the contact's work phone number.
bill_day long Specifies the billing anniversary day.
created_date string Specifies the date the account was created.
date_to_expire string Specifies the date the account is scheduled to expire.
date_to_suspend string Specifies the date the account is scheduled to be suspended.
last_arrears_bill_thru_date string Specifies the date through which the account arrears has been billed.
last_bill_date string Specifies the last date the account was billed.
last_bill_thru_date string Specifies the date through which the account has been billed.
next_bill_date string Specifies the next bill date for the account.
plan_date string Specifies the date the plan assigned to the account.
status_date string Specifies the date the status on the account was set.
status_degrade_date string Specifies the date the account status was degraded.
status_cd long Specifies the status of the object in question for the current API call.  Allowable Values
status_label string Specifies the the human-readable status of the account.
master_plan_no long Specifies the unique master plan identifier.
master_plan_name string Specifies the name of the Master Subscription Plan for this account.
master_plan_units long Specifies the number of master plan units assigned.
notify_method long Specifies the notification method.  Allowable Values
notify_method_name string Specifies the name of the notify method to be used in communicating with the account holder.
password string Specifies the password of the account.
pin string Specifies the Persinal Identification number.
secret_question string Specifies the users secret question recorded to recover a password.
secret_question_answer string Specifies the response to a users secret_question
pay_method long Specifies the method_id corresponding to a payment method such as credit card, Electronic Check, Pre-Paid, Net Terms, etc.
pay_method_name string Specifies the human-readable name of the payment method.
currency_cd string The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
tax_id string Specifies the Tax Identification Number or EIN of the account holder.
list_start_master_file long Indicates whether or not the account shall be listed at the start of a master file.  Allowable Values
billing_email string Specifies the email address of the billing contact, or the general billing email address.
billing_first_name string Specifies the first name of the billing contact for the account.
billing_middle_initial string Specifies the middle initial of the billing contact.
billing_last_name string Specifies the last name of the billing contact.
billing_address1 string Specifies the billing contact's address.
billing_address2 string 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.
billing_address3 string Specifies the third billing address line.
billing_city string Specifies the city name of the billing contact address.
billing_state string Specifies the state or province of the billing contact's address. The official postal-service codes for all United States and Canada states, provinces, and territories.
billing_locality string Specifies the billing contact's locality (for example: county, rural unincorporated area name).
billing_zip string Specifies The zip or postal code for the billing contact's address.
billing_country string Specifies the country for the billing contact's address. The ISO-compliant 2-character country code abbreviation in uppercase.
cc_suffix string Specifies the Credit card number
cc_expire_mm string Specifies the expiration month for the credit card payment instrument.
cc_expire_yyyy string Specifies the expiration year for the credit card payment instrument.
cc_id long A numeric code indicating the type of credit card.  Allowable Values
bank_acct_suffix string Specifies the bank account number.
bank_routing_no string Specifies the credit card ID.
billing_company_name string Specifies the billing company name.
billing_phone string Specifies the billing phone contact.
billing_phone_ext string Specifies the phone extension of the billing contact.
billing_cell_phone string Specifies the cell phone of the billing contact.
billing_work_phone_ext string Specifies the extension of the work phone of billing contact.
balance double Specifies the outstanding balance for this account.
acct_create_client_receipt_id string Specifies the client receipt ID given during account creation.
plan_client_receipt_id string Specifies the client receipt ID given during plan assignment.
status_client_receipt_id string Specifies the client receipt ID.
taxpayer_id string Specifies the Taxpayer Identification number.
alt_msg_template_no long Specifies the Email template number assigned to this account.
seq_func_group_no long Specifies the functional account group number specifically designated for statement sequence number assignment.
promo_cd string Specifies the code provided the client and used by the account holder during registration or when executing a transaction. A promotion generally provides access to a custom set of reduced-rate plans.
address_verification_code string Specifies the address verification code for account contact address.
address_match_score double Specifies the score of match for account contact address verification code.
billing_address_verification_code string Specifies the address verification code for account billing address.
billing_address_match_score double Specifies The score of match for account billing address verification code.
client_master_plan_id string Client-defined Master plan Subscription plan ID.
client_alt_msg_template_id string Client-defined email template ID assigned to this account.
child_acct_no hash An Array of account number of immediate child of the given account number.
acct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
this_acct_supp_plans hash The supplemental plans on this account
supp_plan_no long The supplemental plan number.
supp_plan_name string The name of this supplemental plan.
supp_plan_units long Number of units for the supplemental plan
client_supp_plan_id string Client-defined supplemental plan ID.
this_acct_supp_fields hash
field_name string The machine-readable name of this field
field_value string The value stored in this field
stmnt_email_list string Deprecated (Deprecated) An array containing the list of additional email addresses
stmnt_email_list_cc string An array containing the list of additional cc email addresses
stmnt_email_list_bcc string An array containing the list of additional bcc email addresses

You must to post a comment.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.