List grouped accounting activity

GET

/api/accounting/transaction-groups

curl --request GET \
  --url 'https://api.getvespy.com/api/accounting/transaction-groups?bookType=trust&includeDescendants=false&referenceType=security_deposit&basis=accrual&entryType=deposit_received&page=1&pageSize=20' \
  --header 'Authorization: Bearer <token>'

• Production
• Development
• Local

Authorizations

• bearerAuth

Parameters

Query Parameters

bookType

string

Allowed values: trust security_deposit operating

categoryId

string format: uuid

accountId

string format: uuid

includeDescendants

boolean

propertyId

string format: uuid

unitId

string format: uuid

ownerId

string format: uuid

referenceType

string

Allowed values: security_deposit disposition charge payment expense expense_payment journal_entry

referenceId

string format: uuid

basis

string

Allowed values: accrual cash

startDate

string format: date

endDate

string format: date

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

page

integer

default: 1 >= 1

pageSize

integer

default: 20 >= 1 <= 100

Responses

200

Default Response

Media typeapplication/json

object

page

required

integer

>= 1

pageSize

required

integer

>= 1 <= 100

summary

required

object

categories

required

Array<object>

object

amountCents

required

integer

category

required

object

code

required

string

nullable

id

required

string format: uuid

nullable

name

required

string

nullable

transactionCount

required

integer

totalBalanceCents

required

integer

total

required

integer

totalPages

required

integer

>= 1

transactionGroups

required

Array<object>

object

accountingDate

required

string format: date-time

accrualDate

required

string format: date-time

nullable

amountCents

required

integer

basis

required

string

Allowed values: accrual cash

book

required

string

Allowed values: trust security_deposit operating

cashDate

required

string format: date-time

nullable

cashSettledAt

required

string format: date-time

nullable

category

required

object

code

required

string

nullable

id

required

string format: uuid

nullable

name

required

string

nullable

description

required

string

nullable

dueDate

required

string format: date

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

id

required

string

journalId

required

string format: uuid

nullable

lineCount

required

integer

>= 1

lines

required

Array<object>

object

accountingDate

string format: date-time

accrualDate

string format: date-time

nullable

amountCents

required

integer

balanceAfterCents

required

integer

basis

string

Allowed values: accrual cash

book

required

string

Allowed values: trust security_deposit operating

cashDate

string format: date-time

nullable

cashSettledAt

string format: date-time

nullable

category

required

object

code

required

string

nullable

id

required

string format: uuid

nullable

name

required

string

nullable

creditAccount

object

code

required

string

description

required

string

nullable

id

required

string format: uuid

isActive

required

boolean

isLeaf

required

boolean

name

required

string

organizationId

required

string format: uuid

nullable

parentCode

required

string

nullable

sortOrder

required

integer

type

required

string

Allowed values: asset liability equity income cost_of_services expense trust

debitAccount

object

code

required

string

description

required

string

nullable

id

required

string format: uuid

isActive

required

boolean

isLeaf

required

boolean

name

required

string

organizationId

required

string format: uuid

nullable

parentCode

required

string

nullable

sortOrder

required

integer

type

required

string

Allowed values: asset liability equity income cost_of_services expense trust

description

required

string

nullable

dueDate

string format: date

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

id

required

string format: uuid

journalId

string format: uuid

nullable

journalLineIndex

integer

occurredAt

required

string format: date-time

ownerName

required

string

nullable

postedAt

string format: date-time

nullable

postingBatchId

string format: uuid

nullable

propertyName

required

string

nullable

receivedAt

string format: date-time

nullable

referenceId

required

string format: uuid

nullable

referenceType

required

string

nullable

Allowed values: security_deposit disposition charge payment expense expense_payment journal_entry

sourceUrl

required

string

nullable

unitId

required

string format: uuid

nullable

unitNumber

required

string

nullable

netActivityCents

required

integer

occurredAt

required

string format: date-time

ownerName

required

string

nullable

postedAt

required

string format: date-time

nullable

postingBatchId

required

string format: uuid

nullable

propertyName

required

string

nullable

receivedAt

required

string format: date-time

nullable

referenceId

required

string format: uuid

nullable

referenceType

required

string

nullable

Allowed values: security_deposit disposition charge payment expense expense_payment journal_entry

sourceUrl

required

string

nullable

unitId

required

string format: uuid

nullable

unitNumber

required

string

nullable

Example

{
  "transactionGroups": [
    {
      "basis": "accrual",
      "book": "trust",
      "entryType": "deposit_received",
      "lines": [
        {
          "basis": "accrual",
          "book": "trust",
          "creditAccount": {
            "type": "asset"
          },
          "debitAccount": {
            "type": "asset"
          },
          "entryType": "deposit_received",
          "referenceType": "security_deposit"
        }
      ],
      "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"
}