---
title: "Get Snapshot Summary"
method: GET
path: "/apiHub/payroll/v1/companies/{companyId}/payrollReadiness/snapshots/{snapshotId}"
tags: ["Time Snapshot"]
---

# Get Snapshot Summary

`GET /apiHub/payroll/v1/companies/{companyId}/payrollReadiness/snapshots/{snapshotId}`

## Request

- Base URL: `https://dc1demogwext.paylocity.com`
- URL: `https://dc1demogwext.paylocity.com/apiHub/payroll/v1/companies/{companyId}/payrollReadiness/snapshots/{snapshotId}`
- 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**

Retrieve time snapshot summary data for the specified id.

## Path parameters

- `companyId` string, required
- `snapshotId` integer, required

## Headers

- `testMode` boolean
- `Authorization` string, required

## Response `200`

OK

- TimeSnapshotSummaryV1Response
  - `snapshotId` integer, nullable: The unique identifier of the snapshot.
  - `status` 'queued' | 'inProcess' | 'complete' | 'failed' | 'retry': Generation status enumeration.
  - `statusReason` 'none' | 'invalidEmployeeNumber' | 'emptyGroup': Generation status reason enumeration.
  - `payrollDataConfigurationId` integer, nullable: The payroll data configuration identifier.
  - `startDate` string, date-time: Start date of the pay period range.
  - `endDate` string, date-time: End date of the pay period range.
  - `lastModified` string, date-time: Date and time when the snapshot was last modified.
  - `payPeriodStatus` 'open' | 'closed': Pay period status enumeration.
  - `payrollPolicyNames` string[], nullable: Array of payroll policy names associated with the snapshot.
  - `submissionId` string, uuid, nullable: The payroll submission identifier.
  - `isPayrollLocked` boolean, nullable: Indicates if the payroll is locked.
  - `employeeCount` EmployeeCount: Employee count information.
    - `activeCount` integer, nullable: Number of active employees.
    - `totalCount` integer, nullable: Total number of employees.
    - `activeWithoutHoursCount` integer, nullable: Number of active employees without hours.
    - `inactiveWithHoursCount` integer, nullable: Number of inactive employees with hours.
  - `approvals` Approvals: Approval information for time snapshot.
    - `missingPunchCount` integer, nullable: Number of missing punches
    - `unapprovedAdjustmentCount` integer, nullable: Number of unapproved adjustments.
    - `pendingTimeOffCount` integer, nullable: Number of pending time off requests.
    - `timeCardCorrectionCount` integer, nullable: Number of time card corrections.
    - `unapprovedTimeCardCount` integer, nullable: Number of unapproved time cards.
  - `timeTotals` TimeTotals: Time totals information.
    - `totalHours` number, double, nullable: Total hours.
    - `regularHours` number, double, nullable: Regular hours.
    - `ot1Hours` number, double, nullable: Overtime hours 1.
    - `ot2Hours` number, double, nullable: Overtime hours 2.
    - `paidHours` number, double, nullable: Paid hours.
    - `unpaidHours` number, double, nullable: Unpaid hours.
  - `adjustmentTotals` Adjustments: Adjustment totals information.
    - `totalAdjustments` number, double, nullable: Total adjustments amount.
  - `isEmpty` boolean, nullable: Indicates if the snapshot is empty.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `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)