PMS Generic APIsLeases

Create lease

Create a lease for an integration.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
integration_idstringRequired
typeenumOptional
The type associated with the lease
Allowed values:
unit_idstringOptional
The Propexo unique identifier for the unit
start_datestringOptional
The start date associated with the lease
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

address_1stringOptional
The first address line associated with the resident
citystringOptional
The city associated with the resident
statestringOptional
The state associated with the resident
zipstringOptional
The zip code associated with the resident
countryenumOptional
The country associated with the resident
Allowed values:
financial_account_idstringOptional
The Propexo unique identifier for the financial account
end_datestringOptional
The end date associated with the lease
send_welcome_emailbooleanOptionalDefaults to false
Whether to send a welcome email to the tenant
email_1stringOptionalformat: "email"
The primary email address associated with the applicant
email_2stringOptionalformat: "email"
The secondary email address associated with the resident
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:
date_of_birthstringOptional
The date of birth associated with the applicant
address_2stringOptional
The second address line associated with the resident
address_1_alternatestringOptional<=100 characters
The first alternate address line associated with the resident
address_2_alternatestringOptional<=100 characters
The second alternate address line associated with the resident
city_alternatestringOptional<=100 characters
The alternate city associated with the resident
state_alternatestringOptional
The alternate state associated with the resident
zip_alternatestringOptional
The alternate zip code associated with the resident
country_alternateenumOptional
The alternate country associated with the resident
Allowed values:
rent_cycleenumOptional
The duration in which rent charges will be automatically appended to the lease ledger
rent_amount_in_centsintegerOptional
The rent amount in cents for the lease
rent_due_datestringOptional
The rent due date associated with the lease. The timestamp will be stripped off and only the date will be used
property_idstringOptional
The Propexo unique identifier for the property
lease_period_idstringOptional
The Propexo unique identifier for the lease period
floor_plan_idstringOptional
The Propexo unique identifier for the floor plan
scheduled_move_in_datestringOptional

The move-in date associated with the lease

primary_contact_idstringOptional
The Propexo unique identifier of the primary contact. This must either be a lead, applicant, or resident in Propexo
tenantslist of objectsOptional
An array of Propexo lead, applicant, or resident IDs. This must also include the primary contact ID
scheduled_move_out_datestringOptionalformat: "date-time"

The scheduled move-out date associated with the lease

statusenumOptional
The status associated with the lease
Allowed values:
resident_idstringOptional
The Propexo unique identifier for the resident
realized_move_in_datestringOptionalformat: "date-time"

The move-in date associated with the lease

realized_move_out_datestringOptionalformat: "date-time"

The move-out date associated with the lease

employee_idstringOptional

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

nsf_fee_amount_in_centsintegerOptional
The NSF fee amount in cents for the lease
associated_resident_idslist of stringsOptional
A list of Propexo Resident IDs associated with the lease. The resident must be a primary.
resident_chargeslist of objectsOptional
A list of move in charges for the lease
recurring_resident_chargeslist of objectsOptional
A list of recurring charges for the lease
other_occupantslist of objectsOptional
A list of other occupants for the application
lead_idstringOptional
The Propexo unique identifier for the lead. The lead will be converted to an applicant
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

middle_namestringOptional
The middle name associated with the applicant
maiden_namestringOptional
The maiden name associated with the applicant
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
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

Response

Successful response
job_idstring
The ID of the job created to handle this operation
dataobject

Errors

400
Bad Request Error