Reports
/reports/profit-and-loss
Profit & Loss report grouped by ledger, party, listing, month, quarter, or year (configure with view query param)
Required scope: reports:read
Authorization
apiKey X-API-Key<token>
API key provided in dashboard
In: header
Query Parameters
startDate?string
Date boundary string. Accepted syntax: YYYY, YYYY-MM, or YYYY-MM-DD. Deprecated: use dateRange instead.
Format
vrp-date-boundaryendDate?string
Date boundary string. Accepted syntax: YYYY, YYYY-MM, or YYYY-MM-DD. Deprecated: use dateRange instead.
Format
vrp-date-boundaryparty?string
Value in
"manager" | "owners"view?string
Value in
"ledger" | "party" | "listing" | "month" | "quarter" | "year"listingIds?string
ledger?string
Value in
"trust" | "operating"dateRange?string
Date 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.
Format
vrp-date-rangeisDateRangeEndInclusive?boolean
Whether the end date in dateRange or paidAtRange is treated as inclusive (true) or exclusive (false).
Default
truelistingScope?string
Controls listingIds filter expansion. withChildren includes direct child listings when a parent listing is selected; exact only matches the selected listing ids.
Value in
"exact" | "withChildren"Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.vrplatform.app/reports/profit-and-loss"{
"netIncome": {
"id": "string",
"title": "string",
"total": 0,
"totalPercentage": 0,
"values": [
{
"id": "string",
"title": "string",
"total": 0,
"percentage": 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"
}
}
],
"computedValues": [
{
"id": "string",
"title": "string",
"total": 0,
"percentage": 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"
}
}
],
"categories": [
{
"id": "string",
"title": "string",
"total": 0,
"totalPercentage": 0,
"accounts": [
{
"id": "string",
"title": "string",
"total": 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"
},
"values": [
{
"id": "string",
"title": "string",
"total": 0,
"percentage": 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"
}
}
]
}
]
}
],
"groups": [
{
"id": "string",
"title": "string",
"total": 0,
"totalPercentage": 0,
"values": [
{
"id": "string",
"title": "string",
"total": 0,
"percentage": 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"
}
}
],
"computedValues": [
{
"id": "string",
"title": "string",
"total": 0,
"percentage": 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"
}
}
],
"categories": [
{
"id": "string",
"title": "string",
"total": 0,
"totalPercentage": 0,
"accounts": [
{
"id": "string",
"title": "string",
"total": 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"
},
"values": [
{
"id": "string",
"title": "string",
"total": 0,
"percentage": 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"
}
}
]
}
]
}
],
"groups": [
{
"id": "string",
"title": "string",
"total": 0,
"totalPercentage": 0,
"values": [
{
"id": "string",
"title": "string",
"total": 0,
"percentage": 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"
}
}
],
"computedValues": [
{
"id": "string",
"title": "string",
"total": 0,
"percentage": 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"
}
}
],
"categories": [
{
"id": "string",
"title": "string",
"total": 0,
"totalPercentage": 0,
"accounts": [
{
"id": "string",
"title": "string",
"total": 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"
},
"values": [
{
"id": "string",
"title": "string",
"total": 0,
"percentage": 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"
}
}
]
}
]
}
],
"groups": [
{
"id": "string",
"title": "string",
"total": 0,
"totalPercentage": 0,
"values": [
{
"id": "string",
"title": "string",
"total": 0,
"percentage": 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"
}
}
],
"computedValues": [
{
"id": "string",
"title": "string",
"total": 0,
"percentage": 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"
}
}
],
"categories": [
{
"id": "string",
"title": "string",
"total": 0,
"totalPercentage": 0,
"accounts": [
{
"id": "string",
"title": "string",
"total": 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"
},
"values": [
{
"id": "string",
"title": "string",
"total": 0,
"percentage": 0,
"drilldown": {
"filter": {}
}
}
]
}
]
}
]
}
]
}
]
}
]
}
}{
"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
}