List expenses

GET

/api/expenses

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

• Production
• Development
• Local

Authorizations

• bearerAuth

Parameters

Query Parameters

search

string

>= 1 characters <= 100 characters

propertyId

string format: uuid

ownerId

string format: uuid

unitId

string format: uuid

leaseId

string format: uuid

vendorId

string format: uuid

workOrderId

string format: uuid

category

string

Allowed values: maintenance utility tax insurance management other

status

string

Allowed values: active voided

paymentStatus

string

Allowed values: pending partial paid

incurredAfter

string format: date

incurredBefore

string format: date

createdAfter

string format: date

createdBefore

string format: date

sortBy

string

Allowed values: incurredOn propertyName unitNumber vendorName category amountCents paymentStatus createdAt

sortDirection

string

Allowed values: asc desc

page

integer

default: 1 >= 1

pageSize

integer

default: 20 >= 1 <= 100

Responses

200

Default Response

Media typeapplication/json

object

expenses

required

Array<object>

object

amountCents

required

integer

>= 1

amountPaidCents

required

integer

category

required

string

Allowed values: maintenance utility tax insurance management other

categoryId

required

string format: uuid

nullable

createdAt

required

string format: date-time

description

required

string

nullable

id

required

string format: uuid

incurredOn

required

string format: date

lastPaidAt

required

string format: date-time

nullable

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 terminated expired

leaseId

required

string format: uuid

nullable

name

required

string

nullable <= 160 characters

organizationId

required

string format: uuid

outstandingCents

required

integer

owner

required

object

fullName

required

string

id

required

string format: uuid

ownerId

required

string format: uuid

nullable

paymentStatus

required

string

Allowed values: pending partial paid

property

required

object

city

required

string

>= 1 characters <= 120 characters

id

required

string format: uuid

name

required

string

state

required

string

>= 2 characters <= 2 characters

propertyId

required

string format: uuid

nullable

status

required

string

Allowed values: active voided

unit

required

object

id

required

string format: uuid

unitNumber

required

string

nullable

unitId

required

string format: uuid

nullable

vendorId

required

string format: uuid

nullable

vendorName

required

string

nullable

workOrderId

required

string format: uuid

nullable

page

required

integer

>= 1

pageSize

required

integer

>= 1 <= 100

total

required

integer

totalPages

required

integer

>= 1

Example

{
  "expenses": [
    {
      "category": "maintenance",
      "lease": {
        "status": "draft"
      },
      "paymentStatus": "pending",
      "status": "active"
    }
  ]
}

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