Skip to content
Vespy API

List recurring charge rules

GET
/api/recurring-charges
curl --request GET \
  --url 'https://api.getvespy.com/api/recurring-charges?kind=rent' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
leaseId
string format: uuid
unitId
string format: uuid
kind
string
Allowed values: rent fee

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
recurringChargeRules
required
Array<object>
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
{
  "recurringChargeRules": [
    {
      "frequency": "monthly",
      "kind": "rent",
      "status": "draft"
    }
  ]
}

401

Section titled “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
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

403

Section titled “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
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}