Skip to content
Vespy API

List charges

GET
/api/charges
curl --request GET \
  --url 'https://api.getvespy.com/api/charges?status=pending&sortBy=dueDate&sortDirection=asc&page=1&pageSize=20' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
search
string
>= 1 characters <= 100 characters
status
string
Allowed values: pending posted paid void
tenantId
string format: uuid
propertyId
string format: uuid
unitId
string format: uuid
leaseId
string format: uuid
dueBefore
string format: date
dueAfter
string format: date
createdAfter
string format: date
createdBefore
string format: date
sortBy
string
Allowed values: dueDate tenantName propertyName unitNumber chargeType amountCents balanceCents status createdAt
sortDirection
string
Allowed values: asc desc
page
integer
default: 1 >= 1
pageSize
integer
default: 20 >= 1 <= 100

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
charges
required
Array<object>
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
page
required
integer
>= 1
pageSize
required
integer
>= 1 <= 100
total
required
integer
totalPages
required
integer
>= 1
Example
{
  "charges": [
    {
      "chargeType": "rent",
      "lease": {
        "status": "draft"
      },
      "status": "pending"
    }
  ]
}

400

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

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