get_account_details_m

Last updated
Save as PDF
Share
1. Share
2. Tweet
3. Share

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

Input Arguments

Req	Field Name	Field Type	Max Length	Description
	username	string	30	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	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	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.
	limit	long	12	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	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	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".

* Required field

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.

Output Arguments

Field Name

Field Type

Description

error_code

long

Aria-assigned error identifier. 0 indicates no error

error_msg

string

Textual description of any error that occurred. "OK" if there was no error.

starting_record

long

This indicates the number of objects that were (or would be) skipped before beginning output.

total_records

long

This is the total number of objects that matched the provided criteria.

account_details_m

hash

List of account_details_m associated with this method.

acct_no

long

The Aria assigned ID of the account

client_acct_id

string

Client specified account identifier

user_id

string

The client defined user_id for the account

first_name

string

Middle initial

last_name

string

company_name

string

address1

string

address2

string

address3

string

city

string

locality

string

state_prov

string

State or Province Name

state_prov_cd

string

State or Province Code

country_cd

string

postal_cd

string

Postal code

phone

string

phone_ext

string

cell_phone

string

work_phone

string

work_phone_ext

string

fax

string

stmt_email_list_cc

string

Array containing the list of additional cc and bcc email addresses.

stmt_email_list_bcc

string

Array containing the list of additional cc and bcc email addresses.

birthdate

string

status_cd

string

The status code of the account. See the Aria Account Services API documentation for details

notify_method

long

senior_acct_no

long

The Aria assigned ID of the parent account, if any.

senior_acct_user_id

string

The user_id of the parent account, if any.

senior_client_acct_id

string

The client specified account identifier of the parent account, if any.

test_acct_ind

long

taxpayer_id

string

acct_start_date

string

alt_msg_template_no

long

seq_func_group_no

long

tax_exemption_level

long

client_alt_msg_template_id

string

client_cn_alt_msg_template_id

string

functional_acct_groups

hash

List of functional_acct_groups associated with this method.

functional_acct_group_no

long

client_functional_acct_group_id

string

collection_acct_groups

hash

List of collection_acct_groups associated with this method.

collection_acct_group_no

long

client_collection_acct_group_id

string

acct_supp_fields

hash

List of acct_supp_fields associated with this method.

acct_supp_field_name

string

acct_supp_field_value

string

surcharge_no

hash

List of surcharge_no associated with this method.

surcharge_no

long

acct_currency

string

acct_balance

string

unapplied_payment_summary

double

Total sum of unapplied payments for a given account

address_verification_code

string

address_match_score

long

billing_groups

hash

List of billing_groups associated with this method.

billing_group_no

string

The system defined billing group ID

billing_group_name

string

billing_group_description

string

client_billing_group_id

string

The client defined defined billing group ID

bg_list_start_master_file

long

Indicates whether or not the account shall be listed at the start of a master file.

Allowable Values For bg_list_start_master_file

Values	Description
0	No
1	Yes

primary_pay_method

long

Primary pay method number

primary_pay_method_name

string

Primary pay method name

secondary_pay_method

long

Secondary pay method number

secondary_pay_method_name

string

Secondary pay method name

stmt_email_list_cc

string

Array containing the list of additional cc and bcc email addresses.

stmt_email_list_bcc

string

Array containing the list of additional cc and bcc email addresses.

collection_group_bg_info

hash

Array for collection groups for billing group

collections_group_bg_no

long

Collection Group Number to which this billing group should be assigned.

client_collections_group_bg_id

string

Collection Group ID to which this billing group should be assigned.

collections_group_name

string

Collections Group Name

collections_group_description

string

Collections group description

master_plan_instances

hash

List of master_plan_instances associated with this method.

master_plan_instance_id

string

client_master_plan_instance_id

string

client_master_plan_id

string

master_plan_no

string

master_plan_instance_description

string

dunning_group_no

long

Aria Internal Id for dunning group

client_dunning_group_id

string

Client defined dunning group id

dunning_group_name

string

Name of the dunning group

dunning_group_description

string

Dunning group description

dunning_process_no

long

The unique identifier of the dunning process

client_dunning_process_id

string

The client-defined identifier of the dunning process

po_num

string

Purchase order number assigned to the account or plan instance.

supp_plans

hash

List of supp_plans associated with this method.

supp_plan_instance_no

string

client_supp_plan_instance_id

string

client_supp_plan_id

string

supp_plan_no

string

supp_plan_instance_description

string

supp_plan_instance_status

string

parent_plan_instance_no

string

client_parent_plan_instance_id

string

po_num

string

Purchase order number assigned to the account or plan instance.

supp_plan_plan_inst_fields

hash

List of supp_plan_plan_inst_fields associated with this method.

plan_instance_field_name

string

plan_instance_field_value

string

coupon_cd

hash

List of coupon_cd associated with this method.

coupon_cd

string

master_plan_plan_inst_fields

hash

List of master_plan_plan_inst_fields associated with this method.

plan_instance_field_name

string

plan_instance_field_value

string

bill_lag_days

long

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)

consumer_acct_ind

string

po_num

string

Purchase order number assigned to the account or plan instance.

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	No
1	Yes

matching_contacts

hash

List of matching_contacts associated with this method.

matching_billing_contact_id_number

long

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

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

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

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

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

This output displays all Aria-assigned unique identifiers for all inactive contacts that matched the contact search criteria entered.

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.