Contacts

Contact records contain information about individuals working for, or associated with customers.

Available methods

POST /contacts/ - Insert a Contact
GET /contacts/ - Get the List of Contacts
GET /contacts/{id} - Get a Contact
PUT /contacts/{id} - Update a Contact
DELETE /contacts/{id} - Delete a Contact
OPTIONS /contacts/ - Discover Available Methods and Fetch the Endpoint Reference for Contacts

Contact object properties

A contact is a person working for, or associated with a customer.

The Contact object has the following properties:

Property	Description	Type	Read-only	Query allowed	Sorting allowed
`accountingCode`	Optional accounting code that can be used for integration with external accounting systems.	string	-	Yes	-
`address1`	First line of the contact's address.	string	-	-	-
`address2`	Second line of the contact's address.	string	-	-	-
`address3`	Third line of the contact's address.	string	-	-	-
`address4`	Fourth line of the contact's address.	string	-	-	-
`canBill`	A 1/0 field indicating if the contact can be used for billing.	Boolean	-	Yes	-
`canSell`	A 1/0 field indicating if the contact an be used for selling.	Boolean	-	Yes	-
`canShip`	A 1/0 field indicating if the contact can be used for shipping.	Boolean	-	Yes	-
`city`	The contact's city.	string	-	-	-
`country`	The contact's country.	string	-	-	-
`created`	The date the contact record was created.	string($date-time)	Yes	Yes	-
`customerId`	[REQUIRED] The internal ID of the associated customer.	integer($int64)	-	Yes	Yes
`email`	The contact's Email address.	string	-	Yes	-
`externalId`	The unique external ID of the contact, if the record was imported from an external system.	string	-	Yes	Yes
`fax`	The contact's fax number.	string	-	Yes	-
`firstName`	The contact's first name.	string	-	Yes	-
`id`	The unique internal identifier of the contact.	integer($int64)	Yes	Yes	Yes
`isActive`	A 1/0 field indicating if the contact is active.	Boolean	-	Yes	Yes
`jobTitle`	The contact's job title.	string	-	Yes	-
`lastName`	[REQUIRED] The contact's last name.	string	-	Yes	-
`mobile`	The contact's mobile phone number.	string	-	Yes	-
`nickname`	The nickname used to identify the contact.	string	-	Yes	-
`notes`	Notes about the contact.	string	-	Yes	-
`phone`	The contact's phone number.	string	-	Yes	-
`state`	The contact's State or Region.	string	-	-	-
`title`	The contact's title.	string	-	Yes	-
`updated`	The date the contact record was last updated or modified.	string($date-time)	Yes	Yes	-
`zip`	The contact's ZIP code or postal code.	string	-	-	-

Property

Description

Type

Read-only

Query allowed

Sorting allowed

accountingCode

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

string

Yes

address1

First line of the contact's address.

string

address2

Second line of the contact's address.

string

address3

Third line of the contact's address.

string

address4

Fourth line of the contact's address.

string

canBill

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

Boolean

Yes

canSell

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

Boolean

Yes

canShip

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

Boolean

Yes

city

The contact's city.

string

country

The contact's country.

string

created

The date the contact record was created.

string($date-time)

Yes

customerId

[REQUIRED] The internal ID of the associated customer.

integer($int64)

Yes

email

The contact's Email address.

string

Yes

externalId

The unique external ID of the contact, if the record was imported from an external system.

string

Yes

fax

The contact's fax number.

string

Yes

firstName

The contact's first name.

string

Yes

id

The unique internal identifier of the contact.

integer($int64)

Yes

isActive

A 1/0 field indicating if the contact is active.

Boolean

Yes

jobTitle

The contact's job title.

string

Yes

lastName

[REQUIRED] The contact's last name.

string

Yes

mobile

The contact's mobile phone number.

string

Yes

nickname

The nickname used to identify the contact.

string

Yes

notes

Notes about the contact.

string

Yes

phone

The contact's phone number.

string

Yes

state

The contact's State or Region.

string

title

The contact's title.

string

Yes

updated

The date the contact record was last updated or modified.

string($date-time)

Yes

zip

The contact's ZIP code or postal code.

string

Note:

Access to certain object types and object attributes depend on the business logic configured for your SuiteProjects Pro account. It may vary depending on the role and access privileges associated with the access token and with the user who authorized the application.

Required and read-only attributes also depend on the business logic configured for each specific SuiteProjects Pro account. Some fields such as id, created, and updated are system-generated and always read-only.