Customer

A customer [Customer] is an individual or company that buys a product or service from your company.

Review the Usage Guidelines for the Customer object.

—	XML	SOAP	REST	Database table
Object	`Customer`	`oaCustomer`	`Customer`	`customer`
Supported Commands	`Add`, `Read`, `Modify`, `Delete`	`add()`, `read()`, `modify()`, `upsert()`, `delete()`	See Customers	—

—

XML

SOAP

REST

Database table

Object

Customer

oaCustomer

Customer

customer

Supported Commands

Add, Read, Modify, Delete

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

See Customers

—

The Customer object has the following standard properties:

Note:

Customer 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 customer is designated as an active customer. Defaults to `1` if not set when adding a customer.
`addr`	—	—	—	The customer's address. An `Address` object with the company's address details. See Address Fields.
—	`addr_addr1`	`address1`	`address1`	First line of the customer's address.
—	`addr_addr2`	`address2`	`address2`	Second line of the customer's address.
—	`addr_addr3`	`address3`	`address3`	Third line of the customer's address.
—	`addr_addr4`	`address4`	`address4`	Fourth line of the customer's address.
—	`addr_city`	`city`	`city`	The customer's city.
—	`addr_contact_id`	—	—	The internal ID of the associated contact [`Contact`].
—	`addr_country`	`country`	`country`	The customer's country.
—	`addr_email`	`email`	`email`	The customer's Email address.
—	`addr_fax`	`fax`	`fax`	The customer's fax number.
—	`addr_first`	—	—	The customer's first name.
—	`addr_id`	—	—	The internal ID of the associated address [`Address`].
—	`addr_last`	—	—	The customer's last name.
—	`addr_middle`	—	—	The customer's middle name.
—	`addr_mobile`	—	—	The customer's mobile phone number.
—	`addr_phone`	`phone`	`phone`	The customer's phone number.
—	`addr_salutation`	—	—	The customer's salutation.
—	`addr_state`	`state`	`state`	The customer's state or region.
—	`addr_zip`	`zip`	`zip`	The customer's ZIP or postal code.
`billingaddr`	—	—	—	The billing address. An `Address` object with the company's address details. See Address Fields. The `billingaddr` property is redundant but continues to be supported for backward compatibility. You can use the `billing_contact_id` to designate a Contact object as the billing contact for the customer. If a `billingaddr` is specified when you add a customer object, a contact object is added with the information in `billingaddr`. If a `billingaddr` is specified when you modify a customer object, the contact object is also modified by default. To modify the `billingaddr` but not the contact object, set the `customer_only="yes"` attribute for the `Address` object as per the following example. `<Modify type="customer"> <Customer> <billingaddr> <Address customer_only="yes"> <addr1>1234 Main St</addr1> </Address> </billingaddr> </Customer> </Modify>`
—	`billing_addr_addr1` or `billingaddr_addr1`	—	—	First line on the billing address.
—	`billing_addr_addr2` or `billingaddr_addr2`	—	—	Second line on the billing address.
—	`billing_addr_addr3` or `billingaddr_addr3`	—	—	Third line on the billing address.
—	`billing_addr_addr4` or `billingaddr_addr4`	—	—	Fourth line on the billing address.
—	`billing_addr_city` or `billingaddr_city`	—	—	City on the billing address.
—	`billing_addr_contact_id` or `billingaddr_contact_id`	billingContactId	`billing_contact_id`	The internal ID of the contact [`Contact`] associated with the billing address.
—	`billing_addr_country` or `billingaddr_country`	—	—	Country on the billing address.
—	`billing_addr_email` or `billingaddr_email`	—	—	Email address on the billing address.
—	`billing_addr_fax` or `billingaddr_fax`	—	—	Fax number on the billing address.
—	`billing_addr_first` or `billingaddr_first`	—	—	First name on the billing address.
—	`billing_addr_id` or `billingaddr_id`	—	—	The internal ID of the associated billing address [`Address`].
—	`billing_addr_last` or `billingaddr_last`	—	—	Last name on the billing address.
—	`billing_addr_middle` or `billingaddr_middle`	—	—	Middle name on the billing address.
—	`billing_addr_` or `billingaddr_`	—	—	Mobile phone number on the billing address.
—	`billing_addr_mobile` or `billingaddr_mobile`	—	—	Phone number on the billing address.
—	`billing_addr_salutation` or `billingaddr_salutation`	—	—	Salutation on the billing address.
—	`billing_addr_state` or `billingaddr_state`	—	—	State on the billing address.
—	`billing_addr_zip` or `billingaddr_zip`	—	—	Zip code on the billing address.
`billing_code`	`billing_code`	`billingCode`	`billing_code`	The customer's billing code. Used in bulk invoicing.
`billing_contact_id`	`billing_contact_id`	`billingContactId`	`billing_contact_id`	The internal ID of the customer's billing contact [`Contact`].
`bus_typeid`	`bus_typeid`	`businessTypeId`	`bus_type_id`	The internal ID of the business type associated with the customer.
`code`	`code`	`accountingCode`	`acct_code`	Optional accounting code that can be used for integration with external accounting systems.
`company`	`company`	`company`	`company`	[Required] The company name.
`company_sizeid`	`company_sizeid`	`companySizeId`	`company_size_id`	The internal ID of the company size associated with the customer.
`contactaddr`	—	—	—	The primary contact's address. An `Address` object with the company's address details. See Address Fields.
—	`contact_addr_addr1` or `contactaddr_addr1`	—	—	First line of the contact's address.
—	`contact_addr_addr2` or `contactaddr_addr2`	—	—	Second line of the contact's address.
—	`contact_addr_addr3` or `contactaddr_addr3`	—	—	Third line of the contact's address.
—	`contact_addr_addr4` or `contactaddr_addr4`	—	—	Fourth line of the contact's address.
—	`contact_addr_city` or `contactaddr_city`	—	—	Contact's city.
—	`contact_addr_contact_id` or `contactaddr_contact_id`	—	`primary_contact_id`	The internal ID of the contact [`Contact`] associated with the primary contact's address.
—	`contact_addr_country` or `contactaddr_country`	—	—	Contact's country.
—	`contact_addr_email` or `contactaddr_email`	—	—	Contact's email address.
—	`contact_addr_fax` or `contactaddr_fax`	—	—	Contact's fax number.
—	`contact_addr_first` or `contactaddr_first`	—	—	Contact's first name.
—	`contact_addr_id` or `contactaddr_id`	—	—	The internal ID of the associated contact address [`Address`].
—	`contact_addr_last` or `contactaddr_last`	—	—	Contact's last name.
—	`contact_addr_middle` or `contactaddr_middle`	—	—	Contact's middle name.
—	`contact_addr_mobile` or `contactaddr_mobile`	—	—	Contact's mobile phone number.
—	`contact_addr_phone` or `contactaddr_phone`	—	—	Contact's phone number.
—	`contact_addr_salutation` or `contactaddr_salutation`	—	—	Contact's salutation.
—	`contact_addr_state` or `contactaddr_state`	—	—	Contact's state.
—	`contact_addr_zip` or `contactaddr_zip`	—	—	Contact's zip code.
`cost_centerid`	`cost_centerid`	`costCenterId`	`cost_center_id`	The internal ID of the cost center [`Costcenter`] associated with the customer.
`created`	`created`	`created`	`created`	[Read-only] The date and time when the customer record was created. See Date Fields.
`createtime`	`createtime`	`created`	—	[Read-only] Same as the created field (for legacy systems).
`credit_invoice_layout_id`	`credit_invoice_layout_id`	`creditInvoiceLayoutId`	`credit_invoice_layout_id`	The internal ID of the credit memo (negative invoice) layout [`InvoiceLayout`] associated with the customer.
`currency`	`currency`	`currency`	`currency`	Currency for the money fields in the record. Also the default currency when an invoice is created.
`customer_locationid`	`customer_locationid`	`customerLocationId`	`customer_location_id`	The internal ID of the customer location [`CustomerLocation`] associated with the customer.
`externalid`	`externalid`	`externalId`	`external_id`	The unique external ID of the customer, if the record was imported from an external system. Uniqueness may be enforced depending on your company's SuiteProjects Pro account configuration.
`filterset_ids`	`filterset_ids`	—	—	Comma delimited list of internal IDs of filter sets [`Filterset`] that this object belongs to.
`hear_aboutid`	`hear_aboutid`	`customerSourceId`	`hear_about_id`	The internal ID of the customer source associated with the customer.
`hierarchy_node_ids`	`hierarchy_node_ids`	—	—	Comma delimited list of internal IDs of hierarchy nodes [`HierarchyNode`] this object belongs to.
`id`	`id`	`id`	`id`	[Read-only] The unique internal identifier of the customer. Automatically assigned by SuiteProjects Pro.
—	—	`invoiceEmailText`	`invoice_email_text`	The text to include in the body of invoice Email messages to the customer.
`invoice_layoutid`	`invoice_layoutid`	`invoiceLayoutId`	`invoice_layout_id`	The internal ID of the invoice layout [`InvoiceLayout`] associated with the customer.
`invoice_prefix`	`invoice_prefix`	`invoicePrefix`	`invoice_prefix`	The invoice number prefix for all invoices to the customer.
`invoice_text`	`invoice_text`	`invoiceText`	`invoice_text`	The text to include on every invoice to the customer.
`name`	`name`	`name`	`name`	[Required] The nickname used for display in popup windows and lists.
`notes`	`notes`	`notes`	`notes`	Notes about the customer.
`picklist_label`	`picklist_label`	—	—	Label as shown on form picklist.
`primary_contactid`	`primary_contactid`	`primaryContactId`	`primary_contact_id`	The internal ID of the customer's primary contact [`Contact`].
`rate`	`rate`	`rate`	`rate`	The hourly billing rate for time billed to the customer.
`shipping_contactid`	`shipping_contactid`	`shippingContactId`	`shipping_contact_id`	The internal ID of the customer's shipping contact [`Contact`].
`sold_to_contactid`	`sold_to_contactid`	`soldToContactId`	`sold_to_contact_id`	The internal ID of the customer's sold to contact [`Contact`].
`statements`	`statements`	`statements`	`statements`	A 1/0 field indicating if the customer can view statements.
—	—	syncWorkspace	`sync_workspace`	A 1/0 field indicating whether to keep customer resources in sync with linked workspace members.
`ta_include`	`ta_include`	—	—	A 1/0 field indicating whether a Timesheet filterset is applied.
`tb_approvalprocess`	`tb_approvalprocess`	invoiceApprovalProcess	`tb_approvalprocess`	The internal ID of approval process [`ApprovalProcess`] for invoices to the customer. Mutually exclusive with `tb_approver` (XML and SOAP API) or `invoiceApproverbookingRequestApprover` (REST API).
`tb_approver`	`tb_approver`	invoiceApprover	`tb_approver`	The internal ID of the `User` who approves invoices to the customer, if a single approver process is used. Mutually exclusive with `tb_approvalprocess` (XML and SOAP API) or `invoiceApprovalProcess` (REST API). Other possible values: `-1` — the invoice owner’s manager. `-2` — the manager of the invoice owner’s manager. `-5` — the customer owner.
`te_include`	`te_include`	—	—	A 1/0 field indicating whether an Expense Report filterset is applied.
`terms`	`terms`	`terms`	`terms`	Standard payment terms for the customer. Textual description like "Net 30". Defaults to the default payment terms if not set when adding a new object.
`territoryid`	`territoryid`	`territoryId`	`territory_id`	The internal ID of the territory associated with the customer.
`type`	`type`	`type`	`type`	A C/P field indicating whether the customer is Customer [`C`] or a Prospect [`P`]. Defaults to `C` if not set when adding a customer.
`updated`	`updated`	`updated`	`updated`	[Read-only] The date and time when the customer record was last updated or modified. See Date Fields.
`updatetime`	`updatetime`	`updated`	`updated`	[Read-only] Same as the updated field (for legacy systems). See Date Fields.
`userid`	`userid`	`userId`	`user_id`	The internal ID of the `User` who owns this customer (customer owner).
`web`	`web`	`web`	`web`	The customer's web address.

