purchase_orders_get_list

Retrieve a list of purchase orders filtered by date, ID, job, status, or other criteria. Supports sorting, pagination, and count inclusion for efficient data management.

Input Schema

Name	Required	Description
`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)
`dateBefore`	No	Format - date-time (as date-time in RFC3339). Return POs with date before certain date/time
`dateOnOrAfter`	No	Format - date-time (as date-time in RFC3339). Return POs with date on or after certain date/time
`ids`	No	Perform lookup by multiple IDs (maximum 50)
`includeTotal`	No	Whether total count should be returned
`jobId`	No	Format - int64. Filters by JobId associated with PO
`jobIds`	No	Filters by JobIds associated with PO
`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)
`number`	No	Filters by PO number
`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)
`projectId`	No	Format - int64. Filter by ProjectId associated with PO
`sentBefore`	No	Format - date-time (as date-time in RFC3339). Return POs sent before certain date/time
`sentOnOrAfter`	No	Format - date-time (as date-time in RFC3339). Return POs sent on or after certain date/time
`sort`	No	Applies sorting by the specified field: "?sort=+FieldName" for ascending order, "?sort=-FieldName" for descending order. Available fields are: Id, ModifiedOn, CreatedOn.
`status`	No	Filters by PO status Available values are: Pending, Sent, PartiallyReceived, Received, Exported, Canceled
`technicianId`	No	Format - int64. Filter by TechnicianId associated with PO
`tenant`	Yes	Format - int64. Tenant ID

Input Schema (JSON Schema)

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "properties": {
    "createdBefore": {
      "description": "Format - date-time (as date-time in RFC3339). Return items created before certain date/time (in UTC)",
      "type": [
        "string",
        "null"
      ]
    },
    "createdOnOrAfter": {
      "description": "Format - date-time (as date-time in RFC3339). Return items created on or after certain date/time (in UTC)",
      "type": [
        "string",
        "null"
      ]
    },
    "dateBefore": {
      "description": "Format - date-time (as date-time in RFC3339). Return POs with date before certain date/time",
      "type": [
        "string",
        "null"
      ]
    },
    "dateOnOrAfter": {
      "description": "Format - date-time (as date-time in RFC3339). Return POs with date on or after certain date/time",
      "type": [
        "string",
        "null"
      ]
    },
    "ids": {
      "description": "Perform lookup by multiple IDs (maximum 50)",
      "type": [
        "string",
        "null"
      ]
    },
    "includeTotal": {
      "description": "Whether total count should be returned",
      "type": [
        "boolean",
        "null"
      ]
    },
    "jobId": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "description": "Format - int64. Filters by JobId associated with PO"
    },
    "jobIds": {
      "description": "Filters by JobIds associated with PO",
      "type": [
        "string",
        "null"
      ]
    },
    "modifiedBefore": {
      "description": "Format - date-time (as date-time in RFC3339). Return items modified before certain date/time (in UTC)",
      "type": [
        "string",
        "null"
      ]
    },
    "modifiedOnOrAfter": {
      "description": "Format - date-time (as date-time in RFC3339). Return items modified on or after certain date/time (in UTC)",
      "type": [
        "string",
        "null"
      ]
    },
    "number": {
      "description": "Filters by PO number ",
      "type": [
        "string",
        "null"
      ]
    },
    "page": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "description": "Format - int32. The logical number of page to return, starting from 1"
    },
    "pageSize": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "description": "Format - int32. How many records to return (50 by default)"
    },
    "projectId": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "description": "Format - int64. Filter by ProjectId associated with PO"
    },
    "sentBefore": {
      "description": "Format - date-time (as date-time in RFC3339). Return POs sent before certain date/time",
      "type": [
        "string",
        "null"
      ]
    },
    "sentOnOrAfter": {
      "description": "Format - date-time (as date-time in RFC3339). Return POs sent on or after certain date/time",
      "type": [
        "string",
        "null"
      ]
    },
    "sort": {
      "description": "Applies sorting by the specified field:\n\"?sort=+FieldName\" for ascending order,\n\"?sort=-FieldName\" for descending order.\n\nAvailable fields are: Id, ModifiedOn, CreatedOn.",
      "type": [
        "string",
        "null"
      ]
    },
    "status": {
      "description": "Filters by PO status\n\nAvailable values are: Pending, Sent, PartiallyReceived, Received, Exported, Canceled",
      "type": [
        "string",
        "null"
      ]
    },
    "technicianId": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "description": "Format - int64. Filter by TechnicianId associated with PO"
    },
    "tenant": {
      "description": "Format - int64. Tenant ID",
      "type": "integer"
    }
  },
  "required": [
    "tenant"
  ],
  "type": "object"
}

ServiceTitan MCP Server

purchase_orders_get_list

Input Schema

Input Schema (JSON Schema)

Other Tools from ServiceTitan MCP Server

Related Tools