Record a kind of parking on a lease

POST

/api/leases/{leaseId}/parking-rights

curl --request POST \
  --url https://api.getvespy.com/api/leases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/parking-rights \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "billingScheduleId": null, "effectiveEnd": null, "effectiveStart": "2026-04-15", "location": null, "notes": null, "parkingType": "unreserved", "rateBasis": "fixed", "rateFrequency": null, "ratePerSpaceCents": null, "ratioPer1000Sqft": null, "recurringChargeRuleId": null, "spaceCount": null, "stallLabels": null, "stallUnitIds": [] }'

• Production
• Development
• Local

Records the terms only. Linking to a parking charge on the same lease is optional, and stalls can be linked to parking spaces at the lease’s property or written as free text.

Authorizations

• bearerAuth

Parameters

Path Parameters

leaseId

required

string format: uuid

Request Body^required

Media typeapplication/json

object

billingScheduleId

Any of:

string

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

null

null

effectiveEnd

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

effectiveStart

required

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

location

Any of:

string

string

>= 1 characters <= 200 characters

null

null

notes

Any of:

string

string

>= 1 characters <= 2000 characters

null

null

parkingType

required

string

Allowed values: unreserved reserved other

rateBasis

string

default: unknown

Allowed values: fixed market included unknown

rateFrequency

Any of:

string

string

Allowed values: monthly annual

null

null

ratePerSpaceCents

Any of:

integer

integer

<= 9007199254740991

null

null

ratioPer1000Sqft

Any of:

number

number

> 0 <= 9999.99

null

null

recurringChargeRuleId

Any of:

string

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

null

null

spaceCount

Any of:

integer

integer

> 0 <= 100000

null

null

stallLabels

Any of:

string

string

>= 1 characters <= 500 characters

null

null

stallUnitIds

Array<string>

default: <= 200 items

Responses

201

Default Response

Media typeapplication/json

object

parkingRight

required

object

billingScheduleId

required

Any of:

string

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

null

null

createdAt

required

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/

effectiveEnd

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

effectiveStart

required

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

leaseId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

linkedCharge

required

Any of:

object

object

currentAmountCents

required

Any of:

integer

integer

>= -9007199254740991 <= 9007199254740991

null

null

id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

kind

required

string

Allowed values: billing_schedule recurring_charge_rule

label

required

string

null

null

location

required

Any of:

string

string

null

null

notes

required

Any of:

string

string

null

null

organizationId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

parkingType

required

string

Allowed values: unreserved reserved other

rateBasis

required

string

Allowed values: fixed market included unknown

rateFrequency

required

Any of:

string

string

Allowed values: monthly annual

null

null

ratePerSpaceCents

required

Any of:

integer

integer

<= 9007199254740991

null

null

ratioPer1000Sqft

required

Any of:

number

number

> 0

null

null

recurringChargeRuleId

required

Any of:

string

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

null

null

spaceCount

required

Any of:

integer

integer

> 0 <= 9007199254740991

null

null

stallLabels

required

Any of:

string

string

null

null

stallUnitIds

required

Array<string>

stallUnitNumbers

required

Array<string>

updatedAt

required

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/

Example

{
  "parkingRight": {
    "linkedCharge": {
      "kind": "billing_schedule"
    },
    "parkingType": "unreserved",
    "rateBasis": "fixed",
    "rateFrequency": "monthly"
  }
}

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"
}