Revise a management fee rule for a future period

PATCH

/api/management-fee-rules/{id}

curl --request PATCH \
  --url https://api.getvespy.com/api/management-fee-rules/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "feeFlatCents": 1, "feePercentageBps": 1, "feeType": "flat", "generationDayOfMonth": 1, "rentBasisShareBps": 1 }'

• Production
• Development
• Local

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Request Body^required

Media typeapplication/json

object

>= 1 properties

feeFlatCents

integer

nullable >= 1

feePercentageBps

integer

nullable >= 1 <= 10000

feeType

string

Allowed values: flat percentage hybrid

generationDayOfMonth

integer

>= 1 <= 31

rentBasisShareBps

integer

nullable >= 1 <= 10000

Responses

200

Default Response

Media typeapplication/json

object

managementFeeRule

required

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

{
  "managementFeeRule": {
    "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"
}

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

409

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