View service

Use the view service to execute a system view or user view and get the data that matches the view's filter and sort options at the time of execution.

Any parameters that you provide in the request body override the same parameters defined in the view. For example, if a view is defined to return 10 records but you set size to 20 in the request body, the response will include 20 records.

Execute a view

post/services/core/view

Requests current data that matches the filter and sort options defined in a system view or user view, modified by any parameters in the request body.

SecurityOAuth2
Request
Request Body schema: application/json
key
required
string

Key to identify the view. For system views the key is in the form of <application-name>/<object name>::<view ID>, such as expenses/employee-expense::systemfw1. For user views the key is numeric, such as 540.

Example: "12"
viewType
required
string

The type of view to execute, either system or user.

Enum: "system" "user"
Example: "user"
object

Any filter parameters supported by the query service to narrow the search

asOfDate
string <date>

The "as of" date to use with any relative date comparisons in filters defined in the view. For example, if asOfDate is set to "2025-04-01" then priorMonth will be "03".

The current date is used if asOfDate is not set.

Example: "2025-04-01"
caseSensitiveComparison
boolean
Default: true

Queries are case-sensitive by default. Set to false to ignore case in a query.

Example: true
includeHierarchyFields
boolean
Default: false

Set to true to include hierarchical structure information with each object in the response.

Example: false
includePrivate
boolean
Default: false

By default, in a multi-entity company queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.

Example: false
start
integer

First record of the result set to include in the response. Use with size to paginate the result set. The first record is 1.

Example: 1
size
integer

Number of records per page, 4000 maximum.

Example: 100
Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "key": "540",
  • "viewType": "user",
  • "size": 3,
  • "start": 7,
  • "filterParameters": {
    • "asOfDate": "2025-04-01",
    • "caseSensitiveComparison": false
    }
}
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "61",
      • "id": "Vend-00010",
      • "name": "Design Works",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/61"
      },
    • {
      • "key": "63",
      • "id": "V1234555",
      • "name": "North Fork Power",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/63"
      },
    • {
      • "key": "38",
      • "id": "V80863",
      • "name": "Woodland Construction",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/38"
      }
    ],
  • "ia::meta": {
    • "totalCount": 49,
    • "start": 7,
    • "pageSize": 3,
    • "next": 10,
    • "previous": 4
    }
}