Create lease
Create a lease for an integration.
Request
- Base URL: https://api.propexo.com
- URL: https://api.propexo.com/v1/leases/
- Auth: HTTP bearer
Request body
The type associated with the lease
The Propexo unique identifier for the unit
The first name associated with the applicant. Required if lead_id is not specified
The last name associated with the applicant. Required if lead_id is not specified
The first address line associated with the resident
The city associated with the resident
The state associated with the resident
The zip code associated with the resident
The country associated with the resident
The Propexo unique identifier for the financial account
Whether to send a welcome email to the tenant
The primary email address associated with the applicant
The secondary email address associated with the resident
Primary phone number associated with the applicant
Type of the primary phone number
Secondary phone number associated with the applicant
Type of the secondary phone number
The second address line associated with the resident
The first alternate address line associated with the resident
The second alternate address line associated with the resident
The alternate city associated with the resident
The alternate state associated with the resident
The alternate zip code associated with the resident
The alternate country associated with the resident
The duration in which rent charges will be automatically appended to the lease ledger
The rent amount in cents for the lease
The Propexo unique identifier for the property
The Propexo unique identifier for the lease period
The Propexo unique identifier for the floor plan
The Propexo unique identifier of the primary contact. This must either be a lead, applicant, or resident in Propexo
The scheduled move-out date associated with the lease
The status associated with the lease
The Propexo unique identifier for the resident
The move-in date associated with the lease
The move-out date associated with the lease
The Propexo unique identifier for the employee. Employee must have a role of LEASING_AGENT. Required if lead_id is not specified
The NSF fee amount in cents for the lease
A list of Propexo Resident IDs associated with the lease. The resident must be a primary.
The Propexo unique identifier for the lead. The lead will be converted to an applicant
The Propexo unique identifier for the lead source. Required if lead_id is not specified
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
The name of your organization. Yardi uses this for associating an applicant. Required if lead_id is not specified
The middle name associated with the applicant
The maiden name associated with the applicant
The desired lease term in months of the applicant
Notes associated with the applicant
Whether the applicant has been evicted
Whether the applicant has a felony
Whether the applicant has a criminal charge
The description of the eviction
The description of the felony
The description of the criminal charge
The marital status of the applicant
The social security number of the applicant
The driver's license number of the applicant
Response
Successful response
The ID of the job created to handle this operation
Changes
No recorded changes to this operation across all 1 revision of this API.