Skip to main content
Aria Knowledge Central

get_acct_contacts_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_acct_contacts_m
Class account_services_m
Update Version 6.30

Description

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).

Inputs

Name Type Length Required Description
client_no long 22 Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Yes

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.
acct_no long 22 Yes

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

Alternative required field: client_acct_id
billing_group_no long 22 No

Aria-defined billing group number

Alternative field: client_billing_group_id
client_billing_group_id string 100 No

Client-defined billing group identifier

Alternative field: billing_group_no
include_unused_contacts long 1 No

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.

Allowed values:

Value Description
0 False (default)
1 True
client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: acct_no

Outputs

Name Type Length Required Description
Start of account_contact object
account_contact object   No

Account contact
Name Type Length Required Description
▶contact_no long   No

The Aria-assigned unique identifier for the contact.
▶first_name string   No

First name of the account contact
▶middle_initial string   No

Middle initial of the account contact
▶last_name string   No

Last name of the account contact
▶company_name string   No

Company name of the account contact
▶address1 string   No

First address line of the contact.
▶address2 string   No

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   No

The third line of the address
▶city string   No

City of the account contact
▶locality string 32 No

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   No

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   No

Country of the account contact. The ISO-compliant 2-character country code abbreviation in uppercase.
▶postal_cd string   No

Postal code of the account contact
▶phone string   No

Phone number of the account contact
▶phone_ext string   No

Phone extension of the account contact
▶cell_phone string   No

Cell phone number of the account contact
▶work_phone string   No

Work phone number of the account contact
▶work_phone_ext string   No

Work phone extension of the account contact
▶fax string   No

Fax phone number of the account contact
▶email string   No

Email of the account contact
▶birthdate string 10 No

Birthdate of the contact in yyyy-mm-dd format.
▶address_verification_code string   No

Note: This field is deprecated. Aria no longer supports address_verification_code.
▶address_match_score double   No

Match score for the account contact address
▶address_verification_cd_2 string   No

Verification code for the account contact address
▶addr_method_cd long   No

This field denotes the tax address method code which was used to generate the geo code of the account contact.
End of account_contact object
Start of billing_contacts object
billing_contacts object   No

Array of billing contacts
Name Type Length Required Description
▶bill_contact_no long 22 No

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 100 No

First name of the billing contact.
▶bill_middle_initial string 2 No

Middle initial of the billing contact.
▶bill_last_name string 100 No

Last name of the billing contact.
▶bill_company_name string 100 No

Company name of the billing contact.
▶bill_address1 string 100 No

First address line of the billing contact.
▶bill_address2 string 100 No

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 100 No

The third line of the billing address.
▶bill_city string 100 No

City of the billing contact.
▶bill_locality string 32 No

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 10 No

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 2 No

Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
▶bill_postal_cd string 15 No

Postal code for the billing contact.
▶bill_phone string 25 No

Phone number of the billing contact.
▶bill_phone_ext string 10 No

Phone extension of the billing contact.
▶bill_cell_phone string 20 No

Cell phone number of the billing contact.
▶bill_work_phone string 25 No

Work phone number of the billing contact.
▶bill_work_phone_ext string   No

Work phone extension of the billing contact
▶bill_fax string 25 No

Fax number of the billing contact.
▶bill_email string 320 No

Email of the billing contact.
▶bill_birthdate string 10 No

Birthdate of the billing contact.
▶bill_address_verification_code string   No

Note: This field is deprecated. Aria no longer supports bill_address_verification_code.
▶bill_address_match_score double   No

Match score for the billing contact address
▶bill_billing_group_no long   No

System-defined billing group number for the billing contact
▶bill_client_billing_group_id string   No

Client-defined billing group identifier for the billing contact
▶bill_address_verification_cd_2 string   No

Verification code for the billing contact address
▶bill_addr_method_cd long   No

This field denotes the tax address method code which was used to generate the geo code of the billing contact.
End of billing_contacts object
Start of backup_contacts object
backup_contacts object   No

Array of backup contacts
Name Type Length Required Description
▶bkup_contact_no long   No

The Aria-assigned unique identifier for the contact.
▶bkup_first_name string   No

First name of the backup contact
▶bkup_middle_initial string   No

Middle initial of the backup contact
▶bkup_last_name string   No

Last name of the backup contact
▶bkup_company_name string   No

Company name of the backup contact
▶bkup_address1 string   No

First address line of the backup contact
▶bkup_address2 string   No

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   No

Third address line of the backup contact
▶bkup_city string   No

City of the backup contact
▶bkup_locality string   No

Locality of the backup contact
▶bkup_state_prov string   No

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   No

Country of the backup contact. The ISO-compliant 2-character country code abbreviation in uppercase.
▶bkup_postal_cd string   No

Postal code of the backup contact
▶bkup_phone string   No

