Deputy Data Source

The Deputy connector enables you to ingest workforce management data—including employees, timesheets, schedules, leave requests, locations, and operational units—into Nexla data flows. Follow the instructions below to create a new data flow that ingests data from a Deputy source in Nexla.

Deputy

Create a New Data Flow

1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

2. Select the Deputy connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Deputy instance, and click Next; or, create a new Deputy credential for use in this flow.

3. In Nexla, Deputy data sources can be created using pre-built endpoint templates, which expedite source setup for common Deputy endpoints. Each template is designed specifically for the corresponding Deputy endpoint, making data source setup easy and efficient.
   • To configure this source using a template, follow the instructions in Configure Using a Template.

   Deputy sources can also be configured manually, allowing you to ingest data from Deputy endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
   • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Deputy endpoints. Each template is designed specifically for the corresponding Deputy endpoint, making data source setup easy and efficient.

Endpoint Settings

• Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

  List Employees

  This endpoint returns a list of all employees in the Deputy system, including profile, role, and employment details. Use it to sync employee records to HR systems, build headcount reports, or maintain a roster of your workforce.

  • Sends a GET request to /api/v1/supervise/employee on your Deputy instance URL.
  • Response data is extracted from $.data[*]. Each record contains employee name, contact information, employment type, position, and location assignments.

  The Deputy API base URL is specific to your installation: https://{installname}.{geo}.deputy.com. Ensure your credential is configured with the correct base URL for your Deputy account.

  Employees

  This endpoint returns a list of all employees in the Deputy system via the resource API path. Use it as an alternative to the supervise endpoint when you need to access the full Employee resource schema with all available fields.

  • Sends a GET request to /api/v1/resource/Employee.
  • Response data is extracted from $.data[*]. Each record represents an employee resource object in the Deputy system.

  List Locations

  This endpoint returns a list of all company locations (sites) configured in Deputy. Use it to build location reference datasets, analyze staffing across sites, or synchronize location data with other systems.

  • Sends a GET request to /api/v1/resource/Company.
  • Response data is extracted from $.data[*]. Each record contains the location name, address, timezone, and operational status.

  List Departments

  This endpoint returns a list of all operational units (departments or areas) in the Deputy organization. Use it to build department hierarchies, map staffing to cost centers, or synchronize org structure data.

  • Sends a GET request to /api/v1/resource/OperationalUnit.
  • Response data is extracted from $.data[*]. Each record contains the operational unit name, parent company, and associated employee data.

  List My Timesheets

  This endpoint returns a list of timesheets for the currently authenticated user. Use it to retrieve the logged-in user's time records for payroll verification, self-service reporting, or integration with personal productivity tools.

  • Sends a GET request to /api/v1/my/timesheets.
  • Response data is extracted from $.data[*]. Each record contains shift start/end times, break duration, approved status, and the associated location and department.

  This endpoint returns data scoped to the authenticated user's credentials. To retrieve timesheets for all employees, use the /api/v1/resource/Timesheet endpoint in manual configuration.

  List My Tasks

  This endpoint returns a list of tasks assigned to the currently authenticated user in Deputy. Use it to retrieve pending work items for the logged-in user.

  • Sends a GET request to /api/v1/my/tasks.
  • Response data is extracted from $.data[*]. Each record contains the task description, due date, and completion status.

  List News Feed

  This endpoint returns memos and news items from the authenticated user's Deputy news feed. Use it to extract internal communications or announcements posted to the Deputy platform.

  • Sends a GET request to /api/v1/my/memo.
  • Response data is extracted from $.data[*]. Each record contains the memo subject, content, author, and publication date.

  List Awards Library

  This endpoint returns a list of all awards available in the Deputy payroll awards library. Use it to retrieve pay rate definitions and award configurations for payroll analysis or compliance documentation.

  • Sends a GET request to /api/v1/payroll/listAwardsLibrary.
  • Response data is extracted from $.data[*]. Each record contains award name, pay type, rate multipliers, and applicable conditions.

  List Addresses

  This endpoint returns a list of all addresses stored in the Deputy system. Use it to retrieve address records associated with employees, locations, or contacts for data quality audits or address standardization workflows.

  • Sends a GET request to /api/v1/resource/Address.
  • Response data is extracted from $.data[*]. Each record contains street, city, state, postcode, and country fields.

  List Categories

  This endpoint returns a list of all categories defined in the Deputy system. Use it to retrieve category reference data for classification, reporting, or mapping purposes.

  • Sends a GET request to /api/v1/resource/Category.
  • Response data is extracted from $.data[*].

  List Comments

  This endpoint returns a list of all comments recorded in the Deputy system. Use it to retrieve annotation and note data associated with schedules, timesheets, or other Deputy objects.

  • Sends a GET request to /api/v1/resource/Comment.
  • Response data is extracted from $.data[*]. Each record contains the comment text, the object it is attached to, and the author.

  List Company Periods

  This endpoint returns a list of all company periods (pay periods or reporting periods) in the Deputy system. Use it to retrieve period definitions for payroll processing, reporting alignment, or period-based data segmentation.

  • Sends a GET request to /api/v1/resource/CompanyPeriod.
  • Response data is extracted from $.data[*]. Each record contains the period start/end dates, associated company, and period type.

  List Employee Agreements

  This endpoint returns a list of all employee agreements in the Deputy system, including employment contract details and pay rate configurations. Use it to audit employment terms, support payroll compliance, or synchronize agreement data with HRIS systems.

  • Sends a GET request to /api/v1/resource/EmployeeAgreement.
  • Response data is extracted from $.data[*]. Each record contains the employee ID, agreement type, pay rate, employment type, and effective dates.

