get_acct_contacts_m
Returns all the contacts for the specified client account and/or billing group and information about them (e.g. their locations and whether it is an account, billing, backup, or statement contact).
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. | ||||||
OR | ||||||||||
![]() |
client_acct_id | string | 50 | Client-defined account identifier. | ||||||
billing_group_no | long | 22 | Aria-defined billing group number | |||||||
OR | ||||||||||
client_billing_group_id | string | 100 | Client-defined billing group identifier | |||||||
include_unused_contacts | long | 1 |
Determines whether or not contacts saved on the account that are not currently used as an account contact, billing contact, or statement contact will be included in the API response. Allowable values for include_unused_contacts:
|
|||||||
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. | ||||||||
string | 100 | Name of the field you want to associate with this API call. | ||||||||
string | 100 | Corresponding value of the field you want to associate with this API call. |
Output Arguments
Field Name | Field Type | Description |
---|---|---|
account_contact | hash | Account contact |
long | The Aria-assigned unique identifier for the contact. | |
string | First name of the account contact | |
string | Middle initial of the account contact | |
string | Last name of the account contact | |
string | Company name of the account contact | |
string | First address line of the contact. | |
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. | |
string | The third line of the address | |
string | City of the account contact | |
string | Use this field instead of the state_prov field to designate the state, province or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all United States, Australia and Canada addresses. | |
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. | |
string | Country of the account contact. The ISO-compliant 2-character country code abbreviation in uppercase. | |
string | Postal code of the account contact | |
string | This field denotes the tax address method code which was used to generate the geo code of the account contact. | |
string | Phone number of the account contact | |
string | Phone extension of the account contact | |
string | Cell phone number of the account contact | |
string | Work phone number of the account contact | |
string | Work phone extension of the account contact | |
string | Fax phone number of the account contact | |
string | Email of the account contact | |
string | Birthdate of the contact in yyyy-mm-dd format. | |
string | Verification code for the account contact address. DEPRECATED | |
string | Verification code for the account contact address. | |
double | Match score for the account contact address | |
billing_contacts | hash | Array of billing contacts |
long | The Aria-assigned unique identifier for the contact on this account to be used as the billing contact for the payment method. If bill_contact_no is included in the API request, all other billing contact parameters are ignored. | |
string | First name of the billing contact. | |
string | Middle initial of the billing contact. | |
string | Last name of the billing contact. | |
string | Company name of the billing contact. | |
string | First address line of the billing contact. | |
string | Second address line of the billing contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field. | |
string | The third line of the billing address. | |
string | City of the billing contact. | |
string | Use this field instead of the state_prov field to designate the state, province or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all United States, Australia and Canada addresses. | |
string | State or Province of the billing 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. | |
string | Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase. | |
string | Postal code for the billing contact. | |
string | This field denotes the tax address method code which was used to generate the geo code of the billing contact. | |
string | Phone number of the billing contact. | |
string | Phone extension of the billing contact. | |
string | Cell phone number of the billing contact. | |
string | Work phone number of the billing contact. | |
string | Work phone extension of the billing contact | |
string | Fax number of the billing contact. | |
string | Email of the billing contact. | |
string | Birthdate of the billing contact. | |
string | Verification code for the billing contact address. DEPRECATED | |
string | Verification code for the billing contact address. | |
double | Match score for the billing contact address | |
long | System-defined billing group number for the billing contact | |
string | Client-defined billing group identifier for the billing contact | |
backup_contacts | hash | Array of backup contacts |
long | The Aria-assigned unique identifier for the contact. | |
string | First name of the backup contact | |
string | Middle initial of the backup contact | |
string | Last name of the backup contact | |
string | Company name of the backup contact | |
string | First address line of the backup contact | |
string | Second address line of the backup contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field. | |
string | Third address line of the backup contact | |
string | City of the backup contact | |
string | Locality of the backup contact | |
string | State or Province of the billing 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. | |
string | Country of the backup contact. The ISO-compliant 2-character country code abbreviation in uppercase. | |
string | Postal code of the backup contact | |
string | This field denotes the tax address method code which was used to generate the geo code of the backup contact. | |
string | Phone number of the backup contact | |
string | Phone extension of the backup contact | |
string | Cell phone number of the backup contact | |
string | Work phone number of the backup contact | |
string | Work phone extension of the backup contact | |
string | Fax phone number of the backup contact | |
string | Email of the backup contact | |
string | Date of birth of the backup contact | |
string | Verification code for the backup contact address | |
double | Match score for the backup contact address | |
long | System-defined billing group number for the backup contact | |
string | Client-defined billing group identifier for the backup contact | |
statement_contacts | hash | Array of statement contacts |
long | The Aria-assigned unique identifier for the contact. | |
string | First name of the statement contact | |
string | Middle initial of the statement contact | |
string | Last name of the statement contact | |
string | Company name of the statement contact | |
string | First address line of the statement contact | |
string | Second address line of the statement contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field. | |
string | Third address line of the statement contact | |
string | City of the statement contact | |
string | Locality of the statement contact | |
string | State or Province of the billing 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. | |
string | Country of the statement contact. The ISO-compliant 2-character country code abbreviation in uppercase. | |
string | Postal code of the statement contact | |
string | This field denotes the tax address method code which was used to generate the geo code of the statement contact. | |
string | Phone number of the statement contact | |
string | Phone extension of the statement contact | |
string | Cell phone number of the statement contact | |
string | Work phone number of the statement contact | |
string | Work phone extension of the statement contact | |
string | Fax phone number of the statement contact | |
string | Email of the statement contact | |
string | Date of birth of the statement contact | |
string | Verification code for the statement contact address. DEPRECATED | |
string | Verification code for the statement contact address. | |
double | Match score for the statement contact address | |
long | System-defined billing group number for the statement contact | |
string | Client-defined billing group identifier for the statement contact | |
other_contacts | hash | List of contacts saved on the account not currently used as an account contact, billing contact, or statement contact. |
long | The Aria-assigned unique identifier for the contact. | |
string | The first name of the contact. | |
string | The middle initial of the contact. | |
string | The last name of the contact. | |
string | The company name of the contact. | |
string | The first address line of the contact. | |
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. | |
string | The third address line of the contact. | |
string | The city of the contact. | |
string | The locality of the contact. | |
string | The state or province of the contact. Note that only the official postal-service codes or states, provinces, and territories in the United States, Australia and Canada are supported. Use the other_locality field for states, provinces, or territories in other countries. | |
string | The country of the contact. Provide the ISO-compliant 2-character country code abbreviation in uppercase. | |
string | The postal/zip code of the contact. | |
string | This field denotes the tax address method code which was used to generate the geo code of the other contact. | |
string | The phone number of the contact. | |
string | The phone number extension of the contact. | |
string | The cell phone number of the contact. | |
string | The work phone number of the contact. | |
string | The work phone number extension of the contact. | |
string | The fax number of the contact. | |
string | The email address of the contact. | |
string | The birthdate of the contact. | |
string | Verification code for the contact address. | |
double | Match score for the contact address. | |
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. |