Skip to main content
Aria Knowledge Central

get_account_details_m

  1. Last updated
  2. Save as PDF

Description

Gets detailed account level information for all accounts matching specified query.

Inputs

Name Type Length Required Description
username string 30 No DeprecatedThe login name of the user making this request. It is the same name that is used to log in to the Aria Administration and Configuration Tool.
password string 1000 No DeprecatedThe password of the user making this request. It is the same password that is used to log in to the Aria Administration and Configuration Tool.
client_no long 12 Yes Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Yes Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
limit long 12 No The maximum number of objects to be returned by this call. Note that Aria recommends a maximum limit of less than 1,000. Higher limits may take much longer to return data. If you do not specify a value, or specify a value of "0", this field defaults to 100. Specifying a value of "-1" returns a count of the number of matching records, but does not return any records.
offset long 12 No The number of records to skip. Note that both "0" and NULL will cause the interface not to skip any records.
query_string string 1000 Yes The criteria which all returned objects must match. Different objects have a different set of searchable criteria. Fields marked with "*Query" in the returns section can be used as part of the query_string. Valid operations for the query string include "=", "!=", "<", "<=", ">=", ">", "IS NULL", "IS NOT NULL", "LIKE", and "NOT LIKE". You must leave a space before and after each operation. The first operand must always be a field name, and the second operand must always be a value (except for "IS NULL" and "IS NOT NULL", where the second operand is implicitly "NULL"). If the second operand contains a space, less than, greater than, or equals sign, then it must be enclosed in double quotes. The second operand may not contain double quotes. Multiple conditions must be joined with either "AND" or "OR". Additionally, any queryable field can also be used to order the results, by appending "ORDER BY" to the query, followed by a field name and either "ASC" or "DESC".

Querystring Keys

Key Name Description
acct_no The Aria assigned ID of the account
client_acct_id Client specified account identifier
user_id The client defined user_id for the account
first_name  
last_name  
company_name  
city  
country_cd  
postal_cd Postal code
senior_acct_no The Aria assigned ID of the parent account, if any.
acct_supp_field_name  
acct_supp_field_value  
billing_group_no The system defined billing group ID
client_billing_group_id The client defined defined billing group ID
primary_pay_method Primary pay method number
secondary_pay_method Secondary pay method number
client_master_plan_id  
po_num Purchase order number assigned to the account or plan instance.
client_supp_plan_id  
supp_plan_no  
po_num Purchase order number assigned to the account or plan instance.
consumer_acct_ind  
po_num Purchase order number assigned to the account or plan instance.

Outputs

