get_account_details_m Guide
The get_account_details_m API retrieved detailed account level information for all accounts matching specified query.
| API Specification: | get_account_details_m |
| Required Fields: |
|
Additional Guidance
- Use the <query_string> field to target specific accounts to reduce the payload. The maximum return is 80 accounts. Data sets with more than 80 accounts result in an internal server error. See Input Fields below for recommendations for best results with this API.
Input Fields
Field |
Notes |
|---|---|
| limit | This API supports a maximum return of 80 accounts. Requests that exceed this threshold return an internal server error. |
| query_string | Use this parameter to filter results and reduce payload size. Use targeted filters rather than broad queries such as acct_no IS NOT NULL across the full account base. |
| offset/step |
To retrieve more than 80 records, use pagination via these parameters across multiple calls. Stepping through accounts with Because Call 1—Records 1 through 80: {
"rest_call": "get_account_details_m",
"output_format": "json",
"client_no": "your_client_no",
"auth_key": "your_auth_key",
"query_string": "acct_no IS NOT NULL",
"limit": 80,
"offset": 0
}
Call 2—Records 81 through 160: {
"rest_call": "get_account_details_m",
"output_format": "json",
"client_no": "your_client_no",
"auth_key": "your_auth_key",
"query_string": "acct_no IS NOT NULL",
"limit": 80,
"offset": 80
}
Call 3—Records 161 through 240: {
"rest_call": "get_account_details_m",
"output_format": "json",
"client_no": "your_client_no",
"auth_key": "your_auth_key",
"query_string": "acct_no IS NOT NULL",
"limit": 80,
"offset": 160
}
Repeat this pattern, incrementing |
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 | Account holder's first name | ||||||
| last_name | Account holder's last name | ||||||
| company_name | Account holder's company name | ||||||
| city | Account holder's city | ||||||
| country_cd | Account holder's ISO-compliant, 2-character country code abbreviation in uppercase | ||||||
| postal_cd | Account holder's postal code | ||||||
| senior_acct_no | The Aria assigned ID of the parent account, if any. | ||||||
| acct_supp_field_name | Pipe-delimited array of supplemental field names | ||||||
| acct_supp_field_value | Pipe-delimited array of supplemental field values | ||||||
| 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 (deprecated) | Client-defined unique identifier for a Master Plan | ||||||
| po_num | Purchase order number assigned to the account or Plan instance | ||||||
| client_supp_plan_id | Client-defined identifier for a Supplemental Plan | ||||||
| supp_plan_no | Aria-assigned identifier for a Supplemental Plan | ||||||
| consumer_acct_ind |
Salesforce-specific indicator that identifies an account as a consumer account or a business account Allowable Values
|
||||||
| Email address on account | |||||||
| bill_email | Email address on the account’s associated billing group |
Output Fields
| Field Name | Notes | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| <notify_method> |
Allowable Values
|
||||||||||||||||||||||||||||||||||||||
| <test_acct_ind> |
Allowable Values
|
||||||||||||||||||||||||||||||||||||||
| <tax_exemption_level> |
Allowable Values
|
||||||||||||||||||||||||||||||||||||||
| <bg_list_start_master_file> |
Allowable Values
|
||||||||||||||||||||||||||||||||||||||
| <consumer_acct_ind> |
Allowable Values
|
||||||||||||||||||||||||||||||||||||||
| <list_start_master_file> |
Allowable Values
|