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

 

Home > Aria6 core api > get_acct_details_all

get_acct_details_all

Returns all available information about an account such as contact information, demographic information, dates associated with the account, account status, plan, notification method, password, and billing information.

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.
  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
first_name string Contact first name
mi string Middle initial of the contact
last_name string Contact last name
userid string The users unique identifier.
birthdate string Contact date of birth
job_title string The job title of the contact.
salutation string The contact's salutation (such as Mr., Ms., Dr., etc.)
senior_acct_no string The senior_acct_no is the unique account number for the parent account and is used in establishing parent-child billing relationships.
client_acct_id string This is the client-assigned identifier for the account.
resp_level_cd string The responsibility level code. These are values 1 through 4 as described in the legend for this argument.  Allowable Values
is_test_acct string A Boolean value indicating that the account is a test account.  Allowable Values
alt_email string Alternate email address for 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.
city string City of the contact
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.
locality string Locality of the contact
postal_code string Postal/Zip code for the contact address.
country string Country of the contact. The ISO-compliant 2-character country code abbreviation in uppercase.
company_name string Company name of the contact
cell_phone_npa string Cell phone Numbering Plan Area value (also known as area code).
cell_phone_nxx string Cell phone Exchange (first 3 numbers following the area code/NPA).
cell_phone_suffix string Cell phone number (this is the number on the exchange/NXX for the target phone).
fax_phone string The FAX phone number for the contact.
intl_cell_phone string The international cell phone number of the contact.
intl_phone string This is the international phone number of the contact
phone_extension string The extension for the contact's phone number.
phone_npa string Phone Numbering Plan Area value (also known as area code).
phone_nxx string Phone Exchange (first 3 numbers following the area code/NPA).
phone_suffix string Phone number (this is the number on the exchange/NXX for the target phone).
work_phone string The full work phone number
work_phone_extension string The office/desk extension of the contact's work phone, if any.
work_phone_npa string Phone Numbering Plan Area value (also known as area code).
work_phone_nxx string Phone Exchange (first 3 numbers following the area code/NPA).
work_phone_suffix string Phone number (this is the number on the exchange/NXX for the target phone).
bill_day string The billing anniversary day.
created string Date the account was created.
date_to_expire string The date the account is scheduled to expire.
date_to_suspend string The date the account is scheduled to be suspended.
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.
status_degrade_date string The date the account status was degraded.
status_cd string This is the status of the object in question for the current API call.  Allowable Values
status_label string This is the human-readbale status of the account.
plan_no string The unique plan identifier.
plan_name string Name of the Master Subscription Plan for this account
plan_units string The number of plan units to assign.
notify_method string If notification method is not provided, value will default to 1 (HTML email).  Allowable Values
notify_method_name string The name of the notify method to be used in communicating with the account holder.
PASSWORD string The account's reg/uss password
pin string Persinal Identification number
secret_question string The users secret question recorded to recover a password.
secret_question_answer string The response to a users 'secret_question'
pay_method string This is the method_id corresponding to a payment method such as credit card, Electronic Check, Pre-Paid, Net Terms, etc.
pay_method_name string The human-readable name of the payment method.
currency_cd string The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
tax_id string This is the Tax Identification Number or EIN of the account holder.
billing_email string The email address of the billing contact, or the general billing email address.
billing_first_name string The first name of the billing contact for the account.
billing_middle_initial string The middle initial of the billing contact.
billing_last_name string The last name of the billing contact.
billing_address1 string Street address (number and name) of the billing contact address.
billing_address2 string Second address line of the billing contact (for example: bldg, suite, apt., etc.). If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
billing_city string The city name of the billing contact address.
billing_state string The state or province of the billing contact's address. The official postal-service codes for all United States and Canada states, provinces, and territories.
billing_locality string The billing contact's locality (for example: county, rural unincorporated area name).
billing_zip string The zip or postal code for the billing contact's address.
billing_country string The country for the billing contact's address. The ISO-compliant 2-character country code abbreviation in uppercase.
cc_type string Type of credit card (e.g., Visa, Mastercard, Discover, Amex)
cc_suffix string The last 4 digits of the credit card number
cc_expire_mm string Expiration month for the credit card payment instrument.
cc_expire_yyyy string Expiration year for the credit card payment instrument.
cc_id long A numeric code indicating the type of credit card.  Allowable Values
bank_acct_suffix string The last 4 digits of the bank account
bank_routing_no string This is the ABA (American Banking Association) unique identifier for the financial institution.
billing_cell_phone string The billing cell phone area code.
billing_cell_phone_npa string The 3 digit exchange number for the billing contact's cell phone.
billing_cell_phone_nxx string The 3 digit exchange number for the billing contact's cell phone.
billing_cell_phone_suffix string The cell phone number. Digits following the NXX exchange digits.
billing_company_name string The company or DBA name of the billing contact.
billing_intl_phone string The international phone number of the billing contact.
billing_phone_extension string The office, desk or group extension for the billing contact's phone number.
billing_phone_npa string The billing contact's area code.
billing_phone_nxx string The exchange number for the billing contact phone. (The NXX follows the NPA and preceeds the phone number).
billing_phone_suffix string The last digits of the billing contact's phone number, immediately following the NPA and NXX (also referred to as the phone number).
billing_work_phone string The full billing work phone number
billing_work_phone_extension string The extension of the billing contact work phone.
billing_work_phone_npa string The exchange number of the billing contact's work phone (immediately follows the NPA).
billing_work_phone_nxx string The exchange number of the billing contact's work phone (immediately follows the NPA).
billing_work_phone_suffix string The last digits of the billing contact's work phone (immediately follows the NPA and NXX), also referred to as the "phone number".
balance string The outstanding balance for this account.
acct_create_client_receipt_id string The client-specified receipt ID, returned for this account creation in any API which returns receipt IDs at this level. Useful for auditing and tracking
plan_client_receipt_id string The client-specified receipt ID, returned for this plan creation or assignment in any API which returns receipt IDs at this level. Useful for auditing and tracking
status_client_receipt_id string The client-specified receipt ID, returned for this account status change in any API which returns receipt IDs at this level. Useful for auditing and tracking
taxpayer_id string Taxpayer Identification number.
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.
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.
address3 string The third line of the address
billing_address3 string The third line of the billing address
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
billing_address_verification_code string The address verification code for account billing address
billing_address_match_score double The score of match for account billing address verification code
client_plan_id string Client-defined Plan ID for which to query available child plans
client_alt_msg_template_id string Client-defined email template ID assigned to this account.
bkup_pay_method string This is the method_id corresponding to a payment method such as credit card, Electronic Check, Pre-Paid  Allowable Values
bkup_billing_email string The email address of the billing contact, or the general billing email address.
bkup_billing_first_name string The first name of the billing contact for the account.
bkup_billing_middle_initial string The middle initial of the billing contact.
bkup_billing_last_name string The last name of the billing contact.
bkup_billing_address1 string Street address (number and name) of the billing contact address.
bkup_billing_address2 string Second address line of the billing contact (for example: bldg, suite, apt., etc.) If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
bkup_billing_city string The city name of the billing contact address.
bkup_billing_state string The state or province of the billing contact's address. The official postal-service codes for all United States and Canada states, provinces, and territories.
bkup_billing_locality string The billing contact's locality (for example: county, rural unincorporated area name).
bkup_billing_zip string The zip or postal code for the billing contact's address.
bkup_billing_country string The country for the billing contact's address. The ISO-compliant 2-character country code abbreviation in uppercase.
bkup_cc_type string Type of credit card (e.g., Visa, Mastercard, Discover, Amex)
bkup_cc_suffix string The last 4 digits of the credit card number
bkup_cc_expire_mm string Expiration month for the credit card payment instrument.
bkup_cc_expire_yyyy string Expiration year for the credit card payment instrument.
bkup_cc_id long A numeric code indicating the type of credit card.  Allowable Values
bkup_bank_acct_suffix string The last 4 digits of the bank account
bkup_bank_routing_no string This is the ABA (American Banking Association) unique identifier for the financial institution.
bkup_billing_cell_phone string The billing cell phone area code.
bkup_billing_cell_phone_npa string The 3 digit exchange number for the billing contact's cell phone.
bkup_billing_cell_phone_nxx string The 3 digit exchange number for the billing contact's cell phone.
bkup_billing_cell_phone_suffix string The cell phone number. Digits following the NXX exchange digits.
bkup_billing_company_name string The company or DBA name of the billing contact.
bkup_billing_intl_phone string The international phone number of the billing contact.
bkup_billing_phone_extension string The office, desk or group extension for the billing contact's phone number.
bkup_billing_work_phone string The full billing work phone number
bkup_billing_work_phone_extension string The extension of the billing contact work phone.
bkup_billing_work_phone_npa string The exchange number of the billing contact's work phone (immediately follows the NPA).
bkup_billing_work_phone_nxx string The exchange number of the billing contact's work phone (immediately follows the NPA).
bkup_billing_work_phone_suffix string The last digits of the billing contact's work phone (immediately follows the NPA and NXX), also referred to as the "phone number".
stmnt_email_list string Deprecated (Deprecated) An array containing the list of additional email addresses
invoice_approval_required long Boolean indicator to override client's default configured behavior for creating Pending/Real invoice.  Allowable Values
stmnt_email_list_cc string An array containing the list of additional cc email addresses
stmnt_email_list_bcc string An array containing the list of additional bcc email addresses
invoice_posting_method_cd long 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 This is the date, in yyyy-mm-dd format, that this account was originally started.
bill_agreement_id string Unique ID of the bill agreement (also referred to as a token).
bkup_bill_agreement_id string Unique ID of the bill agreement (also referred to as a token).
mandate_id string Used for the Direct Debit payment method. A mandate is signed by the debtor to authorise the creditor to collect a payment and to instruct the bank of the debtor to pay those collections.
bkup_mandate_id string Used for the Direct Debit payment method. A mandate is signed by the debtor to authorise the creditor to collect a payment and to instruct the bank of the debtor to pay those collections.
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.

You must to post a comment.
Last modified
13:02, 2 Mar 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.