Name Type Length Required Description
error_code long   No Aria-assigned error identifier. 0 indicates no error
error_msg string   No Textual description of any error that occurred. "OK" if there was no error.
starting_record long   No This indicates the number of objects that were (or would be) skipped before beginning output.
total_records long   No This is the total number of objects that matched the provided criteria.
Start of account_details_m hash
account_details_m hash   No List of account_details_m associated with this method.
Name Type Length Required Description
▶acct_no long   No The Aria assigned ID of the account
▶client_acct_id string   No Client specified account identifier
▶user_id string 100 No The client defined user_id for the account
▶first_name string   No  
▶mi string 1 No Middle initial
▶last_name string   No  
▶company_name string   No  
▶address1 string   No  
▶address2 string   No  
▶address3 string   No  
▶city string   No  
▶locality string   No  
▶state_prov string   No State or Province Name
▶state_prov_cd string   No State or Province Code
▶country_cd string   No  
▶postal_cd string   No Postal code
▶phone string   No  
▶phone_ext string   No  
▶cell_phone string   No  
▶work_phone string   No  
▶work_phone_ext string   No  
▶fax string   No  
▶email string   No  
▶stmt_email_list_cc string 300 No Array containing the list of additional cc and bcc email addresses.
▶stmt_email_list_bcc string 300 No Array containing the list of additional cc and bcc email addresses.
▶birthdate string   No  
▶status_cd string   No The status code of the account. See the Aria Account Services API documentation for details
▶notify_method long   No  
▶senior_acct_no long   No The Aria assigned ID of the parent account, if any.
▶senior_acct_user_id string   No The user_id of the parent account, if any.
▶senior_client_acct_id string   No The client specified account identifier of the parent account, if any.
▶test_acct_ind long   No  
▶taxpayer_id string   No  
▶acct_start_date string   No  
▶alt_msg_template_no long   No  
▶seq_func_group_no long   No  
▶tax_exemption_level long   No  
▶client_alt_msg_template_id string   No  
▶client_cn_alt_msg_template_id string   No  
Start of functional_acct_groups hash
▶functional_acct_groups hash   No List of functional_acct_groups associated with this method.
Name Type Length Required Description
▶▶functional_acct_group_no long   No  
▶▶client_functional_acct_group_id string   No  
End of functional_acct_groups hash
Start of collection_acct_groups hash
▶collection_acct_groups hash   No List of collection_acct_groups associated with this method.
Name Type Length Required Description
▶▶collection_acct_group_no long   No  
▶▶client_collection_acct_group_id string   No  
End of collection_acct_groups hash
Start of acct_supp_fields hash
▶acct_supp_fields hash   No List of acct_supp_fields associated with this method.
Name Type Length Required Description
▶▶acct_supp_field_name string   No  
▶▶acct_supp_field_value string   No  
End of acct_supp_fields hash
Start of surcharge_no hash
▶surcharge_no hash   No List of surcharge_no associated with this method.
Name Type Length Required Description
▶▶surcharge_no long   No  
End of surcharge_no hash
▶acct_currency string   No  
▶acct_balance string   No  
▶unapplied_payment_summary double   No Total sum of unapplied payments for a given account
▶address_verification_code string   No  
▶address_match_score long   No  
Start of billing_groups hash
▶billing_groups hash   No List of billing_groups associated with this method.
Name Type Length Required Description
▶▶billing_group_no string   No The system defined billing group ID
▶▶billing_group_name string   No  
▶▶billing_group_description string   No  
▶▶client_billing_group_id string   No The client defined defined billing group ID
▶▶bg_list_start_master_file long   No Indicates whether or not the account shall be listed at the start of a master file.

Allowed values:

