User GuideViews
Creating Views
Create saved views to organize and filter your data
Creating Views
Views are saved configurations for viewing and filtering transaction data. Create views to quickly access commonly needed data subsets.
What is a View?
A view saves:
- Record type (what data to show)
- Filters (which records to include)
- Sorting (how to order records)
- Columns (which fields to display)
- Search query (text search)
View Properties
| Property | Type | Description |
|---|---|---|
id | string | Unique view identifier |
name | string | Display name |
recordType | string | Transaction type to query |
isPublic | boolean | Whether other org members can see it |
icon | string | Optional icon identifier |
color | string | Optional accent color |
viewConfig | object | Filter and display configuration |
View Configuration
The viewConfig object contains:
| Property | Type | Description |
|---|---|---|
search | string | Text search query |
filters | object | Key-value filter pairs |
sortBy | string | Field to sort by |
sortDirection | asc | desc | Sort order |
visibleColumns | string | Comma-separated column IDs |
pageSize | number | Records per page |
Creating a View
Via Dashboard
- Navigate to a transaction list (e.g., Portal → Invoices)
- Apply desired filters, search, and sorting
- Click Save View
- Enter a name for the view
- Choose visibility (private or public)
- Optionally select an icon and color
- Click Save
View Input
| Field | Required | Description |
|---|---|---|
name | Yes | Descriptive name for the view |
recordType | Yes | Type of records (e.g., invoice, sale) |
viewConfig | Yes | Filter and display configuration |
isPublic | No | Share with organization (default: false) |
icon | No | Visual identifier |
color | No | Accent color |
Available Record Types
Views can be created for these transaction types:
| Record Type | Description |
|---|---|
invoice | Invoice transactions |
sale | Sales orders and quotes |
purchase | Purchase orders |
fulfillment | Item fulfillments |
View Visibility
| Setting | Access |
|---|---|
Private (isPublic: false) | Only the creator can see and use |
Public (isPublic: true) | All organization members can see |
Editing Views
- Navigate to Portal → Views
- Find the view to edit
- Click Edit
- Modify configuration
- Click Save
Editable Properties
| Property | Editable |
|---|---|
name | Yes |
viewConfig | Yes |
isPublic | Yes |
icon | Yes |
color | Yes |
recordType | No (create new view instead) |
Deleting Views
- Navigate to Portal → Views
- Find the view to delete
- Click Delete
- Confirm deletion
Deleting a view also removes any associated subscriptions.
Using Views
Quick Access
Saved views appear in the sidebar for quick access:
- Click on a view name in the sidebar
- The transaction list loads with saved configuration
- Optionally modify filters temporarily (changes not saved)
Applying to Current List
From any transaction list:
- Click Load View
- Select a saved view
- Configuration is applied
View Examples
"Overdue Invoices" View
{
"name": "Overdue Invoices",
"recordType": "invoice",
"viewConfig": {
"filters": {
"status": "open",
"duedate": { "$lt": "today" }
},
"sortBy": "duedate",
"sortDirection": "asc"
},
"isPublic": true,
"icon": "alert",
"color": "#ef4444"
}"Recent Large Orders" View
{
"name": "Recent Large Orders",
"recordType": "sale",
"viewConfig": {
"filters": {
"amount": { "$gte": 10000 }
},
"sortBy": "trandate",
"sortDirection": "desc",
"pageSize": 25
},
"isPublic": false
}Next: Email Subscriptions