Leases

Create lease

POST
Create a lease for an integration.

Request

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

Response

This endpoint returns 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
1curl -X POST https://api.propexo.com/v1/leases \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "integration_id": "integration_id"
6}'
200Successful
1{
2 "job_id": "clwh5uics000608me9v74du0a",
3 "data": {}
4}