List trust ledger entries

GET

/api/trust/ledger

curl --request GET \
  --url 'https://api.getvespy.com/api/trust/ledger?book=trust&entryType=deposit_received&limit=50&offset=0' \
  --header 'Authorization: Bearer <token>'

• Production
• Development
• Local

Authorizations

• bearerAuth

Parameters

Query Parameters

bankAccountId

string format: uuid

book

string

Allowed values: trust security_deposit operating

entryType

string

Allowed values: deposit_received deposit_returned deposit_deducted deposit_forfeited charge_posted charge_voided payment_received payment_reversed expense_recorded expense_paid expense_payment_voided expense_voided adjustment

categoryId

string format: uuid

startDate

string format: date

endDate

string format: date

limit

integer

default: 50 >= 1 <= 100

offset

integer

0

Responses

200

Default Response

Media typeapplication/json

object

ledgerEntries

required

Array<object>

object

amountCents

required

integer

balanceAfterCents

required

integer

bankAccountId

required

string format: uuid

basis

string

Allowed values: accrual cash

book

required

string

Allowed values: trust security_deposit operating

cashSettledAt

string format: date-time

nullable

categoryId

required

string format: uuid

nullable

createdAt

required

string format: date-time

createdByUserId

required

string format: uuid

nullable

creditAccountId

string format: uuid

nullable

debitAccountId

string format: uuid

nullable

description

required

string

nullable

entryType

required

string

Allowed values: deposit_received deposit_returned deposit_deducted deposit_forfeited charge_posted charge_voided payment_received payment_reversed expense_recorded expense_paid expense_payment_voided expense_voided adjustment

fundId

string format: uuid

nullable

id

required

string format: uuid

journalId

string format: uuid

nullable

occurredAt

required

string format: date-time

organizationId

required

string format: uuid

ownerId

required

string format: uuid

nullable

propertyId

required

string format: uuid

nullable

referenceId

required

string format: uuid

nullable

referenceType

required

string

nullable

Allowed values: security_deposit disposition charge payment expense expense_payment journal_entry

unitId

required

string format: uuid

nullable

Example

{
  "ledgerEntries": [
    {
      "basis": "accrual",
      "book": "trust",
      "entryType": "deposit_received",
      "referenceType": "security_deposit"
    }
  ]
}

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