> 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. # Create Purchase Order: Yardi POST https://api.propexo.com/v1/purchase-orders/yardi/ Content-Type: application/json Create Purchase Order: Yardi| Interface | Method | | ---------------- | ------------------- | | Vendor Invoicing | ImportPurchaseOrder |Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. Reference: https://docs.propexo.com/api-reference/yardi/purchase-orders/create-purchase-order-yardi ## 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 ### Body (application/json) This endpoint expects a _v1_purchase-orders_yardi__post_input. - `integration_id` (string, required) — The Propexo unique identifier for the integration - `vendor_id` (string, required) — The Propexo unique identifier for the vendor - `description` (string, required) — Description of the purchase order - `number` (string, required) — The number of the purchase order - `total_amount_in_cents` (double, required) — The amount of the purchase order, in cents - `order_date` (V1PurchaseOrdersYardiPostInputOrderDate, required) — The order date for the purchase order - `expense_type` (string, required) — The expense type of the purchase order. You'll have to request this data from your customer - `display_type` (string, required) — The display type of the purchase order. You'll have to request this data from your customer - `shipping_address_1` (string, required) — The first address line associated with the shipping address for the purchase order - `shipping_address_2` (string, required) — The second address line associated with the shipping address for the purchase order - `shipping_city` (string, required) — The city associated with the shipping address for the purchase order - `shipping_state` (V1PurchaseOrdersYardiPostInputShippingState, required) — The state associated with the shipping address for the purchase order. This must be a state abbreviation - `shipping_zip` (string, required) — The zip code associated with the shipping address for the purchase order - `shipping_country` (string, required) — The country associated with the shipping address for the purchase order - `billing_address_1` (string, required) — The first address line associated with the billing address for the purchase order - `billing_address_2` (string, required) — The second address line associated with the billing address for the purchase order - `billing_city` (string, required) — The city associated with the billing address for the purchase order - `billing_state` (V1PurchaseOrdersYardiPostInputBillingState, required) — The state associated with the billing address for the purchase order. This must be a state abbreviation - `billing_zip` (string, required) — The zip code associated with the billing address for the purchase order - `billing_country` (string, required) — The country associated with the billing address for the purchase order - `purchase_order_items` (list of V1PurchaseOrdersYardiPostInputPurchaseOrderItemsItems, required) — A list of the items associated with the purchase orders ## Response ### 200 Successful response - `meta` (V1PurchaseOrdersYardiPostOutputMeta, required) - `result` (V1PurchaseOrdersYardiPostOutputResult, required) ## Errors ### 400 Bad Request Error Bad Request - `error` (ErrorResponseError, required) ## Types ### V1PurchaseOrdersYardiPostInputOrderDate The order date for the purchase order ### V1PurchaseOrdersYardiPostInputShippingState The state associated with the shipping address for the purchase order. This must be a state abbreviation ### V1PurchaseOrdersYardiPostInputBillingState The state associated with the billing address for the purchase order. This must be a state abbreviation ### V1PurchaseOrdersYardiPostInputPurchaseOrderItemsItems ### V1PurchaseOrdersYardiPostOutputMeta - `job_id` (string, required) ### V1PurchaseOrdersYardiPostOutputResult - `integration_id` (string, required) — The Propexo unique identifier for the integration - `vendor_id` (string, required) — The Propexo unique identifier for the vendor - `description` (string, required) — Description of the purchase order - `number` (string, required) — The number of the purchase order - `total_amount_in_cents` (double, required) — The amount of the purchase order, in cents - `order_date` (V1PurchaseOrdersYardiPostOutputResultOrderDate, required, nullable) - `expense_type` (string, required) — The expense type of the purchase order. You'll have to request this data from your customer - `display_type` (string, required) — The display type of the purchase order. You'll have to request this data from your customer - `shipping_address_1` (string, required) — The first address line associated with the shipping address for the purchase order - `shipping_address_2` (string, required) — The second address line associated with the shipping address for the purchase order - `shipping_city` (string, required) — The city associated with the shipping address for the purchase order - `shipping_state` (V1PurchaseOrdersYardiPostOutputResultShippingState, required) — The state associated with the shipping address for the purchase order. This must be a state abbreviation - `shipping_zip` (string, required) — The zip code associated with the shipping address for the purchase order - `shipping_country` (string, required) — The country associated with the shipping address for the purchase order - `billing_address_1` (string, required) — The first address line associated with the billing address for the purchase order - `billing_address_2` (string, required) — The second address line associated with the billing address for the purchase order - `billing_city` (string, required) — The city associated with the billing address for the purchase order - `billing_state` (V1PurchaseOrdersYardiPostOutputResultBillingState, required) — The state associated with the billing address for the purchase order. This must be a state abbreviation - `billing_zip` (string, required) — The zip code associated with the billing address for the purchase order - `billing_country` (string, required) — The country associated with the billing address for the purchase order - `purchase_order_items` (list of V1PurchaseOrdersYardiPostOutputResultPurchaseOrderItemsItems, required) ### ErrorResponseError - `code` (string, required) - `message` (string, required) - `details` (map from string to any, optional) ### V1PurchaseOrdersYardiPostInputPurchaseOrderItemsItems0 A purchase order item that is associated with a construction job - `property_id` (string, required) — The Propexo unique identifier for the property - `description` (string, required) — Description of the purchase order item - `construction_job_id` (string, required) — The Propexo unique identifier for the construction job - `stock_code` (string, required) — The stock code for the purchase order item. You'll have to request this data from your customer - `quantity_ordered` (string, required) — The quantity ordered for the purchase order item - `unit_price_in_cents` (integer, required) — The unit price, in cents, of the purchase order item - `total_cost_in_cents` (integer, required) — The total cost, in cents, of the purchase order item - `cost_code` (string, required) — The cost code of the purchase order item. You'll have to request this data from your customer - `category_code` (string, required) — The category code for the purchase order item. You'll have to request this data from your customer - `financial_account_id` (string, optional) — The Propexo unique identifier for the financial account ### V1PurchaseOrdersYardiPostInputPurchaseOrderItemsItems1 A purchase order item that's not associated with a construction job - `property_id` (string, required) — The Propexo unique identifier for the property - `description` (string, required) — Description of the purchase order item - `financial_account_id` (string, required) — The Propexo unique identifier for the financial account - `stock_code` (string, required) — The stock code for the purchase order item. You'll have to request this data from your customer - `quantity_ordered` (string, required) — The quantity ordered for the purchase order item - `unit_price_in_cents` (integer, required) — The unit price, in cents, of the purchase order item - `total_cost_in_cents` (integer, required) — The total cost, in cents, of the purchase order item ### V1PurchaseOrdersYardiPostOutputResultOrderDate ### V1PurchaseOrdersYardiPostOutputResultShippingState The state associated with the shipping address for the purchase order. This must be a state abbreviation ### V1PurchaseOrdersYardiPostOutputResultBillingState The state associated with the billing address for the purchase order. This must be a state abbreviation ### V1PurchaseOrdersYardiPostOutputResultPurchaseOrderItemsItems ### V1PurchaseOrdersYardiPostOutputResultPurchaseOrderItemsItems0 A purchase order item that is associated with a construction job - `property_id` (string, required) — The Propexo unique identifier for the property - `description` (string, required) — Description of the purchase order item - `construction_job_id` (string, required) — The Propexo unique identifier for the construction job - `stock_code` (string, required) — The stock code for the purchase order item. You'll have to request this data from your customer - `quantity_ordered` (string, required) — The quantity ordered for the purchase order item - `unit_price_in_cents` (integer, required) — The unit price, in cents, of the purchase order item - `total_cost_in_cents` (integer, required) — The total cost, in cents, of the purchase order item - `cost_code` (string, required) — The cost code of the purchase order item. You'll have to request this data from your customer - `category_code` (string, required) — The category code for the purchase order item. You'll have to request this data from your customer - `financial_account_id` (string, optional) — The Propexo unique identifier for the financial account ### V1PurchaseOrdersYardiPostOutputResultPurchaseOrderItemsItems1 A purchase order item that's not associated with a construction job - `property_id` (string, required) — The Propexo unique identifier for the property - `description` (string, required) — Description of the purchase order item - `financial_account_id` (string, required) — The Propexo unique identifier for the financial account - `stock_code` (string, required) — The stock code for the purchase order item. You'll have to request this data from your customer - `quantity_ordered` (string, required) — The quantity ordered for the purchase order item - `unit_price_in_cents` (integer, required) — The unit price, in cents, of the purchase order item - `total_cost_in_cents` (integer, required) — The total cost, in cents, of the purchase order item ## Examples **Request** ```json { "integration_id": "intg-789456123", "vendor_id": "vend-123456789", "description": "Office furniture purchase for HQ renovation", "number": "PO123456", "total_amount_in_cents": 1250000, "order_date": "2024-01-15T09:30:00Z", "expense_type": "Capital Expenditure", "display_type": "Standard", "shipping_address_1": "1234 Elm Street", "shipping_address_2": "Suite 500", "shipping_city": "Springfield", "shipping_state": "IL", "shipping_zip": "62704", "shipping_country": "USA", "billing_address_1": "5678 Oak Avenue", "billing_address_2": "Floor 3", "billing_city": "Springfield", "billing_state": "IL", "billing_zip": "62701", "billing_country": "USA", "purchase_order_items": [ { "property_id": "prop-456789123", "description": "Ergonomic office chairs", "construction_job_id": "job-321654987", "stock_code": "CH-ERG-001", "quantity_ordered": "50", "unit_price_in_cents": 25000, "total_cost_in_cents": 1250000, "cost_code": "CC-OfficeFurniture", "category_code": "CAT-Furniture" } ] } ``` **Response** ```json { "meta": { "job_id": "job-321654987" }, "result": { "integration_id": "intg-789456123", "vendor_id": "vend-123456789", "description": "Office furniture purchase for HQ renovation", "number": "PO123456", "total_amount_in_cents": 1250000, "order_date": "2024-01-15T09:30:00Z", "expense_type": "Capital Expenditure", "display_type": "Standard", "shipping_address_1": "1234 Elm Street", "shipping_address_2": "Suite 500", "shipping_city": "Springfield", "shipping_state": "IL", "shipping_zip": "62704", "shipping_country": "USA", "billing_address_1": "5678 Oak Avenue", "billing_address_2": "Floor 3", "billing_city": "Springfield", "billing_state": "IL", "billing_zip": "62701", "billing_country": "USA", "purchase_order_items": [ { "property_id": "prop-456789123", "description": "Ergonomic office chairs", "construction_job_id": "job-321654987", "financial_account_id": "finacc-987654321", "stock_code": "CH-ERG-001", "quantity_ordered": "50", "unit_price_in_cents": 25000, "total_cost_in_cents": 1250000, "cost_code": "CC-OfficeFurniture", "category_code": "CAT-Furniture" } ] } } ``` **SDK Code** ```python import requests url = "https://api.propexo.com/v1/purchase-orders/yardi/" payload = { "integration_id": "intg-789456123", "vendor_id": "vend-123456789", "description": "Office furniture purchase for HQ renovation", "number": "PO123456", "total_amount_in_cents": 1250000, "order_date": "2024-01-15T09:30:00Z", "expense_type": "Capital Expenditure", "display_type": "Standard", "shipping_address_1": "1234 Elm Street", "shipping_address_2": "Suite 500", "shipping_city": "Springfield", "shipping_state": "IL", "shipping_zip": "62704", "shipping_country": "USA", "billing_address_1": "5678 Oak Avenue", "billing_address_2": "Floor 3", "billing_city": "Springfield", "billing_state": "IL", "billing_zip": "62701", "billing_country": "USA", "purchase_order_items": [ { "property_id": "prop-456789123", "description": "Ergonomic office chairs", "construction_job_id": "job-321654987", "stock_code": "CH-ERG-001", "quantity_ordered": "50", "unit_price_in_cents": 25000, "total_cost_in_cents": 1250000, "cost_code": "CC-OfficeFurniture", "category_code": "CAT-Furniture" } ] } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.propexo.com/v1/purchase-orders/yardi/'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"integration_id":"intg-789456123","vendor_id":"vend-123456789","description":"Office furniture purchase for HQ renovation","number":"PO123456","total_amount_in_cents":1250000,"order_date":"2024-01-15T09:30:00Z","expense_type":"Capital Expenditure","display_type":"Standard","shipping_address_1":"1234 Elm Street","shipping_address_2":"Suite 500","shipping_city":"Springfield","shipping_state":"IL","shipping_zip":"62704","shipping_country":"USA","billing_address_1":"5678 Oak Avenue","billing_address_2":"Floor 3","billing_city":"Springfield","billing_state":"IL","billing_zip":"62701","billing_country":"USA","purchase_order_items":[{"property_id":"prop-456789123","description":"Ergonomic office chairs","construction_job_id":"job-321654987","stock_code":"CH-ERG-001","quantity_ordered":"50","unit_price_in_cents":25000,"total_cost_in_cents":1250000,"cost_code":"CC-OfficeFurniture","category_code":"CAT-Furniture"}]}' }; 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/yardi/" payload := strings.NewReader("{\n \"integration_id\": \"intg-789456123\",\n \"vendor_id\": \"vend-123456789\",\n \"description\": \"Office furniture purchase for HQ renovation\",\n \"number\": \"PO123456\",\n \"total_amount_in_cents\": 1250000,\n \"order_date\": \"2024-01-15T09:30:00Z\",\n \"expense_type\": \"Capital Expenditure\",\n \"display_type\": \"Standard\",\n \"shipping_address_1\": \"1234 Elm Street\",\n \"shipping_address_2\": \"Suite 500\",\n \"shipping_city\": \"Springfield\",\n \"shipping_state\": \"IL\",\n \"shipping_zip\": \"62704\",\n \"shipping_country\": \"USA\",\n \"billing_address_1\": \"5678 Oak Avenue\",\n \"billing_address_2\": \"Floor 3\",\n \"billing_city\": \"Springfield\",\n \"billing_state\": \"IL\",\n \"billing_zip\": \"62701\",\n \"billing_country\": \"USA\",\n \"purchase_order_items\": [\n {\n \"property_id\": \"prop-456789123\",\n \"description\": \"Ergonomic office chairs\",\n \"construction_job_id\": \"job-321654987\",\n \"stock_code\": \"CH-ERG-001\",\n \"quantity_ordered\": \"50\",\n \"unit_price_in_cents\": 25000,\n \"total_cost_in_cents\": 1250000,\n \"cost_code\": \"CC-OfficeFurniture\",\n \"category_code\": \"CAT-Furniture\"\n }\n ]\n}") req, _ := http.NewRequest("POST", 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/yardi/") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"integration_id\": \"intg-789456123\",\n \"vendor_id\": \"vend-123456789\",\n \"description\": \"Office furniture purchase for HQ renovation\",\n \"number\": \"PO123456\",\n \"total_amount_in_cents\": 1250000,\n \"order_date\": \"2024-01-15T09:30:00Z\",\n \"expense_type\": \"Capital Expenditure\",\n \"display_type\": \"Standard\",\n \"shipping_address_1\": \"1234 Elm Street\",\n \"shipping_address_2\": \"Suite 500\",\n \"shipping_city\": \"Springfield\",\n \"shipping_state\": \"IL\",\n \"shipping_zip\": \"62704\",\n \"shipping_country\": \"USA\",\n \"billing_address_1\": \"5678 Oak Avenue\",\n \"billing_address_2\": \"Floor 3\",\n \"billing_city\": \"Springfield\",\n \"billing_state\": \"IL\",\n \"billing_zip\": \"62701\",\n \"billing_country\": \"USA\",\n \"purchase_order_items\": [\n {\n \"property_id\": \"prop-456789123\",\n \"description\": \"Ergonomic office chairs\",\n \"construction_job_id\": \"job-321654987\",\n \"stock_code\": \"CH-ERG-001\",\n \"quantity_ordered\": \"50\",\n \"unit_price_in_cents\": 25000,\n \"total_cost_in_cents\": 1250000,\n \"cost_code\": \"CC-OfficeFurniture\",\n \"category_code\": \"CAT-Furniture\"\n }\n ]\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.propexo.com/v1/purchase-orders/yardi/") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"integration_id\": \"intg-789456123\",\n \"vendor_id\": \"vend-123456789\",\n \"description\": \"Office furniture purchase for HQ renovation\",\n \"number\": \"PO123456\",\n \"total_amount_in_cents\": 1250000,\n \"order_date\": \"2024-01-15T09:30:00Z\",\n \"expense_type\": \"Capital Expenditure\",\n \"display_type\": \"Standard\",\n \"shipping_address_1\": \"1234 Elm Street\",\n \"shipping_address_2\": \"Suite 500\",\n \"shipping_city\": \"Springfield\",\n \"shipping_state\": \"IL\",\n \"shipping_zip\": \"62704\",\n \"shipping_country\": \"USA\",\n \"billing_address_1\": \"5678 Oak Avenue\",\n \"billing_address_2\": \"Floor 3\",\n \"billing_city\": \"Springfield\",\n \"billing_state\": \"IL\",\n \"billing_zip\": \"62701\",\n \"billing_country\": \"USA\",\n \"purchase_order_items\": [\n {\n \"property_id\": \"prop-456789123\",\n \"description\": \"Ergonomic office chairs\",\n \"construction_job_id\": \"job-321654987\",\n \"stock_code\": \"CH-ERG-001\",\n \"quantity_ordered\": \"50\",\n \"unit_price_in_cents\": 25000,\n \"total_cost_in_cents\": 1250000,\n \"cost_code\": \"CC-OfficeFurniture\",\n \"category_code\": \"CAT-Furniture\"\n }\n ]\n}") .asString(); ``` ```php request('POST', 'https://api.propexo.com/v1/purchase-orders/yardi/', [ 'body' => '{ "integration_id": "intg-789456123", "vendor_id": "vend-123456789", "description": "Office furniture purchase for HQ renovation", "number": "PO123456", "total_amount_in_cents": 1250000, "order_date": "2024-01-15T09:30:00Z", "expense_type": "Capital Expenditure", "display_type": "Standard", "shipping_address_1": "1234 Elm Street", "shipping_address_2": "Suite 500", "shipping_city": "Springfield", "shipping_state": "IL", "shipping_zip": "62704", "shipping_country": "USA", "billing_address_1": "5678 Oak Avenue", "billing_address_2": "Floor 3", "billing_city": "Springfield", "billing_state": "IL", "billing_zip": "62701", "billing_country": "USA", "purchase_order_items": [ { "property_id": "prop-456789123", "description": "Ergonomic office chairs", "construction_job_id": "job-321654987", "stock_code": "CH-ERG-001", "quantity_ordered": "50", "unit_price_in_cents": 25000, "total_cost_in_cents": 1250000, "cost_code": "CC-OfficeFurniture", "category_code": "CAT-Furniture" } ] }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.propexo.com/v1/purchase-orders/yardi/"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"integration_id\": \"intg-789456123\",\n \"vendor_id\": \"vend-123456789\",\n \"description\": \"Office furniture purchase for HQ renovation\",\n \"number\": \"PO123456\",\n \"total_amount_in_cents\": 1250000,\n \"order_date\": \"2024-01-15T09:30:00Z\",\n \"expense_type\": \"Capital Expenditure\",\n \"display_type\": \"Standard\",\n \"shipping_address_1\": \"1234 Elm Street\",\n \"shipping_address_2\": \"Suite 500\",\n \"shipping_city\": \"Springfield\",\n \"shipping_state\": \"IL\",\n \"shipping_zip\": \"62704\",\n \"shipping_country\": \"USA\",\n \"billing_address_1\": \"5678 Oak Avenue\",\n \"billing_address_2\": \"Floor 3\",\n \"billing_city\": \"Springfield\",\n \"billing_state\": \"IL\",\n \"billing_zip\": \"62701\",\n \"billing_country\": \"USA\",\n \"purchase_order_items\": [\n {\n \"property_id\": \"prop-456789123\",\n \"description\": \"Ergonomic office chairs\",\n \"construction_job_id\": \"job-321654987\",\n \"stock_code\": \"CH-ERG-001\",\n \"quantity_ordered\": \"50\",\n \"unit_price_in_cents\": 25000,\n \"total_cost_in_cents\": 1250000,\n \"cost_code\": \"CC-OfficeFurniture\",\n \"category_code\": \"CAT-Furniture\"\n }\n ]\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "integration_id": "intg-789456123", "vendor_id": "vend-123456789", "description": "Office furniture purchase for HQ renovation", "number": "PO123456", "total_amount_in_cents": 1250000, "order_date": "2024-01-15T09:30:00Z", "expense_type": "Capital Expenditure", "display_type": "Standard", "shipping_address_1": "1234 Elm Street", "shipping_address_2": "Suite 500", "shipping_city": "Springfield", "shipping_state": "IL", "shipping_zip": "62704", "shipping_country": "USA", "billing_address_1": "5678 Oak Avenue", "billing_address_2": "Floor 3", "billing_city": "Springfield", "billing_state": "IL", "billing_zip": "62701", "billing_country": "USA", "purchase_order_items": [ [ "property_id": "prop-456789123", "description": "Ergonomic office chairs", "construction_job_id": "job-321654987", "stock_code": "CH-ERG-001", "quantity_ordered": "50", "unit_price_in_cents": 25000, "total_cost_in_cents": 1250000, "cost_code": "CC-OfficeFurniture", "category_code": "CAT-Furniture" ] ] ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.propexo.com/v1/purchase-orders/yardi/")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" 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() ```