VRPlatformVRPlatform
Statements

/statements/pdf/batch

Get Owner Statements ZIP by month or listing month range

GET
/statements/pdf/batch
X-API-Key<token>

API key provided in dashboard

In: header

Query Parameters

ownershipPeriodIds?string

comma separated ownership periods

month?string

Month string in format YYYY-MM.

Match^\d{4}-\d{2}$
Formatvrp-month
listingId?string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
startMonth?string

Month string in format YYYY-MM.

Match^\d{4}-\d{2}$
Formatvrp-month
endMonth?string

Month string in format YYYY-MM.

Match^\d{4}-\d{2}$
Formatvrp-month
currency?string

Currency in ISO 4217 format, will be converted to lowercase

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.vrplatform.app/statements/pdf/batch"
{
  "url": "string",
  "expIn": 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
}