The renewal intent object - Yorlet Documentation

{
  "id": "<string>",
  "created": 123,
  "object": "renewal_intent",
  "application": {
    "id": "<string>",
    "created": 123,
    "object": "application",
    "advance_rent_amount": 123,
    "application_configuration": "<string>",
    "assignee": "<string>",
    "building": "<string>",
    "building_snapshot": {
      "name": "<string>",
      "single_unit": true
    },
    "completed_at": 123,
    "contract": "<string>",
    "contract_address": "<string>",
    "contract_options": {
      "automatic_counter_signature": true,
      "legal_entity": "<string>",
      "owner_signature_required": true,
      "send_applicant_email": true,
      "send_owner_completion_email": true
    },
    "contract_template": "<string>",
    "current_step": {
      "id": "<string>",
      "next_step": "<string>",
      "type": "advance_rent"
    },
    "currency": "gbp",
    "deal_assignee": "<string>",
    "deposit_amount": 123,
    "has_owner": true,
    "holding_fee_amount": 123,
    "end_date": 123,
    "from_application": {
      "action": "revision",
      "application": "<string>"
    },
    "move_in_date": 123,
    "move_out_date": 123,
    "open": true,
    "owner_options": {
      "apply_unit_fees": true
    },
    "partial_payment": {
      "amount": 49999950,
      "description": "<string>"
    },
    "rent_term": "<string>",
    "start_date": 123,
    "status": "<string>",
    "subscription_data": {
      "add_invoice_items": [
        {
          "amount": 123,
          "currency": "<string>",
          "description": "<string>",
          "tax_percent": 50,
          "metadata": {},
          "price": "<string>",
          "tax_rate": "<string>",
          "transfer_destination": "<string>",
          "unit": "<string>"
        }
      ],
      "billing_anchor": 123,
      "billing_anchor_config": {
        "day_of_month": 16
      },
      "coupon": "<string>",
      "custom_fields": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "days_before_collection": 3,
      "days_until_due": 1,
      "end_date": 123,
      "end_date_config": {
        "day": 16,
        "month": 6,
        "year": 123
      },
      "interval_count": 123,
      "items": [
        {
          "price_data": {
            "amount": 123,
            "currency": "<string>",
            "tax_percent": 123
          },
          "description": "<string>",
          "metadata": {},
          "price": "<string>",
          "schedule": [
            {
              "amount": 123,
              "effective_at": 123
            }
          ],
          "tax_rate": "<string>",
          "transfer_destination": "<string>",
          "unit": "<string>"
        }
      ],
      "phases": [
        {
          "start_date": 123,
          "items": [
            {
              "price_data": {
                "amount": 123,
                "currency": "<string>",
                "tax_percent": 123
              },
              "description": "<string>",
              "metadata": {},
              "price": "<string>",
              "schedule": [
                {
                  "amount": 123,
                  "effective_at": 123
                }
              ],
              "tax_rate": "<string>",
              "transfer_destination": "<string>",
              "unit": "<string>"
            }
          ]
        }
      ],
      "start_date": 123,
      "start_date_config": {
        "day": 16,
        "month": 6,
        "year": 123
      }
    },
    "unit": "<string>",
    "unit_snapshot": {
      "name": "<string>"
    },
    "account": "<string>",
    "deleted": false,
    "metadata": {},
    "overrides": {
      "rent_increase": {
        "tenancy_start_at": 123,
        "first_increase_at": 123
      }
    },
    "steps": [
      {
        "id": "<string>",
        "status": "<string>",
        "type": "<string>"
      }
    ]
  },
  "canceled_at": 123,
  "completed_at": 123,
  "source_application": {
    "id": "<string>",
    "created": 123,
    "object": "application",
    "advance_rent_amount": 123,
    "application_configuration": "<string>",
    "assignee": "<string>",
    "building": "<string>",
    "building_snapshot": {
      "name": "<string>",
      "single_unit": true
    },
    "completed_at": 123,
    "contract": "<string>",
    "contract_address": "<string>",
    "contract_options": {
      "automatic_counter_signature": true,
      "legal_entity": "<string>",
      "owner_signature_required": true,
      "send_applicant_email": true,
      "send_owner_completion_email": true
    },
    "contract_template": "<string>",
    "current_step": {
      "id": "<string>",
      "next_step": "<string>",
      "type": "advance_rent"
    },
    "currency": "gbp",
    "deal_assignee": "<string>",
    "deposit_amount": 123,
    "has_owner": true,
    "holding_fee_amount": 123,
    "end_date": 123,
    "from_application": {
      "action": "revision",
      "application": "<string>"
    },
    "move_in_date": 123,
    "move_out_date": 123,
    "open": true,
    "owner_options": {
      "apply_unit_fees": true
    },
    "partial_payment": {
      "amount": 49999950,
      "description": "<string>"
    },
    "rent_term": "<string>",
    "start_date": 123,
    "status": "<string>",
    "subscription_data": {
      "add_invoice_items": [
        {
          "amount": 123,
          "currency": "<string>",
          "description": "<string>",
          "tax_percent": 50,
          "metadata": {},
          "price": "<string>",
          "tax_rate": "<string>",
          "transfer_destination": "<string>",
          "unit": "<string>"
        }
      ],
      "billing_anchor": 123,
      "billing_anchor_config": {
        "day_of_month": 16
      },
      "coupon": "<string>",
      "custom_fields": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "days_before_collection": 3,
      "days_until_due": 1,
      "end_date": 123,
      "end_date_config": {
        "day": 16,
        "month": 6,
        "year": 123
      },
      "interval_count": 123,
      "items": [
        {
          "price_data": {
            "amount": 123,
            "currency": "<string>",
            "tax_percent": 123
          },
          "description": "<string>",
          "metadata": {},
          "price": "<string>",
          "schedule": [
            {
              "amount": 123,
              "effective_at": 123
            }
          ],
          "tax_rate": "<string>",
          "transfer_destination": "<string>",
          "unit": "<string>"
        }
      ],
      "phases": [
        {
          "start_date": 123,
          "items": [
            {
              "price_data": {
                "amount": 123,
                "currency": "<string>",
                "tax_percent": 123
              },
              "description": "<string>",
              "metadata": {},
              "price": "<string>",
              "schedule": [
                {
                  "amount": 123,
                  "effective_at": 123
                }
              ],
              "tax_rate": "<string>",
              "transfer_destination": "<string>",
              "unit": "<string>"
            }
          ]
        }
      ],
      "start_date": 123,
      "start_date_config": {
        "day": 16,
        "month": 6,
        "year": 123
      }
    },
    "unit": "<string>",
    "unit_snapshot": {
      "name": "<string>"
    },
    "account": "<string>",
    "deleted": false,
    "metadata": {},
    "overrides": {
      "rent_increase": {
        "tenancy_start_at": 123,
        "first_increase_at": 123
      }
    },
    "steps": [
      {
        "id": "<string>",
        "status": "<string>",
        "type": "<string>"
      }
    ]
  },
  "unit": "<string>",
  "account": "<string>",
  "deleted": false,
  "assignee": "<string>",
  "due_at": 123,
  "no_renewal": {
    "end_date": 123,
    "reason": "<string>",
    "reason_description": "<string>",
    "sub_reason": "<string>"
  },
  "renewal": {
    "end_date": 123,
    "start_date": 123
  },
  "rent_increase": {
    "current_rent": 123,
    "proposed_rent": 123,
    "notice_served_at": 123,
    "notice_file": "<string>",
    "notice_file_url": "<string>",
    "effective_date": 123,
    "tribunal_reference": "<string>",
    "tribunal_outcome_rent": 123,
    "tribunal_decided_at": 123,
    "reversed_at": 123
  },
  "overrides": {
    "rent_increase": {
      "tenancy_start_at": 123,
      "last_increase_at": 123,
      "first_increase_at": 123
    }
  }
}

