Create recurring charge rule

POST

/api/recurring-charges

curl --request POST \
  --url https://api.getvespy.com/api/recurring-charges \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "amountCents": 1, "categoryId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "label": "example", "leaseId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "propertyId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "recurrence": { "dayOfMonth": 1, "endDate": "2026-04-15", "frequency": "monthly", "startDate": "2026-04-15" }, "tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "unitId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

• Production
• Development
• Local

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

amountCents

required

integer

>= 1

categoryId

required

string format: uuid

label

required

string

>= 1 characters <= 160 characters

leaseId

string format: uuid

propertyId

string format: uuid

recurrence

required

object

dayOfMonth

required

integer

>= 1 <= 31

endDate

string format: date

frequency

required

string

Allowed values: monthly

startDate

required

string format: date

tenantId

string format: uuid

unitId

string format: uuid

Responses

201

Default Response

Media typeapplication/json

object

charge

required

object

amountCents

required

integer

>= 1

balanceCents

required

integer

categoryId

required

string format: uuid

nullable

chargeType

required

string

Allowed values: rent fee deposit adjustment other

createdAt

required

string format: date-time

description

required

string

nullable

dueDate

required

string format: date

id

required

string format: uuid

lease

required

object

endDate

required

string format: date

nullable

id

required

string format: uuid

startDate

required

string format: date

status

required

string

Allowed values: draft active ended terminated

leaseId

required

string format: uuid

nullable

name

required

string

nullable <= 160 characters

organizationId

required

string format: uuid

postedAt

required

string format: date-time

property

required

object

city

required

string

>= 1 characters <= 120 characters

id

required

string format: uuid

name

required

string

>= 1 characters <= 160 characters

state

required

string

>= 2 characters <= 2 characters

propertyId

required

string format: uuid

nullable

recurringRuleId

string format: uuid

nullable

status

required

string

Allowed values: pending posted paid void

tenant

required

object

fullName

required

string

>= 1 characters <= 160 characters

id

required

string format: uuid

tenantId

required

string format: uuid

nullable

unit

required

object

id

required

string format: uuid

unitNumber

required

string

nullable >= 1 characters <= 32 characters

unitId

required

string format: uuid

nullable

recurringChargeRule

required

object

amountCents

required

integer

>= 1

categoryId

required

string format: uuid

createdAt

required

string format: date-time

dayOfMonth

required

integer

>= 1 <= 31

endDate

required

string format: date

nullable

frequency

required

string

Allowed values: monthly

id

required

string format: uuid

kind

required

string

Allowed values: rent fee

label

required

string

>= 1 characters <= 160 characters

leaseId

required

string format: uuid

nullable

organizationId

required

string format: uuid

propertyId

required

string format: uuid

nullable

startDate

required

string format: date

status

required

string

Allowed values: draft active paused ended

tenantId

required

string format: uuid

nullable

unitId

required

string format: uuid

nullable

updatedAt

required

string format: date-time

Example

{
  "charge": {
    "chargeType": "rent",
    "lease": {
      "status": "draft"
    },
    "status": "pending"
  },
  "recurringChargeRule": {
    "frequency": "monthly",
    "kind": "rent",
    "status": "draft"
  }
}

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