get_account_details_m

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.
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".
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.
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.

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

Detailed information about any accounts matching the query

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

Account holder's first name

string

Account holder's middle initial

last_name

string

Account holder's last name

company_name

string

Account holder's company name

address1

string

First address line of the account holder

address2

string

Second address line of the account holder

address3

string

Third address line of the account holder

city

string

Account holder's city

locality

string

Account holder's locality

state_prov

string

Account holder's state or province name

state_prov_cd

string

Account holder's state or province code

country_cd

string

Account holder's ISO-compliant, 2-character country code abbreviation

postal_cd

string

Account holder's postal code

phone

string

Account holder's phone number

phone_ext

string

Account holder's phone extension

cell_phone

string

Account holder's cell phone number

work_phone

string

Account holder's work phone number

work_phone_ext

string

Account holder's work phone extension

fax

string

Account holder's fax number

string

Account holder's email address

birthdate

string

Account holder's date of birth

status_cd

string

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

notify_method

long

How the client communicates with the account holder

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

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

Indicates whether the account is a test account and is treated as such in the system.

Allowable Values For test_acct_id

Values	Description
1	test
0	live

taxpayer_id

string

Account holder's 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 the account

seq_func_group_no

long

Functional account group number specifically designated for statement sequence number assignment

tax_exemption_level

long

Tax exemption level for the account. This field only applies to the Aria internal tax engine.

Allowable Values For tax_exemption_level

Values	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

Client-defined email template identifier assigned to the account

client_cn_alt_msg_template_id

string

The client-defined alternate email template identifier used for the account

functional_acct_groups

hash

List of functional account groups to which the account is assigned

functional_acct_group_no

long

Aria-assigned identifier for the functional account group to which the account is assigned

client_functional_acct_group_id

string

Client-defined identifier for the functional account group to which the account is assigned

collection_acct_groups

hash

List of collection account groups to which the account is assigned

collection_acct_group_no

long

Aria-assigned identifier for the collection account group to which the account is assigned

client_collection_acct_group_id

string

Client-defined identifier for the collection account group to which the account is assigned

acct_supp_fields

hash

List of supplemental field names associated with an account

acct_supp_field_name

string

Array of supplemental field names

acct_supp_field_value

string

Array of supplemental field values

surcharge_no

hash

List of surcharge numbers associated with an account

surcharge_no

long

Surcharge number associated with an account

acct_currency

string

The 3-character ISO-compliant currency code for monetary values used for an account

acct_balance

string

The balance owed by an account

address_verification_code

string

Address verification code for the account contact address

address_match_score

long

The match score of the account contact address verification code

billing_groups

hash

List of billing groups to which the account's Master Plan's belong

billing_group_no

string

The Aria-assigned billing group identifier

billing_group_name

string

Name of a billing group

billing_group_description

string

Description of a billing group

client_billing_group_id

string

The client-defined billing group identifier

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

Comma-delimited list of email addresses to which the account holder's statements are currently cc'd (carbon copied).

stmt_email_list_bcc

string

Comma-delimited list of email addresses to which the account holder's statements are currently bcc'd (blind carbon copied).

collections_group_bg_no

long

Aria-assigned identifier of the collection group assigned to a billing group

client_collections_group_bg_id

string

Client-defined identifier of the collection group assigned to a billing group

collections_group_name

string

Collection group name

collections_group_description

string

Collection group description

master_plan_instances

hash

List of Master Plan Instances associated with an account

master_plan_instance_id

string

Aria-assigned identifier for a Master Plan Instance

client_master_plan_instance_id

string

Client-defined identifier for a Master Plan Instance

client_master_plan_id

string

Client-defined identifier for a Master Plan

master_plan_no (deprecated)

string

Aria-assigned identifier for a Master Plan

master_plan_instance_description

string

Description of a Master Plan Instance

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

supp_plans

hash

List of Supplemental Plans assigned to an account

supp_plan_instance_no

string

Aria-assigned identifier for a Supplemental Plan instance

client_supp_plan_instance_id

string

Client-defined identifier for a Supplemental Plan instance

client_supp_plan_id

string

Client-defined identifier for a Supplemental Plan

supp_plan_no

string

Aria-assigned identifier for a Supplemental Plan

supp_plan_instance_description

string

Description of each assigned Supplemental Plan instance

supp_plan_instance_status

string

Status of each assigned Supplemental Plan instance

parent_plan_instance_no

string

Aria-assigned identifier for the parent Plan instance

client_parent_plan_instance_id

string

Client-defined identifier for the parent Plan instance

po_num

string

Purchase order number assigned to the account or Plan instance

supp_plan_plan_inst_fields

hash

List of the supplemental field names and values associated with the assigned Supplemental Plan

plan_instance_field_name

string

Supplemental field name associated with the assigned Supplemental Plan

plan_instance_field_value

string

Supplemental field value associated with the assigned Supplemental Plan

coupon_cd

hash

List of coupon codes used by the account holder

coupon_cd

string

Unique coupon identifier for a coupon

master_plan_plan_inst_fields

hash

List of the supplemental field names and values associated with the assigned Master Plan Instance

plan_instance_field_name

string

Supplemental field name associated with the assigned Master Plan Instance

plan_instance_field_value

string

Supplemental field value associated with the assigned Master Plan Instance

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 you specified that an invoice should be generated for a Master Plan Instance.

Examples:

-14 means that an invoice is generated 14 days before the billing date.
10 means that an invoice is generated 10 days after the billing date.

consumer_acct_ind

string

Salesforce-specific indicator that identifies an account as a consumer account or a business account

Allowable Values For consumer_acct_ind

Values	Description
0	business
1	consumer

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 contact details associated with an account

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.

get_account_details_m

Table of contents

Input Arguments

Querystring Keys

Allowable Values For notify_method

Allowable Values For test_acct_id

Allowable Values For tax_exemption_level

Allowable Values For bg_list_start_master_file

Allowable Values For consumer_acct_ind

Allowable Values For list_start_master_file

Tags

Classifications

get_account_details_m

Table of contents

Input Arguments

Querystring Keys

Allowable Values For notify_method

Allowable Values For test_acct_id

Allowable Values For tax_exemption_level

Allowable Values For bg_list_start_master_file

Allowable Values For consumer_acct_ind

Allowable Values For list_start_master_file

Related articles

Tags

Classifications