Users

accountingCode

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

string

—

Yes

—

address1

First line of the user's address.

string

—

Yes

Yes

address2

Second line of the user's address.

string

—

Yes

Yes

address3

Third line of the user's address.

string

—

Yes

Yes

address4

Fourth line of the user's address.

string

—

Yes

Yes

attachments

The attachments associated with this user. Array of internal IDs for Attachment objects.

array

—

—

—

bccSelf

A 1/0 field indicating whether the user should be blind copied (Bcc) into emails sent from SuiteProjects Pro.

boolean

—

Yes

Yes

bookingApprovalProcess

The internal ID of the approval process for bookings for the resource (user). Mutually exclusive with bookingApprover.

integer($int64)

—

Yes

—

bookingApprover

The internal ID of the User who approves bookings for the user (resource), if a single approver process is used. Mutually exclusive with bookingApprovalProcess.

Other possible values:

• -1 — the booked resource’s manager.

• -2 — the manager of the booked resource's manager.

• -4 — self (booked resource).

• -9 — submitter. This option may not be available depending on your SuiteProjects Pro account configuration.

integer($int64)

—

Yes

—

bookingRequestApprovalProcess

The internal ID of the approval process for booking requests for the user (requested resource) or for booking requests submitted by the user, depending on your SuiteProjects Pro account configuration. Mutually exclusive with bookingRequestApprover.

integer($int64)

—

Yes

—

bookingRequestApprover

The internal ID of the User who approves booking requests for the user (requested resource) or booking requests submitted by the user, depending on your SuiteProjects Pro account configuration, if a single approver process is used. Mutually exclusive with bookingApprovalProcess.

Other possible values:

• -1 — the requested resource or the requester's manager.

• -2 — the manager of the booked resource or requester's manager.

• -4 — self (booked resource or the requester).

• -9 — submitter (requester). This option may not be available depending on your SuiteProjects Pro account configuration.

integer($int64)

—

Yes

—

budgetApprovalProcess

The internal ID of the approval process for budgets submitted by the user. Mutually exclusive with budgetApprover.

integer($int64)

—

Yes

—

budgetApprover

The internal ID of the User who approves budgets submitted by the user (budget owner), if a single approver process is used. Mutually exclusive with budgetApprovalProcess.

Other possible values:

• -1 — the budget owner’s manager.

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

• -4 — self (budget owner).

integer($int64)

—

Yes

—

city

The user's city.

string

—

Yes

Yes

costCenterId

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

integer($int64)

—

Yes

Yes

country

The user's country.

string

—

Yes

Yes

created

The date and time when the user record was created.

string($date-time)

Yes

Yes

—

currency

The user's currency. Three-letter currency code.

string

—

Yes

—

customerId

The internal ID of the customer [Customer] associated with the user if the user is a guest user.

integer($int64)

—

Yes

Yes

dealBookingRequestApprovalProcess

The internal ID of the approval process for deal booking requests for the user (requested resource) or for deal booking requests submitted by the user, depending on your SuiteProjects Pro account configuration. Mutually exclusive with dealBookingRequestApprover.

integer($int64)

—

Yes

—

dealBookingRequestApprover

The internal ID of the User who approves deal booking requests for the user (requested resource) or deal booking requests submitted by the user, depending on your SuiteProjects Pro account configuration, if a single approver process is used. Mutually exclusive with dealBookingRequestApprovalProcess.

Other possible values:

• -1 — the requested resource or the requester's manager.

• -2 — the manager of the booked resource or the requester's manager.

• -4 — self (booked resource or the requester).

• -9 — submitter (requester). This option may not be available depending on your SuiteProjects Pro account configuration.

integer($int64)

—

Yes

—

defaultSamlSettingsName

Name of the identity provider profile used for service provider initiated SAML single sign-on.

string

—

Yes

Yes

departmentId

The internal ID of the department associated with the user.

integer($int64)

—

Yes

Yes

email

[Required] The user's Email address.

string

—

Yes

Yes

expenseAllowanceApprovalProcess

The internal ID of the approval process for allowance reports submitted by the user. Mutually exclusive with expenseAllowanceApprover.

integer($int64)

—

Yes

—

expenseAllowanceApprover

The internal ID of the User who approves allowance reports submitted by the user (allowance report owner), if a single approver process is used. Mutually exclusive with expenseAllowanceApprovalProcess.

Other possible values:

• -1 — the allowance report owner’s manager.

• -2 — the manager of the allowance report owner’s manager.

• -4 — self (allowance report owner).

integer($int64)

—

Yes

—

expenseApprovalProcess

The internal ID of the approval process for expense reports submitted by the user. Mutually exclusive with expenseApprover.

