When first integrating with Deputy, to assist with mapping between departments/divisions within an organisation you may be required to add new locations to Deputy. This is easily achieved using the Deputy API and in our Enterprise product you can even implement a structural hierarchy to better represent the overall organisation structure of your clients.

The process to add a new location is detailed below.

URL and Payload

URL

curl --location --request PUT 'https://{install}.{geo}.deputy.com/api/v1/supervise/company

Sample Payload

{
  "Code": "1234",
  "Active": true,
  "ParentCompany": 1,
  "CompanyName": "The Company Co",
  "TradingName": "Company Pty Ltd",
  "IsWorkplace": 1,
  "IsPayrollEntity": 1,
  "PayrollExportCode": "PAY123",
  "Address": "123 Jones St, Sydney, NSW, 2001",
}

This will create a new location in the Deputy install called The Company Co with payroll export code PAY123

Adding an area

For a location to become valid for timesheets to be generated from it, the location must have an area. In a scenario where in Enterprise you are using a location for top level hierarchy, an area is not required. When a user adds a location in Deputy via the UI, a default area is always added. This does not occur when adding locations via the API and so it is important to always remember to add an area if you need timesheets to be attributed to the location added

To add an area to a location in Deputy follow the below guide.

URL

curl --location --request PUT 'https://{install}.{geo}.deputy.com/api/v1/supervise/department

Sample Payload

{
    "intCompanyId": 381,
    "strOpunitName": "This is an area",
    "strAddress": "1 Smith Street, Sydney, Australia",
    "strExportName": "SmithStreet",
    "intOpunitType": 0
}

This will create a new area linked to an existing location in the Deputy install.