Corrigo: Employee schemas
1 Corrigo schema with complete fields and constraints.
← Employee operations · All schemas
Create employee — request body — body entity
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | integer | Optional | Format: int32 |
isNew | boolean | Optional | Read only: true |
limitMultipleEntitiesNumberBehaviour | boolean | Optional | |
performDeletion | boolean | Optional | |
properties | JSON | Optional | |
properties (anyOf 1) | array | Alternative | |
properties (anyOf 1)[] | JSON | Each item | |
properties (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo PropertyTreeNode. |
properties (anyOf 1)[] (anyOf 2) | null | Alternative | |
properties (anyOf 2) | null | Alternative | |
concurrencyId | integer | Optional | Format: int32 |
isRemoved | boolean | Optional | |
accessToAllWorkZones | boolean | Optional | |
actorTypeId | Model | Optional | Expand Create actor — request body — body entity type Id |
address | JSON | Optional | |
address (anyOf 1) | object | Alternative | A Corrigo Address2. |
address (anyOf 2) | null | Alternative | |
alertSubscriptions | JSON | Optional | |
alertSubscriptions (anyOf 1) | array | Alternative | |
alertSubscriptions (anyOf 1)[] | JSON | Each item | |
alertSubscriptions (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo AlertSubscription. |
alertSubscriptions (anyOf 1)[] (anyOf 2) | null | Alternative | |
alertSubscriptions (anyOf 2) | null | Alternative | |
billAtZero | boolean | Optional | |
certifications | JSON | Optional | |
certifications (anyOf 1) | array | Alternative | |
certifications (anyOf 1)[] | JSON | Each item | |
certifications (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo UserCertification. |
certifications (anyOf 1)[] (anyOf 2) | null | Alternative | |
certifications (anyOf 2) | null | Alternative | |
contactAddresses | JSON | Optional | |
contactAddresses (anyOf 1) | array | Alternative | |
contactAddresses (anyOf 1)[] | JSON | Each item | |
contactAddresses (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo ContactInfo. |
contactAddresses (anyOf 1)[] (anyOf 2) | null | Alternative | |
contactAddresses (anyOf 2) | null | Alternative | |
customFields | JSON | Optional | |
customFields (anyOf 1) | array | Alternative | |
customFields (anyOf 1)[] | JSON | Each item | |
customFields (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo CustomField2. |
customFields (anyOf 1)[] (anyOf 2) | null | Alternative | |
customFields (anyOf 2) | null | Alternative | |
customerGroups | JSON | Optional | |
customerGroups (anyOf 1) | array | Alternative | |
customerGroups (anyOf 1)[] | JSON | Each item | |
customerGroups (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo LinkUserAndCustomerGroup. |
customerGroups (anyOf 1)[] (anyOf 2) | null | Alternative | |
customerGroups (anyOf 2) | null | Alternative | |
defaultPriceList | JSON | Optional | |
defaultPriceList (anyOf 1) | object | Alternative | A Corrigo PriceList. |
defaultPriceList (anyOf 2) | null | Alternative | |
displayAs | JSON | Optional | |
displayAs (anyOf 1) | string | Alternative | |
displayAs (anyOf 2) | null | Alternative | |
dtPwdChange | string | Optional | Format: date-time |
externalId | JSON | Optional | |
externalId (anyOf 1) | string | Alternative | |
externalId (anyOf 2) | null | Alternative | |
federalId | JSON | Optional | |
federalId (anyOf 1) | string | Alternative | |
federalId (anyOf 2) | null | Alternative | |
firstName | JSON | Optional | |
firstName (anyOf 1) | string | Alternative | |
firstName (anyOf 2) | null | Alternative | |
forcePasswordReset | boolean | Optional | |
freeTextAllowed | boolean | Optional | |
instructions | JSON | Optional | |
instructions (anyOf 1) | string | Alternative | |
instructions (anyOf 2) | null | Alternative | |
isElectronicPayment | boolean | Optional | |
isSupplier | boolean | Optional | |
jobTitle | JSON | Optional | |
jobTitle (anyOf 1) | string | Alternative | |
jobTitle (anyOf 2) | null | Alternative | |
labelId | integer | Optional | Format: int32 |
languageId | integer | Optional | Format: int32 |
lastName | JSON | Optional | |
lastName (anyOf 1) | string | Alternative | |
lastName (anyOf 2) | null | Alternative | |
limitAssignmentByPortfolioId | integer | Optional | Format: int32 |
number | JSON | Optional | |
number (anyOf 1) | string | Alternative | |
number (anyOf 2) | null | Alternative | |
organization | JSON | Optional | |
organization (anyOf 1) | object | Alternative | A Corrigo Organization. |
organization (anyOf 2) | null | Alternative | |
password | JSON | Optional | |
password (anyOf 1) | string | Alternative | |
password (anyOf 2) | null | Alternative | |
payRates | JSON | Optional | |
payRates (anyOf 1) | array | Alternative | |
payRates (anyOf 1)[] | JSON | Each item | |
payRates (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo UserPayRate. |
payRates (anyOf 1)[] (anyOf 2) | null | Alternative | |
payRates (anyOf 2) | null | Alternative | |
portfolios | JSON | Optional | |
portfolios (anyOf 1) | array | Alternative | |
portfolios (anyOf 1)[] | JSON | Each item | |
portfolios (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo LinkUserAndPortfolio. |
portfolios (anyOf 1)[] (anyOf 2) | null | Alternative | |
portfolios (anyOf 2) | null | Alternative | |
priceListIntegrationDate | JSON | Optional | |
priceListIntegrationDate (anyOf 1) | string | Alternative | Format: date-time |
priceListIntegrationDate (anyOf 2) | null | Alternative | |
priceListIntegrationEnabled | JSON | Optional | |
priceListIntegrationEnabled (anyOf 1) | boolean | Alternative | |
priceListIntegrationEnabled (anyOf 2) | null | Alternative | |
priceListIntegrationStatus | string | Optional | One of: Disabled, Enabled Format: int32 |
priceLists | JSON | Optional | |
priceLists (anyOf 1) | array | Alternative | |
priceLists (anyOf 1)[] | JSON | Each item | |
priceLists (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo LinkProviderPriceList. |
priceLists (anyOf 1)[] (anyOf 2) | null | Alternative | |
priceLists (anyOf 2) | null | Alternative | |
providerInvitedOn | JSON | Optional | |
providerInvitedOn (anyOf 1) | string | Alternative | Format: date-time |
providerInvitedOn (anyOf 2) | null | Alternative | |
providerStatusId | string | Optional | One of: NA, NotConnected, Suspended, Connected, Invited Format: int32 |
providerTypeId | string | Optional | One of: Regular, Supplier, Landlord Format: int32 |
radiusUnit | string | Optional | One of: Unknown, Kilometer, Mile Format: int32 |
role | JSON | Optional | |
role (anyOf 1) | object | Alternative | A Corrigo Role. |
role (anyOf 2) | null | Alternative | |
services | JSON | Optional | |
services (anyOf 1) | array | Alternative | |
services (anyOf 1)[] | JSON | Each item | |
services (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo LinkProviderAndService. |
services (anyOf 1)[] (anyOf 2) | null | Alternative | |
services (anyOf 2) | null | Alternative | |
shiftHours | JSON | Optional | |
shiftHours (anyOf 1) | array | Alternative | |
shiftHours (anyOf 1)[] | JSON | Each item | |
shiftHours (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo EmpShiftHours. |
shiftHours (anyOf 1)[] (anyOf 2) | null | Alternative | |
shiftHours (anyOf 2) | null | Alternative | |
specialties | JSON | Optional | |
specialties (anyOf 1) | array | Alternative | |
specialties (anyOf 1)[] | JSON | Each item | |
specialties (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo LinkUserAndSpecialty. |
specialties (anyOf 1)[] (anyOf 2) | null | Alternative | |
specialties (anyOf 2) | null | Alternative | |
startAddress | JSON | Optional | |
startAddress (anyOf 1) | object | Alternative | A Corrigo Address2. |
startAddress (anyOf 2) | null | Alternative | |
stockLocations | JSON | Optional | |
stockLocations (anyOf 1) | array | Alternative | |
stockLocations (anyOf 1)[] | JSON | Each item | |
stockLocations (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo LinkUserAndStockLocation. |
stockLocations (anyOf 1)[] (anyOf 2) | null | Alternative | |
stockLocations (anyOf 2) | null | Alternative | |
taxExempt | boolean | Optional | |
taxWarnOnly | boolean | Optional | |
teams | JSON | Optional | |
teams (anyOf 1) | array | Alternative | |
teams (anyOf 1)[] | JSON | Each item | |
teams (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo LinkUserAndTeam. |
teams (anyOf 1)[] (anyOf 2) | null | Alternative | |
teams (anyOf 2) | null | Alternative | |
username | JSON | Optional | |
username (anyOf 1) | string | Alternative | |
username (anyOf 2) | null | Alternative | |
wonLocationId | integer | Optional | Format: int32 |
wonMemberId | integer | Optional | Format: int32 |
wonServiceRadius | integer | Optional | Format: int32 |
workZones | JSON | Optional | |
workZones (anyOf 1) | array | Alternative | |
workZones (anyOf 1)[] | JSON | Each item | |
workZones (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo LinkUserAndWorkZone. |
workZones (anyOf 1)[] (anyOf 2) | null | Alternative | |
workZones (anyOf 2) | null | Alternative |
Referenced models: Create actor — request body — body entity type Id