> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.propexo.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.propexo.com/_mcp/server. # Get purchase order by ID GET https://api.propexo.com/v1/purchase-orders/{purchase_order_id} Get purchase order by ID Reference: https://docs.propexo.com/api-reference/pms-generic-ap-is/purchase-orders/get-purchase-order-by-id ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Servers - `https://api.propexo.com` (Production, default) - `https://api.sandbox.propexo.com` (Sandbox) ## Request ### Path parameters - `purchase_order_id` (string, required) — The Propexo unique identifier for the purchase order ### Query parameters - `order-by` (string, optional, default: created_at:desc) — Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc - `updated_at_gte` (string, optional, nullable) — Filter to records updated at or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z) - `updated_at_lte` (string, optional, nullable) — Filter to records updated at or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z) - `last_seen_gte` (string, optional, nullable) — Filter to records whose last_seen date is on or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z) - `last_seen_lte` (string, optional, nullable) — Filter to records whose last_seen date is on or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z) - `offset` (integer, optional, nullable, default: 0) — Can be used for paginating results - `limit` (integer, optional, nullable, default: 100) — A number between 1 and 250 to determine the number of results to return in a single query ## Response ### 200 Successful response - `meta` (ResponseMeta, required) - `results` (PurchaseOrder, required) ## Errors ### 400 Bad Request Error Bad Request - `error` (ErrorResponseError, required) ## Types ### ResponseMeta - `orderBy` (list of ResponseMetaOrderByItems, required) - `offset` (integer, optional) — The offset of the first result - `limit` (integer, optional) — The number of results to return - `hasMore` (boolean, optional, nullable) — Whether there are more results - `total` (integer, optional) — The total number of results ### PurchaseOrder - `id` (string, required) — The Propexo unique identifier for the purchase order - `created_at` (string, required) — The date record first entered Propexo - `updated_at` (string, required) — The date record was last updated in Propexo - `last_seen` (string, required, nullable) — The date the record was last seen from the PMS - `x_id` (string, required) — The external ID from the integration vendor - `x_property_id` (string, required) — The external ID of the property from the integration vendor - `x_location_id` (string, required, nullable) — The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. - `x_invoice_id` (string, required, nullable) — The external ID of the invoice from the integration vendor - `x_vendor_id` (string, required, nullable) — The external ID of the vendor from the integration vendor - `x_parent_purchase_order_id` (string, required, nullable) — The external ID of the purchase order from the integration vendor. This field is not null if this is a change order - `number` (string, required, nullable) — The number of the purchase order - `is_closed` (boolean, required, nullable) — Whether the purchase order is closed or not - `description` (string, required, nullable) — Description of the purchase order - `total_amount_in_cents` (double, required, nullable) — The amount of the purchase order, in cents - `order_date` (string, required, nullable) — The order date for the purchase order - `expense_type` (string, required, nullable) — The expense type of the purchase order - `display_type` (string, required, nullable) — The display type of the purchase order - `status_raw` (string, required, nullable) — The raw status associated with the purchase order - `shipping_address_1` (string, required, nullable) — The first address line associated with the shipping address for the purchase order - `shipping_address_2` (string, required, nullable) — The second address line associated with the shipping address for the purchase order - `shipping_city` (string, required, nullable) — The city associated with the shipping address for the purchase order - `shipping_state` (string, required, nullable) — The state associated with the shipping address for the purchase order - `shipping_zip` (string, required, nullable) — The zip code associated with the shipping address for the purchase order - `shipping_country` (string, required, nullable) — The country associated with the shipping address for the purchase order - `billing_address_1` (string, required, nullable) — The first address line associated with the billing address for the purchase order - `billing_address_2` (string, required, nullable) — The second address line associated with the billing address for the purchase order - `billing_city` (string, required, nullable) — The city associated with the billing address for the purchase order - `billing_state` (string, required, nullable) — The state associated with the billing address for the purchase order - `billing_zip` (string, required, nullable) — The zip code associated with the billing address for the purchase order - `billing_country` (string, required, nullable) — The country associated with the billing address for the purchase order - `custom_data` (PurchaseOrderCustomData, required, nullable) - `associated_invoice_ids` (list of string, required) - `property_id` (string, required) — The Propexo unique identifier for the property - `integration_id` (string, required) — The Propexo unique identifier for the integration - `integration_vendor` (enum, required) — The property management system of record - Allowed values: `APPFOLIO`, `BUILDIUM`, `ENTRATA`, `MRI`, `PROPERTYWARE`, `PROPERTYWARE_REST`, `REALPAGE`, `REALPAGE_RPX`, `RENTMANAGER`, `RENTVINE`, `RESMAN`, `YARDI`, `YARDI_REST` - `invoice_id` (string, required, nullable) — The Propexo unique identifier for the invoice - `vendor_id` (string, required, nullable) — The Propexo unique identifier for the vendor - `parent_purchase_order_id` (string, required, nullable) — The Propexo unique identifier for the purchase order. This field is not null if this is a change order ### ErrorResponseError - `code` (string, required) - `message` (string, required) - `details` (map from string to any, optional) ### ResponseMetaOrderByItems ### PurchaseOrderCustomData ## Examples **Request** ```json {} ``` **Response** ```json { "meta": { "orderBy": [ {} ], "offset": 0, "limit": 100, "hasMore": true, "total": 1000 }, "results": { "id": "po_9f8b7c6d5e4a3b2c1d0e", "created_at": "2024-05-10T09:15:00Z", "updated_at": "2024-06-01T14:45:00Z", "last_seen": "2024-06-01T14:45:00Z", "x_id": "EXT-PO-20240601-1234", "x_property_id": "EXT-PROP-5678", "x_location_id": null, "x_invoice_id": "EXT-INV-7890", "x_vendor_id": "EXT-VEND-3456", "x_parent_purchase_order_id": null, "number": "PO-2024-000123", "is_closed": false, "description": "Purchase order for HVAC system replacement", "total_amount_in_cents": 1250000, "order_date": "2024-05-09", "expense_type": "Maintenance", "display_type": "Standard", "status_raw": "Open", "shipping_address_1": "1234 Elm Street", "shipping_address_2": "Suite 200", "shipping_city": "Springfield", "shipping_state": "IL", "shipping_zip": "62704", "shipping_country": "USA", "billing_address_1": "5678 Oak Avenue", "billing_address_2": null, "billing_city": "Springfield", "billing_state": "IL", "billing_zip": "62701", "billing_country": "USA", "custom_data": {}, "associated_invoice_ids": [ "inv_20240601_001" ], "property_id": "prop_1234567890abcdef", "integration_id": "int_abcdef1234567890", "integration_vendor": "APPFOLIO", "invoice_id": "inv_abcdef1234567890", "vendor_id": "vend_123456abcdef7890", "parent_purchase_order_id": null } } ``` **SDK Code** ```python import requests url = "https://api.propexo.com/v1/purchase-orders/purchase_order_id" payload = {} headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.propexo.com/v1/purchase-orders/purchase_order_id'; const options = { method: 'GET', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.propexo.com/v1/purchase-orders/purchase_order_id" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.propexo.com/v1/purchase-orders/purchase_order_id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.propexo.com/v1/purchase-orders/purchase_order_id") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://api.propexo.com/v1/purchase-orders/purchase_order_id', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.propexo.com/v1/purchase-orders/purchase_order_id"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.propexo.com/v1/purchase-orders/purchase_order_id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```