Skip to main content
Aria Knowledge Central

get_acct_hierarchy_details_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_acct_hierarchy_details_m
Class account_services_m
Update Version 56

Description

This API is used to retrieve the account details, and also the details of its master plan instances, supplemental plan instances, billing groups and payment methods (based on various filter flags in the input). It is also capable of fetching the details of its parent and child account details.

Inputs

Name Type Length Required Description
client_no long 22 Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Yes

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.
acct_no long 22 Yes

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

Alternative required field: client_acct_id
hierarchy_filter long 1 No

Specifies the filter which may be parent only, child only or complete hierarchy.

Allowed values:

Value 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 No

Specifies the current account to be included or not.
include_supp_plans long 1 No

Indicates whether to include the supplemental plan instance while retreving the accound details.

Allowed values:

Value Description
1 Yes
0 No
include_billing_groups long 1 No

Indicates whether to include the billing groups while retreving the accound details.

Allowed values:

Value Description
1 Yes
0 No
include_payment_methods long 1 No

Indicates whether to include payment methods while retreving the accound details.

Allowed values:

Value Description
1 Yes
0 No
locale_no long 30 No

Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients.

Alternative field: locale_name
locale_name string 100 No

Name of the locale.

Alternative field: locale_no
client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: acct_no

Outputs

Name Type Length Required Description
error_code long   No

Aria-assigned error identifier. 0 indicates no error.
error_msg string   No

Description of any error that occurred. "OK" if there was no error.
acct_hierarchy_dtls object   No

An Array of account hierarchy details.

See fields below
chief_acct_info object   No

Information of the Chief account in the account hierarchy.

See fields below

acct_hierarchy_dtls.functional_acct_group fields

Name Type Length Required Description
functional_acct_group_no long   No

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.
client_functional_acct_group_id string   No

Array of functional account group IDs to which this account should be assigned

acct_hierarchy_dtls.collection_acct_group fields

Name Type Length Required Description
collections_acct_group_no long   No 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.

client_collections_acct_group_id string   No

Array of collections account group IDs to which this account should be assigned

acct_hierarchy_dtls.supp_field fields

Name Type Length Required Description
supp_field_name string 100 No

Name of the supplemental field. This value is required if you want to assign supplemental fields. For example, if you have any accounts that are tax-exempt or international, you must set up corresponding account supplemental fields prior to your tax provider configuration. Create fields for the tax exemption number and for the VAT ID used by the tax provider.
supp_field_value string 300 No

The value for the supplemental field name given in supp_field_name

acct_hierarchy_dtls.acct_surcharges_info fields

Name Type Length Required Description
surcharge_no long   No

The Surcharge number to be attached to the account
rate_schedule_no long   No

The Rate Schedule Number for the Surcharge

acct_hierarchy_dtls.billing_groups_info fields

Name Type Length Required Description
client_primary_payment_method_id     No  
client_backup_payment_method_id     No  

acct_hierarchy_dtls.payment_methods_info fields

Name Type Length Required Description
payment_method_no long 22 No

Aria-assigned sequence number for this payment method.

acct_hierarchy_dtls.master_plans_info fields

Name Type Length Required Description
client_master_plan_instance_id string 100 No

Client-defined master plan subscription plan instance ID.
client_master_plan_id     No  
master_plan_instance_description     No  
client_dunning_group_id     No  
client_billing_group_id string 100 No

Client-defined unique identifier for billing group.
alt_rate_schedule_no     No  
client_alt_rate_schedule_id     No  

acct_hierarchy_dtls.child_acct_no fields

Name Type Length Required Description
acct_no long   No

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

acct_hierarchy_dtls.collection_group_bg_info fields

Name Type Length Required Description
collections_group_bg_no long 22 No

Collection Group Number to which this billing group should be assigned.
client_collections_group_bg_id string 100 No

Collection Group ID to which this billing group should be assigned.
collections_group_name string 300 No

Collection Group Name
collections_group_description string 1000 No

Collections group description

acct_hierarchy_dtls.acct_einvoicing_field_list fields

Name Type Length Required Description
acct_einvoicing_field_name string 100 No

Name of the e-invoicing field.
acct_einvoicing_field_value string 100 No

The value corresponding to the e-invoicing field name.

acct_hierarchy_dtls fields

Name Type Length Required Description
acct_no long   No

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
client_acct_id string 50 No

Client-defined account identifier.
userid string   No

The users unique identifier.
first_name string   No

Contact First name
middle_initial string   No

Middle initial of the contact
last_name string   No

Contact last name
company_name string   No

Company name of the contact
address1 string   No

First address line of the contact.
address2 string   No

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   No

The third line of the address
city string   No

City of the contact
locality string 32 No

Use this field instead of the state_prov field to designate the state, province or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all United States, Australia and Canada addresses.
state_prov string   No

State or Province of the contact. The official postal-service codes for all United States, Australia and Canada states, provinces, and territories. This field does not support states, provinces or territories from other countries. Use the locality field for other countries.
country_cd string   No

