Monthly rent owed vs rent collected time-series

GET

/api/analytics/rent-owed-vs-collected

curl --request GET \
  --url https://api.getvespy.com/api/analytics/rent-owed-vs-collected \
  --header 'Authorization: Bearer <token>'

• Production
• Development
• Local

Authorizations

• bearerAuth

Responses

200

Default Response

Media typeapplication/json

object

points

required

Array<object>

object

collectedCents

required

integer

month

required

string

/^\d{4}-\d{2}$/

owedCents

required

integer

summary

required

object

collectionRate

required

number

totalCollectedCents

required

integer

totalOwedCents

required

integer

Example^generated

{
  "points": [
    {
      "collectedCents": 1,
      "month": "example",
      "owedCents": 1
    }
  ],
  "summary": {
    "collectionRate": 1,
    "totalCollectedCents": 1,
    "totalOwedCents": 1
  }
}

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