Skip to main content

Paycor Data Source

The Paycor connector enables you to access Paycor API endpoints to retrieve employee data, payroll information, time and attendance records, and other HR-related data. This connector is particularly useful for applications that need to extract HR data, integrate payroll information with other systems, analyze workforce data, or build HR analytics and reporting solutions. Follow the instructions below to create a new data flow that ingests data from a Paycor source in Nexla.
paycor_api.png

Paycor

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 Paycor connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Paycor API, and click Next; or, create a new Paycor credential for use in this flow.

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

    Paycor sources can also be configured manually, allowing you to ingest data from Paycor API 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 Paycor API endpoints. Each template is designed specifically for the corresponding Paycor API 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.

    Get Employees

    This endpoint retrieves employee records from your Paycor legal entity. Use this endpoint when you need to extract employee data, analyze workforce information, or integrate employee records with other systems.

    • Optionally, specify additional fields to include in the response in the Include Fields field. This can be a comma-separated list of field names to include additional employee data.
    • This endpoint uses pagination with continuationToken to handle large datasets efficiently. The endpoint automatically fetches additional pages using the continuationToken from the response.

    The Get Employees endpoint uses GET requests with pagination through continuationToken. The endpoint automatically fetches additional pages using the continuationToken from the response metadata, ensuring all employee records are retrieved. For more information about the Get Employees endpoint, refer to the Paycor API Documentation.

    Get Employee by ID

    This endpoint retrieves a specific employee's details using their Employee ID. Use this endpoint when you need to get detailed information about a specific employee, retrieve employee profiles, or fetch employee data by identifier.

    • Enter the Employee ID in the Employee ID field. This is the unique identifier for the employee you want to retrieve.
    • Optionally, specify additional fields to include in the response in the Include Fields field. This can be a comma-separated list of field names to include additional employee data.

    The Get Employee by ID endpoint uses GET requests to retrieve detailed employee information from the Paycor API. The endpoint returns comprehensive employee data including personal information, employment details, and other employee attributes. For more information about the Get Employee by ID endpoint, refer to the Paycor API Documentation.

    Get Payroll Data

    This endpoint retrieves payroll information for employees within a specified date range. Use this endpoint when you need to extract payroll data, analyze compensation information, or integrate payroll records with financial systems.

    • Enter the start date for the payroll data retrieval in the Start Date field. The date should be in ISO 8601 format (YYYY-MM-DD), such as 2024-01-01.
    • Enter the end date for the payroll data retrieval in the End Date field. The date should be in ISO 8601 format (YYYY-MM-DD), such as 2024-01-31.
    • This endpoint uses pagination with continuationToken to handle large datasets efficiently. The endpoint automatically fetches additional pages using the continuationToken from the response.

    The Get Payroll Data endpoint uses GET requests with pagination through continuationToken. The endpoint automatically fetches additional pages using the continuationToken from the response metadata, ensuring all payroll records within the specified date range are retrieved. For more information about the Get Payroll Data endpoint, refer to the Paycor API Documentation.

    Get Time Card Punches

    This endpoint retrieves time card punch data for employees from Paycor Perform Time system. Use this endpoint when you need to extract time and attendance data, analyze work hours, or integrate time card information with payroll or scheduling systems.

    • Enter the start date for the time card retrieval in the Start Date field. The date should be in ISO 8601 format (YYYY-MM-DD), such as 2024-01-01.
    • Enter the end date for the time card retrieval in the End Date field. The date should be in ISO 8601 format (YYYY-MM-DD), such as 2024-01-31.
    • This endpoint uses pagination with continuationToken to handle large datasets efficiently. The endpoint automatically fetches additional pages using the continuationToken from the response.

    The Get Time Card Punches endpoint uses GET requests with pagination through continuationToken. The endpoint automatically fetches additional pages using the continuationToken from the response metadata, ensuring all time card records within the specified date range are retrieved. For more information about the Get Time Card Punches endpoint, refer to the Paycor API Documentation.

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​

Paycor data sources can be manually configured to ingest data from any valid Paycor API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Paycor sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom authentication headers or request parameters.

API Method​

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

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

    • GET: For retrieving data from the API (most Paycor endpoints use GET)

API Endpoint URL​

  1. Enter the URL of the Paycor 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. Paycor API endpoints typically follow the pattern https://apis.paycor.com/v1/{resource}, where {resource} is the specific endpoint path.

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. Paycor API requires dual authentication: OAuth 2.0 Bearer token in the Authorization header and APIM Subscription Key in the ocp-apim-subscription-key header. Both are automatically included from your credential.

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 employees or payroll data, the API will typically return data along with metadata. By entering the path to the relevant data, you can configure Nexla to extract the specific records you need.

Path to Data is essential when 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. For Paycor API responses, common paths include $.records[*] for arrays of records or $ for the entire response.

  • 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., $.records to access the records array).
    Path to Data Example:

    If the API response is in JSON format and includes a records array that contains the employee or payroll data, the path to the response would be entered as $.records[*].

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.

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. Common headers like Authorization, Content-Type, and Accept are typically handled automatically by Nexla based on your credential configuration. For Paycor, the Authorization header with Bearer token and the ocp-apim-subscription-key header are automatically included from your credential.

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 Paycor 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.