string

required

Unique identifier for the object.

created

number

required

Time at which the object was created. Measured in seconds since the Unix epoch.

object

enum<string>

required

Available options:

renewal_intent

application

required

The new application created when this renewal is accepted.

Show child attributes

canceled_at

number | null

required

The time at which the renewal intent was canceled.

completed_at

number | null

required

The time at which the renewal intent was completed.

source_application

required

The application the renewal intent is being created from.

Show child attributes

status

enum<string>

required

The status of the renewal intent.

Available options:

accepted,

canceled,

challenged,

complete,

effective,

leaving,

notice_served,

pending,

renewing,

tribunal_decided,

withdrawn

type

enum<string> | null

required

The type of renewal intent.

Available options:

no_renewal,

renewal,

rent_increase,

null

unit

required

The unit the renewal intent is associated with.

account

string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

deleted

boolean

default:false

Only returned if the object has been deleted.

assignee

string | null

The ID of the user the renewal intent is assigned to.

due_at

number | null

The time at which the renewal intent is due to be actioned.

no_renewal

object

Details when the renewal intent type is no_renewal.

Show child attributes

renewal

object

Details when the renewal intent type is renewal.

Show child attributes

rent_increase

object

Details when the renewal intent type is rent_increase.

Show child attributes

overrides

object

Manual overrides for values that are otherwise derived from the system, used when generating documents such as the Form 4A rent increase notice.

Show child attributes

Cancel a reference

Create a renewal intent