--- title: "Get Snapshot by Employee and Pay Period Range" method: POST path: "/apiHub/payroll/v1/companies/{companyId}/payrollReadiness/snapshots" tags: ["Time Snapshot"] --- # Get Snapshot by Employee and Pay Period Range `POST /apiHub/payroll/v1/companies/{companyId}/payrollReadiness/snapshots` ## Request - Base URL: `https://dc1demogwext.paylocity.com` - URL: `https://dc1demogwext.paylocity.com/apiHub/payroll/v1/companies/{companyId}/payrollReadiness/snapshots` - Auth: HTTP bearer > 🚧 Partner Restricted > > This endpoint is only available to approved partners who have signed a Paylocity Technology Partnership Agreement. If you are not yet a partner and are interested, [please reach out to our team](https://www.paylocity.com/contact/partner-form/) to discuss partnership opportunities. **Summary Description** Request time snapshot data for the specified employees within the given pay period date range. ## Path parameters - `companyId` string, required ## Headers - `testMode` boolean - `Authorization` string, required ## Request body - TimeSnapshotV1Request: Request object for creating or querying a time snapshot. Contains payroll configuration, date range, and optional override settings. - `payrollDataConfigurationId` integer, nullable: Identifier for payroll data configuration. Optional, but either this property or `PayrollSettingsOverride` must be provided. If both are populated, `PayrollSettingsOverride` takes precedence over this ID. - `startDate` string, date-time, required: Start date of the snapshot. Format: yyyy-MM-dd. Required. - `endDate` string, date-time, required: End date of the snapshot. Format: yyyy-MM-dd. Required. - `payrollSettingsOverride` PayrollSettingsOverride: Overrides for payroll settings. Includes detailed settings and optional labor levels. - `settings` PayrollSettingsDetail, required: Detailed payroll settings for a snapshot. - `exportType` 'webPay' | 'payPeriodProjection' | 'payPeriodReconciliation', required: Export type enumeration. - `selectedEmployeeType` 'group' | 'number', required: Employee type enumeration. - `selectedId` string, nullable: Identifier of the selected group or employee. Optional, but conditionally required depending on `SelectedEmployeeType`: - Required if `SelectedEmployeeType = Group` (must contain the Group Id). - Required if `SelectedEmployeeType = Number` and `WebPayEmployeeIds` is empty. - `webPayEmployeeIds` string[], nullable: List of employee IDs for WebPay export. Optional, but required if `SelectedEmployeeType = Number` and `SelectedId` is not provided. - `exempt` boolean, required: Include exempt employees. Required. - `nonExempt` boolean, required: Include non-exempt employees. Required. - `salary` boolean, required: Include salaried employees. Required. - `hourly` boolean, required: Include hourly employees. Required. - `includeInactive` boolean, required: Include inactive employees. Required. - `includeNonCompanyEmployees` boolean, required: Include employees not part of the company. Required. - `exportOptions` ExportOptions: Options for exporting payroll data. Includes settings for wages, job costing, pay rates, labor levels, and tax codes. - `exportWages` boolean, required: Export wages for employees. Required. - `breakDownJobCostingByDay` boolean, required: Break down job costing by day when exporting. Required. - `exportPayRates` boolean, required: Export employee pay rates. Required. - `llid1` integer, nullable: Labor Level 1 ID. Optional. Used for categorizing labor costs. - `llid2` integer, nullable: Labor Level 2 ID. Optional. - `llid3` integer, nullable: Labor Level 3 ID. Optional. - `llid4` integer, nullable: Labor Level 4 ID. Optional. - `llid5` integer, nullable: Labor Level 5 ID. Optional. - `jobCodeLlid` integer, nullable: Job code Labor Level ID. Optional. Used to map job codes to labor levels. - `tCode1Llid` integer, nullable: Tax Code 1 Labor Level ID. Optional. Maps TCode1 to a labor level for export purposes. - `tCode2Llid` integer, nullable: Tax Code 2 Labor Level ID. Optional. - `tCode4Llid` integer, nullable: Tax Code 4 Labor Level ID. Optional. - `useBadgeNumber` boolean, required: Use the employee badge number when exporting data. Required. - `useUserId` boolean, required: Use the employee user ID when exporting data. Required. - `exportOnlyOverriddenCC` boolean, required: Export only overridden cost centers. Required. - `suppressRateIfBase` boolean, required: Suppress rate if it is the base rate. Required. - `exportShiftCode` boolean, required: Export shift code for employees. Required. - `exportWeekNumber` boolean, required: Include week number in export. Required. - `weekNumber` string, nullable: Week number string. Optional. - `laborLevels` LaborLevels: Labor level detail codes. Optional. - `laborLevel1DetailCode` string, nullable: Labor Level 1 detail code. Optional. - `laborLevel2DetailCode` string, nullable: Labor Level 2 detail code. Optional. - `laborLevel3DetailCode` string, nullable: Labor Level 3 detail code. Optional. - `laborLevel4DetailCode` string, nullable: Labor Level 4 detail code. Optional. - `laborLevel5DetailCode` string, nullable: Labor Level 5 detail code. Optional. - `laborLevel6DetailCode` string, nullable: Labor Level 6 detail code. Optional. - `laborLevel7DetailCode` string, nullable: Labor Level 7 detail code. Optional. - `laborLevel8DetailCode` string, nullable: Labor Level 8 detail code. Optional. - `laborLevel9DetailCode` string, nullable: Labor Level 9 detail code. Optional. - `laborLevel10DetailCode` string, nullable: Labor Level 10 detail code. Optional. - `laborLevel11DetailCode` string, nullable: Labor Level 11 detail code. Optional. - `laborLevel12DetailCode` string, nullable: Labor Level 12 detail code. Optional. - `laborLevel13DetailCode` string, nullable: Labor Level 13 detail code. Optional. - `laborLevel14DetailCode` string, nullable: Labor Level 14 detail code. Optional. - `laborLevel15DetailCode` string, nullable: Labor Level 15 detail code. Optional. ## Response `202` Accepted - TimeSnapshotV1Response - `snapshotId` integer, nullable: The unique identifier of the created snapshot. ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `404`: Not Found - `415`: Unsupported Media Type - `500`: Internal Server Error - `502`: Bad Gateway - `503`: Service Unavailable --- [API](https://skmtc.dev/paylocity/apis/pay-details-api.md) - [All operations](https://skmtc.dev/paylocity/apis/pay-details-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paylocity/apis/pay-details-api/revisions/8cbe85265888?raw)