VRPlatformVRPlatform
Reports

/reports/journal-entries/csv

Generate an admitted journal-entry CSV and return its signed download URL. Use POST for a durable background export. The UI placeholders "-", "all", and "none" are treated as no selection in their respective comma-separated filters. An entityTypes selection with no supported relation returns an empty export. Relationship ID filters accept "unmapped" to select journal entries without that relationship.

Required scope: reports:read, reports:export

GET
/reports/journal-entries/csv

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

Amount in cents, also accepts ranges like 100...200

Match^(?:(?:>=|<=|>|<)?-?\d+|-?\d+\.\.\.-?\d+)$
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 or "unmapped"

Length1 <= length
ownerStatementIds?string

comma separated owner statement ids or "unmapped"

Length1 <= length
currency?string

Currency in ISO 4217 format, will be converted to lowercase

listingIds?string

listing ids comma separated or "unmapped"

Length1 <= length
listingScope?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"
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

Accounting attribution: owners affects owner-side balances and statements; manager affects manager-side accounting

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"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.vrplatform.app/reports/journal-entries/csv"
{
  "url": "http://example.com",
  "expiresAt": "2024-01-15T12:30:00.000+00:00"
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "MISDIRECTED_REQUEST",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": {
    "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",
    "dataRegion": "ap",
    "apiBaseUrl": "http://example.com"
  }
}
{
  "code": "EXPORT_REQUIRES_POST",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": {
    "recommendedMethod": "POST",
    "reason": "selectionTooLarge"
  }
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "BAD_GATEWAY",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "GATEWAY_TIMEOUT",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}

/reports/guest-balances GET

Previous Page

/reports/journal-entries GET

Next Page