/reports/owner-statement-summaries-per-layout
Owner statement summaries aggregated by contact and layout. Listing payouts linked to a non-owner contact are allocated by ownership split.
Required scope: reports:read
Authorization
apiKey API key provided in dashboard
In: header
Query Parameters
Date boundary string. Accepted syntax: YYYY, YYYY-MM, or YYYY-MM-DD. Deprecated: use dateRange instead.
vrp-date-boundaryDate boundary string. Accepted syntax: YYYY, YYYY-MM, or YYYY-MM-DD. Deprecated: use dateRange instead.
vrp-date-boundaryDate range string. Accepted syntax: YYYY, YYYY-MM, YYYY-MM-DD, or range YYYY-MM-DD...YYYY-MM-DD. Single values expand to the full year, month, or day.
vrp-date-rangeWhether the end date in dateRange or paidAtRange is treated as inclusive (true) or exclusive (false).
truecomma separated listings
"manager""owner" | "manager"Response Body
application/json
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"{
"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",
"listingScope": "exact",
"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",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}