VRPlatformVRPlatform
Statements

/statements/csv

Get owner statement list CSV export. Produces a summary CSV with one row per matched statement (status, payment, and balance columns) for a month, year, date range, or explicit statement IDs. Returns a short-lived download URL.

Required scope: statements:read, statements:export

GET
/statements/csv

Authorization

apiKey
X-API-Key<token>

API key provided in dashboard

In: header

Query Parameters

limit?number
Default100
page?number
Default1
periodIds?string

Comma-separated ownership period UUIDs.

year?integer

Year in format YYYY

Range1900 <= value <= 2100
listingIds?string

Comma-separated listing UUIDs.

statementIds?string

Comma-separated statement UUIDs.

month?string

Month string in format YYYY-MM.

Match^\d{4}-\d{2}$
Formatvrp-month
search?string
status?string|string
ownerIds?string

Comma-separated owner UUIDs.

listingCollectionIds?stringDeprecated
recurringFeeIds?string
dateRange?string

Date range string. Accepted syntax: YYYY, YYYY-MM, YYYY-MM-DD, or range YYYY-MM-DD...YYYY-MM-DD (legacy comma separator also accepted). Single values expand to the full year, month, or day.

Formatvrp-date-range
isDateRangeEndInclusive?boolean
Defaultfalse

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://staging.api.vrplatform.app/statements/csv"
{
  "url": "string",
  "expIn": 0
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}

/statements/by-period GET

Previous Page

/statements/detail/csv GET

Next Page