Value Description
0No
1Yes
▶▶primary_pay_method long   No Primary pay method number
▶▶primary_pay_method_name string   No Primary pay method name
▶▶secondary_pay_method long   No Secondary pay method number
▶▶secondary_pay_method_name string   No Secondary pay method name
▶▶stmt_email_list_cc string 300 No Array containing the list of additional cc and bcc email addresses.
▶▶stmt_email_list_bcc string 300 No Array containing the list of additional cc and bcc email addresses.
Start of collection_group_bg_info hash
▶▶collection_group_bg_info hash   No Array for collection groups for billing group
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 Collections Group Name
▶▶▶collections_group_description string 1000 No Collections group description
End of collection_group_bg_info hash
End of billing_groups hash
Start of master_plan_instances hash
▶master_plan_instances hash   No List of master_plan_instances associated with this method.
Name Type Length Required Description
▶▶master_plan_instance_id string   No  
▶▶client_master_plan_instance_id string   No  
▶▶client_master_plan_id string   No  
▶▶master_plan_no string   No  
▶▶master_plan_instance_description string   No  
▶▶dunning_group_no long   No Aria Internal Id for dunning group
▶▶client_dunning_group_id string   No Client defined dunning group id
▶▶dunning_group_name string   No Name of the dunning group
▶▶dunning_group_description string   No Dunning group description
▶▶dunning_process_no long   No The unique identifier of the dunning process
▶▶client_dunning_process_id string   No The client-defined identifier of the dunning process
▶▶po_num string 100 No Purchase order number assigned to the account or plan instance.
Start of supp_plans hash
▶▶supp_plans hash   No List of supp_plans associated with this method.
Name Type Length Required Description
▶▶▶supp_plan_instance_no string   No  
▶▶▶client_supp_plan_instance_id string   No  
▶▶▶client_supp_plan_id string   No  
▶▶▶supp_plan_no string   No  
▶▶▶supp_plan_instance_description string   No  
▶▶▶supp_plan_instance_status string   No  
▶▶▶parent_plan_instance_no string   No  
▶▶▶client_parent_plan_instance_id string   No  
▶▶▶po_num string 100 No Purchase order number assigned to the account or plan instance.
Start of supp_plan_plan_inst_fields hash
▶▶▶supp_plan_plan_inst_fields hash   No List of supp_plan_plan_inst_fields associated with this method.
Name Type Length Required Description
▶▶▶▶plan_instance_field_name string   No  
▶▶▶▶plan_instance_field_value string   No  
End of supp_plan_plan_inst_fields hash
End of supp_plans hash
Start of coupon_cd hash
▶▶coupon_cd hash   No List of coupon_cd associated with this method.
Name Type Length Required Description
▶▶▶coupon_cd string   No  
End of coupon_cd hash
Start of master_plan_plan_inst_fields hash
▶▶master_plan_plan_inst_fields hash   No List of master_plan_plan_inst_fields associated with this method.
Name Type Length Required Description
▶▶▶plan_instance_field_name string   No  
▶▶▶plan_instance_field_value string   No  
End of master_plan_plan_inst_fields hash
▶▶bill_lag_days long   No 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 this Master Plan Instance. Negative bill lag days are typically used for subscription-based services (often subscription-based services paid using net-terms), in which the user would like to send out invoices to customers well in advance of the real invoice date. Positive bill lag days are typically used for usage-based services. By default, bill lag days are restricted to +/- the (minimum number of days in a recurring interval period – 1 day). However, if the “Allow Negative Bill Lag Days to Extend Beyond One Bill Cycle”is enabled set to TRUE)), then the negative value can go beyond a single recurring interval. The precedence for bill lag days is as follows: Master Plan Instance (for a given account) > Collection Group setting > Payment Gateway setting > Client setting (Configuration – Billing – Bill Lag Days)
End of master_plan_instances hash
▶consumer_acct_ind string   No  
▶po_num string 100 No Purchase order number assigned to the account or plan instance.
▶list_start_master_file long   No Indicates whether or not the account shall be listed at the start of a master file.

Allowed values:

Value Description
0No
1Yes
Start of matching_contacts hash
▶matching_contacts hash   No List of matching_contacts associated with this method.
Name Type Length Required Description
▶▶matching_billing_contact_id_number long   No This output displays all Aria-assigned unique identifiers for all billing contacts that match the contact search criteria entered. The get_acct_contacts_m API can be used to reference contact information for each matching contact. If no contact-specific search criteria was input, then all billing contact ID numbers for the account are displayed.
▶▶matching_statement_contact_id_number long   No This output displays all Aria-assigned unique identifiers for all statement contacts that match the contact search criteria entered. The get_acct_contacts_m API can be used to reference contact information for each matching contact. If no contact-specific search criteria was input, then all statement contact ID numbers for the account are displayed.
▶▶matching_account_contact_id_number long   No This output displays all Aria-assigned unique identifiers for all account contacts that match the contact search criteria entered. The get_acct_contacts_m API can be used to review details for each matching contact. If no contact-specific search criteria was input, then all account contact ID numbers for the account are displayed.
▶▶matching_destination_contact_order_id_number long   No This output displays all Aria-assigned unique identifiers for all destination contacts, related to orders, which match the contact search criteria entered. The get_acct_contacts_m API can be used to reference contact information for each matching contact. If no contact-specific search criteria was input, then all destination contact order ID numbers for the account are displayed.
▶▶matching_destination_contact_service_id_number long   No This output displays all Aria assigned unique identifiers for all destination contacts, related to services, which match the contact search criteria entered. If no contact-specific search criteria was input, then all destination contact service ID numbers for the account are displayed.
▶▶matching_inactive_contact_id_number long   No This output displays all Aria-assigned unique identifiers for all inactive contacts that matched the contact search criteria entered.
End of matching_contacts hash
▶legal_entity_no long 32 No Aria-assigned legal entity identification number.
▶legal_entity_name string 300 No Client-assigned descriptor of the legal entity.
▶client_legal_entity_id string 300 No Client-assigned unique identifier for the legal entity.
End of account_details_m hash
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

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