VRPlatformVRPlatform
Bank records

/bank-records/csv

Bank records CSV export

GET
/bank-records/csv
X-API-Key<token>

API key provided in dashboard

In: header

Query Parameters

status?string
Value in"active" | "inactive"
search?string
amount?string

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

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.

Formatvrp-date-range
isDateRangeEndInclusive?boolean

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

Defaulttrue
bankAccountId?string
accountId?string
uniqueRefs?string
reconcileStatus?string
Value in"unpaid" | "underpaid" | "overpaid" | "paid"
matchedByBankRule?boolean
includeBalanceRecords?boolean
includeMatchingRules?boolean
includeMatchingTransactions?string

Include matching transactions, optionally with max days offset

hasMatchingTransactions?boolean
reservationLineFilter?string
Value in"all" | "reservationOnly" | "nonReservationOnly"
sort?string
Value in"created_desc" | "created_asc" | "amount_desc" | "amount_asc"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.vrplatform.app/bank-records/csv"
{
  "url": "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
}