Customers

accountingCode

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

string

—

Yes

—

address1

First line of the customer's address.

string

—

Yes

Yes

address2

Second line of the customer's address.

string

—

Yes

Yes

address3

Third line of the customer's address.

string

—

Yes

Yes

address4

Fourth line of the customer's address.

string

—

Yes

Yes

billingCode

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

string

—

Yes

Yes

billingContactId

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

integer($int64)

—

Yes

Yes

businessTypeId

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

integer($int64)

—

Yes

Yes

city

The customer's city.

string

—

Yes

Yes

company

[Required] The company name.

string

—

Yes

Yes

companySizeId

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

integer($int64)

—

Yes

Yes

costCenterId

The internal ID of the cost center associated with the customer.

integer($int64)

—

Yes

Yes

country

The customer's country.

string

—

Yes

Yes

created

The date and time when the customer record was created.

string($date-time)

Yes

Yes

—

creditInvoiceLayoutId

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

integer($int64)

—

Yes

Yes

currency

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

string

—

Yes

—

customerLocationId

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

integer($int64)

—

Yes

Yes

email

The customer's Email address.

string

—

Yes

Yes

externalId

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

string

—

Yes

Yes

fax

The customer's fax number.

string

—

Yes

Yes

customerSourceId

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

integer($int64)

—

Yes

Yes

id

The unique internal identifier of the customer.

integer($int64)

Yes

Yes

Yes

invoiceApprovalProcess

The internal ID of approval process for invoices to the customer. Mutually exclusive with invoiceApprover.

integer($int64)

—

Yes

—

invoiceApprover

The internal ID of the User who approves invoices to the customer, if a single approver process is used. Mutually exclusive with invoiceApprovalProcess.

Other possible values:

• -1 — the invoice owner’s manager.

• -2 — the manager of the invoice owner’s manager.

• -5 — the customer owner.

integer($int64)

—

Yes

—

invoiceEmailText

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

string

—

Yes

—

invoiceLayoutId

The internal ID of the invoice layout associated with the customer.

integer($int64)

—

Yes

Yes

invoicePrefix

The invoice number prefix for all invoices to the customer.

string

—

Yes

—

invoiceText

The text to include on every invoice to the customer.

string

—

Yes

—

isActive

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

boolean

—

Yes

Yes

name

[Required] The customer's nickname. This is the display name for the customer in popup windows and lists.

string

—

Yes

Yes

notes

Notes about the customer.

string

—

Yes

—

phone

The customer's phone number.

string

—

Yes

Yes

primaryContactId

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

integer($int64)

—

Yes

Yes

rate

The hourly billing rate for time billed to the customer.

number($float)

—

Yes

—

shippingContactId

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

integer($int64)

—

Yes

Yes

soldToContactId

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

integer($int64)

—

Yes

Yes

state

The customer's state or region.

string

—

Yes

Yes

statements

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

boolean

—

Yes

—

syncWorkspace

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

boolean

—

Yes

—

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.

string

—

Yes

—

territoryId

The internal ID of the territory associated with the customer.

integer($int64)

—

Yes

Yes

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.

string

—

Yes

Yes

updated

The date and time when the customer record was last updated or modified.

string($date-time)

Yes

Yes

—

userId

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

integer($int64)

—

Yes

Yes

web

The customer's web address.

string

—

Yes

Yes

zip

The customer's ZIP code or postal code.

string

—

Yes

Yes