Endpoint Testing

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

• To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

• If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually

Deputy sources can also be manually configured to ingest data from any valid Deputy API endpoint. The Deputy REST API base URL follows the pattern https://{installname}.{geo}.deputy.com/api/v1. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates — including using chained API calls to fetch data from multiple endpoints or applying custom request parameters.

API Method

1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

2. Select the method that will be used for calls to the Deputy API from the Method pulldown menu. The most common methods are:

   • GET: For retrieving data from the Deputy API (most common for data ingestion)
   • POST: For triggering queries or actions that return data

The Deputy API is a RESTful JSON API. Most data retrieval operations use GET requests. For complete information about available endpoints and their HTTP methods, refer to the Deputy API documentation.

API Endpoint URL

3. Enter the URL of the Deputy API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters.

   Common Deputy API endpoints include:

   • Employees: https://{installname}.{geo}.deputy.com/api/v1/resource/Employee
   • Timesheets: https://{installname}.{geo}.deputy.com/api/v1/resource/Timesheet
   • Rosters (Schedules): https://{installname}.{geo}.deputy.com/api/v1/resource/Roster
   • Leave Requests: https://{installname}.{geo}.deputy.com/api/v1/resource/Leave
   • Locations: https://{installname}.{geo}.deputy.com/api/v1/resource/Company
   • Operational Units (Areas): https://{installname}.{geo}.deputy.com/api/v1/resource/OperationalUnit

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. For a full list of Deputy resources and endpoint patterns, refer to the Deputy API reference documentation.

Date/Time Macros (API URL)

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements.

Date/time macros are particularly useful for Deputy data sources that retrieve timesheets, rosters, or leave requests for a specific date range. For example, you can configure a source to automatically retrieve timesheets for the current day or the previous week.

1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

   • {now} – The current datetime
   • {now-1} – The datetime one time unit before the current datetime
   • {now+1} – The datetime one time unit after the current datetime
   • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.

Lookup-based macros are useful for Deputy sources when you need to create API endpoints that reference specific Deputy resource IDs—such as employee IDs, location IDs, or operational unit IDs—from other data sources in your Nexla environment.

1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data

Optional

If only a subset of the data that will be returned by API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful when API responses contain metadata, pagination information, or other data that you don't need for your analysis.

For example, when a request call is used to fetch a list of items, the API will typically return an array of records, along with metadata, in the response. By entering the path to the relevant data, you can configure Nexla to treat each element of the returned array as a record.

Path to Data is essential when Deputy API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records. Deputy resource endpoint responses typically return arrays of objects directly, which may not require a path, but paginated or filtered queries may return data nested under a key.

• To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

  • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.data.items[*] to access an array of items within a data object).

  • For responses in XML format, enter the XPath that points to the object/array containing relevant data. XPath uses slash notation (e.g., /response/data/item to access item elements within a data element).

  Path to Data Example:

  If the API response is in JSON format and includes a top-level array named data that contains the relevant data, the path to the response would be entered as $.data[*].

Autogenerate Path Suggestions

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

• To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

• Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

  

Metadata

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful when you want to preserve important contextual information that applies to all records but isn't part of the main data array.

For example, when a request call is used to fetch a list of Deputy timesheets, the API response may include pagination details or request context alongside the array of timesheet records. Specifying a path to this metadata allows you to include it with each record in the generated Nexset(s).

Metadata paths are particularly useful for preserving Deputy API response context like request IDs, timestamps, or summary statistics that apply to all records in the response.

• To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

  • For responses in JSON format, enter the JSON path to the object or array that contains the metadata, and for responses in XML format, enter the XPath.

Request Headers

Optional

• If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers are often required for API versioning, content type specifications, or custom authentication requirements.

  You do not need to include any headers already present in the credentials. The Deputy API uses Bearer token authentication, which is handled automatically by Nexla based on your credential configuration.

Endpoint Testing

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

• To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

• If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source

1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Deputy data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.