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



 

Home > Aria6 object query api > get_account_details

get_account_details

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

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

Querystring Keys

Key Name Description
acct_no The Aria assigned ID of the account
user_id The client defined user_id for the account
status_cd The status code of the account. See the Aria Account Services API documentation for details
plan_no The Aria assigned ID of the master plan for this account
first_name Account holder's first name
last_name Account holder's last name
city Account holder's city
postal_code Account holder's postal code
country Account holder's ISO-compliant, 2-character country code abbreviation in uppercase
alt_email Account holder's alternate email address 
client_acct_id Client specified account identifier
pay_method Pay method number
created The date the account was created
last_updated Most recent date on which the account information was updated
company_name Account holder's company name
billing_email Specifies the email address of the billing contact, or the general billing email address
supp_field_name Array of supplemental field names
supp_field_value Array of supplemental field values
supp_plan_no Aria-assigned identifier for a supplemental plan
invoice_posting_method_cd This configuration specifies whether invoices for this Account need to be manually posted. This setting supersedes the standard client setting for this specific Account.
 

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 hash Detailed information about any accounts matching the query
acct_no long The Aria assigned ID of the account
senior_acct_no long The Aria assigned ID of the parent account, if any.
user_id string The client defined user_id for the account
password string Deprecated The password of the account. Warning: this is sensitive data!
status_cd string The status code of the account. See the Aria Account Services API documentation for details
plan_no long The Aria assigned ID of the master plan for this account
first_name string Account holder's first name
mi string Account holder's middle initial
last_name string Account holder's last name
address_1 string First address line of the account holder
address_2 string Second address line of the account holder
city string Account holder's city
locality string Account holder's locality
postal_code string Account holder's postal code
country string Account holder's ISO-compliant, 2-character country code abbreviation in uppercase
phone_npa long Account holder's numbering Plan Area value (area code) 
phone_nxx long Account holder's exchange (first 3 numbers following the area code/NPA)
phone_suffix string Account holder's phone number (this is the number on the exchange/NXX)
phone_extension string Account holder's phone extension
intl_phone string Account holder's international phone number 
alt_email string Account holder's alternate email address 
client_acct_id string Client specified account identifier
promo_cd string Promotion code used
resp_level_cd string Responsibility level of this account (for child accounts)
pay_method string Primary pay method number
created string The date the account was created
last_updated string Most recent date on which the account information was updated
client_1 string Client defined field
company_name string Account holder's company name
current_billing_info hash  
billing_first_name string First name of the billing contact 
billing_middle_initial string Middle initial of the billing contact
billing_last_name string Last name of the billing contact
billing_address1 string Billing contact's first address line
billing_address2 string Billing contact's second address line
billing_city string Billing contact's city
billing_state string Billing contact's state
billing_locality string Billing contact's locality (examples: county, rural unincorporated area name)
billing_zip string Billing contact's zip or postal code
billing_country string Billing contact's ISO-compliant 2-character country code abbreviation in uppercase
billing_phone_npa string Billing contact's area code
billing_phone_nxx string Billing contact's exchange number (The NXX follows the NPA and comes before the phone number).
billing_phone_suffix string Last digits of the billing contact's phone number, immediately following the NPA and NXX (also referred to as the phone number)
billing_phone_extension string The office, desk, or group extension for the billing contact's phone number
billing_intl_phone string The international phone number of the billing contact
billing_email string The email address of the billing contact, or the general billing email address
billing_pay_method string Pay method number
billing_cc_expire_mm string Expiration month of the credit card 
billing_cc_expire_yyyy string Expiration year of the credit card 
billing_bank_routing_num string ABA (American Banking Association) unique identifier for the account's financial institution
billing_agreement_id string Unique identifier of the bill agreement (also referred to as a token)
plan_name string Name of the master plan for this account
state_prov string State or Province Name
country_english string Country name in english
promo_name string Description of the promotion that this account, is using
no_provision_ind long Whether this account should be provisioned
bill_action_cd long Whether this account should be billed
status_name string The status of this account
acct_balance double The current balance for this account
supp_field hash  
supp_field_name string Array of supplemental field names
supp_field_value string Array of supplemental field values
bill_day long Billing day for account, e.g., 12
supp_plan hash  
supp_plan_no long Aria-assigned identifier for a supplemental plan
supp_plan_name string Name of a supplemental plan
invoice_posting_method_cd int This configuration specifies whether invoices for this Account need to be manually posted. This setting supersedes the standard client setting for this specific Account.  Allowable Values
acct_start_date string Returns the account start date. If account start date is empty, account created date will be returned
pay_method_name string Returns the payment method name
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.