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 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
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
required-icon.png 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
  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.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif 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
brd_arrow.gif contact_no long The Aria-assigned unique identifier for the contact.
brd_arrow.gif first_name string First name of the account contact
brd_arrow.gif middle_initial string Middle initial of the account contact
brd_arrow.gif last_name string Last name of the account contact
brd_arrow.gif company_name string Company name of the account contact
brd_arrow.gif address1 string First address line of the contact.
brd_arrow.gif 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.
brd_arrow.gif address3 string The third line of the address
brd_arrow.gif city string City of the account contact
brd_arrow.gif 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.
brd_arrow.gif 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.
brd_arrow.gif country_cd string Country of the account contact. The ISO-compliant 2-character country code abbreviation in uppercase.
brd_arrow.gif postal_cd string Postal code of the account contact
brd_arrow.gif phone string Phone number of the account contact
brd_arrow.gif phone_ext string Phone extension of the account contact
brd_arrow.gif cell_phone string Cell phone number of the account contact
brd_arrow.gif work_phone string Work phone number of the account contact
brd_arrow.gif work_phone_ext string Work phone extension of the account contact
brd_arrow.gif fax string Fax phone number of the account contact
brd_arrow.gif email string Email of the account contact
brd_arrow.gif birthdate string Birthdate of the contact in yyyy-mm-dd format.
brd_arrow.gif address_verification_cd string Verification code for the account contact address. DEPRECATED
brd_arrow.gif address_verification_cd_2 string Verification code for the account contact address.
brd_arrow.gif address_match_score double Match score for the account contact address
billing_contacts hash Array of billing contacts
brd_arrow.gif 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.
brd_arrow.gif bill_first_name string First name of the billing contact.
brd_arrow.gif bill_middle_initial string Middle initial of the billing contact.
brd_arrow.gif bill_last_name string Last name of the billing contact.
brd_arrow.gif bill_company_name string Company name of the billing contact.
brd_arrow.gif bill_address1 string First address line of the billing contact.
brd_arrow.gif 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.
brd_arrow.gif bill_address3 string The third line of the billing address.
brd_arrow.gif bill_city string City of the billing contact.
brd_arrow.gif 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.
brd_arrow.gif 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.
brd_arrow.gif bill_country string Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
brd_arrow.gif bill_postal_cd string Postal code for the billing contact.
brd_arrow.gif bill_phone string Phone number of the billing contact.
brd_arrow.gif bill_phone_ext string Phone extension of the billing contact.
brd_arrow.gif bill_cell_phone string Cell phone number of the billing contact.
brd_arrow.gif bill_work_phone string Work phone number of the billing contact.
brd_arrow.gif bill_work_phone_ext string Work phone extension of the billing contact
brd_arrow.gif bill_fax string Fax number of the billing contact.
brd_arrow.gif bill_email string Email of the billing contact.
brd_arrow.gif bill_birthdate string Birthdate of the billing contact.
brd_arrow.gif bill_address_verification_cd string Verification code for the billing contact address. DEPRECATED
brd_arrow.gif bill_address_verification_cd_2 string Verification code for the billing contact address.
brd_arrow.gif bill_address_match_score double Match score for the billing contact address
brd_arrow.gif bill_billing_group_no long System-defined billing group number for the billing contact
brd_arrow.gif bill_client_billing_group_id string Client-defined billing group identifier for the billing contact
backup_contacts hash Array of backup contacts
brd_arrow.gif bkup_contact_no long The Aria-assigned unique identifier for the contact.
brd_arrow.gif bkup_first_name string First name of the backup contact
brd_arrow.gif bkup_middle_initial string Middle initial of the backup contact
brd_arrow.gif bkup_last_name string Last name of the backup contact
brd_arrow.gif bkup_company_name string Company name of the backup contact
brd_arrow.gif bkup_address1 string First address line of the backup contact
brd_arrow.gif 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.
brd_arrow.gif bkup_address3 string Third address line of the backup contact
brd_arrow.gif bkup_city string City of the backup contact
brd_arrow.gif bkup_locality string Locality of the backup contact
brd_arrow.gif 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.
brd_arrow.gif bkup_country string Country of the backup contact. The ISO-compliant 2-character country code abbreviation in uppercase.
brd_arrow.gif bkup_postal_cd string Postal code of the backup contact
brd_arrow.gif bkup_phone string Phone number of the backup contact
brd_arrow.gif bkup_phone_ext string Phone extension of the backup contact
brd_arrow.gif bkup_cell_phone string Cell phone number of the backup contact
brd_arrow.gif bkup_work_phone string Work phone number of the backup contact
brd_arrow.gif bkup_work_phone_ext string Work phone extension of the backup contact
brd_arrow.gif bkup_fax string Fax phone number of the backup contact
brd_arrow.gif bkup_email string Email of the backup contact
brd_arrow.gif bkup_birthdate string Date of birth of the backup contact
brd_arrow.gif bkup_address_verification_code string Verification code for the backup contact address
brd_arrow.gif bkup_address_match_score double Match score for the backup contact address
brd_arrow.gif bkup_billing_group_no long System-defined billing group number for the backup contact
brd_arrow.gif bkup_client_billing_group_id string Client-defined billing group identifier for the backup contact
statement_contacts hash Array of statement contacts
brd_arrow.gif stat_contact_no long The Aria-assigned unique identifier for the contact.
brd_arrow.gif stat_first_name string First name of the statement contact
brd_arrow.gif stat_middle_initial string Middle initial of the statement contact
brd_arrow.gif stat_last_name string Last name of the statement contact
brd_arrow.gif stat_company_name string Company name of the statement contact
brd_arrow.gif stat_address1 string First address line of the statement contact
brd_arrow.gif 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.
brd_arrow.gif stat_address3 string Third address line of the statement contact
brd_arrow.gif stat_city string City of the statement contact
brd_arrow.gif stat_locality string Locality of the statement contact
brd_arrow.gif 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.
brd_arrow.gif stat_country string Country of the statement contact. The ISO-compliant 2-character country code abbreviation in uppercase.
brd_arrow.gif stat_postal_cd string Postal code of the statement contact
brd_arrow.gif stat_phone string Phone number of the statement contact
brd_arrow.gif stat_phone_ext string Phone extension of the statement contact
brd_arrow.gif stat_cell_phone string Cell phone number of the statement contact
brd_arrow.gif stat_work_phone string Work phone number of the statement contact
brd_arrow.gif stat_work_phone_ext string Work phone extension of the statement contact
brd_arrow.gif stat_fax string Fax phone number of the statement contact
brd_arrow.gif stat_email string Email of the statement contact
brd_arrow.gif stat_birthdate string Date of birth of the statement contact
brd_arrow.gif stat_address_verification_cd string Verification code for the statement contact address. DEPRECATED
brd_arrow.gif stat_address_verification_cd_2 string Verification code for the statement contact address.
brd_arrow.gif stat_address_match_score double Match score for the statement contact address
brd_arrow.gif stat_billing_group_no long System-defined billing group number for the statement contact
brd_arrow.gif 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.
brd_arrow.gif other_contact_no long The Aria-assigned unique identifier for the contact.
brd_arrow.gif other_first_name string The first name of the contact.
brd_arrow.gif other_middle_initial string The middle initial of the contact.
brd_arrow.gif other_last_name string The last name of the contact.
brd_arrow.gif other_company_name string The company name of the contact.
brd_arrow.gif other_address1 string The first address line of the contact.
brd_arrow.gif 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.
brd_arrow.gif other_address3 string The third address line of the contact.
brd_arrow.gif other_city string The city of the contact.
brd_arrow.gif other_locality string The locality of the contact.
brd_arrow.gif 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.
brd_arrow.gif other_country_cd string The country of the contact. Provide the ISO-compliant 2-character country code abbreviation in uppercase.
brd_arrow.gif other_postal_cd string The postal/zip code of the contact.
brd_arrow.gif other_phone string The phone number of the contact.
brd_arrow.gif other_phone_ext string The phone number extension of the contact.
brd_arrow.gif other_cell_phone string The cell phone number of the contact.
brd_arrow.gif other_work_phone string The work phone number of the contact.
brd_arrow.gif other_work_phone_ext string The work phone number extension of the contact.
brd_arrow.gif other_fax string The fax number of the contact.
brd_arrow.gif other_email string The email address of the contact.
brd_arrow.gif other_birthdate string The birthdate of the contact.
brd_arrow.gif other_address_verification_code string Verification code for the contact address.
brd_arrow.gif 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.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.