List management fee rules

GET

/api/management-fee-rules

curl --request GET \
  --url https://api.getvespy.com/api/management-fee-rules \
  --header 'Authorization: Bearer <token>'

• Production
• Development
• Local

Authorizations

• bearerAuth

Parameters

Query Parameters

propertyId

string format: uuid

ownerId

string format: uuid

includeEnded

boolean

Responses

200

Default Response

Media typeapplication/json

object

managementFeeRules

required

Array<object>

object

createdAt

required

string format: date-time

effectiveEnd

required

string format: date

nullable

effectiveStart

required

string format: date

feeFlatCents

required

integer

nullable >= 1

feePercentageBps

required

integer

nullable >= 1 <= 10000

feeType

required

string

Allowed values: flat percentage hybrid

generationDayOfMonth

required

integer

>= 1 <= 31

id

required

string format: uuid

organizationId

required

string format: uuid

ownerId

required

string format: uuid

ownerName

required

string

>= 1 characters <= 160 characters

propertyId

required

string format: uuid

propertyName

required

string

>= 1 characters <= 160 characters

rentBasisShareBps

required

integer

nullable >= 1 <= 10000

status

required

string

Allowed values: scheduled active ended

updatedAt

required

string format: date-time

Example

{
  "managementFeeRules": [
    {
      "feeType": "flat",
      "status": "scheduled"
    }
  ]
}

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