Home > Aria6 User Documentation > 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
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.
required-icon.png 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 for hierarchy_filter:

Values Description
0 Returns the entire hierarchy of the account
1 Returns child hierarchy details of the account
2 Returns parent hierarchy details of the account
  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.
  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.
 

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.
brd_arrow.gif acct_no long Aria-assigned account number.
brd_arrow.gif first_name string Specifies the contact First name.
brd_arrow.gif mi string Specifies the middle initial of the contact.
brd_arrow.gif last_name string Specifies the contact Last name.
brd_arrow.gif userid string Specifies the users unique identifier.
brd_arrow.gif birthdate string Specifies the contact date of birth.
brd_arrow.gif job_title string Specifies the job title of the contact.
brd_arrow.gif salutation string Specifies the contact's salutation (such as Mr., Ms., Dr., etc.)
brd_arrow.gif 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.
brd_arrow.gif client_acct_id string Specifies the client-assigned identifier for the account.
brd_arrow.gif resp_level_cd long The responsibility level code. These are values 1 through 4 as described in the legend for this argument. 

Allowable values for resp_level_cd:

Values Description
1 Standard Self-Pay: default
2 Parent Pay: Usage accrues under self, invoices are generated per self's plan rules BUT are presented for payment against parent account'
3 Parent Usage & Pay: Usage accrues under parent and applied only to parent's plan rules and presented to parent for payment'
4 Parent Usage & Pay w/note: Same as "Parent Usage & Pay", except that usage will also be accrued under self for notational purposes only
brd_arrow.gif is_test_acct long Indicates whether the account is a test account or not. 

Allowable values for is_test_acct:

Values Description
0 0
1 1
brd_arrow.gif alt_email string Specifies alternate email address for contact.
brd_arrow.gif address1 string Specifies the first address line of the contact.
brd_arrow.gif 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.
brd_arrow.gif address3 string Specifies the third address line of the contact
brd_arrow.gif city string Specifies the city of the contact.
brd_arrow.gif 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.
brd_arrow.gif locality string Specifies the locality of the contact.
brd_arrow.gif postal_code string Specifies the postal/zip code for the contact address.
brd_arrow.gif country string Specifies the country of the contact. The ISO-compliant 2-character country code abbreviation in uppercase.
brd_arrow.gif company_name string Specifies the company name of the contact.
brd_arrow.gif fax_phone string Specifies the FAX phone number for the contact.
brd_arrow.gif phone string Specifies the phone number of the contact.
brd_arrow.gif phone_ext string Specifies the extension for the contact's phone number.
brd_arrow.gif cell_phone string Specifies the cell phone number of the contact.
brd_arrow.gif work_phone string Specifies the work phone number of the contact.
brd_arrow.gif work_phone_ext string Specifies the extension for the contact's work phone number.
brd_arrow.gif bill_day long Specifies the billing anniversary day.
brd_arrow.gif created_date string Specifies the date the account was created.
brd_arrow.gif date_to_expire string Specifies the date the account is scheduled to expire.
brd_arrow.gif date_to_suspend string Specifies the date the account is scheduled to be suspended.
brd_arrow.gif last_arrears_bill_thru_date string Specifies the date through which the account arrears has been billed.
brd_arrow.gif last_bill_date string Specifies the last date the account was billed.
brd_arrow.gif last_bill_thru_date string Specifies the date through which the account has been billed.
brd_arrow.gif next_bill_date string Specifies the next bill date for the account.
brd_arrow.gif plan_date string Specifies the date the plan assigned to the account.
brd_arrow.gif status_date string Specifies the date the status on the account was set.
brd_arrow.gif status_degrade_date string Specifies the date the account status was degraded.
brd_arrow.gif status_cd long Specifies the status of the object in question for the current API call. 

Allowable values for status_cd:

Values Description
0 INACTIVE
1 ACTIVE
2 CANCELLATION PENDING
3 TERMINATION PENDING
10 ACTIVE DUNNING PENDING
11 ACTIVE DUNNING 1
12 ACTIVE DUNNING 1
13 ACTIVE DUNNING 3
14 ACTIVE DUNNING 4
15 ACTIVE DUNNING 5
16 ACTIVE DUNNING 6
17 ACTIVE DUNNING 7
18 ACTIVE DUNNING 8
21 REINSTATED FORWARD BILL
22 REINSTATED BACK BILL
31 INSTALLATION PENDING
32 REGISTERED PENDING ACTIVATION
41 ACTIVE TRIAL
51 TEMPORARY SERVICE BAN
61 ACTIVE NON-BILLABLE
99 PERMANENT
-1 SUSPENDED
-2 CANCELLED
-3 TERMINATED
-4 CONTRACT EXPIRED
-11 SUSPENDED DUNNING 1
-12 SUSPENDED DUNNING 2
-13 SUSPENDED DUNNING 3
-14 SUSPENDED DUNNING 4
-15 SUSPENDED DUNNING 5
-99 ARCHIVED
brd_arrow.gif status_label string Specifies the the human-readable status of the account.
brd_arrow.gif master_plan_no long Specifies the unique master plan identifier.
brd_arrow.gif master_plan_name string Specifies the name of the Master Subscription Plan for this account.
brd_arrow.gif master_plan_units long Specifies the number of master plan units assigned.
brd_arrow.gif notify_method long Specifies the notification method. 

Allowable values for notify_method:

