Create lease
https://api.propexo.com/v1/leases/Create a lease for an integration.
Authentication
- AuthorizationBearerBearer authentication of the form
Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
- string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - Array [
- ]
- Array [
- string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - ]
- Array [
- string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - ]
- Array [
- ]
- string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - Array [
- string
USCA - string
- string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - ]
- Array [
- string
USCA - string
- ]
- Array [
- string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - ]
- Array [
- ]
The type associated with the lease
Show 3 enum values
FixedFixedWithRolloverAtWillThe Propexo unique identifier for the unit
The start date associated with the lease
Show 2 variants
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
Show 1 enum value
USThe Propexo unique identifier for the financial account
The end date associated with the lease
Show 2 variants
Whether to send a welcome email to the tenant
falseThe primary email address associated with the applicant
The secondary email address associated with the resident
Primary phone number associated with the applicant
Possible values: Value must match regular expression ^\d{10}$
Type of the primary phone number
Show 4 enum values
FAXHOMEMOBILEWORKSecondary phone number associated with the applicant
Possible values: Value must match regular expression ^\d{10}$
Type of the secondary phone number
Show 4 enum values
FAXHOMEMOBILEWORKThe date of birth associated with the applicant
Show 2 variants
The second address line associated with the resident
The first alternate address line associated with the resident
Possible values: <= 100 characters
The second alternate address line associated with the resident
Possible values: <= 100 characters
The alternate city associated with the resident
Possible values: <= 100 characters
The alternate state associated with the resident
The alternate zip code associated with the resident
The alternate country associated with the resident
Show 1 enum value
USThe duration in which rent charges will be automatically appended to the lease ledger
Show 9 enum values
MonthlyWeeklyEvery2WeeksQuarterlyYearlyEvery2MonthsDailyEvery6MonthsOneTimeThe rent amount in cents for the lease
Possible values: > 0
The rent due date associated with the lease. The timestamp will be stripped off and only the date will be used
Show 2 variants
The Propexo unique identifier for the property
The Propexo unique identifier for the lease period
The Propexo unique identifier for the floor plan
The move-in date associated with the lease
Show 2 variants
The Propexo unique identifier of the primary contact. This must either be a lead, applicant, or resident in Propexo
tenants object[]
An array of Propexo lead, applicant, or resident IDs. This must also include the primary contact ID
The Propexo unique identifier for the lead, applicant, or resident
The scheduled move-out date associated with the lease
The status associated with the lease
Show 2 enum values
PENDINGACTIVEThe 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
Possible values: > 0
A list of Propexo Resident IDs associated with the lease. The resident must be a primary.
Possible values: >= 1
resident_charges object[]
A list of move in charges for the lease
The Propexo unique identifier for the financial account
The post date for the resident charge
Show 2 variants
Description of the resident charge
The amount of the resident charge, in cents
Possible values: > 0
Whether or not the resident charge is prorated
recurring_resident_charges object[]
A list of recurring charges for the lease
The Propexo unique identifier for the financial account
The start date associated with the recurring resident charge
Show 2 variants
The end date associated with the recurring resident charge
Show 2 variants
Description of the resident charge
The amount of the recurring resident charge, in cents
Possible values: > 0
The day of the month the charge is due
Possible values: > 0 and <= 31
The raw value of the frequency of the recurring resident charge. This will be the frequency (in months) for Rentvine
Possible values: > 0 and <= 12
other_occupants object[]
A list of other occupants for the application
The relationship of the occupant to the applicant
Show 4 enum values
ROOMMATESPOUSEGUARANTOROTHERThe first name associated with the occupant
The last name associated with the occupant
A unique ID you would like to associate with the occupant. This is not the Yardi occupant ID
Possible values: non-empty
The name of your organization. Yardi uses this for associating an occupant
The primary email address associated with the occupant
Primary phone number associated with the occupant
Possible values: Value must match regular expression ^\d{10}$
Type of the primary phone number
Show 4 enum values
FAXHOMEMOBILEWORKSecondary phone number associated with the occupant
Possible values: Value must match regular expression ^\d{10}$
Type of the secondary phone number
Show 4 enum values
FAXHOMEMOBILEWORKThe first address line associated with the occupant
The city associated with the occupant
The state associated with the occupant
Show 70 enum values
AAAEAKALAPARASAZCACOCTDCDEFLFMGAGUHIIAIDINKSKYLAMAMDMEMHMIMNMOMPMSMTNCNENLNJNMNVNYOHOKORPAPRSDTNTXUTVAVIVTWAWIWVWYABBCMBNBNLNTNSNUONPEQCSKYTThe zip code associated with the occupant
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
Possible values: non-empty
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 move-in date to the unit listed in the application
Show 2 variants
The desired move-out date to the unit listed in the application
Show 2 variants
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
Show 2 enum values
SINGLEMARRIEDThe social security number of the applicant
The driver's license number of the applicant
address_history object[]
The address history of the applicant
Possible values: <= 2
The first address line associated with the applicant's historical address
The city associated with the applicant's historical address
The state associated with the applicant
Show 70 enum values
AAAEAKALAPARASAZCACOCTDCDEFLFMGAGUHIIAIDINKSKYLAMAMDMEMHMIMNMOMPMSMTNCNENLNJNMNVNYOHOKORPAPRSDTNTXUTVAVIVTWAWIWVWYABBCMBNBNLNTNSNUONPEQCSKYTThe zip code associated with the applicant's historical address
The country associated with the applicant's historical address. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help
Show 2 variants
Whether notice has been given to the applicant's historical address
The property name of the applicant's historical address
The reason the applicant left their historical address
For the applicant's historical address, the applicant's monthly payment for rent or mortgage in cents
Possible values: >= 0
The date when the applicant moved into their historical address
Show 2 variants
The date when the applicant moved out of their historical address. If this is the applicant's current address, omit this field
Show 2 variants
The phone number of a property manager who works at this address
Possible values: Value must match regular expression ^\d{10}$
The email of a property manager who works at this address
The name of the company who owns the property at this address
emergency_contacts object[]
A list of emergency contacts for the applicant
Possible values: <= 1
The first name of the emergency contact
The last name of the emergency contact
The relationship of the emergency contact to the applicant
Show 6 enum values
DAUGHTERFRIENDHUSBANDSONWIFEOTHERThe first line of the address of the emergency contact
The city of the address of the emergency contact
The state of the address of the emergency contact
Show 70 enum values
AAAEAKALAPARASAZCACOCTDCDEFLFMGAGUHIIAIDINKSKYLAMAMDMEMHMIMNMOMPMSMTNCNENLNJNMNVNYOHOKORPAPRSDTNTXUTVAVIVTWAWIWVWYABBCMBNBNLNTNSNUONPEQCSKYTThe zip code of the address of the emergency contact
The country of the address of the emergency contact. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help
Show 2 variants
The phone number of the emergency contact
Possible values: Value must match regular expression ^\d{10}$
employment_history object[]
The employment history of the applicant
Possible values: <= 2
Whether this employment history entry is for a current employer
The name of the employer
The start date of the applicant's employment at this employer
Show 2 variants
The end date of the applicant's employment at this employer. Ignore this field if is_current_employer is set to true
Show 2 variants
The first line of the address of the employer
The city of the address of the employer
The state of the address of the employer
Show 70 enum values
AAAEAKALAPARASAZCACOCTDCDEFLFMGAGUHIIAIDINKSKYLAMAMDMEMHMIMNMOMPMSMTNCNENLNJNMNVNYOHOKORPAPRSDTNTXUTVAVIVTWAWIWVWYABBCMBNBNLNTNSNUONPEQCSKYTThe zip code of the address of the employer
The phone number of the employer
Possible values: Value must match regular expression ^\d{10}$
The first name of the applicant's supervisor at this employer
The last name of the applicant's supervisor at this employer
The position held at this employer, or the job description of the applicant
The monthly income of the applicant at this employer in cents
Possible values: >= 0
other_income object[]
A list of other income sources for the applicant
Possible values: <= 2
The source of the income for the applicant
The monthly income from this income source in cents
Possible values: >= 0
vehicles object[]
A list of vehicles for the application
Possible values: <= 4
The make of the vehicle
The model of the vehicle
The year the vehicle was made
The color of the vehicle
The license plate number of the vehicle
The issuing state of the license plate
pets object[]
A list of applicant pets
Possible values: <= 6
The type associated with the applicant pet
The name associated with the applicant pet
The age in years of the applicant pet
Possible values: >= 0
The weight in pounds of the applicant pet
Possible values: >= 0
The breed of the applicant pet
The color of the applicant pet
The raw value for the gender of the applicant pet
Whether the applicant pet is fixed
Whether the applicant pet is a service animal
concession_fees object[]
A list of concession fees for the application
The start date of the applicant's recurring concession fee
Show 2 variants
The end date of the applicant's recurring concession fee
Show 2 variants
The Propexo unique identifier for the concession. This concession must be associated with the unit that the applicant is applying for
application_fees object[]
A list of application fees for the application
The Propexo unique identifier for the charge code. This must be an application fee charge code
The application fee amount in cents
Possible values: >= 0
Description of the application fee
Response
Successful response
The ID of the job created to handle this operation
data objectrequired
Errors
400Bad Request
error objectrequired
codestringrequiredExample:invalid_requestmessagestringrequiredExample:invalid requestdetails object
property name*anyExample:{"details":{"issues":[{"code":"unrecognized_keys","keys":["foo"],"path":[],"message":"Unrecognized key(s) in object: 'foo'"}],"name":"ZodError"}}
curl -X POST https://api.propexo.com/v1/leases/ \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"integration_id": "string"
}'
{
"job_id": "string",
"data": {}
}