YardiLeases

Create Lease: Yardi

Create Lease: Yardi | Interface | Method | |---|---| | ILS Guest Card | ImportYardiGuest_Login | | ILS Guest Card | ImportApplication_Login |

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
integration_idstringRequired
The Propexo unique identifier for the integration
property_idstringRequired
The Propexo unique identifier for the property
unit_idstringRequired
The Propexo unique identifier for the unit
lead_idstringOptional
The Propexo unique identifier for the lead. The lead will be converted to an applicant
employee_idstringOptional

The Propexo unique identifier for the employee. Employee must have a role of LEASING_AGENT. Required if lead_id is not specified

lead_source_idstringOptional

The Propexo unique identifier for the lead source. Required if lead_id is not specified

third_party_idstringOptional>=1 character

A unique ID you would like to associate with the applicant. This is not the Yardi applicant ID. Required if lead_id is not specified

organization_namestringOptional

The name of your organization. Yardi uses this for associating an applicant. Required if lead_id is not specified

first_namestringOptional

The first name associated with the applicant. Required if lead_id is not specified

last_namestringOptional

The last name associated with the applicant. Required if lead_id is not specified

middle_namestringOptional
The middle name associated with the applicant
maiden_namestringOptional
The maiden name associated with the applicant
email_1stringOptionalformat: "email"
The primary email address associated with the applicant
phone_1stringOptionalformat: "^\d{10}$"
Primary phone number associated with the applicant
phone_1_typeenumOptional
Type of the primary phone number
Allowed values:
phone_2stringOptionalformat: "^\d{10}$"
Secondary phone number associated with the applicant
phone_2_typeenumOptional
Type of the secondary phone number
Allowed values:
move_in_datestringOptional

The desired move-in date to the unit listed in the application

move_out_datestringOptional

The desired move-out date to the unit listed in the application

desired_lease_term_in_monthsstringOptional
The desired lease term in months of the applicant
date_of_birthstringOptional
The date of birth associated with the applicant
notesstringOptional
Notes associated with the applicant
is_evictedbooleanOptional
Whether the applicant has been evicted
is_felonybooleanOptional
Whether the applicant has a felony
is_criminal_chargebooleanOptional
Whether the applicant has a criminal charge
eviction_descriptionstringOptional
The description of the eviction
felony_descriptionstringOptional
The description of the felony
criminal_charge_descriptionstringOptional
The description of the criminal charge
marital_statusenumOptional
The marital status of the applicant
Allowed values:
identification_numberstringOptional
The social security number of the applicant
drivers_license_numberstringOptional
The driver's license number of the applicant
address_historylist of objectsOptional
The address history of the applicant
emergency_contactslist of objectsOptional
A list of emergency contacts for the applicant
employment_historylist of objectsOptional
The employment history of the applicant
other_incomelist of objectsOptional
A list of other income sources for the applicant
vehicleslist of objectsOptional
A list of vehicles for the application
petslist of objectsOptional
A list of applicant pets
concession_feeslist of objectsOptional
A list of concession fees for the application
application_feeslist of objectsOptional
A list of application fees for the application
other_occupantslist of objectsOptional
A list of other occupants for the application

Response

Successful response
metaobject
resultobject

Errors