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

 

Home > Aria Crescendo core api > get_acct_hierarchy_details_m

get_acct_hierarchy_details_m

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 Specifies the current account to be included or not.
include_supp_plans long 1 Indicates whether to include the supplemental plan instance while retreving the accound details.   Allowable Values
include_billing_groups long 1 Indicates whether to include the billing groups while retreving the accound details.   Allowable Values
include_payment_methods long 1 Indicates whether to include payment methods while retreving the accound details.   Allowable Values
locale_no long 22 Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients.
OR
locale_name string 50 Name of the locale.
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_dtls hash An Array of account hierarchy details.
acct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
client_acct_id string Client-defined account identifier.
userid string The users unique identifier.
first_name string Contact First name
middle_initial string Middle initial of the contact
last_name string Contact last name
company_name string Company name of the contact
address1 string 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 The third line of the address
city string City of the contact
locality string 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 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 Country of the contact. The ISO-compliant 2-character country code abbreviation in uppercase.
postal_cd string Postal/Zip code for the contact address.
phone string The phone number of the contact
phone_ext string The extension for the contact phone
cell_phone string The contact cell phone.
work_phone string The full work phone number
work_phone_ext string The office/desk extension of the contact's work phone, if any.
fax string The FAX phone number for the contact.
email string Alternate email address for contact.
birthdate string Birthdate of the contact in yyyy-mm-dd format.
status_cd long This is the status of the object in question for the current API call.   Allowable Values
notify_method long How the client communicates with the account holder. If a notification method is not provided, this value defaults to "1" (HTML email).   Allowable Values
senior_acct_no long 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 The senior account user ID of the account.
senior_client_acct_id string The client senior account ID of the account.
test_acct_ind long This argument indicates the account is a test account and is treated as such in the system.   Allowable Values
taxpayer_id string Taxpayer Identification number.
acct_start_date string Date, in yyyy-mm-dd format, on which the account was first created outside of Aria
alt_msg_template_no long Email template number assigned to this account.
seq_func_group_no long Functional account group number specifically designated for statement sequence number assignment.
tax_exemption_level long To provide Tax Exemption Level for the account   Allowable Values
client_alt_msg_template_id string Client-defined email template ID assigned to this account.
list_start_master_file long Indicates whether the account is listed at the start of a master file.   Allowable Values
client_cn_alt_msg_template_id string The client-defined alternate email template ID to use for this account
functional_acct_group hash Array of functional account groups.
functional_acct_group_no long 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 Array of functional account group IDs to which this account should be assigned
collection_acct_group hash Array of collections account groups.
collections_acct_group_no long 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. <p> 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 Array of collections account group IDs to which this account should be assigned
supp_field hash
supp_field_name string 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 The values for the supplemental field names given in supp_field_names
acct_surcharges_info hash
surcharge_no long The Surcharge number to be attached to the account
rate_schedule_no long The Rate Schedule Number for the Surcharge
acct_currency string The 3-character ISO-compliant currency code in lowercase for monetary values used for this account
acct_balance double Specifies the balance for this account.
address_verification_code string The address verification code for account contact address
address_match_score double The score of match for account contact address verification code
acct_create_client_receipt_id string The client-specified receipt ID, assigned during this account creation. Useful for auditing and tracking.
status_client_receipt_id string The client-specified receipt ID, assigned for account status change. Useful for auditing and tracking.
po_num string Purchase order number assigned to the account.
billing_groups_info hash
billing_group_no long The billing group number mapped against each master plan.
billing_group_name string Billing group name
billing_group_description string Billing group description
client_def_billing_group_id string Client-defined billing group ID.
notify_method long How the client communicates with the account holder. If a notification method is not provided, this value defaults to "1" (HTML email).   Allowable Values
notify_template_group long Notify template No.
statement_template long Statement template No.
credit_note_template long Credit note template No.
payment_option string This allows you to select either payment methods (such as a credit card or other electronic form of payment) or payment terms (such as a physical check) when creating or modifying a billing group'   Allowable Values
primary_payment_method_name string Pay Method Name from Pay Methods configuration.
primary_payment_method_id long The primary payment_method_no of the billing group.
primary_payment_method_no long Pay Method Number from Pay Methods configuration.
backup_payment_method_name string Pay Method Name from Pay Methods configuration.
backup_payment_method_id long The secondary payment_method_no of billing group.
backup_payment_method_no long Pay Method Number from Pay Methods configuration.
client_payment_term_id string Client Payment Term ID from Payment Terms configuration.
payment_terms_name string Payment Terms Name from Payment Terms configuration.
payment_terms_no long Payment Terms Number from Payment Terms configuration.
payment_terms_type string Payment Terms Type from Payment Terms configuration.
ean_gln_num string 'EAN or GLN Number from billing group that is only applicable if payment_option="Terms" and pmt_terms_type="EAN/GLN"'
ean_gln_requisition_num string 'EAN or GLN Requisition Number from billing group that is only applicable if payment_option="Terms" and pmt_terms_type="EAN/GLN"'
stmt_first_name string First name of the billing contact
stmt_mi string Middle Initial of the billing contact
stmt_last_name string Last name of the billing contact
stmt_company_name string Company name of the billing contact
stmt_address1 string First address line of the billing contact
stmt_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.
stmt_address3 string Third address line of the billing contact
stmt_city string City of the billing contact
stmt_locality string 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.
stmt_state_prov string State or Province of the billing 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.
stmt_country string Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
stmt_postal_cd string This is the postal code for the billing contact address.
stmt_phone string Phone of the billing contact
stmt_phone_ext string This is the billing contacts extension for the phone given.
stmt_cell_phone string Cell phone of the billing contact
stmt_work_phone string Work phone of the billing contact
stmt_work_phone_ext string This is the work phone extension for the billing contact work phone.
stmt_fax string Specifies the FAX phone number for the billing contact.
stmt_email string Email of the billing contact
stmt_birthdate string The birthdate, in yyyy-mm-dd format, of the statement contact.
bg_list_start_master_file long Indicates whether or not the account shall be listed at the start of a master file.   Allowable Values
stmt_address_verification_code string The address verification code for billing contact.
stmt_address_match_score double The score of match for billing contact verification code
client_primary_payment_method_id string Client-defined ID of primary payment method on the billing group
client_backup_payment_method_id string Client-defined ID of backup payment method on the billing group
stmt_contact_no long The Aria-assigned unique identifier for the statement contact associated with a billing group on the account.
credit_memo_template long Credit memo template No.
rebill_template long Rebill template No.
payment_methods_info hash List of primary and secondary payment methods of billing groups on this account.
billing_group_no long The billing group number mapped against each master plan.
client_def_billing_group_id string Client-defined billing group ID
payment_method_no long Aria-assigned sequence number for this payment method.
bill_first_name string First name of the billing contact.
bill_middle_initial string Middle initial of the billing contact.
bill_last_name string Last name of the billing contact.
bill_company_name string Company name of the billing contact.
bill_address1 string First address line of the billing contact.
bill_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.
bill_address3 string The third line of the billing address.
bill_city string City of the billing contact.
bill_locality string 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.
bill_state_prov string State or Province of the billing 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.
bill_country string Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
bill_postal_cd string Postal code for the billing contact.
bill_address_verification_code string The address verification code for account billing address
bill_address_match_score double The score of match for account billing address verification code
bill_phone string Phone number of the billing contact.
bill_phone_ext string Phone extension of the billing contact.
bill_cell_phone string Cell phone number of the billing contact.
bill_work_phone string Work phone number of the billing contact.
bill_work_phone_ext string This is the work phone extension for the billing contact work phone.
bill_fax string Fax number of the billing contact.
bill_email string Email of the billing contact.
bill_birthdate string Birthdate of the billing contact.
pay_method_name string The human-readable name of the payment method.
client_payment_method_id string The client-defined billing primary payment method ID.
pay_method_description string Description for the primary payment method.'
pay_method_type long This is the method_id corresponding to a payment method such as credit card, Electronic Check, Pre-Paid, Net Terms, etc.   Allowable Values
suffix string The last 4 digits of the credit card number
cc_expire_mm long Expiration month for the credit card payment instrument.
cc_expire_yyyy long Expiration year for the credit card payment instrument.
cc_type string The type of credit card used for the original payment.
bank_routing_num string The American Banking Association (ABA) routing number for the financial institution.
bill_agreement_id string Unique ID of the bill agreement (also referred to as a token).
iban string International Bank Account Number(IBAN). Used for the Direct Debit payment method. It consists of 16 to 34 alphanumeric characters. Only hyphen and space are allowed to format the IBAN.
bank_swift_cd string 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.
bank_country_cd string Country of the bank. The ISO-compliant 2-character country code abbreviation in uppercase. Used for the Direct Debit payment method. It is required for IBAN and BBAN.
mandate_id string 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.
bank_id_cd string Up to 10 digit numeric bank identifier code. Used for the Direct Debit payment method. Used in Europe. Only hyphen and space are allowed to format the bank ID code. It is required for BBAN.
bank_branch_cd string 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.
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.
master_plans_info hash 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.
master_plan_instance_no long Unique plan instance number for each assigned master plan.
client_master_plan_instance_id string Client-defined plan instance ID for each assigned master plan.
client_master_plan_id string The client-defined unique ID for plan this line represents
master_plan_no long The Master Subscription plan number.
master_plan_instance_description string Description for each assigned master plan
dunning_group_no long The dunning group number mapped against each master plan.
client_dunning_group_id string The client-defined dunning group ID mapped against each master plan.
dunning_group_name string Name of the dunning group.
dunning_group_description string Description of the dunning group.
dunning_process_no long Dunning process.
client_dunning_process_id string Client-defined dunning process identifier.
billing_group_no long The billing group number mapped against each master plan.
client_billing_group_id string The client-defined billing group ID mapped against each master plan.
master_plan_instance_status long This is the status of the object in question for the current API call.
mp_instance_status_label string Status label associated with master plan instance status code.
master_plan_units long This is 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.
resp_level_cd long The responsibility level code. These are values 1 through 4 as described in the legend for this argument.
parent_master_plan_inst_no long The system-defined master plan instance number of the parent account. This field is required if the resp_level_cd is not equal to 1
alt_rate_schedule_no long The alternate rate schedule number for the master subscription plan being considered.
client_alt_rate_schedule_id string The client-defined alternate rate schedule ID for the master subscription plan being considered.
promo_cd string This is 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.
bill_day long Day of the month that the account is billed.
last_arrears_bill_thru_date string The most recent date at which the account was fully billed in arrears
last_bill_date string The last date the account was billed
last_bill_thru_date string The date through which the account has been billed.
next_bill_date string The next bill date for the account.
plan_date string The date the plan assigned to the account.
status_date string This is the date the status on the account was set.
master_plan_instance_balance double Stack balance of each master plan
status_degrade_date string Specifies the date, in yyyy-mm-dd format, when the plan instance status was degraded.
recurring_billing_interval long Recurring billing interval associated with the assigned rate schedule.
usage_billing_interval long Usage billing interval associated with the assigned rate schedule.
initial_plan_status long Default status used when master plan is initially assigned on an account.   Allowable Values
rollover_plan_status long Status used for the master plan instance at the completion of the rollover period.   Allowable Values
rollover_plan_status_duration long Duration of the plan status rollover period, after which the initial plan status on the master plan instance will change to the pre-defined rollover plan status (used in conjuction with rollover_plan_status_uom_cd).
rollover_plan_status_uom_cd long Units associated with the duration of the plan status rollover period after which the initial plan status on the master plan instance will change to the pre-defined rollover plan status. (used in conjunction with rollover_plan_status_duration).   Allowable Values
init_free_period_duration long Duration of the initial free period (used in conjunction with init_free_period_uom_cd).
init_free_period_uom_cd long Units associated with the duration of the initial free period (used in conjunction with init_free_period_duration).   Allowable Values
dunning_state long Dunning state assigned to the master plan instance. In Progress indicates the master plan is in dunning. None indicates the master plan is not in dunning. Note that dunning state is applicable only for master plans and is set to Complete by the system once the dunning process is completed.   Allowable Values
dunning_step long Current dunning step of the plan instance (applicable only for master plans currently in dunning).
dunning_degrade_date string Next future date on which the plan instance would advance to the next dunning step (applicable only for master plans currently in dunning).
plan_deprovisioned_date string The date on which the current plan on this plan instance was suspended, cancelled or terminated.
coupon_codes hash An array of coupon details for each master plan instance.
coupon_codes string The coupon codes to assign to this plan instance, if any
master_plan_product_fields hash
field_name string The product field number
field_value string The product field value
mp_plan_inst_fields hash
plan_instance_field_name string Field name associated with each plan instance field on master plan instance.
plan_instance_field_value string Field value associated with each plan instance field on master plan instance.
po_num string Purchase order number assigned to the master plan instance.
master_plans_services hash
service_no long The Aria-assigned unique identifier for the service associated with the plan.
client_service_id string The client-defined identifier for the service associated with the plan.
svc_location_no long The Aria-assigned unique identifier for the origin location for the specified service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations.
client_svc_location_id string 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.
dest_contact_no long The Aria-assigned unique identifier for the destination contact for the specified service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations.
supp_plans_info hash
supp_plan_instance_no long Unique plan instance number for each assigned supplemental plan.
client_supp_plan_instance_id string Client-defined plan instance ID for each assigned supplemental plan.
supp_plan_no long The Aria-assigned identifier for a supplemental service plan. Allowable values are limited to valid custom plan numbers for client.
client_supp_plan_id string Client-defined supplemental plan ID.
supp_plan_instance_description string Description for each assigned supplemental plan instance
supp_plan_units long The units of each plan in the above supp_plan_instance array to assign to this account
alt_rate_schedule_no long The unique ID for the alternate rate schedules to assign to this account, by supplemental plan above
client_alt_rate_schedule_id string The client alternate rate schedule ID for the supplementary subscription plan being considered.
last_arrears_bill_thru_date string The most recent date at which the account was fully billed in arrears
last_bill_date string The last date the account was billed
last_bill_thru_date string The date through which the account has been billed.
next_bill_date string The next bill date for the account.
plan_date string The date the plan assigned to the account.
status_date string This is the date the status on the account was set.
supp_plan_instance_status_cd long Status code associated with supplemental plan instance status.
supp_plan_instance_status string Supplemental Plan Instance Status
parent_plan_instance_no long Aria internal ID of parent plan instance
client_parent_plan_instance_id string Client-defined ID of parent plan instance no
recurring_billing_interval long Recurring billing interval associated with the assigned rate schedule.
usage_billing_interval long Usage billing interval associated with the assigned rate schedule.
rollover_plan_status long Status used for the master plan instance at the completion of the rollover period.   Allowable Values
rollover_plan_status_duration long Duration of the plan status rollover period, after which the initial plan status on the master plan instance will change to the pre-defined rollover plan status (used in conjuction with rollover_plan_status_uom_cd).
rollover_plan_status_uom_cd long Units associated with the duration of the plan status rollover period after which the initial plan status on the master plan instance will change to the pre-defined rollover plan status. (used in conjunction with rollover_plan_status_duration).   Allowable Values
plan_deprovisioned_date string The date on which the current plan on this plan instance was suspended, cancelled or terminated.
supp_plan_product_fields hash
field_name string The product field number
field_value string The product field value
supp_plan_plan_inst_fields hash
plan_instance_field_name string The plan instance field name
plan_instance_field_value string The plan instance field value
po_num string Purchase order number assigned to the supplemental plan instance.
supp_plans_services hash
service_no long The Aria-assigned unique identifier for the service associated with the plan.
client_service_id string The client-defined identifier for the service associated with the plan.
svc_location_no long The Aria-assigned unique identifier for the origin location for the specified service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations.
client_svc_location_id string 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.
dest_contact_no long The Aria-assigned unique identifier for the destination contact for the specified service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations.
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.
acct_locale_no long Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts.
acct_locale_name string Name of the account level locale.
legal_entity_no long Aria-assigned legal entity identification number.
legal_entity_name string Client-assigned descriptor of the legal entity.
client_legal_entity_id string Client-assigned unique identifier for the legal entity.

You must to post a comment.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.