XML

SOAP

REST

Database

Description

active

isActive

active

A 1/0 field indicating if the customer is designated as an active customer. Defaults to 1 if not set when adding a customer.

addr

—

The customer's address. An Address object with the company's address details. See Address Fields.

—

addr_addr1

address1

First line of the customer's address.

—

addr_addr2

address2

Second line of the customer's address.

—

addr_addr3

address3

Third line of the customer's address.

—

addr_addr4

address4

Fourth line of the customer's address.

—

addr_city

city

The customer's city.

—

addr_contact_id

—

The internal ID of the associated contact [Contact].

—

addr_country

country

The customer's country.

—

addr_email

email

The customer's Email address.

—

addr_fax

fax

The customer's fax number.

—

addr_first

—

The customer's first name.

—

addr_id

—

The internal ID of the associated address [Address].

—

addr_last

—

The customer's last name.

—

addr_middle

—

The customer's middle name.

—

addr_mobile

—

The customer's mobile phone number.

—

addr_phone

phone

The customer's phone number.

—

addr_salutation

—

The customer's salutation.

—

addr_state

state

The customer's state or region.

—

addr_zip

zip

The customer's ZIP or postal code.

billingaddr

—

The billing address. An Address object with the company's address details. See Address Fields.

The billingaddr property is redundant but continues to be supported for backward compatibility.

