Select any of the web services below to view details and examples.
Update Specials for the Properties/FloorPlans/UnitTypes/Units
*propertyId [Integer] | This is a required field. This field accepts single value. This is a required field. This field accepts single value. Property ID for insert Specials |
*specialGroupId [Integer] | This is a required field. This field accepts single value. This is a required field. This field accepts single value. This accept s the Special Group Id. |
*specialGroupName [String] | This is a required field. This field accepts single value. This is a required field. This field accepts single value. This accept s the Special Group name. |
internalDescription [String] | This is an optional field. This field accepts single value. This is an optional field. This field accepts single value. This is an internal description that will not be visible to residents. |
isActive [Boolean] | This is an optional field. This field accepts single value. This is a optional field. This field accepts single value. Active dete rmines if the special is eligible to be used. |
isWebVisible [Boolean] | This is an optional field. This field accepts single value. This is a optional field. This field accepts single value. Web Visible determines if the special will be shown in advertising. |
startDate [Date] | This is an optional field. This field accepts single value. This is an optional field. This field accepts single value. Determines if the special will be advertised from this date. |
endDate [Date] | This is an optional field. This field accepts single value. This is an optional field. This field accepts single value. Determines if the special will be advertised to this date. |
hideEndDate [Boolean] | This is an optional field. This field accepts single value. This is a optional field. This field accepts single value. It determin es if the special will be advertised end date. |
marketingDescription [String] | This is an optional field. This field accepts single value. This is an optional field. This field accepts single value. This is th e description shown to the resident which describes the special in gre ater detail. |
termsAndConditions [String] | This is an optional field. This field accepts single value. This is an optional field. This field accepts single value. This is th e terms and conditions which we will display for the specials |
isAdvertised [String] | This is an optional field. This field accepts single value. This is a optional field. This field accepts single value. isAdvertise d determines if the special is manual only special. |
moveInDateFrom [Date] | This is an optional field. This field accepts single value. This is an optional field. This field accepts single value. This optio nal setting allows the special to be given only to residents whose mov e-in date falls within the specified date range. |
moveInDateTo [Date] | This is an optional field. This field accepts single value. This is an optional field. This field accepts single value. This optio nal setting allows the special to be given only to residents whose mov e-in date falls within the specified date range. |
renewalStartDateFrom [Date] | This is an optional field. This field accepts single value. This is an optional field. This field accepts single value.This option al setting allows the special to be given only to residents whose rene wal start date falls within the specified date range. |
renewalStartDateTo [Date] | This is an optional field. This field accepts single value. This is an optional field. This field accepts single value.This option al setting allows the special to be given only to residents whose rene wal start date falls within the specified date range. |
limitQuantity [Boolean] | This is an optional field. This field accepts single value. This is an optional field. This field accepts single value. This setti ng allows you to set limit the specials. |
quantityBudgeted [Integer] | This is an optional field. This field accepts single value. This is an optional field. This field accepts single value. This setti ng allows you to limit the number of specials that will be given. |
couponCode [String] | This is an optional field. This field accepts single value. This is an optional field. This field accepts single value. This setti ng allows you to enter a Promotional Code that must be entered during the application process to receive the special. |
leadSourceId [Integer] | This is an optional field. This field accepts single value. This is a opstional field. This field accepts single value. leadSource Id determines the source of the promo code |
incentiveLimit [Integer] | This is an optional field. This field accepts single value. This is an optional field. This field accepts single value. Determines how many of the incentives the resident receives. For example if a sp ecial has 5 different incentives to choose from and the resident only gets to pick 2 of them. |
isSelectable [Boolean] | This is an optional field. This field accepts single value. This is an optional field. This field accepts single value. Determines if the specials incentive count and incentive limit is same or not. |
specialTriggerTypeIdProspect [Integer] | This is an optional field. This field accepts single value. This is an optional field. This field accepts single value. It determi nes the special trigger type id as prospect. |
specialTriggerTypeIdRenewal [Integer] | This is an optional field. This field accepts single value. This is an optional field. This field accepts single value. It determi nes the special trigger type id as renewal. |
specialRecipientIds [String] | This is an optional field. This field accepts single value. This is an optional field. This field accepts comma separated multiple value. This node indicated the special is applicable for which recipi ent. |
specialGroupSpaceConfigurationIds [String] | This is an optional field. This field accepts single value. This is an optional field. This field accepts comma separated multiple values. This node allows to set space configurations for special |
*specialTypeId [Integer] | This is a required field. This field accepts single value. This is a required field. This field accepts single value. This node i s used to indicated the Special Type |
*specialId [Integer] | This is a required field. This field accepts single value. This is a required field. This field accepts single value. This node i ndicates the special Id |
*specialName [String] | This is a required field. This field accepts single value. This is a required field. This field accepts single value. This node i ndicates the special name |
giftValue [Float] | This is an optional field. This field accepts single value. This is an optional field. This field accepts single value. this node indicates the value of gift type special. |
arCodeId [Integer] | This is an optional field. This field accepts single value. This is an optional field. This field accepts single value.The ar code is the vehicle for telling us how to post this charge to the GL. It a lso tells us the nature of the rate/charge, and all its accompanying c haracteristics. |
arTriggerId [Integer] | This is an optional field. This field accepts single value. This is an optional field. This field accepts single value.This is the event that causes a rate or scheduled charge to post to ar transactio ns (e.g. move in, move out, notice, application, etc) |
arCodeTypeId [Integer] | This is an optional field. This field accepts single value. This is an optional field. This field accepts single value.For Entrata Core properties, this is simply a cache of the ar_code_type_id of the charge code for this rate. For integrated properties, there can be a mismatch, because we allow users to select any AR code, regardless of what tab they are on, but we still need to know which set of rules to apply to the rate, some of which are driven by ar_code_type_id. |
customerRelationshipId [Integer] | This is an optional field. This field accepts single value. This is an optional field. This field accepts single value.The custome r relationship tells us if this is a primary resident, financially res ponsible co-applicant (wife or roommate), non-financially responsible (child or dependent), guarantor, or non-leasing co-applicant (where th e person has to apply, but not sign the lease). This field is only use d for application fees, and should be set to zero when the ar trigger is not an application fee type. |
leaseTermId [Integer] | This is an optional field. This field accepts single value. This is a required field. This field accepts single value.This tells u s if the charge belongs to a 6-month, 12-month, or 18-month lease. For student housing, it tells us if this is the Fall/Winter or Spring/Sum mer lease term. |
leaseTermMonth [Integer] | This is an optional field. This field accepts single value. This is a require field. This field accepts single value. This field i s an integer representation of the lease term. |
leaseStartWindowId [Integer] | This is an optional field. This field accepts single value. This is a required field. This field accepts single value.The lease st art window is the window within which the prospects lease would start. This is an important pricing dimension in revenue management. |
windowStartDate [Date] | This is an optional field. This field accepts single value. This is an optional field. This field accepts single value.The window_ start_date and window_end_date fields are the same as window_start_day s and window_end_days. However, window_start_date and window_end_date fields are used for student housing, and are actual dates rather than relative dates. This is important as student housing lease windows are fixed dates each year, and are not a moving target like we see in con ventional housing. This is not customizable and should be only set to closed ran |
windowEndDate [Date] | This is an optional field. This field accepts single value. This is an optional field. This field accepts single value. The window _start_date and window_end_date fields are the same as window_start_da ys and window_end_days. However, window_start_date and window_end_date fields are used for student housing, and are actual dates rather than relative dates. This is important as student housing lease windows ar e fixed dates each year, and are not a moving target like we see in co nventional housing. This is not customizable and should be only set to closed ra |
arFormulaId [Integer] | This is an optional field. This field accepts single value. This is a required field. This field accepts single value. The AR form ula tells us if this is a flat fee, or derived through some type of eq uation, multiplier, or look up table. |
rateIntervalStart [Integer] | This is an optional field. This field accepts single value. This is an optional field. This field accepts single value. Specials o ccasionally are scheduled to start in a certain month of the lease. Th is field tells us what month of the lease the special should be applie d. |
rateAmount [Float] | This is an optional field. This field accepts single value. This is a required field. This field accepts single value. Rate Amount . |
rateIncreaseIncrement [Float] | This is an optional field. This field accepts single value. This is an optional field. This field accepts single value. if the for mula is set as percent base then we need this field data to calculate rate amount. |
spaceConfigurationId [Integer] | This is an optional field. This field accepts single value. This is an optional field. This field accepts single value. This space configuration exists for student housing, where the property will pri ce a shared room differently than a private room for the same lease te rm. Typically only base rent, and special rent would ever use space co nfigurations. If space configurations arent applicable to a certain ar ea, the space configuration id will be set to zero. Zero means all spa ce configurations. |
showInEntrata [Boolean] | This is an optional field. This field accepts single value. This is a required field. This field accepts single value. This node i s used wheter we want to display this within the entrata |
showOnWebsite [Boolean] | This is an optional field. This field accepts single value. This is a required field. This field accepts single value. This node i s used whether we want to display the pricing on website |
effectiveDate [Date] | This is an optional field. This field accepts single value. This is an optional field. This is the date this rate should become ef fective. |