Values Description
0 None
1 HTML Email
2 Text Email
3 Text Email w/link to HTML
4 Data export
5 Printable (no Email) w/Surcharge
6 Printable & Text Email
7 Printable & HTML Email w/Surcharge
8 Printable (no Email)
9 PDF (Printing required, no Email)
10 PDF (delivered by Email)
11 PDF (Printing req & Email)w/surcharge
12 PDF (Printing req, no Email)w/surcharge
13 XML Master File
14 PDF Master File
brd_arrow.gif notify_method_name string Specifies the name of the notify method to be used in communicating with the account holder.
brd_arrow.gif password string Specifies the password of the account.
brd_arrow.gif pin string Specifies the Personal Identification number.
brd_arrow.gif secret_question string Specifies the users secret question recorded to recover a password.
brd_arrow.gif secret_question_answer string Specifies the response to a users secret_question
brd_arrow.gif pay_method long Specifies the method_id corresponding to a payment method such as credit card, Electronic Check, Pre-Paid, Net Terms, etc.
brd_arrow.gif pay_method_name string Specifies the human-readable name of the payment method.
brd_arrow.gif currency_cd string The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
brd_arrow.gif tax_id string Specifies the Tax Identification Number or EIN of the account holder.
brd_arrow.gif list_start_master_file long Indicates whether or not the account shall be listed at the start of a master file. 

Allowable values for list_start_master_file:

Values Description
0 0
1 When value=1, account shall be sorted at the top of the master file when generated.
brd_arrow.gif billing_email string Specifies the email address of the billing contact, or the general billing email address.
brd_arrow.gif billing_first_name string Specifies the first name of the billing contact for the account.
brd_arrow.gif billing_middle_initial string Specifies the middle initial of the billing contact.
brd_arrow.gif billing_last_name string Specifies the last name of the billing contact.
brd_arrow.gif billing_address1 string Specifies the billing contact's address.
brd_arrow.gif 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.
brd_arrow.gif billing_address3 string Specifies the third billing address line.
brd_arrow.gif billing_city string Specifies the city name of the billing contact address.
brd_arrow.gif 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.
brd_arrow.gif billing_locality string Specifies the billing contact's locality (for example: county, rural unincorporated area name).
brd_arrow.gif billing_zip string Specifies The zip or postal code for the billing contact's address.
brd_arrow.gif billing_country string Specifies the country for the billing contact's address. The ISO-compliant 2-character country code abbreviation in uppercase.
brd_arrow.gif cc_suffix string Specifies the Credit card number
brd_arrow.gif cc_expire_mm string Specifies the expiration month for the credit card payment instrument.
brd_arrow.gif cc_expire_yyyy string Specifies the expiration year for the credit card payment instrument.
brd_arrow.gif cc_id long A numeric code indicating the type of credit card. 

Allowable values for cc_id:

Values Description
1 Visa
2 MasterCard
3 American Express
4 Discover
5 Diners Club/Carte Blanche
6 Maestro
7 JCB
8 Laser
9 Dankoort
brd_arrow.gif bank_acct_suffix string Specifies the bank account number.
brd_arrow.gif bank_routing_no string Specifies the credit card ID.
brd_arrow.gif billing_company_name string Specifies the billing company name.
brd_arrow.gif billing_phone string Specifies the billing phone contact.
brd_arrow.gif billing_phone_ext string Specifies the phone extension of the billing contact.
brd_arrow.gif billing_cell_phone string Specifies the cell phone of the billing contact.
brd_arrow.gif billing_work_phone_ext string Specifies the extension of the work phone of billing contact.
brd_arrow.gif balance double Specifies the outstanding balance for this account.
brd_arrow.gif acct_create_client_receipt_id string Specifies the client receipt ID given during account creation.
brd_arrow.gif plan_client_receipt_id string Specifies the client receipt ID given during plan assignment.
brd_arrow.gif status_client_receipt_id string Specifies the client receipt ID.
brd_arrow.gif taxpayer_id string Specifies the Taxpayer Identification number.
brd_arrow.gif alt_msg_template_no long Specifies the Email template number assigned to this account.
brd_arrow.gif seq_func_group_no long Specifies the functional account group number specifically designated for statement sequence number assignment.
brd_arrow.gif 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.
brd_arrow.gif address_verification_code string Specifies the address verification code for account contact address.
brd_arrow.gif address_match_score double Specifies the score of match for account contact address verification code.
brd_arrow.gif billing_address_verification_code string Specifies the address verification code for account billing address.
brd_arrow.gif billing_address_match_score double Specifies The score of match for account billing address verification code.
brd_arrow.gif client_master_plan_id string Client-defined Master plan Subscription plan ID.
brd_arrow.gif client_alt_msg_template_id string Client-defined email template ID assigned to this account.
brd_arrow.gif child_acct_no hash An Array of account number of immediate child of the given account number.
brd_arrow.gif acct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
brd_arrow.gif this_acct_supp_plans hash The supplemental plans on this account
brd_arrow.gif supp_plan_no long The supplemental plan number.
brd_arrow.gif supp_plan_name string The name of this supplemental plan.
brd_arrow.gif supp_plan_units long Number of units for the supplemental plan
brd_arrow.gif client_supp_plan_id string Client-defined supplemental plan ID.
brd_arrow.gif this_acct_supp_fields hash  
brd_arrow.gif field_name string The machine-readable name of this field
brd_arrow.gif field_value string The value stored in this field
brd_arrow.gif stmnt_email_list string Deprecated (Deprecated) An array containing the list of additional email addresses
brd_arrow.gif stmnt_email_list_cc string An array containing the list of additional cc email addresses
brd_arrow.gif stmnt_email_list_bcc string An array containing the list of additional bcc email addresses
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®