Get the authenticated owner ledger

GET

/api/owner/ledger

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

• Production
• Development
• Local

Authorizations

• bearerAuth

Parameters

Query Parameters

startDate

string format: date

endDate

string format: date

Responses

200

Default Response

Media typeapplication/json

object

closingBalanceCents

required

integer

openingBalanceCents

required

integer

summary

required

object

netBalanceCents

integer

netIncomeCents

integer

totalChargesCents

integer

totalExpensesCents

integer

totalIncomeCents

integer

totalManagementFeesCents

integer

totalPaymentsCents

integer

transactions

required

Array<object>

object

balanceCents

required

integer

categoryCode

string

nullable >= 1 characters <= 16 characters

categoryName

string

nullable >= 1 characters <= 160 characters

chargeCents

integer

date

required

string format: date

description

required

string

>= 1 characters <= 500 characters

expenseCents

integer

incomeCents

integer

managementFeeCalculation

object

collectedRentCents

required

integer

feeBasisCents

required

integer

feeFlatCents

required

integer

feePercentageBps

required

integer

nullable >= 1 <= 10000

periodEnd

required

string format: date

periodStart

required

string format: date

rentBasisShareBps

required

integer

nullable >= 1 <= 10000

paymentCents

integer

propertyName

string

nullable >= 1 characters <= 160 characters

type

required

string

Allowed values: charge payment income expense

Example

{
  "transactions": [
    {
      "type": "charge"
    }
  ]
}

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