GuidesAPI ReferenceChangelog

Documents Overview

Introduction

The Document Management API is designed to streamline the retrieval of documents from Paylocity. Specifically tailored for both employee and company documents, this API offers a solution for organizations looking to enhance their document management workflows.

With this API, users can access a wide range of documents through a GET request. It is engineered to accommodate various scenarios, from retrieving a single document to managing large batches of records.

Key Features:

  • Company and Employee-Specific Retrieval: Two separate endpoints cater to the different needs of retrieving company-specific documents and employee-specific documents.
  • Query Options: Extensive query parameters allow for filtering by dates, employee IDs, and other criteria, ensuring that users can pinpoint the exact documents they need.
  • Pagination and Counting: Supports pagination for data handling, especially useful for large sets of documents, and offers the ability to count the total number of relevant documents.
  • Secure and Compliant: Designed with security and compliance at its forefront, incorporating necessary authorization protocols to protect sensitive information.

Retrieving Employee Documents

Common Use Cases

Individual Employee Document Retrieval:

  • Retrieve all documents associated with a particular employee by specifying the employeeId parameter.

Document Retrieval for a Specific Date:

  • Retrieve all documents of a particular employee or all employees that were uploaded on a specific date.

Document Retrieval within a Date Range:

  • Retrieve all documents of a particular employee or all employees that were uploaded within a certain date range by using the uploadedDate.greaterThanOrEqualTo and uploadedDate.lessThanOrEqualTo parameters.

Paginated Document Retrieval:

  • Retrieve documents of a particular employee or all employees in a paginated manner by utilizing the limit and offset parameters, which can be especially useful in applications with a large number of documents.

Document Count Retrieval:

  • Determine the total count of documents available for a particular employee or all employees by setting the includeTotalCount parameter to true. This can be useful for applications that need to display the total number of available documents to the user.

Selective Document Retrieval:

  • Retrieve a specific number of documents for a particular employee or all employees by setting the limit parameter, which can be useful for previewing or sampling the available documents.

Retrieving Company Documents

Common Use Cases

Document Retrieval for a Specific Date:

  • Retrieve all company documents that were uploaded on a specific date.

Document Retrieval within a Date Range:

-Retrieve all company documents that were uploaded within a certain date range by using the uploadedDate.greaterThanOrEqualTo and uploadedDate.lessThanOrEqualTo parameters.

Paginated Document Retrieval:

  • Retrieve company documents in a paginated manner by utilizing the limit and offset parameters, which can be especially useful in applications with a large number of documents.

Document Count Retrieval:

  • Determine the total count of company documents available by setting the includeTotalCount parameter to true. This can be useful for applications that need to display the total number of available documents to the user.

Selective Document Retrieval:

  • Retrieve a specific number of company documents by setting the limit parameter, which can be useful for previewing or sampling the available documents.

Copyright © 2023 Paylocity. All Rights Reserved. Privacy Center | Terms and Conditions | Accessibility