List charges the authenticated tenant can pay

GET

/api/portal/payments/charges

curl --request GET \
  --url https://api.getvespy.com/api/portal/payments/charges \
  --header 'Authorization: Bearer <token>'

• Production
• Development
• Local

Authorizations

• bearerAuth

Responses

200

Default Response

Media typeapplication/json

object

charges

required

Array<object>

object

amountCents

required

integer

>= 1

balanceCents

required

integer

>= 1

chargeType

required

string

Allowed values: rent fee deposit adjustment other

description

required

string

nullable

dueDate

required

string format: date

id

required

string format: uuid

leaseId

required

string format: uuid

nullable

name

required

string

nullable

Example

{
  "charges": [
    {
      "chargeType": "rent"
    }
  ]
}

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

503

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