Country of the contact. The ISO-compliant 2-character country code abbreviation in uppercase.
postal_cd string   No

Postal/Zip code for the contact address.
phone string   No

The phone number of the contact
phone_ext string   No

The extension for the contact phone
cell_phone string   No

The contact cell phone.
work_phone string   No

The full work phone number
work_phone_ext string   No

The office/desk extension of the contact's work phone, if any.
fax string   No

The FAX phone number for the contact.
email string   No

Alternate email address for contact.
birthdate string 10 No

Birthdate of the contact in yyyy-mm-dd format.
status_cd long   No

This is the status of the object in question for the current API call.

Allowed values:

Value Description
0 INACTIVE
1 ACTIVE
32 REGISTERED PENDING ACTIVATION
99 PERMANENT
-99 ARCHIVED
notify_method long 2 No

How the client communicates with the account holder. If a notification method is not provided, this value defaults to "1" (HTML email).

Allowed values:

Value 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
15 XML Master File and HTML Email
16 XML Master File and Text Email
17 PDF Master File and HTML Email
senior_acct_no long   No

The senior_acct_no is the unique account number for the parent account and is used in establishing parent-child billing relationships.
senior_acct_user_id string   No

The senior account user ID of the account.
senior_client_acct_id string   No

The client senior account ID of the account.
test_acct_ind long   No

This argument indicates the account is a test account and is treated as such in the system.

Allowed values:

Value Description
1 test
0 live
taxpayer_id string   No

Taxpayer Identification number.
acct_start_date string 10 No

Date, in yyyy-mm-dd format, on which the account was first created outside of Aria
alt_msg_template_no long   No

Email template number assigned to this account.
seq_func_group_no long   No

Functional account group number specifically designated for statement sequence number assignment.
tax_exemption_level long   No

To provide Tax Exemption Level for the account

Allowed values:

Value Description
0 Account is not exempt from taxation (DEFAULT).
1 Account is exempt from state/province taxation.
2 Account is exempt from federal/national taxation.
3 Account is exempt from both federal/national and state/province taxation.
client_alt_msg_template_id string   No

Client-defined email template ID assigned to this account.
list_start_master_file long 1 No

Indicates whether the account is listed at the start of a master file.

Allowed values:

Value Description
0  
1 When value=1, account is listed at the top of the master file when generated.
client_cn_alt_msg_template_id string   No

The client-defined alternate email template ID to use for this account
functional_acct_group object   No

Array of functional account groups.

See fields below
collection_acct_group object   No

Array of collections account groups.

See fields below
supp_field object   No

Assigns one or more supplemental field values to the account

See fields below
acct_surcharges_info object   No

See fields below
acct_currency string   No

The 3-character ISO-compliant currency code in lowercase for monetary values used for this account
acct_balance double   No

Specifies the balance for this account.
address_verification_code string   No

The address verification code for account contact address
address_match_score double   No

The score of match for account contact address verification code
acct_create_client_receipt_id string   No

The client-specified receipt ID, assigned during this account creation. Useful for auditing and tracking.
status_client_receipt_id string   No

The client-specified receipt ID, assigned for account status change. Useful for auditing and tracking.
po_num string   No

Purchase order number assigned to the account.
billing_groups_info object   No

See fields below
payment_methods_info object   No

List of primary and secondary payment methods of billing groups on this account.

See fields below
master_plans_info object   No

If billing groups are not excluded, then this array returns all the associated master plan instances for each billing group (provided this is a self-pay account). If billing groups are excluded (or if this is a parent-pay account), then this array returns all the master plan instances on this account.

See fields below
child_acct_no object   No

An Array of account number of immediate child of the given account number.

See fields below
acct_locale_no long 30 No

Note: This field is deprecated. Aria no longer supports acct_locale_no.
acct_locale_name string 100 No

Name of the account level locale.
legal_entity_no long   No

Note: This field is deprecated. Aria no longer supports legal_entity_no.
legal_entity_name string   No

Client-assigned descriptor of the legal entity.
client_legal_entity_id string   No

Client-assigned unique identifier for the legal entity.
acct_email_list_cc string 3000 No

An array containing the list of additional cc email addresses
acct_email_list_bcc string 3000 No

An array containing the list of additional bcc email addresses
acct_locale_no_2 long 30 No

Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts.
legal_entity_no_2 long   No

Aria-assigned legal entity identification number.
collection_group_bg_info object   No

See fields below
addr_method_cd long   No

This field denotes the tax address method code which was used to generate the geo code of the account contact.
acct_einvoicing_field_list object   No

Array of e-invoicing fields associated with the account.

See fields below

chief_acct_info fields

Name Type Length Required Description
chief_acct_no long   No

Aria-assigned account identifier. This is the Chief of all accounts in hierarchy.
chief_acct_user_id string   No

The User ID of the Chief account in account hierarchy.
chief_client_acct_id string   No

Client-assigned identifier for the Chief account in account hierarchy.
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.