Area (OperationalUnit)

Operational Units are called Areas in the Deputy UI

Data ElementData TypeWhat is itMandatory
IdIntegerThe unique id for the recordNo
CompanyIntegerThe id of the location the area is associated withYes
WorkTypeVarCharDifferent types of work for the locationNo
ParentIntegerThe id of a parent area. This is only available in EnterpriseNo
OperationalUnitNameVarCharThe name of the areaYes
ActiveBoolean True/FalseWhether the area is activeNo
PayrollExportNameVarCharExport code to match external payroll system for timesheetsNo
AddressIntegerThe address object linked to the area. Can be used if a physical location exists for the areaNo
ContactIntegerThe id for the contact record which stores contact details for this area.No
RosterSortOrderIntegerDefines the order in which areas are listed within a locationNo
ShowOnRosterBoolean True/FalseDetermines whether the area shows on the shift. Enterprise onlyNo
ColourVarCharDefines a colour for the area on schedules/rostersNo
OperationalUnitTypeInteger0 = Area without geographical location defined
1 = Area with geographical location defined
CreatorIntegerThe id of the user that created the recordNo
CreatedDateTimeThe time the record was originally createdNo
ModifiedDateTimeThe last time the record was modifiedNo

Foreign Objects which can be linked with the Resource API

CompanyObject - Company
ParentOperationalUnit - Operational Unit
AddressObject - Address
ContactObject - Contact
RosterActiveHoursScheduleObject - Schedule

Associated Object:

EmployeeSalaryOpunits - Employee Agreement
OperationalUnit - Event
ManagementEmployeeOperationalUnit - Employee
TrainingModule - Training
OperationUnitDeputecPayRulesesAsOperationUnit - Pay Rules
OperationUnitDeputecPublicHolidaiesAsOperationUnit - Public Holiday
RosterEmployeeOperationalUnit - Employee
TaskGroupOpUnit - Task Group Setup