You can use the billing_contact_id to designate a Contact object as the billing contact for the customer.
If a billingaddr is specified when you add a customer object, a contact object is added with the information in billingaddr.

If a billingaddr is specified when you modify a customer object, the contact object is also modified by default. To modify the billingaddr but not the contact object, set the customer_only="yes" attribute for the Address object as per the following example.

                        <Modify type="customer">
     <Customer>
          <billingaddr>
               <Address customer_only="yes">
                    <addr1>1234 Main St</addr1>
               </Address>
          </billingaddr>
     </Customer>
</Modify>

—

billing_addr_addr1 or billingaddr_addr1

—

First line on the billing address.

—

billing_addr_addr2 or billingaddr_addr2

—

Second line on the billing address.

—

billing_addr_addr3 or billingaddr_addr3

—

Third line on the billing address.

—

billing_addr_addr4 or billingaddr_addr4

—

Fourth line on the billing address.

—

billing_addr_city or billingaddr_city

—

City on the billing address.

—

billing_addr_contact_id or billingaddr_contact_id

billingContactId

billing_contact_id

The internal ID of the contact [Contact] associated with the billing address.

—

billing_addr_country or billingaddr_country

—

Country on the billing address.

—

billing_addr_email or billingaddr_email

—

Email address on the billing address.

