Statements
/statements/pdf/batch
Get owner statements PDF ZIP by month or listing month range
Required scope: statements:read, statements:export
Authorization
apiKey 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}$Format
vrp-monthlistingId?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)$Format
uuidstartMonth?string
Month string in format YYYY-MM.
Match
^\d{4}-\d{2}$Format
vrp-monthendMonth?string
Month string in format YYYY-MM.
Match
^\d{4}-\d{2}$Format
vrp-monthcurrency?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
application/json
curl -X GET "https://api.vrplatform.app/statements/pdf/batch"{
"url": "string",
"expIn": 0
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}