Webhooks V3 | Lease Events

« Back to Webhooks V3

Lease Events

• Lease Move In
• Lease Move In Canceled

Lease Move In

Event Type: lease.move_in

This event is published when a renter should be marked as moved in.

Attributes

• move_in_date String/ISODate The lease start date
• pms_identifier String The identifier for this renter in PMS
• community_pms_identifier String The identifier for the community in PMS
• charges List A list of charges to apply at move in
  • charge_type String Indicates whether this is a one time or monthly charge
  • pms_identifier String The charge code to use with this charge
  • start_date String/ISODate The first date the charge should be applied
  • end_date String/ISODate The last date the charge should be applied
  • amount Integer How much the charge is for in cents.
  • description String A summary of the charge

Example Event

{
  "id": "3eb29a92-e480-40ee-9a9f-61fff5e3f3d5",
  "event": "lease.move_in",
  "timestamp": "2023-03-11T14:23:56.010+00:00",
  "data": {
    "move_in_date": "2023-03-11",
    "pms_identifier": "t0000000",
    "community_pms_identifier": "123",
    "charges": [
      {
        "charge_type": "Monthly",
        "pms_identifier": "rent",
        "start_date": "2023-03-11",
        "end_date": "2024-03-10",
        "amount": 250000,
        "description": "Rent"
      },
      {
        "charge_type": "Monthly",
        "pms_identifier": "pet",
        "start_date": "2023-03-11",
        "end_date": "2024-03-10",
        "amount": 5000,
        "description": "Dog Rent"
      }
    ]
  }
}

Lease Move In Canceled

Event Type: lease.move_in_canceled

This event is published when a renter’s move in should be canceled/reversed. This may occur if an update needs to be made to the lease or if the renter has not actually moved in at the property.

Attributes

• move_in_date String/ISODate The lease start date
• pms_identifier String The identifier for this renter in PMS
• community_pms_identifier String The identifier for the community in PMS

Example Event

{
  "id": "3eb29a92-e480-40ee-9a9f-61fff5e3f3d5",
  "event": "lease.move_in_canceled",
  "timestamp": "2023-03-11T14:23:56.010+00:00",
  "data": {
    "move_in_date": "2023-03-11",
    "pms_identifier": "t0000000",
    "community_pms_identifier": "123"
  }
}