—

billing_addr_fax or billingaddr_fax

—

Fax number on the billing address.

—

billing_addr_first or billingaddr_first

—

First name on the billing address.

—

billing_addr_id or billingaddr_id

—

The internal ID of the associated billing address [Address].

—

billing_addr_last or billingaddr_last

—

Last name on the billing address.

—

billing_addr_middle or billingaddr_middle

—

Middle name on the billing address.

—

billing_addr_ or billingaddr_

—

Mobile phone number on the billing address.

—

billing_addr_mobile or billingaddr_mobile

—

Phone number on the billing address.

—

billing_addr_salutation or billingaddr_salutation

—

Salutation on the billing address.

—

billing_addr_state or billingaddr_state

—

State on the billing address.

—

billing_addr_zip or billingaddr_zip

—

Zip code on the billing address.

billing_code

billingCode

billing_code

The customer's billing code. Used in bulk invoicing.

billing_contact_id

billingContactId

billing_contact_id

The internal ID of the customer's billing contact [Contact].

bus_typeid

businessTypeId

bus_type_id

The internal ID of the business type associated with the customer.

code

accountingCode

acct_code

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

company

[Required] The company name.

company_sizeid

companySizeId

company_size_id

The internal ID of the company size associated with the customer.

contactaddr

—

The primary contact's address. An Address object with the company's address details. See Address Fields.

—

contact_addr_addr1 or contactaddr_addr1

—

First line of the contact's address.

—

contact_addr_addr2 or contactaddr_addr2

—

Second line of the contact's address.

—

contact_addr_addr3 or contactaddr_addr3

—

Third line of the contact's address.

—

contact_addr_addr4 or contactaddr_addr4

—

Fourth line of the contact's address.

—

contact_addr_city or contactaddr_city

—

Contact's city.

—

contact_addr_contact_id or contactaddr_contact_id

—

primary_contact_id

The internal ID of the contact [Contact] associated with the primary contact's address.

—

contact_addr_country or contactaddr_country

—

Contact's country.

—

contact_addr_email or contactaddr_email

—

Contact's email address.

—

contact_addr_fax or contactaddr_fax

—

Contact's fax number.

—

contact_addr_first or contactaddr_first

—

Contact's first name.

—

contact_addr_id or contactaddr_id

—

The internal ID of the associated contact address [Address].

—

contact_addr_last or contactaddr_last

—

Contact's last name.

—

contact_addr_middle or contactaddr_middle

—

Contact's middle name.

—

contact_addr_mobile or contactaddr_mobile

—

Contact's mobile phone number.

—

contact_addr_phone or contactaddr_phone

—