integer($int64)

—

Yes

—

expenseApprover

The internal ID of the User who approves expense reports submitted by the user (expense report owner), if a single approver process is used. Mutually exclusive with expenseApprovalProcess.

Other possible values:

• -1 — the expense report owner’s manager.

• -2 — the manager of the expense report owner’s manager.

• -4 — self (expense report owner).

integer($int64)

—

Yes

—

expenseAuthorizationApprovalProcess

The internal ID of the approval process for expense authorizations submitted by the user. Mutually exclusive with expenseAuthorizationApprover.

integer($int64)

—

Yes

—

expenseAuthorizationApprover

The internal ID of the User who approves expense authorizations submitted by the user (expense authorization owner), if a single approver process is used. Mutually exclusive with expenseAuthorizationApprovalProcess.

Other possible values:

• -1 — the expense authorization owner’s manager.

• -2 — the manager of the expense authorization owner’s manager.

• -4 — self (expense authorization owner).

integer($int64)

—

Yes

—

expensesFilterSet

The internal ID of the filter set override for the Expenses application (module).

integer($int64)

—

Yes

Yes

externalId

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

string

—

Yes

Yes

fax

The user's fax number.

string

—

Yes

Yes

firstName

The user's first name.

string

—

Yes

Yes

generic

A 1/0 field indicating whether this is a generic resource. Cannot be modified.

boolean

—

Yes

Yes

id

The unique internal identifier of the user.

integer($int64)

Yes

Yes

Yes

invoicesFilterSet

The internal ID of the filter set override for the Invoices application (module).

integer($int64)

—

Yes

Yes

isActive

A 1/0 field indicating if the user is designated as an active user.

boolean

—

Yes

Yes

isLocked

A 1/0 field indicating if the user is locked out of your company's SuiteProjects Pro account.

boolean

—

Yes

Yes

jobCodeId

The internal ID of the job code [JobCode] associated with the user.

integer($int64)

—

Yes

Yes

lastName

The user's last name.

string

—

Yes

Yes

lineManagerId

The internal ID of the user's line manager (internal ID of another User).

integer($int64)

—

Yes

Yes

mfaSetupDate

The deadline when the user must set up two-factor authentication (2FA) by.

string($date-time)

—

Yes

Yes

mfaStatus

The user's two-factor authentication (2FA) status. The property is read-only if two-factor authentication is not enabled for your company's SuiteProjects Pro account.

Possible values:

• 0 – 2FA is not required.

• 1 – 2FA is required and the user must set up 2FA.

• 2 – 2FA is required and the user has paired an authenticator app with SuiteProjects Pro.

• 7 – 2FA is required and the user has completed the 2FA setup.

integer($int64)

—

Yes

Yes

middleName

The user's middle name.

string

—

Yes

Yes

mobile

The user's mobile number.

string

—

Yes

Yes

myAccountFilterSet

The internal ID of the filter set override for the My Account application (module).

integer($int64)

—

Yes

Yes

name

The display name for the user in lists. This is generated automatically if not set.

string

—

Yes

Yes

nickname

[Required] The user's nickname. This must be unique.

string

—

Yes

Yes

opportuntiesFilterSet

The internal ID of the filter set override for the Opportunities application (module).

integer($int64)

—

Yes

Yes

passwordForcedChange

A 1/0 field indicating if the user must change password on next sign in.

boolean

—

Yes

Yes

payrollCode

The user's payroll code.

string

—

Yes

Yes

phone

The user's phone number.

string

—

Yes

Yes

primaryFilterSet

The internal ID of the user's primary filter set. Defaults to the default primary filter set if not set when adding a user.

integer($int64)

—

Yes

Yes

projectAccessNodes

Comma delimited list of hierarchy node internal IDs for project level access control.

string

—

Yes

Yes

projectsFilterSet

The internal ID of the filter set override for the Projects application (module).

integer($int64)

—

Yes

Yes

proposalApprovalProcess

The internal ID of the approval process for proposals submitted by the user. Mutually exclusive with proposalApprover.

integer($int64)

—

Yes

—

proposalApprover

The internal ID of the User who approves proposals submitted by the user (proposal owner), if a single approver process is used. Mutually exclusive with proposalApprovalProcess.

Other possible values:

• -1 — the proposal owner’s manager.

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

• -4 — self (proposal owner).

integer($int64)

—

Yes

—

purchaseOrderApprovalProcess

The internal ID of the approval process for purchase orders submitted by the user. Mutually exclusive with purchaseOrderApprover.

integer($int64)

—

Yes

—

purchaseOrderApprover

