Documents

Get Documents List by Company

Summary Description

The GET company documents resource will return a list of documents for a specified company ID.

get/documents/v1/companies/{companyId}/companyDocuments

Request

Base URL
https://dc1demogwext.paylocity.com
URL
https://dc1demogwext.paylocity.com/documents/v1/companies/{companyId}/companyDocuments
Auth
none declared. Required headers: Authorization

Path parameters

companyIdstring required

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity. Allowable Values: 9 char max

Query parameters

uploadedDatestring date-time

Allows for an equals comparison to the uploadedDate field. Time portion of the input is ignored.

uploadedDate.lessThanOrEqualTostring date-time

Allows for a Less Than Or Equal (<=) comparison to the uploadedDate field. Time portion of the input is ignored.

uploadedDate.greaterThanOrEqualTostring date-time

Allows for a Greater Than Or Equal (>=) comparison to the uploadedDate field. Time portion of the input is ignored.

includeTotalCountboolean

Requests that the response include the Pcty-Total-Count header containing the total number of objects that match the request. This may be useful if requesting a small [limit].

limitinteger

Defines the maximum number of items to be returned in the response.

offsetinteger

Defines the start location to return. Ex. offset=100 means starting at item 100, return the next [limit] items.

Headers

Authorizationstring required

Authorization token. Ex. Bearer ...

Response

Success

documentIdstring uuid

companyIdstring

displayNamestring

receivedDatestring date-time