Contact

A contact [Contact] is a person working for, or associated with a customer. For more information about contacts, see Contacts.

XML

SOAP

REST

Database table

Object

Contact

oaContact

Contact

contact

Supported Commands

Add, Read, Modify, Delete

add(), read(), modify(), upsert(), delete()

See Contacts

The Contact object has the following standard properties:

Note:

Contact object properties may also include custom fields. The object type supports the custom equal to read method and the enable_custom read attribute.

XML

SOAP

REST

Database

Description

active

active

isActive

active

A 1/0 field indicating if the contact is active. Defaults to 1 if not set when adding a contact.

addr

[Required] An Address object with the contact's address details. The Address object must include at least a last name [last]. See Address Fields

addr_addr1

address1

address.address1

First line of the contact's address.

addr_addr2

address2

address.address2

Second line of the contact's address.

addr_addr3

address3

address.address3

Third line of the contact's address.

addr_addr4

address4

address.address4

Fourth line of the contact's address.

addr_city

city

address.city

The contact's city.

addr_contact_id

The associated contact ID.

addr_country

country

address.country

The contact's country.

addr_email

email

addr_email

The contact's Email address.

addr_fax

fax

addr_fax

The contact's fax number.

addr_first

firstName

addr_first

The contact's first name.

addr_id

address.id

The ID of the associated address.

addr_last

lastName

addr_last

[Required] The contact's last name.

addr_middle

Middle name.

addr_mobile

mobile

addr_mobile

The contact's mobile phone number.

addr_phone

phone

addr_phone

The contact's phone number.

addr_salutation

title

addr_salutation

The contact's title.

addr_state

state

address.state

The contact's State or Region.

addr_zip

zip

address.zip

The contact's ZIP code or postal code.

can_bill_to

can_bill_to

canBill

can_bill_to

A 1/0 field indicating if the contact can be used for billing.

can_ship_to

can_ship_to

canShip

can_ship_to

A 1/0 field indicating if the contact can be used for shipping.

can_sold_to

can_sold_to

canSell

can_sold_to

A 1/0 field indicating if the contact an be used for selling.

code

code

accountingCode

acct_code

Optional accounting code that can be used for integration with external accounting systems.

created

created

created

created

[Read-only] The date the contact record was created.

See Date Fields

customer_company

customer_company

customer_company

Import-only field to specify customer by company name.

customerid

customerid

customerId

customer_id

[Required] The internal ID of the associated customer.

exported

exported

exported

[Read-only] Date and time the record was marked as exported.

See Date Fields

externalid

externalid

externalId

external_id

The unique external ID of the contact, if the record was imported from an external system. Uniqueness may be enforced depending on your company's OpenAir account configuration.

id

id

id

id

[Read-only] The unique internal identifier of the contact. Assigned by OpenAir.

job_title

job_title

jobTitle

job_title

The contact's job title.

name

name

nickname

name

The nickname used to identify the contact. Automatically generated if not supplied.

notes

notes

notes

notes

Notes about the contact.

picklist_label

picklist_label

Label as shown on form picklist.

updated

updated

updated

updated

[Read-only] The date the contact record was last updated or modified.

See Date Fields