Area (OperationalUnit)

Operational Units are called Areas in the Deputy UI

Data Element

Data Type

What is it

Mandatory

Id

Integer

The unique id for the record

No

Company

Integer

The id of the location the area is associated with

Yes

WorkType

VarChar

Different types of work for the location

No

Parent

Integer

The id of a parent area. This is only available in Enterprise

No

OperationalUnitName

VarChar

The name of the area

Yes

Active

Boolean True/False

Whether the area is active

No

PayrollExportName

VarChar

Export code to match external payroll system for timesheets

No

Address

Integer

The address object linked to the area. Can be used if a physical location exists for the area

No

Contact

Integer

The id for the contact record which stores contact details for this area.

No

RosterSortOrder

Integer

Defines the order in which areas are listed within a location

No

ShowOnRoster

Boolean True/False

Determines whether the area shows on the shift. Enterprise only

No

Colour

VarChar

Defines a colour for the area on schedules/rosters

No

OperationalUnitType

Integer

0 = Area without geographical location defined
1 = Area with geographical location defined

No

Creator

Integer

The id of the user that created the record

No

Created

DateTime

The time the record was originally created

No

Modified

DateTime

The last time the record was modified

No

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