API

Code Snippet

Select any of the web services below to view details and examples.

API » Pricing » insertPricing

insertPricing

insertPricing allows updating pricing at a different level with multiple combinations. All nodes create a number of combinations and depending on the property setup API accepts the data. E.g If the property has the setup to accept term wise pricing then only API can accept the allowed terms under the node "leaseTermMonths". Please note that this API is designed for Conventional property type and may not work for other property types.



*pricingLevelId [Integer] This is a required field. This field accepts single value. Pricing level has four possible values, 1: property, 2: floor plan 3: Unit type 4: Unit space.
*pricingLevelReferenceId [Integer] This is a required field. This field accepts single value. This is Entrata's record id depending on #pricingLevelId. E.g. If pric ingLevelId = 4 then pricingLevelReferenceId needs to be unit space id.
*chargeUsageId [Integer] This is a required field. This field accepts single value. This helps to differentiate pricing usage. 1. Base 2: Amenity 3: Pet 4: Add-Ons 5: Risk Premium 7: Maintenance
*chargeUsageReferenceId [Integer] This is a required field. This field accepts single value. This value needs to set if needs to update pricing any other than base rent. E.g if want to update amenity rent then chargeUsageReferenceId should amenity id. In the case of base pricing, it needs to be 0.
isRenewal [Integer] This is an optional field. This field accepts single value. Just to specify if it is renewal rent.
*chargeTimingId [Integer] This is a required field. This field accepts single value. This explains when charge suppose to apply [charge trigger timing]. E .g. There are a number of possible values but common is 307: Monthly 202: Move In 206: Move Out 102: Application Completed
*chargeCodeTypeId [Integer] This is a required field. This field accepts single value. This explains charge code types. 1: Payment 2: Rent 3: Other Income 7: Deposit
*chargeCodeId [Integer] This is a required field. This field accepts single value. This is Entrata charge code id which we want to use.
leaseTermMonths [Integer] This is an optional field. This field accepts single value. Most of the cases it will be zero but if the property has the setup to have term wise pricing/rent then you can send the different pricing f or different terms. Zero means single value for all lease terms.
leaseStartRangeStart [Integer] This is an optional field. This field accepts single value. This nodes allows to send different rent amount for different move in dates but with same intervals. Refer Property setting: Price By Lease Start Range. E.g Property has pricing setup to have 3 days interval pricing then data can looks like, leaseStartRangeStart:0 leaseStartRa ngeEnd:2 amount:700 Zero represents current date or unit's available on the date [if available on a date is in future]. If sending 'isRe newal' as true this value should always be sent as 0
leaseStartRangeEnd [Integer] This is an optional field. This field accepts single value. This nodes allows to send different rent amount for different move in dates but with the same intervals. E.g Property has pricing setup to have 3 days interval pricing then data can look like, leaseStartRange Start:0 leaseStartRangeEnd:2 amount:700. If sending 'isRenewal' as true this value should always be sent as 0
*amount [Float] This is a required field. This field accepts single value. Rate Amount.
*leaseTermName [String] This is a required field. This field accepts single value. If there are multiple lease terms with same length then this node is m andatory.
No Parameters Found.

Request URL

https://YOUR_DOMAIN.entrata.com/api/pricing

Request Type

Request Copy to Clipboard

Response Copy to Clipboard



/* An Example XML Request */
string xmlRequest = '';

/* An Example JSON Request */ string jsonRequest = '';
/* Initiate a Web Request object */ HttpWebRequest webRequest = null; webRequest = WebRequest.Create(' REPLACE THIS WITH THE WEB SERVICE URL ') as HttpWebRequest; webRequest.Method = 'POST'; webRequest.Headers.Add("Authorization", "Basic ");
/* Add Form data */
FileInfo fi = new FileInfo(@"E:\RabitMQ\Learn RabbitMQ With C.pdf"); string fileName = fi.Name; byte[] fileContents = File.ReadAllBytes(fi.FullName);
string boundary = "--AaB03x";
StringBuilder sb = new StringBuilder();
sb.AppendLine(boundary); sb.AppendLine(string.Format("Content-Disposition: form-data; name=\"{0}\"", "requestBody")); sb.AppendLine(); sb.AppendLine(xmlRequest);
sb.AppendLine(boundary); sb.AppendLine(string.Format("Content-Disposition: form-data; name=\"{0}\"", "requestContentType")); sb.AppendLine(); sb.AppendLine("application/xml; CHARSET=UTF-8");
sb.AppendLine(boundary); sb.AppendLine(string.Format("Content-Disposition: file; name=\"{0}\"; filename=\"{1}\"", "file1", fileName)); sb.AppendLine("Content-Type: application/octet-stream"); sb.AppendLine(); sb.AppendLine(Encoding.UTF8.GetString(fileContents)); sb.AppendLine(boundary);
/* Initiate the request writer */ StreamWriter requestWriter = new StreamWriter(webRequest.GetRequestStream());
/* If you want to send an XML Request, use these options */ webRequest.ContentType = "multipart/form-data; boundary=AaB03x"; requestWriter.Write(xmlRequest);
/* If you want to send an XML Request, use these options */ webRequest.ContentType = 'multipart/form-data; boundary=AaB03x'; requestWriter.Write(jsonRequest);
requestWriter.Close();
/* Read the response */ StreamReader responseReader = new StreamReader(webRequest.GetResponse().GetResponseStream()); string responseData = responseReader.ReadToEnd(); responseReader.Close();

