Reports
/reports/guest-balances
Guest Balances Report
Authorization
apiKey X-API-Key<token>
API key provided in dashboard
In: header
Query Parameters
date*string
occupancyStatus*string
Value in
"departed" | "inHouse" | "upcoming" | "cancelled" | "unassigned" | "all"channels?string
search?string
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.vrplatform.app/reports/guest-balances?date=string&occupancyStatus=departed"{
"data": [
{
"status": "booked",
"total": 0,
"charges": 0,
"payments": 0,
"listings": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"total": 0,
"charges": 0,
"payments": 0,
"reservations": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"checkIn": "string",
"checkOut": "string",
"bookedAt": "string",
"cancelledAt": "string",
"bookingPlatform": "string",
"guestName": "string",
"confirmationCode": "string",
"nights": 0,
"transactionReferenceId": "string",
"transactionDate": "string",
"transactionDescription": "string",
"total": 0,
"charges": 0,
"payments": 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
}