Statements
/statements/historic
Import a historic owner statement with journal entries on the historical ledger; re-posting the same uniqueRef replaces the previous import
Authorization
apiKey X-API-Key<token>
API key provided in dashboard
In: header
Request Body
application/json
uniqueRef*string
Stable statement idempotency key; re-posting replaces
Length
1 <= lengthlistingId*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
uuidstartAt*string
endAt*string
currency*string
Currency in ISO 4217 format, will be converted to lowercase
status?string
Default
"published"Value in
"inReview" | "published"centBalanceStart?integer
Value in cents (100 = 1€)
Range
-9007199254740991 <= value <= 9007199254740991centBalanceEnd?integer
Derived from balanceStart + net income + payouts when omitted
Range
-9007199254740991 <= value <= 9007199254740991lines*
Items
1 <= itemsResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.vrplatform.app/statements/historic" \ -H "Content-Type: application/json" \ -d '{ "uniqueRef": "string", "listingId": "8c73d933-f7ed-437e-9da1-caac95adc1ae", "startAt": "string", "endAt": "string", "currency": "string", "lines": [ { "uniqueRef": "string", "centTotal": -9007199254740991 } ] }'{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"uniqueRef": "string",
"status": "inReview",
"listingId": "8c73d933-f7ed-437e-9da1-caac95adc1ae",
"listingOwnershipPeriodId": "3b44a97e-91a8-47fa-80c4-180ad3352fe2",
"startAt": "string",
"endAt": "string",
"currency": "string",
"replaced": true,
"journalEntryCount": 0,
"financials": {
"centBalanceStart": 0,
"centBalanceEnd": 0,
"centTotal": 0,
"centExpenses": 0,
"centNetRevenue": 0,
"centTransfer": 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
}