Check base-rent billing against the rent commencement date

GET

/api/leases/{id}/rent-commencement

curl --request GET \
  --url https://api.getvespy.com/api/leases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/rent-commencement \
  --header 'Authorization: Bearer <token>'

• Production
• Development
• Local

Setting rent commencement never rewrites billing. This lists base rent scheduled or already billed before it, so staff can adjust the schedule. Nothing is credited automatically.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

Default Response

Media typeapplication/json

object

status

required

object

baseRentStartsOn

required

When base rent bills from now: the residential rent rule’s start, or the first commercial base-rent step.

string format: date

nullable

billedBeforeRentCommencement

required

object

count

required

integer

>= 1

firstDueDate

required

string format: date

lastDueDate

required

string format: date

totalCents

required

integer

rentCommencementDate

required

string format: date

nullable

ruleHeld

required

Residential: the rent rule was kept at an earlier start because rent was already billed.

boolean

stepsBeforeRentCommencement

required

Array<object>

object

effectiveEnd

required

string format: date

nullable

effectiveStart

required

string format: date

scheduleId

required

string format: uuid

stepId

required

string format: uuid

Example^generated

{
  "status": {
    "baseRentStartsOn": "2026-04-15",
    "billedBeforeRentCommencement": {
      "count": 1,
      "firstDueDate": "2026-04-15",
      "lastDueDate": "2026-04-15",
      "totalCents": 1
    },
    "rentCommencementDate": "2026-04-15",
    "ruleHeld": true,
    "stepsBeforeRentCommencement": [
      {
        "effectiveEnd": "2026-04-15",
        "effectiveStart": "2026-04-15",
        "scheduleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "stepId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
      }
    ]
  }
}

400

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

401

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

403

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

404

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}