Lease
{
"job_id": "string",
"data": {}
}Path Parameters
The ID of the resource.
The ID of the resource.
Body
The lease type. The value of this field must be one of "Fixed", "FixedWithRollover", or "AtWill"
Fixed, FixedWithRollover, AtWill The external ID of the unit from the integration vendor
The date that the lease begins
The date that the lease ends
Boolean indicating whether the lease has an eviction pending. If not set, defaults to "false"
Boolean indicating whether residents should be set to "past" status automatically at the expiration of the lease. If not set, defaults to "false"
The Propify unique identifier for the lease
The Propify unique identifier for the property
The Propify unique identifier for the unit
The Propify unique identifier for the resident. Required if updating resident information.
The move in date
The first name of the primary resident on this lease.
The last name of the primary resident on this lease.
The first line of the primary resident's address.
The second line of the primary resident's address.
The city of the primary resident's address.
The state of the primary resident's address.
The postal code of the primary resident's address.
The email address for the primary resident on this lease.
The phone number of the primary resident on this lease.
The date of birth for the primary resident on this lease.
The external ID of the property from the integration vendor
The external ID of the resident from the integration vendor
The move out date
The date that the resident moved in
The date that the resident moved out
The Propify unique identifier of the primary contact. This must either be a lead, applicant or resident in Propify
An array of Propify lead, applicant, or resident IDs. This must also include the primary contact ID
The status of the lease
Draft, Active, Active - Notice Given, Terminated, Eviction Response
The ID of the job created to handle this operation
Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.