Employee

Property NameProperty ValueProperty Description
FirstNameStringFirst name. Max Length=80. Is required.
LastNameStringLast name. Max Length=176. Is required.
DisplayAsStringDisplayable name. Max Length=256. Is required.
Role{Role entity reference}Role. Is required.
AccessToAllWorkZonesBooleanTrue means Technician has access to all work zones and thus his Team, Portfolio and direct Work Zone scope are irrelevant for determining list of accessible work zones.
LanguageIdIntegerPreferred language
ActorTypeIdActorType enumeration memberShould be ActorType.Employee. Is required.
UsernameStringUser ID. Max Length=256. Is required.
DtPwdChangeDateTimeDate (no time part) when password was set/changed last time; based on server time. This value is used by code enforcing password policies.
ProviderInvitedOnDateTime or NULLDate (no time part) when Provider was invited to WON (Work Order Network) last time. This field is not used by Technicians.
InstructionsStringSpecial instructions. Max Length=3072.
WonMemberIdIntegerWON (Work Order Network) member ID; non-zero indicates connected Providers. This field is not used by Technicians.
WonLocationIdIntegerWON (Work Order Network) location ID;
WonServiceRadiusIntegerService radius in miles or kilometers, depending on WonRadiusType value. Is required.
IsElectronicPaymentBooleanTrue means Provider prefers electronic payments. This field is not used by Technicians.
ProviderStatusIdEmployeeWonStatus enumeration memberWON (Work Order Network) status. This field is computed automatically in response to modifications for certain fields.
LabelIdIntegerUser-defined Provider label. This field is not used by Technicians.
FreeTextAllowedBooleanTrue means Provider can enter free-text entries (i.e. not based on price list imposed by requestor) when preparing invoices. This field is not used by Technicians.
RadiusUnitDistanceUnit enumeration memberStores units for service radius. Supported values are kilometers and miles.
PasswordStringUser's password for login. Max Length=64. Is required.
NumberStringNumber (often used as integration key). Max Length=64.
JobTitleStringJob Title. Max Length=256.
FederalIdStringFederal ID#. Used for tax purposes. Max Length=64.
ExternalIdStringUsed by Providers. Max Length=64.
ForcePasswordResetBooleanTrue means Technician must reset his password upon login. This field is not used by Providers.
TaxWarnOnlyBooleanTax Warn Only
DefaultPriceList{PriceList entity reference}Default Price List
PriceLists[{LinkProviderPriceList entity reference}, ...]Price Lists
CustomFields[{CustomField2 entity reference}, ...]Custom Fields
Organization{Organization entity reference}Organization Bridge
BillAtZeroBooleanBill At Zero
IsSupplierBooleanIs Supplier [Obsolete("Disabled for writing since 9.6su1")]
ProviderTypeIdProviderlType enumeration memberProviderTypeId (tied with Is Supplier for backward compatibility)
ContactAddresses[{ContactInfo entity reference}, ...]Contact Addresses
Certifications[{UserCertification entity reference}, ...]Certifications
Address{Address2 entity reference}Address
Teams[{LinkUserAndTeam entity reference}, ...]Teams
WorkZones[{LinkUserAndWorkZone entity reference}, ...]Work Zones
Portfolios[{LinkUserAndPortfolio entity reference}, ...]Portfolios
CustomerGroups[{LinkUserAndCustomerGroup entity reference}, ...]Customer Groups
Specialties[{LinkUserAndSpecialty entity reference}, ...]Specialties
PayRates[{UserPayRate entity reference}, ...]Pay Rates
StockLocations[{LinkUserAndStockLocation entity reference}, ...]Stock Locations
Services[{LinkProviderAndService entity reference}, ...]Services
AlertSubscriptions[{AlertSubscription entity reference}, ...]Alert Subscriptions
TaxExemptBooleanTaxExempt
LimitAssignmentByPortfolioIdInteger
PriceListIntegrationStatusPriceListIntegrationStatus enumeration memberPriceListIntegrationStatus
PriceListIntegrationEnabledBoolean or NULLPriceListIntegrationEnabled
PriceListIntegrationDateDateTime or NULLLast sync date for specific company
StartAddress{Address2 entity reference}StartAddress. This value comes from StartLocation property.
ShiftHours[{EmpShiftHours entity reference}, ...]
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.
Properties[{PropertyTreeNode object reference}, ...]List of filled properties
LimitMultipleEntitiesNumberBehaviourBooleanReturn exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API