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

 

Home > Aria Crescendo core api > get_acct_contacts_m

get_acct_contacts_m

Returns all the contacts for the specified client account and/or billing group and information about each contact''s locations, e.g., 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.
  billing_group_no long 22 System-defined billing group number
  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
  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
account_contact hash Account contact
contact_no long The Aria-assigned unique identifier for the contact.
first_name string First name of the account contact
middle_initial string Middle initial of the account contact
last_name string Last name of the account contact
company_name string Company name of the account 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.
address3 string The third line of the address
city string City of the account contact
locality 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.
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.
country_cd string Country of the account contact. The ISO-compliant 2-character country code abbreviation in uppercase.
postal_cd string Postal code of the account contact
phone string Phone number of the account contact
phone_ext string Phone extension of the account contact
cell_phone string Cell phone number of the account contact
work_phone string Work phone number of the account contact
work_phone_ext string Work phone extension of the account contact
fax string Fax phone number of the account contact
email string Email of the account contact
birthdate string Birthdate of the contact in yyyy-mm-dd format.
address_verification_code string Verification code for the account contact address
address_match_score double Match score for the account contact address
billing_contacts hash Array of billing contacts
bill_contact_no 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.
bill_first_name string First name of the billing contact.
bill_middle_initial string Middle initial of the billing contact.
bill_last_name string Last name of the billing contact.
bill_company_name string Company name of the billing contact.
bill_address1 string First address line of the billing contact.
bill_address2 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.
bill_address3 string The third line of the billing address.
bill_city string City of the billing contact.
bill_locality 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.
bill_state_prov 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.
bill_country string Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
bill_postal_cd string Postal code for the billing contact.
bill_phone string Phone number of the billing contact.
bill_phone_ext string Phone extension of the billing contact.
bill_cell_phone string Cell phone number of the billing contact.
bill_work_phone string Work phone number of the billing contact.
bill_work_phone_ext string Work phone extension of the billing contact
bill_fax string Fax number of the billing contact.
bill_email string Email of the billing contact.
bill_birthdate string Birthdate of the billing contact.
bill_address_verification_code string Verification code for the billing contact address
bill_address_match_score double Match score for the billing contact address
bill_billing_group_no long System-defined billing group number for the billing contact
bill_client_billing_group_id string Client-defined billing group identifier for the billing contact
backup_contacts hash Array of backup contacts
bkup_contact_no long The Aria-assigned unique identifier for the contact.
bkup_first_name string First name of the backup contact
bkup_middle_initial string Middle initial of the backup contact
bkup_last_name string Last name of the backup contact
bkup_company_name string Company name of the backup contact
bkup_address1 string First address line of the backup contact
bkup_address2 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.
bkup_address3 string Third address line of the backup contact
bkup_city string City of the backup contact
bkup_locality string Locality of the backup contact
bkup_state_prov 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.
bkup_country string Country of the backup contact. The ISO-compliant 2-character country code abbreviation in uppercase.
bkup_postal_cd string Postal code of the backup contact
bkup_phone string Phone number of the backup contact
bkup_phone_ext string Phone extension of the backup contact
bkup_cell_phone string Cell phone number of the backup contact
bkup_work_phone string Work phone number of the backup contact
bkup_work_phone_ext string Work phone extension of the backup contact
bkup_fax string Fax phone number of the backup contact
bkup_email string Email of the backup contact
bkup_birthdate string Date of birth of the backup contact
bkup_address_verification_code string Verification code for the backup contact address
bkup_address_match_score double Match score for the backup contact address
bkup_billing_group_no long System-defined billing group number for the backup contact
bkup_client_billing_group_id string Client-defined billing group identifier for the backup contact
statement_contacts hash Array of statement contacts
stat_contact_no long The Aria-assigned unique identifier for the contact.
stat_first_name string First name of the statement contact
stat_middle_initial string Middle initial of the statement contact
stat_last_name string Last name of the statement contact
stat_company_name string Company name of the statement contact
stat_address1 string First address line of the statement contact
stat_address2 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.
stat_address3 string Third address line of the statement contact
stat_city string City of the statement contact
stat_locality string Locality of the statement contact
stat_state_prov 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.
stat_country string Country of the statement contact. The ISO-compliant 2-character country code abbreviation in uppercase.
stat_postal_cd string Postal code of the statement contact
stat_phone string Phone number of the statement contact
stat_phone_ext string Phone extension of the statement contact
stat_cell_phone string Cell phone number of the statement contact
stat_work_phone string Work phone number of the statement contact
stat_work_phone_ext string Work phone extension of the statement contact
stat_fax string Fax phone number of the statement contact
stat_email string Email of the statement contact
stat_birthdate string Date of birth of the statement contact
stat_address_verification_code string Verification code for the statement contact address
stat_address_match_score double Match score for the statement contact address
stat_billing_group_no long System-defined billing group number for the statement contact
stat_client_billing_group_id 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.
other_contact_no long The Aria-assigned unique identifier for the contact.
other_first_name string The first name of the contact.
other_middle_initial string The middle initial of the contact.
other_last_name string The last name of the contact.
other_company_name string The company name of the contact.
other_address1 string The first address line of the contact.
other_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.
other_address3 string The third address line of the contact.
other_city string The city of the contact.
other_locality string The locality of the contact.
other_state_prov 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.
other_country_cd string The country of the contact. Provide the ISO-compliant 2-character country code abbreviation in uppercase.
other_postal_cd string The postal/zip code of the contact.
other_phone string The phone number of the contact.
other_phone_ext string The phone number extension of the contact.
other_cell_phone string The cell phone number of the contact.
other_work_phone string The work phone number of the contact.
other_work_phone_ext string The work phone number extension of the contact.
other_fax string The fax number of the contact.
other_email string The email address of the contact.
other_birthdate string The birthdate of the contact.
other_address_verification_code string Verification code for the contact address.
other_address_match_score 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.

You must to post a comment.
Last modified
10:40, 9 May 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.