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