VRPlatformVRPlatform
StatementsLayouts

/statements/layouts/{id}

Get statement layout by ID

Required scope: statement-layouts:read

GET
/statements/layouts/{id}
X-API-Key<token>

API key provided in dashboard

In: header

Path Parameters

id*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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.vrplatform.app/statements/layouts/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "name": "string",
  "summaryType": "default",
  "isDefault": true,
  "showTeamEmail": true,
  "netRevenueSections": [
    {
      "id": "string",
      "name": "string",
      "locked": true,
      "visible": "all",
      "aggregate": true,
      "columns": [
        {
          "id": "string",
          "name": "string",
          "locked": true,
          "visible": "all",
          "type": "field",
          "value": "string"
        }
      ]
    }
  ],
  "otherSections": [
    {
      "id": "string",
      "name": "string",
      "locked": true,
      "visible": "all",
      "columns": [
        {
          "id": "string",
          "name": "string",
          "locked": true,
          "visible": "all",
          "type": "field",
          "value": "string"
        }
      ]
    }
  ],
  "id": "string",
  "version": -9007199254740991,
  "activeListings": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "linkedAccounts": [
    {
      "id": "string",
      "name": "string",
      "uniqueRef": "string",
      "status": "active"
    }
  ],
  "createdAt": "2024-01-15T12:30:00.000+00:00",
  "systemSections": [
    {
      "id": "string",
      "name": "string",
      "locked": true,
      "visible": "all",
      "columns": [
        {
          "id": "string",
          "name": "string",
          "locked": true,
          "visible": "all",
          "type": "field",
          "value": "string"
        }
      ]
    }
  ]
}
{
  "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
}