Package

PLEASE NOTE: When adding packages for the first time for newly onboarded clients, please provide at least a 15 minute delay from sending the 'Approved' onboarding status to synching packages for that client. Due to caching in the gateway, there could be up to a 15 minute delay for allowing this Upsert Package(s) functionality to work.

A Package is essentially a combined group of assessment services that Paylocity's customer has already created on a partners platform. As an example, a Package could be “Personality test” which includes all questions that would be applicable in the personality test for the job. An assessment partner platform can combine several such assessments, which are individual tests, and bundle up into a single assessment package with unique name and ID.

A PUT on the /assessmentPackages endpoint inserts or updates a list of the packages defined for Paylocity's customers. As an assessment partner, you can also remove any package which is not active by using the status value flag, or set end date on the package in order to remove the package information from Paylocity's UI. Paylocity will prevent any future orders using this package id, however, any in-flight assessment orders should still be processed by your platform.

Paylocity can support different assessment packages for every company you partner with. If the company is b6001 in the request URL then the assessmentpackages will be applicable for all the Paylocity companies, however, if you want to send assessment packages at a company level then use the specific companyId in the request which will allow you granular control on your offerings to our mutual customers.