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 Element | Data Type | What is it | Mandatory |
|---|---|---|---|
| Id | Integer | The unique id of the record | No |
| Code | String | The export code for the location. | Yes |
| Active | Boolean True/False | Whether the location is currently active in the Deputy install or not | No |
| ParentCompany | Integer | The unique id of the locations parent location if it exists | No |
| CompanyName | VarChar | The name of the location | Yes |
| CompanyNumber | VarChar | An ID, number or code to map to another system. This doesn't display anywhere in the end user interface. | No |
| TradingName | VarChar | The trading name of the location | No |
| IsWorkplace | Boolean | If 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 |
| IsPayrollEntity | Boolean | Indicates whether the location is a pay center or not. If it is, the payroll export code field will be present in Deputy. | Yes |
| PayrollExportCode | VarChar | The payroll export code for the location | No |
| Address | Integer | The unique id of the address record associated with this location. | No |
| Contact | Integer | The unique id of the Deputy contact associated with this location | No |
| Creator | Integer | The unique id of the Deputy install employee who created the record | No |
| Created | DateTime | When the record was created in the Deputy install | No |
| Modified | DateTime | When the record was last modified in the Deputy install | No |
Foreign Objects which can be linked with the Resource API
ParentCompanyObject - Company
AddressObject - Address
ContactObject - Contact
Associated Objects
Updated over 1 year ago