VRPlatformVRPlatform
Reports

/reports/owner-statement-summaries-per-layout

Owner statement summaries aggregated by contact (per layout)

GET
/reports/owner-statement-summaries-per-layout
X-API-Key<token>

API key provided in dashboard

In: header

Query Parameters

startAt*string
endAt*string
listingIds?string

comma separated listings

currency?string
viewAs?string
Default"manager"
Value in"owner" | "manager"
search?string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.vrplatform.app/reports/owner-statement-summaries-per-layout?startAt=string&endAt=string"
{
  "data": [
    {
      "contact": {
        "contactId": "string",
        "name": "string",
        "firstName": "string",
        "email": "user@example.com",
        "phone": "string"
      },
      "currency": "string",
      "financials": {
        "balanceStart": 0,
        "netRevenue": 0,
        "expenses": 0,
        "reserve": 0,
        "payouts": 0,
        "netIncome": 0,
        "currentBalance": 0,
        "balanceEnd": 0
      },
      "drilldown": {
        "type": "journalEntryReport",
        "filter": {
          "ids": "string",
          "txnCode": "string",
          "published": true,
          "status": "active",
          "ledger": "historical",
          "startAt": "string",
          "endAt": "string",
          "search": "string",
          "date": "string",
          "amount": "string",
          "isDateRangeEndInclusive": true,
          "reservationIds": "string",
          "transactionIds": "string",
          "ownerStatementIds": "string",
          "currency": "string",
          "excludeApAppendix": true,
          "listingIds": "string",
          "listingOwnershipPeriodIds": "string",
          "accountIds": "string",
          "accountReservationLineTypeIds": "string",
          "categoryIds": "string",
          "excludeCategoryIds": "string",
          "contactIds": "string",
          "classifications": "string",
          "accountType": "ledger",
          "types": "string",
          "excludeTypes": "string",
          "entityTypes": "string",
          "bookingChannels": "string",
          "triggerTypes": "string",
          "excludeTriggerTypes": "string",
          "parties": "string",
          "party": "owners",
          "accountAssignmentTypes": "string",
          "managerStatementSectionIds": "string",
          "recurringFee": true,
          "openingBalanceType": "taxPayable"
        },
        "measure": "periodActivity",
        "label": "string"
      }
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}