/* An Example XML Request */
string xmlRequest = '';

/* An Example JSON Request */ string jsonRequest = '';
import java.io.InputStream; import org.apache.commons.httpclient.HttpClient;
public class PostExample {
public static void main(String[] args){
HttpClient httpClient = new DefaultHttpClient();
try { HttpPost request = new HttpPost("REPLACE THIS WITH THE WEB SERVICE URL"); request.addHeader("Authorization", "Basic <BASE64 ENCODED VALUE OF USERNAME:PASSWORD>"); request.addHeader("content-type", "multipart/form-data");
File file1 = new File("[/path/to/upload]");
MultipartEntityBuilder builder = MultipartEntityBuilder.create(); builder.addBinaryBody( "file1", new FileInputStream( file1 ), ContentType.APPLICATION_OCTET_STREAM, file1.getName() );
/* If you want to send an XML Request, use these options */ builder.addTextBody( "requestBody", xmlRequest ); builder.addTextBody( "requestContentType", "APPLICATION/XML; CHARSET=UTF-8" );
/* If you want to send an JSON Request, use these options */ builder.addTextBody( "requestBody", jsonRequest ); builder.addTextBody( "requestContentType", "APPLICATION/JSON; CHARSET=UTF-8" );
HttpEntity multipartFormData = builder.build(); request.setEntity( multipartFormData );
HttpResponse response = httpClient.execute(request);
// handle response here... System.out.println(response); }catch (Exception ex) { // handle exception here ex.printStackTrace(); } finally { httpClient.getConnectionManager().shutdown(); } } }

/* An Example XML Request */
string xmlRequest = '' ;

/* An Example JSON Request */ $jsonRequest = '' ;
$resCurl = curl_init();
curl_setopt( $resCurl, CURLOPT_POST, true ); curl_setopt( $resCurl, CURLOPT_URL, REPLACE THIS WITH THE WEB SERVICE URL ); curl_setopt( $resCurl, CURLOPT_RETURNTRANSFER, 1 );
$strFirstFileName = '<filename with path>'; $strSecondFileName = '<filename with path>'; if( true == function_exists( 'curl_file_create' ) ) { $strFirsFilePath = curl_file_create( $strFirstFileName ); $strSecondFilePath = curl_file_create( $strSecondFileName ); } else { $strFirsFilePath = '@' . realpath( $strFirstFileName ); $strSecondFilePath = '@' . realpath( $strSecondFileName ); }
/* If you want to send an XML Request, use these options */ $arrmixPost = [ 'requestContentType' => 'APPLICATION/XML; CHARSET=UTF-8', 'requestBody' => $xmlRequest, 'file1' => $strFirsFilePath, 'file2' => $strSecondFilePath ]; /* If you want to send a JSON Request, use these options */ $arrmixPost = [ 'requestContentType' => 'APPLICATION/JSON; CHARSET=UTF-8', 'requestBody' => $jsonRequest, 'file1' => $strFirsFilePath, 'file2' => $strSecondFilePath ];
curl_setopt( $resCurl, CURLOPT_HTTPHEADER, array( 'Content-type: multipart/form-data', 'Authorization: Basic <BASE64 ENCODED VALUE OF USERNAME:PASSWORD>' ) ); curl_setopt( $resCurl, CURLOPT_POSTFIELDS, $arrmixPost ); $result = curl_exec( $resCurl ); if( false === $result ) { echo 'Curl error: ' . curl_error( $resCurl ); curl_close( $resCurl ); } else { curl_close( $resCurl ); echo $result; }

Your life is about to
get a whole lot easier

Sign in
to Entrata