Contact's phone number.

—

contact_addr_salutation or contactaddr_salutation

—

Contact's salutation.

—

contact_addr_state or contactaddr_state

—

Contact's state.

—

contact_addr_zip or contactaddr_zip

—

Contact's zip code.

cost_centerid

costCenterId

cost_center_id

The internal ID of the cost center [Costcenter] associated with the customer.

created

[Read-only] The date and time when the customer record was created. See Date Fields.

createtime

created

—

[Read-only] Same as the created field (for legacy systems).

credit_invoice_layout_id

creditInvoiceLayoutId

credit_invoice_layout_id

The internal ID of the credit memo (negative invoice) layout [InvoiceLayout] associated with the customer.

currency

Currency for the money fields in the record. Also the default currency when an invoice is created.

customer_locationid

customerLocationId

customer_location_id

The internal ID of the customer location [CustomerLocation] associated with the customer.

externalid

externalId

external_id

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

filterset_ids

—

Comma delimited list of internal IDs of filter sets [Filterset] that this object belongs to.

hear_aboutid

customerSourceId

hear_about_id

The internal ID of the customer source associated with the customer.

hierarchy_node_ids

—

Comma delimited list of internal IDs of hierarchy nodes [HierarchyNode] this object belongs to.

id

[Read-only] The unique internal identifier of the customer. Automatically assigned by SuiteProjects Pro.

—

invoiceEmailText

invoice_email_text

The text to include in the body of invoice Email messages to the customer.

invoice_layoutid

invoiceLayoutId

invoice_layout_id

The internal ID of the invoice layout [InvoiceLayout] associated with the customer.

invoice_prefix

invoicePrefix

invoice_prefix

The invoice number prefix for all invoices to the customer.

invoice_text

invoiceText

invoice_text

The text to include on every invoice to the customer.

name

[Required] The nickname used for display in popup windows and lists.

notes

Notes about the customer.

picklist_label

—

Label as shown on form picklist.

primary_contactid

primaryContactId

primary_contact_id

The internal ID of the customer's primary contact [Contact].

rate

The hourly billing rate for time billed to the customer.

shipping_contactid

shippingContactId

shipping_contact_id

The internal ID of the customer's shipping contact [Contact].

sold_to_contactid

soldToContactId

sold_to_contact_id

The internal ID of the customer's sold to contact [Contact].

statements

A 1/0 field indicating if the customer can view statements.

—

syncWorkspace

sync_workspace

A 1/0 field indicating whether to keep customer resources in sync with linked workspace members.

ta_include

—

A 1/0 field indicating whether a Timesheet filterset is applied.

tb_approvalprocess

invoiceApprovalProcess

tb_approvalprocess

The internal ID of approval process [ApprovalProcess] for invoices to the customer. Mutually exclusive with tb_approver (XML and SOAP API) or invoiceApproverbookingRequestApprover (REST API).

tb_approver

invoiceApprover

tb_approver

The internal ID of the User who approves invoices to the customer, if a single approver process is used. Mutually exclusive with tb_approvalprocess (XML and SOAP API) or invoiceApprovalProcess (REST API).

Other possible values:

-1 — the invoice owner’s manager.
-2 — the manager of the invoice owner’s manager.
-5 — the customer owner.

te_include

—

A 1/0 field indicating whether an Expense Report filterset is applied.

terms

Standard payment terms for the customer. Textual description like "Net 30". Defaults to the default payment terms if not set when adding a new object.

territoryid

territoryId

territory_id

The internal ID of the territory associated with the customer.

type

A C/P field indicating whether the customer is Customer [C] or a Prospect [P]. Defaults to C if not set when adding a customer.

updated

[Read-only] The date and time when the customer record was last updated or modified. See Date Fields.

updatetime

updated

[Read-only] Same as the updated field (for legacy systems). See Date Fields.

userid

userId

user_id

The internal ID of the User who owns this customer (customer owner).

web

The customer's web address.

Usage Guidelines

Review the following notes and guidelines:

To work with information about both customers and prospects using the XML API, use the CustomerProspect object.
When adding a Customer object, the primary filter set for the authenticated user is updated automatically to allow access to the newly added customer.
You cannot delete a Customer object if this object is referenced by an object of any of the following type. Delete any dependent objects first before you delete a Customer object.
- bulk_payment
- Invoice
- Payment
- Project
- Proposal
- Proposalblock
- Slip
- Task
- Ticket