Payrolls_GetList

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
`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

Input Schema (JSON Schema)

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

ServiceTitan MCP Server

Input Schema

Input Schema (JSON Schema)

Other Tools from ServiceTitan MCP Server

Related Tools