/listings/ownership-periods
Create a listing ownership period. Periods cannot overlap; onConflict controls how date-range conflicts with existing periods are resolved (updateExisting by default, or error / adjustInsertingItem). Journal entries in the range are relinked to the new period, and setListingInactive=true marks entries in the range inactive so they are excluded from the books and owner statements. Changes touching books-closed or statement-locked months are rejected. Supports dryRun. See https://docs.vrplatform.app/guides/build/portfolio.
Required scope: ownerships:write
Authorization
apiKey API key provided in dashboard
In: header
Query Parameters
Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode.
Request Body
application/json
^([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)$uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.vrplatform.app/listings/ownership-periods" \ -H "Content-Type: application/json" \ -d '{ "listingId": "8c73d933-f7ed-437e-9da1-caac95adc1ae", "members": [ {} ] }'{
"listingId": "8c73d933-f7ed-437e-9da1-caac95adc1ae",
"startAt": "string",
"endAt": "string",
"setListingInactive": true,
"businessModel": "managed",
"reserve": -9007199254740991,
"members": [
{
"split": 100000,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"firstName": "string",
"uniqueRef": "string",
"shortRef": "string",
"email": "user@example.com",
"type": "owner"
}
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}{
"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
}