Phone number of the backup contact
▶bkup_phone_ext string   No

Phone extension of the backup contact
▶bkup_cell_phone string   No

Cell phone number of the backup contact
▶bkup_work_phone string   No

Work phone number of the backup contact
▶bkup_work_phone_ext string   No

Work phone extension of the backup contact
▶bkup_fax string   No

Fax phone number of the backup contact
▶bkup_email string   No

Email of the backup contact
▶bkup_birthdate string   No

Date of birth of the backup contact
▶bkup_address_verification_code string   No

Note: This field is deprecated. Aria no longer supports bkup_address_verification_code.
▶bkup_address_match_score double   No

Match score for the backup contact address
▶bkup_billing_group_no long   No

System-defined billing group number for the backup contact
▶bkup_client_billing_group_id string   No

Client-defined billing group identifier for the backup contact
▶bkup_address_verification_cd_2 string   No

Verification code for the backup contact address
▶bkup_addr_method_cd long   No

This field denotes the tax address method code which was used to generate the geo code of the backup contact.
End of backup_contacts object
Start of statement_contacts object
statement_contacts object   No

Array of statement contacts
Name Type Length Required Description
▶stat_contact_no long   No

The Aria-assigned unique identifier for the contact.
▶stat_first_name string   No

First name of the statement contact
▶stat_middle_initial string   No

Middle initial of the statement contact
▶stat_last_name string   No

Last name of the statement contact
▶stat_company_name string   No

Company name of the statement contact
▶stat_address1 string   No

First address line of the statement contact
▶stat_address2 string   No

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   No

Third address line of the statement contact
▶stat_city string   No

City of the statement contact
▶stat_locality string   No

Locality of the statement contact
▶stat_state_prov string   No

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   No

Country of the statement contact. The ISO-compliant 2-character country code abbreviation in uppercase.
▶stat_postal_cd string   No

Postal code of the statement contact
▶stat_phone string   No

Phone number of the statement contact
▶stat_phone_ext string   No

Phone extension of the statement contact
▶stat_cell_phone string   No

Cell phone number of the statement contact
▶stat_work_phone string   No

Work phone number of the statement contact
▶stat_work_phone_ext string   No

Work phone extension of the statement contact
▶stat_fax string   No

Fax phone number of the statement contact
▶stat_email string   No

Email of the statement contact
▶stat_birthdate string   No

Date of birth of the statement contact
▶stat_address_verification_code string   No

Note: This field is deprecated. Aria no longer supports stat_address_verification_code.
▶stat_address_match_score double   No

Match score for the statement contact address
▶stat_billing_group_no long   No

System-defined billing group number for the statement contact
▶stat_client_billing_group_id string   No

Client-defined billing group identifier for the statement contact
▶stat_address_verification_cd_2 string   No

Verification code for the statement contact address
▶stat_addr_method_cd long   No

This field denotes the tax address method code which was used to generate the geo code of the statement contact.
End of statement_contacts object
Start of other_contacts object
other_contacts object   No

List of contacts saved on the account not currently used as an account contact, billing contact, or statement contact.
Name Type Length Required Description
▶other_contact_no long   No

The Aria-assigned unique identifier for the contact.
▶other_first_name string   No

The first name of the contact.
▶other_middle_initial string   No

The middle initial of the contact.
▶other_last_name string   No

The last name of the contact.
▶other_company_name string   No

The company name of the contact.
▶other_address1 string   No

The first address line of the contact.
▶other_address2 string   No

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   No

The third address line of the contact.
▶other_city string   No

The city of the contact.
▶other_locality string   No

The locality of the contact.
▶other_state_prov string   No

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   No

The country of the contact. Provide the ISO-compliant 2-character country code abbreviation in uppercase.
▶other_postal_cd string   No

The postal/zip code of the contact.
▶other_phone string   No

The phone number of the contact.
▶other_phone_ext string   No

The phone number extension of the contact.
▶other_cell_phone string   No

The cell phone number of the contact.
▶other_work_phone string   No

The work phone number of the contact.
▶other_work_phone_ext string   No

The work phone number extension of the contact.
▶other_fax string   No

The fax number of the contact.
▶other_email string   No

The email address of the contact.
▶other_birthdate string   No

The birthdate of the contact.
▶other_address_verification_code string   No

Note: This field is deprecated. Aria no longer supports other_address_verification_code.
▶other_address_match_score double   No

Match score for the contact address.
▶other_address_verification_cd_2 string   No

Verification code for the contact address.
▶other_addr_method_cd long   No

This field denotes the tax address method code which was used to generate the geo code of the other contact.
End of other_contacts object
error_code long   No

Aria-assigned error identifier. 0 indicates no error.
error_msg string   No

Description of any error that occurred. "OK" if there was no error.
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.