Service

Name	Edit Property Policies
Description	Edit the policies of a property
Method	PUT
URL	/properties/{property}/policies
Example	/api/properties/11111111/policies
Access	OWNER, MANAGER

HTTP Headers

Authorization	eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields	Type	Required	Description
property	number	yes	Property id.
cleaning_fee	number	no	If apply fee per cleaning property after used.
cleaning_tax	bool	no	If apply tax for price of the cleaning, fill only when cleaning_fee has a value.
pet_fee	number	no	If apply fee per pets.
pet_tax	bool	no	If apply tax for price of the pet_fee, fill only when pet_fee has a value.
lodging_tax	number	no	If apply lodging tax over rent, fill only in percent.
sales_tax	number	no	If apply sales tax over rent, fill only in percent.
damage_deposit	number	no	Value for security damage deposit.
damage_deposit_hold	bool	no	Allow to HomeEscape hold the damage deposit, is required if damage_deposit has value.
damage_deposit_hold_days	number	no	Number the days to hold damage deposit after check in (3-30), is required if damage_deposit has value.
other_fees	array	no	Adds other fees.
cancellation_policy	number	yes	Flexible, Standard, Rigid, Strict, No-Refund, Other.
cancellation_policy_additional	text	no	Additional information about policy for cancellation.
type_payment	number	yes	0 - Single Payment, 1 - Multi Payment.
first_payment	number	no	Required if multi payment, then first_payment + second_payment = 100.
second_payment	number	no	Required if multi payment, then first_payment + second_payment = 100.
due_date	number	no	Required if multi payment, value between 0 and 90.
check_in	time	no	Only hour between 0 and 23.
check_out	time	no	Only hour between 0 and 23.
max_stay	number	no	Maximum of nigth that the traveler may reserve.
deposit_requirements	text	no	Information about deposit requirements.
house_rules	text	no	Information about house rules.

Parameter: other_fees

Fields	Type	Required	Description
[name]	text	yes	Name of the fee.
[value]	number	yes	Value of the fee.
[type]	number	yes	Value: 1 - fixed, 2 - percent.
[tax]	bool	yes	If fee is taxable.

Response

            
                {
                    "code": R111,
                    "message": "Success"
                }
            
            

Response Codes

Code	Message	Cause	Possible Frontend Message [Behavior]
EC000	Internal error in API	Internal error connecting the database	"Oops! Looks like we hit a snag. Try closing the app and reopening it."
EC001	User not found	Token user id doesn't match our records	"Sorry, We couldn't find your information!"
EC002	Property not found	Property id doesn't match our records	"Sorry, We couldn't find that property!"
EC014	Property does not belong to the user	The user logged in is not the property's owner	"Sorry, you do not have access to that property!"
R000	Fail	The policies were not updated
R111	Success	The operation was successful
SC006	User no authorization	The token role is not valid for using the API services	"You have been logged out." - [Take the user to the login screen]
SC014	Expired token	The token has expired	"You have been logged out." - [Take the user to the login screen]
VID112	Invalid input for property	Property id is not a number	[Call the API again using a valid value for property id]
VID187	Invalid input for cleaning_fee	Cleaning_fee is not a number or it has more than 7 digits	"Cleaning fee must have only numbers"
VID188	Invalid input for cleaning_tax	Cleaning_tax is not in [0, 1]	[Call the API again using a valid value for cleaning_tax]
VID189	Invalid input for pet_fee	Pet_fee is not a number or it has more than 7 digits	"Pet fee must have only numbers"
VID190	Invalid input for pet_tax	Pet_tax is not in [0, 1]	[Call the API again using a valid value for pet_tax]
VID191	Invalid input for lodging_tax	Lodging_tax is not a number or it has more than 5 digits	"Lodging tax must have only numbers"
VID192	Invalid input for sales_tax	Sales_tax is not a number or it has more than 5 digits	"Sales tax must have only numbers"
VID193	Invalid input for damage_deposit	Damage_deposit is not a number or it has more than 7 digits	"Damage deposit must have only numbers"
VID194	Invalid input for damage_deposit_hold	Damage_deposit_hold is not in [0, 1]	[Call the API again using a valid value for damage_deposit_hold]
VID195	Invalid input for cancellation_policy	Cancellation_policy is empty or it is not in ["Flexible", "Standard", "Rigid", "Strict", "No-Refund", "Other"]	"Please select an item in the list" - [Call the API again using a valid value for cancellation_policy]
VID196	Invalid input for cancellation_policy_additional	Cancellation_policy_additional is empty, has more than 2000 characters or it has only characters not allowed(" ", ', ’, ‘, ’, ", &, \, <, >, --)	"Please fill out this field" - "Please enter a valid text for Additional Information"
VID197	Invalid input for type_payment	Type_payment is not in [0, 1]	[Call the API again using a valid value for type_payment]
VID198	Invalid input for first_payment	First_payment is not a number between 0-100	[Call the API again using a valid value for first_payment]
VID199	Invalid input for second_payment	Second_payment is not a number between 0-100	[Call the API again using a valid value for second_payment]
VID200	Invalid input the sum of payments must equal 100 percent	The sum of First_payment + Second_payment is not a number between 0-100	[Call the API again using a valid value for first_payment and/or second_payment]
VID201	Invalid input for due_date	Due_date is not a number between 0-90	[Call the API again using a valid value for due_date]
VID202	Invalid input for check_in	Check_in is not a number between 0-23	[Call the API again using a valid value for check_in hour]
VID203	Invalid input for check_out	Check_out is not a number between 0-23	[Call the API again using a valid value for check_out hour]
VID204	Invalid input for max_stay	Max_stay is not a number	[Call the API again using a valid value for max_stay]
VID205	Invalid input for deposit_requirements	Deposit_requirements has more than 2000 characters or it has only characters not allowed(" ", ', ’, ‘, ’, ", &, \, <, >, --)	"Please enter a valid text for Deposit Requirements"
VID206	Invalid input for house_rules	House_rules has more than 2000 characters or it has only characters not allowed(" ", ', ’, ‘, ’, ", &, \, <, >, --)	"Please enter a valid text for House Rules"
VID209	Invalid input for array other_fees	Other_fees is not an array with less than 5 items	[Call the API again using a valid value for other_fees]
VID210	Invalid input for name in other_fees "x"	Name in other_fees has more than 80 characters or it has only characters not allowed	"Please enter a valid text for Fee Name"
VID211	Invalid input for value in other_fees "x"	Value in other_fees is not a number or it has more than 7 digits	"Fee value must have only numbers"
VID212	Invalid input for tax in other_fees "x"	Tax in other_fees is not in [0, 1]	[Call the API again using a valid value for tax in other_fees]
VID213	Invalid input for type in other_fees "x"	Type in other_fees is not in [0, 1]	[Call the API again using a valid value for type in other_fees]
VID215	Invalid input for damage_deposit_hold_days	Damage_deposit_hold_days is not a number between 3-30	[Call the API again using a valid value for damage_deposit_hold_days]