Location (Company)

A location in Deputy is referred to as a Company in the API. A location can be a physical building (for example a retail store) or something different, such as a delivery truck or it might even be something like a website. Locations are where employees are assigned work.

Data ElementData TypeWhat is itMandatory
IdIntegerThe unique id of the recordNo
CodeStringThe export code for the location.Yes
ActiveBoolean True/FalseWhether the location is currently active in the Deputy install or notNo
ParentCompanyIntegerThe unique id of the locations parent location if it existsNo
CompanyNameVarCharThe name of the locationYes
CompanyNumberVarCharAn ID, number or code to map to another system. This doesn't display anywhere in the end user interface.No
TradingNameVarCharThe trading name of the locationNo
IsWorkplaceBooleanIf the location is a workplace it can have parent locations and will be set to 1. If not, it can only be for grouping and will be 0.Yes
IsPayrollEntityBooleanIndicates whether the location is a pay center or not. If it is, the payroll export code field will be present in Deputy.Yes
PayrollExportCodeVarCharThe payroll export code for the locationNo
AddressIntegerThe unique id of the address record associated with this location.No
ContactIntegerThe unique id of the Deputy contact associated with this locationNo
CreatorIntegerThe unique id of the Deputy install employee who created the recordNo
CreatedDateTimeWhen the record was created in the Deputy installNo
ModifiedDateTimeWhen the record was last modified in the Deputy installNo

Foreign Objects which can be linked with the Resource API

ParentCompanyObject - Company
AddressObject - Address
ContactObject - Contact

Associated Objects

Team - Team
Memo - Memo