Payrolls_GetEmployeePayrolls

Retrieve employee payroll data by specifying employee ID, tenant ID, and criteria such as status, date ranges, or page size for precise results.

Input Schema

Name	Required	Description
`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)
`employee`	Yes	Format - int64. The employee ID
`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

Input Schema (JSON Schema)

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "properties": {
    "active": {
      "description": "What kind of items should be returned (only active items will be returned by default)\nValues: [True, Any, False]",
      "type": "string"
    },
    "approvedOnOrAfter": {
      "description": "Format - date-time (as date-time in RFC3339). Return items approved on or after certain date/time (in UTC)",
      "format": "date-time",
      "type": "string"
    },
    "employee": {
      "description": "Format - int64. The employee ID",
      "type": "integer"
    },
    "endedOnOrBefore": {
      "description": "Format - date-time (as date-time in RFC3339). Return items having end date before certain date/time (in UTC)",
      "format": "date-time",
      "type": "string"
    },
    "includeTotal": {
      "description": "Whether total count should be returned",
      "type": "boolean"
    },
    "modifiedBefore": {
      "description": "Format - date-time (as date-time in RFC3339). Return items modified before certain date/time (in UTC)",
      "format": "date-time",
      "type": "string"
    },
    "modifiedOnOrAfter": {
      "description": "Format - date-time (as date-time in RFC3339). Return items modified on or after certain date/time (in UTC)",
      "format": "date-time",
      "type": "string"
    },
    "page": {
      "description": "Format - int32. The logical number of page to return, starting from 1",
      "type": "integer"
    },
    "pageSize": {
      "description": "Format - int32. How many records to return (50 by default)",
      "type": "integer"
    },
    "startedOnOrAfter": {
      "description": "Format - date-time (as date-time in RFC3339). Return items having start date after certain date/time (in UTC)",
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "description": "Return items of the specified payroll status\nValues: [Pending, Expired, Approved, Paid, Locked]",
      "type": "string"
    },
    "tenant": {
      "description": "Format - int64. Tenant ID",
      "type": "integer"
    }
  },
  "required": [
    "employee",
    "tenant"
  ],
  "type": "object"
}

ServiceTitan MCP Server

Payrolls_GetEmployeePayrolls

Input Schema

Input Schema (JSON Schema)

Other Tools from ServiceTitan MCP Server

Related Tools