VRPlatformVRPlatform
Reports

/reports/journal-entries

Paginated journal entries with configurable filters

GET
/reports/journal-entries

Authorization

apiKey
X-API-Key<token>

API key provided in dashboard

In: header

Query Parameters

ids?string

comma separated journal entry ids

txnCode?string
published?boolean
status?string
Value in"active" | "inactive"
ledger?string
Value in"historical" | "trust" | "operating"
startAt?string
endAt?string
search?string
Length1 <= length
date?string
amount?string
isDateRangeEndInclusive?boolean

Whether the end date in dateRange or paidAtRange is treated as inclusive (true) or exclusive (false).

Defaulttrue
reservationIds?string

comma separated reservation ids or "unmapped"

Length1 <= length
transactionIds?string

comma separated transaction ids

ownerStatementIds?string

comma separated owner statement ids

currency?string

Currency in ISO 4217 format, will be converted to lowercase

listingIds?string

listing ids comma separated or "unmapped"

Length1 <= length
listingOwnershipPeriodIds?string

listing ownership period ids comma separated or "unmapped"

Length1 <= length
accountIds?string

account ids comma separated accounts or "unmapped"

Length1 <= length
accountReservationLineTypeIds?string

comma separated account reservation line type ids

Length1 <= length
categoryIds?string

comma separated categories

excludeCategoryIds?string

comma separated categories to exclude

contactIds?string

comma separated contacts

classifications?string
accountType?string
Value in"ledger" | "bank" | "recurringFee" | "nonPosting"
types?string

comma separated journal entry types

excludeTypes?string

comma separated journal entry types to exclude

entityTypes?string

comma separated entity types "reservation" | "deposit" | "expense" | "recurringFee" | "transfer" | "payout"

bookingChannels?string

comma separated booking channel refs

triggerTypes?string

comma separated trigger types "deferredRevenue" | "intercompany" | "rebalance" | "recurringFee" | "revenueRecognition"

excludeTriggerTypes?string

comma separated journal entry trigger types to exclude

parties?string

comma separated parties

party?string
Value in"owners" | "manager"
accountAssignmentTypes?string

comma separated account assignment types "accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "openingBalance" | "payout_bankAccount" | "payout_distribution"

managerStatementSectionIds?string

comma separated manager statement section ids

recurringFee?boolean
openingBalanceType?string
Value in"taxPayable" | "advancedDeposit" | "listingOpeningBalance" | "openingTrialBalance"
includeDetails?boolean
limit?number
Default100
Range1 <= value <= 250
page?number
Default1
Range1 <= value

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.vrplatform.app/reports/journal-entries"
{
  "data": [
    {
      "id": "string",
      "active": "active",
      "issues": [
        {
          "code": "generalLedgerStartAt",
          "severity": "warning",
          "context": {
            "statementStartAt": "string"
          }
        }
      ],
      "txnCode": "string",
      "txnAt": "string",
      "description": "string",
      "centTotal": 0,
      "type": "reservation",
      "reservationId": "string",
      "transactionId": "string",
      "ownerStatementId": "string",
      "currency": "string",
      "ledger": "historical",
      "entityType": "string",
      "status": "string",
      "listingId": "string",
      "uniqueRef": "string",
      "triggerType": "deferredRevenue",
      "party": "string",
      "contactId": "string",
      "listingOwnershipPeriodId": "string",
      "recurringFeeId": "string",
      "recurringFeeListingSubscriptionId": "string",
      "account": {
        "id": "string",
        "name": "string"
      },
      "detail": {
        "owners": "string",
        "listing": "string",
        "reservationConfirmationCode": "string",
        "bookingChannel": "string",
        "transactionReference": "string",
        "reservationLineReference": "string",
        "contact": "string",
        "classification": "string",
        "category": "string"
      }
    }
  ],
  "pagination": {
    "limit": 100,
    "page": 1,
    "total": 0,
    "totalPage": 0,
    "nextPage": 0
  }
}
{
  "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
}

/reports/journal-entries/csv GET

Previous Page

/reports/manager-statements/detail/csv GET

Next Page