Follows:
Authentication •
Caching •
Polling •
List Response Format •
Scheduled Job
The purchase orders endpoint returns a list of all purchase orders in your AppFolio® account — the same rows, values and visibility a user sees on the Purchase Orders screen. Narrow the list with the same filters that screen offers: a creation date range, approval status, whether the order is completed or submitted, a property, a vendor or a GL account. Canceled purchase orders are left out unless you ask for them with includeCanceled. Line items are not part of the list; fetch one purchase order's detail with Get One Purchase Order. This endpoint should respond immediately with your most recently cached data.
Parameters
createdOnFromdate
Earliest creation date to include, as MM/DD/YYYY. May be used without createdOnTo.
createdOnTodate
Latest creation date to include, as MM/DD/YYYY. May be used without createdOnFrom.
approvalStatusselect
Approval status to include, as shown on the Purchase Orders screen: Pending Approval, Approved or Pending Revision. Defaults to All.
Possible Values: All
Pending Approval
Approved
Pending Revision
completedboolean
Set true to return only purchase orders marked completed, or false for those not yet completed. When omitted, both are returned.
submittedboolean
Set true to return only purchase orders marked as submitted to the vendor, or false for those not yet submitted. When omitted, both are returned.
includeCanceledboolean
Set true to include canceled purchase orders. Defaults to false: canceled purchase orders are left out, as they are on the Purchase Orders screen.
propertyIdselect
AppFolio ID of a property. When provided, returns only purchase orders with a line item for that property. The property must exist and be visible to your connected AppFolio user.
vendorIdstring
AppFolio ID of a vendor. When provided, returns only purchase orders issued to that vendor. The vendor must exist and be visible to your connected AppFolio user. Look vendors up with the Vendors endpoint.
glAccountIdstring
AppFolio ID of a GL account. When provided, returns only purchase orders with a line item coded to that GL account. Look GL accounts up with the GL Accounts endpoint.
Returns
The standard List Response Format with a data property containing an array of Purchase Order objects.