Payrolls_GetList
Retrieve payroll data from ServiceTitan by filtering based on employee type, status, date ranges, and pagination for efficient payroll management.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| active | No | What kind of items should be returned (only active items will be returned by default). Values: [True, Any, False] | |
| approvedOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return items approved on or after certain date/time (in UTC) | |
| employeeType | No | The type of employee. Values: [Technician, Employee] | |
| endedOnOrBefore | No | Format - date-time (as date-time in RFC3339). Return items having end date before certain date/time (in UTC) | |
| includeTotal | No | Whether total count should be returned | |
| modifiedBefore | No | Format - date-time (as date-time in RFC3339). Return items modified before certain date/time (in UTC) | |
| modifiedOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return items modified on or after certain date/time (in UTC) | |
| page | No | Format - int32. The logical number of page to return, starting from 1 | |
| pageSize | No | Format - int32. How many records to return (50 by default) | |
| startedOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return items having start date after certain date/time (in UTC) | |
| status | No | Return items of the specified payroll status. Values: [Pending, Expired, Approved, Paid, Locked] | |
| tenant | Yes | Format - int64. Tenant ID |