PayrollSettings_GetPayrollSettingsList

Retrieve payroll settings based on filters like date ranges, employee types, and activity status using the ServiceTitan API. Access customized payroll data for efficient management.

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]
`createdBefore`	No	Format - date-time (as date-time in RFC3339). Return items created before certain date/time (in UTC)
`createdOnOrAfter`	No	Format - date-time (as date-time in RFC3339). Return items created on or after certain date/time (in UTC)
`employeeType`	No	The type of employee Values: [Technician, Employee]
`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)
`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"
    },
    "createdBefore": {
      "description": "Format - date-time (as date-time in RFC3339). Return items created before certain date/time (in UTC)",
      "format": "date-time",
      "type": "string"
    },
    "createdOnOrAfter": {
      "description": "Format - date-time (as date-time in RFC3339). Return items created on or after certain date/time (in UTC)",
      "format": "date-time",
      "type": "string"
    },
    "employeeType": {
      "description": "The type of employee\nValues: [Technician, Employee]",
      "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"
    },
    "tenant": {
      "description": "Format - int64. Tenant ID",
      "type": "integer"
    }
  },
  "required": [
    "tenant"
  ],
  "type": "object"
}

ServiceTitan MCP Server

PayrollSettings_GetPayrollSettingsList

Input Schema

Input Schema (JSON Schema)

Other Tools from ServiceTitan MCP Server

Related Tools