purchase_orders_getrequests
Retrieve purchase order requests in ServiceTitan using specific filters like date range, job ID, status, or sorting. Supports pagination and retrieving total counts for efficient data management.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
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 PO requests with date before certain date/time | |
dateOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return PO requests with date on or after certain date/time | |
ids | No | ||
includeTotal | No | Whether total count should be returned | |
jobId | No | Format - int64. Filters by JobId associated with PO request | |
jobIds | No | Filters by JobIds associated with PO request | |
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) | |
projectId | No | Format - int64. Filter by ProjectId associated with PO request | |
requestNumber | No | Filters by PO request number | |
requestStatus | No | Filters by PO request status Available values are: PendingApproval, Rejected\ Values: [PendingApproval, Approved, Rejected] | |
sort | No | Applies sorting by the specified field: "?sort=+FieldName" for ascending order, "?sort=-FieldName" for descending order. Available fields are: Id, ModifiedOn, CreatedOn. | |
technicianId | No | Format - int64. Filter by TechnicianId associated with PO request | |
tenant | Yes | Format - int64. Tenant ID |