Contacts

## Contacts_Create

Adds a contact to a customer.

Input

  • Contact
    CustomerID As Integer – The customer the new contact will belong to.
 IDAs Integer – Prohibited
    Name As String – Optional - The name of the contact.
 PhoneAs String - Optional - The contact's phone number.
    Mobile As String - Optional - The contact's mobile phone number.
 FaxAs String – Optional - The contact's fax number.
    Email As String – Optional - The contact's email address.
 Contact_Type_IDAs Integer – Optional - The ID of the contact type.
    Contact_Type As String – Optional - The type of contact such as "Billing", "General", "Other", etc. Has to match Contact_Type_ID if both are populated.
 Address – Optional - Only the following fields are used
    Address1 As String – Address line 1.
 Address2As String – Address line 2 i.e. apt, unit, building.
    City As String – City name.
 StateAs String – 2 digit state abbreviation.
    Zip As String – Valid 5 digit zip code.
 Zip4As String – The zip code +4.\

Output

  • ContactIDAs Integer – ID of the new contact.

Contacts_Delete

Deletes a customer contact.

Input

  • ContactIDAs Integer – The unique identifier for the contact.*\

Output

None

Contacts_Query

Finds a specific contact using the ContactID or all contacts on a customer.

Required Input

  • One of the optional inputs is required.\

Optional Input

  • ContactIDAs Integer – The unique identifier for the contact.
  • **CustomerIDAs Integer ** – The customer we are querying for related contacts.

Output

  • Contacts – Array of ContactItems
    • ContactItem
      • ID **As Integer** – The ContactID.
      • Name **As String** – The name of the contact.
      • Phone **As String** – The contact's phone number.
      • Mobile **As String** – The contact's mobile phone number.
      • Fax **As String** – The contact's fax number.
      • Email **As String** – the contact's email address.
      • Contact_Type_ID **As Integer** – The ID of the contact type.
      • Contact_Type **As String** – The type of contact such as "Billing", "General", "Other", etc.
      • Address
        • ID **As Integer** – The AddressIDv
        • FirstName **As String** – First name of the person at the address.
        • LastName **As String** – The last name of the person at the address.
        • Address1 **As String** – Address line 1
        • Address2 **As String** – Address line 2 i.e. apt, unit, building
        • City **As String** – City name.
        • State **As String** – 2 digit state abbreviation.
        • Zip **As String** – 5 digit zip code.
        • Zip4 **As String** – The zip code +4.
        • Country **As String** –3 character Country ISO code.

Contacts_Update

Updates a customer contact.

Input

  • Contact
    • ID **As String** – The ContactID that is being updated.
    • CustomerID **As String** – Optional - The customer the contact is related to. If no CustomerID is provided, the contact will stay on the original customer. If a new CustomerID is used, the contact will be moved to that customer.
    • Name **As String** – Optional - The name of the contact.
    • Phone **As String** – Optional - The contact's phone number.
    • Mobile **As String** – Optional - The contact's mobile phone number.
    • Fax **As String** – Optional - The contact's fax number.
    • Email **As String** – Optional - the contact's email address.
    • Contact_Type_ID **As String** – Optional - The ID of the contact type.
    • Contact_Type **As String** – Optional - The type of contact such as "Billing", "General", "Other", etc. Has to match Contact_Type_ID if both are populated.
    • Address – Optional - Only the following fields are used
      • Address1 **As String** – Address line 1
      • Address2 **As String** – Address line 2 i.e. apt, unit, building
      • City **As String** – City name.
      • State **As String** – 2 digit state abbreviation.
      • Zip **As String** – 5 digit zip code.
      • Zip4 **As String** – The zip code +4.

Output

None