Leases

Create Lease: Buildium

Create Lease: Buildium

InterfaceMethod
LeasesPOST /leases

<Note title="Notice">This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately.</Note>

post/v1/leases/buildium/

Request

  • Base URL: https://api.propexo.com
  • URL: https://api.propexo.com/v1/leases/buildium/
  • Auth: HTTP bearer

Request body

integration_idstring required

The Propexo unique identifier for the integration

type'Fixed' | 'FixedWithRollover' | 'AtWill' required

The type associated with the lease

unit_idstring required

The Propexo unique identifier for the unit

start_datestring date-time required

The start date associated with the lease

first_namestring required

The first name associated with the resident

last_namestring required

The last name associated with the resident

address_1string required

The first address line associated with the resident

citystring required

The city associated with the resident

statestring required

The state associated with the resident

zipstring required

The zip code associated with the resident

country'US' required

The country associated with the resident

financial_account_idstring

The Propexo unique identifier for the financial account

end_datestring date-time

The end date associated with the lease

send_welcome_emailboolean

Whether to send a welcome email to the tenant

email_1string email

The primary email address associated with the resident

email_2string email

The secondary email address associated with the resident

phone_1string

Primary phone number associated with the resident

phone_1_type'HOME' | 'WORK' | 'MOBILE' | 'FAX'

Type of the primary phone number

phone_2string

Secondary phone number associated with the resident

phone_2_type'HOME' | 'WORK' | 'MOBILE' | 'FAX'

Type of the secondary phone number

address_2string

The second address line associated with the resident

address_1_alternatestring

The first alternate address line associated with the resident

address_2_alternatestring

The second alternate address line associated with the resident

city_alternatestring

The alternate city associated with the resident

state_alternatestring

The alternate state associated with the resident

zip_alternatestring

The alternate zip code associated with the resident

country_alternate'US'

The alternate country associated with the resident

rent_cycle'Monthly' | 'Weekly' | 'Every2Weeks' | 'Quarterly' | 'Yearly' | 'Every2Months' | 'Daily' | 'Every6Months' | 'OneTime'

The duration in which rent charges will be automatically appended to the lease ledger

rent_amount_in_centsinteger

The rent amount in cents for the lease

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.