Leases

Create lease

POST
https://api.propexo.com/v1/leases
Create a lease for an integration.

Request

This endpoint expects an object.
integration_id
string
type
optional enum
The type associated with the lease
Allowed values: FixedFixedWithRolloverAtWill
x_unit_id
optional string
The external ID of the unit from the integration vendor
start_date
optional datetime
The start date associated with the lease
end_date
optional datetime
The end date associated with the lease
send_welcome_email
optional boolean
Whether to send a welcome email to the tenant
first_name
optional string
The first name associated with the resident
last_name
optional string
The last name associated with the resident
email_1
optional string
The primary email address associated with the resident
email_2
optional string
The secondary email address associated with the resident
phone_1
optional string
'Primary phone number associated with the resident
phone_1_type
optional enum
Type of the primary phone number
Allowed values: HOMEWORKMOBILEFAX
phone_2
optional string
'Secondary phone number associated with the resident
phone_2_type
optional enum
Type of the secondary phone number
Allowed values: HOMEWORKMOBILEFAX
date_of_birth
optional datetime
The date of birth associated with the resident
address_1
optional string
The first address line associated with the resident
address_2
optional string
The second address line associated with the resident
city
optional string
The city associated with the resident
state
optional string
The state associated with the resident
zip
optional string
The zip code associated with the resident
country
optional "US"
address_1_alternate
optional string
The first alternate address line associated with the resident
address_2_alternate
optional string
The second alternate address line associated with the resident
city_alternate
optional string
The alternate city associated with the resident
state_alternate
optional string
The alternate state associated with the resident
zip_alternate
optional string
The alternate zip code associated with the resident
country_alternate
optional string
The alternate country associated with the resident
rent_cycle
optional enum
The duration in which rent charges will be automatically appended to the lease ledger
rent_amount_in_cents
optional integer
The rent amount in cents for the lease
rent_due_date
optional string
The rent due date associated with the lease
gl_account_id
optional string
The external ID of the general ledger account from the integration vendor
property_id
optional string
The Propexo unique identifier for the property
unit_id
optional string
The Propexo unique identifier for the unit
floor_plan_id
optional string
The external ID of the floor plan from the integration vendor
scheduled_move_in_date
optional datetime
The move-in date associated with the lease
lease_term_in_months
optional integer
The amount of months for the lease term
resident_id
optional string
The Propexo unique identifier for the resident
scheduled_move_out_date
optional datetime
The move-out date associated with the lease
realized_move_in_date
optional datetime
The move-in date associated with the lease
realized_move_out_date
optional datetime
The move-out date associated with the lease
x_property_id
optional string
The external ID of the property from the integration vendor
x_resident_id
optional string
The external ID of the resident from the integration vendor
primary_contact_id
optional string
The Propexo unique identifier of the primary contact. This must either be a lead, applicant, or resident in Propexo
tenants
optional list of objects
An array of Propexo lead, applicant, or resident IDs. This must also include the primary contact ID
status
optional enum
The status associated with the lease
Allowed values: DraftActiveActive - Notice GivenTerminatedEviction

Response

This endpoint return an object.
job_id
string
The ID of the job created to handle this operation
data
object
Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.
POST
/v1/leases
curl -X POST https://api.propexo.com/v1/leases \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"integration_id": "integration_id"
}'
Response
{
"job_id": "job_id",
"data": {}
}