System views

System views are pre-defined query filters for objects, and are used in Sage Intacct to display data in ways that meet the needs of most users. Each time you execute a view, the response includes all data that matches the filtering and sorting options set up in the view.

System views cannot be changed, but users can use the UI to create user views based on them. For example, a user could create a user view that uses the same filter as a system view but returns different fields.

Use the view service to execute a system view and get the data that matches the view's filter and sort options.

Note: Queries for system views must use a very specific set of filters in the request body, as shown in this example:

object: system-view
fields:
  - key
  - id
  - name
  - description
  - query
filters:
  - $eq:
      object: expenses/electronic-receipt
  - $eq:
      contexts: __default
  - $eq:
      id: getAllVendors

System view query rules:

  • The only supported filter is $eq.
  • Filtering by context is done via the $eq operation on the contexts field, and can only be a single context. If you need to query for more than one context you must execute 2 separate queries.
  • If id is not provided the query will return all system views in a specific context.
  • If id is unique across all contexts, the context filter is not required.

Get a system view

get/objects/core/system-view

Returns all system views for an object or a specified system view.

SecurityOAuth2
Request
query Parameters
name
required
string

The name of an object or system view.

  • Use the form <application-name>/<object name> to get all views defined for an object, such as expenses/employee-expense.
  • Use the form <application-name>/<object name>::<view ID> to get a specific system view, such as expenses/employee-expense::systemfw1.
Example: name=accounts-payable/vendor::systemVendorFW1
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "contexts": [
      • "__default"
      ],
    • "description": "IA.ALL_ACTIVE_EMPLOYEE_EXPENSES",
    • "id": "systemfw1",
    • "key": "expenses/employee-expense::systemfw1",
    • "name": "IA.ALL",
    • "object": "expenses/employee-expense",
    • "query": {
      • "fields": [
        ],
      • "object": "expenses/employee-expense",
      • "orderBy": [
        ]
      },
    • "href": "/objects/core/system-view?name=expenses/employee-expense::systemfw1"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}