> 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 Vendor: Yardi REST POST https://api.propexo.com/v1/vendors/yardi_rest/ Content-Type: application/json Create Vendor: Yardi REST| Interface | Method | | ---------------- | --------------------------------- | | Vendor Invoicing | /ItfVendorInvoicing/ImportVendors |This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. Reference: https://docs.propexo.com/api-reference/yardi-rest/vendors/create-vendor-yardi-rest ## 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_vendors_yardi_rest__post_input. - `integration_id` (string, required) — The Propexo unique identifier for the integration - `property_id` (string, required) — The Propexo unique identifier for the property - `name` (string, required) — The name associated with the vendor - `is_active` (boolean, optional) — Whether the vendor is active - `notes` (string, optional) — Notes associated with the vendor - `tax_id` (string, optional) - `tax_payer_first_name` (string, optional) — The first name of the tax payer associated with the vendor - `tax_payer_last_name` (string, optional) — The last name of the tax payer associated with the vendor - `workers_comp_expiration_date` (V1VendorsYardiRestPostInputWorkersCompExpirationDate, optional) — The expiration date of the workers compensation policy on file for this vendor - `liability_expiration_date` (V1VendorsYardiRestPostInputLiabilityExpirationDate, optional) — The expiration date of the liability insurance policy on file for this vendor - `payment_method` (enum, optional) — The payment method for the vendor. - Allowed values: `Check`, `EFT` - `address_1` (string, optional) — The first address line associated with the vendor - `address_2` (string, optional) — The second address line associated with the vendor - `city` (string, optional) — The city associated with the vendor - `state` (enum, optional) — The state associated with the vendor - Allowed values: `AA`, `AE`, `AK`, `AL`, `AP`, `AR`, `AS`, `AZ`, `CA`, `CO`, `CT`, `DC`, `DE`, `FL`, `FM`, `GA`, `GU`, `HI`, `IA`, `ID`, `IN`, `KS`, `KY`, `LA`, `MA`, `MD`, `ME`, `MH`, `MI`, `MN`, `MO`, `MP`, `MS`, `MT`, `NC`, `NE`, `NL`, `NJ`, `NM`, `NV`, `NY`, `OH`, `OK`, `OR`, `PA`, `PR`, `SD`, `TN`, `TX`, `UT`, `VA`, `VI`, `VT`, `WA`, `WI`, `WV`, `WY`, `AB`, `BC`, `MB`, `NB`, `NL`, `NT`, `NS`, `NU`, `ON`, `PE`, `QC`, `SK`, `YT` - `zip` (string, optional) — The zip code associated with the vendor - `country` (V1VendorsYardiRestPostInputCountry, optional) — The country associated with the vendor - `email_1` (string, optional) — The primary email address associated with the vendor - `phone_1` (string, optional) — Primary phone number associated with the vendor - `phone_2` (string, optional) — Secondary phone number associated with the vendor ## Response ### 200 Successful response - `meta` (V1VendorsYardiRestPostOutputMeta, required) - `result` (V1VendorsYardiRestPostOutputResult, required) ## Errors ### 400 Bad Request Error Bad Request - `error` (ErrorResponseError, required) ## Types ### V1VendorsYardiRestPostInputWorkersCompExpirationDate The expiration date of the workers compensation policy on file for this vendor ### V1VendorsYardiRestPostInputLiabilityExpirationDate The expiration date of the liability insurance policy on file for this vendor ### V1VendorsYardiRestPostInputCountry The country associated with the vendor ### V1VendorsYardiRestPostOutputMeta - `job_id` (string, required) ### V1VendorsYardiRestPostOutputResult - `integration_id` (string, required) — The Propexo unique identifier for the integration - `property_id` (string, required) — The Propexo unique identifier for the property - `name` (string, required) — The name associated with the vendor - `is_active` (boolean, required, nullable) — Whether the vendor is active - `notes` (string, required, nullable) — Notes associated with the vendor - `tax_id` (string, required, nullable) — The tax payer identification number associated with the vendor - `tax_payer_first_name` (string, required, nullable) — The first name of the tax payer associated with the vendor - `tax_payer_last_name` (string, required, nullable) — The last name of the tax payer associated with the vendor - `workers_comp_expiration_date` (V1VendorsYardiRestPostOutputResultWorkersCompExpirationDate, required, nullable) — The expiration date of the workers compensation policy on file for this vendor - `liability_expiration_date` (V1VendorsYardiRestPostOutputResultLiabilityExpirationDate, required, nullable) — The expiration date of the liability insurance policy on file for this vendor - `payment_method` (enum, required) — The payment method for the vendor. - Allowed values: `Check`, `EFT` - `address_1` (string, required, nullable) — The first address line associated with the vendor - `address_2` (string, required, nullable) — The second address line associated with the vendor - `city` (string, required, nullable) — The city associated with the vendor - `state` (enum, required) — The state associated with the vendor - Allowed values: `AA`, `AE`, `AK`, `AL`, `AP`, `AR`, `AS`, `AZ`, `CA`, `CO`, `CT`, `DC`, `DE`, `FL`, `FM`, `GA`, `GU`, `HI`, `IA`, `ID`, `IN`, `KS`, `KY`, `LA`, `MA`, `MD`, `ME`, `MH`, `MI`, `MN`, `MO`, `MP`, `MS`, `MT`, `NC`, `NE`, `NL`, `NJ`, `NM`, `NV`, `NY`, `OH`, `OK`, `OR`, `PA`, `PR`, `SD`, `TN`, `TX`, `UT`, `VA`, `VI`, `VT`, `WA`, `WI`, `WV`, `WY`, `AB`, `BC`, `MB`, `NB`, `NL`, `NT`, `NS`, `NU`, `ON`, `PE`, `QC`, `SK`, `YT` - `zip` (string, required, nullable) — The zip code associated with the vendor - `country` (V1VendorsYardiRestPostOutputResultCountry, required, nullable) — The country associated with the vendor - `email_1` (string, required, nullable) — The primary email address associated with the vendor - `phone_1` (string, required, nullable) — Primary phone number associated with the vendor - `phone_2` (string, required, nullable) — Secondary phone number associated with the vendor ### ErrorResponseError - `code` (string, required) - `message` (string, required) - `details` (map from string to any, optional) ### V1VendorsYardiRestPostOutputResultWorkersCompExpirationDate The expiration date of the workers compensation policy on file for this vendor ### V1VendorsYardiRestPostOutputResultLiabilityExpirationDate The expiration date of the liability insurance policy on file for this vendor ### V1VendorsYardiRestPostOutputResultCountry The country associated with the vendor ## Examples **Request** ```json { "integration_id": "intg-9f8b7c6d5e4a3b2c1d0e", "property_id": "prop-1234567890abcdef", "name": "Green Valley Landscaping" } ``` **Response** ```json { "meta": { "job_id": "job-20240615-001" }, "result": { "integration_id": "intg-9f8b7c6d5e4a3b2c1d0e", "property_id": "prop-1234567890abcdef", "name": "Green Valley Landscaping", "is_active": true, "notes": "Preferred vendor for all landscaping and maintenance services. Contract renewed annually.", "tax_id": "12-3456789", "tax_payer_first_name": "John", "tax_payer_last_name": "Doe", "workers_comp_expiration_date": "2025-12-31", "liability_expiration_date": "2025-12-31", "payment_method": "Check", "address_1": "1234 Elm Street", "address_2": "Suite 200", "city": "Springfield", "state": "IL", "zip": "62704", "country": "United States", "email_1": "contact@greenvalleylandscaping.com", "phone_1": "+1-217-555-1234", "phone_2": "+1-217-555-5678" } } ``` **SDK Code** ```python import requests url = "https://api.propexo.com/v1/vendors/yardi_rest/" payload = { "integration_id": "intg-9f8b7c6d5e4a3b2c1d0e", "property_id": "prop-1234567890abcdef", "name": "Green Valley Landscaping" } 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/vendors/yardi_rest/'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"integration_id":"intg-9f8b7c6d5e4a3b2c1d0e","property_id":"prop-1234567890abcdef","name":"Green Valley Landscaping"}' }; 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/vendors/yardi_rest/" payload := strings.NewReader("{\n \"integration_id\": \"intg-9f8b7c6d5e4a3b2c1d0e\",\n \"property_id\": \"prop-1234567890abcdef\",\n \"name\": \"Green Valley Landscaping\"\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/vendors/yardi_rest/") 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-9f8b7c6d5e4a3b2c1d0e\",\n \"property_id\": \"prop-1234567890abcdef\",\n \"name\": \"Green Valley Landscaping\"\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/vendors/yardi_rest/") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"integration_id\": \"intg-9f8b7c6d5e4a3b2c1d0e\",\n \"property_id\": \"prop-1234567890abcdef\",\n \"name\": \"Green Valley Landscaping\"\n}") .asString(); ``` ```php request('POST', 'https://api.propexo.com/v1/vendors/yardi_rest/', [ 'body' => '{ "integration_id": "intg-9f8b7c6d5e4a3b2c1d0e", "property_id": "prop-1234567890abcdef", "name": "Green Valley Landscaping" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.propexo.com/v1/vendors/yardi_rest/"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"integration_id\": \"intg-9f8b7c6d5e4a3b2c1d0e\",\n \"property_id\": \"prop-1234567890abcdef\",\n \"name\": \"Green Valley Landscaping\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "integration_id": "intg-9f8b7c6d5e4a3b2c1d0e", "property_id": "prop-1234567890abcdef", "name": "Green Valley Landscaping" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.propexo.com/v1/vendors/yardi_rest/")! 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() ```