Leases

Create a charge notification

Create a new charge notification for a lease

post/leases/{lease_id}/charges/notifications

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/charges/notifications
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required

Lease ID

Request body

lease_idstring uuid required
notification_type'CONSUMPTION_ALERT' | 'ANNUAL_REVIEW' | 'REGULARIZATION_DUE' | 'DOCUMENTATION_REQUEST' required

Type of charge notification.

  • CONSUMPTION_ALERT: Alert about unusual consumption patterns
  • ANNUAL_REVIEW: Annual charge review notification
  • REGULARIZATION_DUE: Regularization is due for the period
  • DOCUMENTATION_REQUEST: Request for supporting documents
contentobject required

Notification content (JSON)

Example request

{
  "notification_type": "ANNUAL_REVIEW"
}

Response

Notification created successfully

idstring uuid required
lease_idstring uuid required

Lease this notification relates to

notification_type'CONSUMPTION_ALERT' | 'ANNUAL_REVIEW' | 'REGULARIZATION_DUE' | 'DOCUMENTATION_REQUEST' required

Type of charge notification.

  • CONSUMPTION_ALERT: Alert about unusual consumption patterns
  • ANNUAL_REVIEW: Annual charge review notification
  • REGULARIZATION_DUE: Regularization is due for the period
  • DOCUMENTATION_REQUEST: Request for supporting documents
contentobject required

Notification content (JSON)

sent_datestring date-time nullable

Date when the notification was sent

status'DRAFT' | 'SENT' | 'READ' | 'ACTIONED' | 'EXPIRED' required

Status of a charge notification.

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "notification_type": "ANNUAL_REVIEW",
  "status": "DRAFT"
}

Changes

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