The internal ID of the User who approves purchase orders submitted by the user (purchase order owner), if a single approver process is used. Mutually exclusive with purchaseOrderApprovalProcess.

Other possible values:

• -1 — the purchase order owner’s manager.

• -2 — the manager of the purchase order owner’s manager.

• -4 — self (purchase order owner).

integer($int64)

—

Yes

—

purchaseRequestApprovalProcess

The internal ID of the approval process for purchase requests submitted by the user. Mutually exclusive with purchaseRequestApprover.

integer($int64)

—

Yes

—

purchaseRequestApprover

The internal ID of the User who approves purchase requests submitted by the user (purchase request owner), if a single approver process is used. Mutually exclusive with purchaseRequestApprovalProcess.

Other possible values:

• -1 — the purchase request owner’s manager.

• -2 — the manager of the purchase request owner’s manager.

• -4 — self (purchase request owner).

integer($int64)

—

Yes

—

purchasesFilterSet

The internal ID of the filter set override for the Purchases application (module).

integer($int64)

—

Yes

Yes

rate

The hourly billing rate for the user's time.

number($float)

—

Yes

—

reportsFilterSet

The internal ID of the filter set override for the Reports application (module).

integer($int64)

—

Yes

Yes

resourceProfileApprovalProcess

The internal ID of approval process for resource profile submitted by the user. Mutually exclusive with resourceProfileApprover.

integer($int64)

—

Yes

—

resourceProfileApprover

The internal ID of the User who approves resource profile items for the user, if a single approver process is used. Mutually exclusive with resourceProfileApprovalProcess.

Other possible values:

• -1 — the purchase order owner’s manager.

• -2 — the manager of the purchase order owner’s manager.

• -4 — self.

integer($int64)

—

Yes

—

resourcesFilterSet

The internal ID of the filter set override for the Resources application (module).

integer($int64)

—

Yes

Yes

roleId

The internal ID of the role associated with the user. Defaults to the default role if not set when adding a user.

integer($int64)

—

Yes

Yes

rpcApiUpdated

The date and time when the user's resource profile was last updated using SuiteProjects Pro API.

string($date-time)

—

Yes

Yes

rpcUpdatedBy

The internal ID of the User who last updated the user's resource profile.

integer($int64)

—

Yes

Yes

rpcUserUpdated

The date and time when the user's resource profile was last updated using SuiteProjects Pro UI.

string($date-time)

—

Yes

Yes

salutation

The user's salutation.

string

—

Yes

Yes

scheduleRequestApprovalProcess

The internal ID of approval process for schedule requests (time-off requests) submitted by the user. Mutually exclusive with scheduleRequestApprover.

integer($int64)

—

Yes

—

scheduleRequestApprover

The internal ID of the User who approves schedule requests (time-off requests) for the user (schedule request owner), if a single approver process is used. Mutually exclusive with scheduleRequestApprovalProcess.

Other possible values:

• -1 — the schedule request owner’s manager.

• -2 — the manager of the schedule request owner’s manager.

• -4 — self (schedule request owner).

integer($int64)

—

Yes

—

ssn

The user's social security number.

string

—

Yes

Yes

state

The user's state or region.

string

—

Yes

Yes

territoryId

The internal ID of the territory associated with the user

integer($int64)

—

Yes

Yes

timesheetApprovalProcess

The internal ID of the approval process for timesheets submitted by the user. Mutually exclusive with timesheetApprover.

integer($int64)

—

Yes

—

timesheetApprover

The internal ID of the User who approves timesheets submitted by the user (timesheet owner), if a single approver process is used. Mutually exclusive with timesheetApprovalProcess.

Other possible values:

• -1 — the timesheet owner’s manager.

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

• -4 — self (timesheet owner).

integer($int64)

—

Yes

—

timesheetsFilterSet

The internal ID of the filter set override for the Timesheets application (module).

integer($int64)

—

Yes

Yes

timezone

The user's timezone. Defaults to the time zone for the company's account if not set when adding a user.

string

—

Yes

Yes

updated

Date and time when the record was last updated or modified.

string($date-time)

Yes

Yes

—

userLocationId

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

integer($int64)

—

Yes

Yes

weekStarts

The first day of the week for the user:

• 0 – Monday

• 6 – Sunday

Defaults to the first day of the week for the company's account if not set when adding a user.

integer($int64)

—

Yes

Yes

workScheduleId

The internal ID of the user's work schedule.

integer($int64)

—

Yes

Yes

workspacesFilterSet

The internal ID of the filter set override for the Workspaces application (module).

integer($int64)

—

Yes

Yes

zip

The user's ZIP code or postal code.

string

—

Yes

Yes