Consolidated Item

Overview

Consolidated Items represent the individual transactions that were aggregated into a consolidation journal entry. When multiple shipments or invoices are consolidated for general ledger purposes, consolidated items provide the line-by-line detail showing exactly which source transactions contributed to the consolidated GL entry and how much each contributed.

Each consolidated item links to a source transaction - a specific shipment or invoice. The amount field shows how much of the consolidated total came from that transaction. By summing all the consolidated items, you get the total of the consolidation journal entry. This detailed linkage means you can always drill down from a summary GL entry to see the underlying operational transactions.

The relationship to the consolidation journal entry is one-to-many - one consolidation contains many consolidated items. This structure mirrors how journal entries contain journal entry items, but with the added dimension that consolidated items reference external source transactions rather than just specifying accounts and amounts.

Querying consolidated items supports audit and analysis workflows. When an accountant sees a consolidated GL entry for $50,000 of cost of goods sold, they can query the consolidated items to see the 200 individual shipments that made up that total. Each consolidated item shows the shipment ID, date, and amount, providing complete transparency into the consolidation.

Consolidated items maintain the audit trail when shipments and invoices are aggregated for GL purposes. While the GL shows clean, summarized entries that keep accounting reports readable, the consolidated items preserve the operational detail. This satisfies both the accountant's need for clean reports and the auditor's need for detailed documentation.

The system automatically creates consolidated items when the consolidation process runs. As shipments or invoices are marked for consolidation and aggregated into a journal entry, the system creates a consolidated item for each source transaction. This automatic creation ensures the linkage is always complete and accurate.

When a consolidation is reversed, the consolidated items show which transactions need to revert to individual GL entries. This supports correction workflows when consolidations need to be undone, whether due to errors or period-end accounting adjustments.

GraphQL API

The consolidatedItem collection provides access to consolidatedItem data via the GraphQL API. All queries use the Relay connection specification with cursor-based pagination.

Query Name: consolidatedItemViewConnection

Available Features:

Cursor-based pagination (first/last/after/before)
2 filter options
9 relations to other collections

Query Examples

Basic Query

The consolidatedItem collection is accessed via the consolidatedItemViewConnection query, which returns a Relay-style connection with pagination support.

query {
  consolidatedItemViewConnection(first: 10) {
    edges {
      node {
        amount
        sourceTransaction
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

Pagination

Use cursor-based pagination to retrieve large datasets:

# First page
query {
  consolidatedItemViewConnection(first: 50) {
    edges {
      node { amount }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

# Subsequent pages
query {
  consolidatedItemViewConnection(first: 50, after: "cursor-from-previous-page") {
    edges {
      node { amount }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

Filtering

Apply filters to narrow results (see Filters section for all available options):

query {
  consolidatedItemViewConnection(
    first: 10
    account: "Sales Revenue"
  ) {
    edges {
      node { amount }
    }
  }
}

Relations

Query related data (see Relations section for all available relations):

query {
  consolidatedItemViewConnection(first: 10) {
    edges {
      node {
        amount
        build {
          buildId
          buildUrl
        }
      }
    }
  }
}

Summary and Aggregation

This collection supports metrics aggregation through the summary field. You can calculate totals, averages, counts, and other aggregate values across filtered data.

Note: This collection does not support groupBy dimensions. For dimensional analysis, use collections like product, order, or invoice.

For a comprehensive guide to using aggregations, see the Aggregation Concept Guide.

Query Structure

consolidatedItemViewConnection(filters...) {
  summary {
    errorCode
    errorMessage
    metrics {
      # Calculated metrics (see table below)
    }
  }
}

Available Metrics

This collection provides 2 metrics that can be aggregated:

Metric	Parameters	Description
`amount`	`transform`, `operator`	amount for consolidatedItem
`count`	None	Count of items in the result set

Common Parameters:

operator - Aggregation function: sum, mean, min, max
transform - Mathematical transformation: abs
dateRange - Filter to specific date range
facilityUrlList - Filter to specific facilities

Examples

Example 1: Total consolidatedItem Metrics

Calculate aggregate metrics across all consolidatedItem records:

query {
  consolidatedItemViewConnection(first: 1) {
    summary {
      errorCode
      errorMessage
      metrics {
        totalCount: count
      }
    }
  }
}

Expected result structure:

{
  "data": {
    "consolidatedItemViewConnection": {
      "summary": {
        "errorCode": null,
        "errorMessage": null,
        "metrics": {
          "totalCount": [1523]
        }
      }
    }
  }
}

Fields

This collection has 2 fields:

2 simple fields
0 enum fields (with predefined values)
0 parameterized fields (accept query options)

Note on Field Formatting: All scalar fields support the formatter argument to control output format. Available options: "html", "none", "abbreviated", "blank-zero". Some fields have a default formatter (shown below). See the Formatting guide for details.

Note on Sorting: Field sortability may vary depending on the UI context and query parameters used. Some parameter options explicitly disable sorting (marked with ⚠️ not sortable).

Simple Fields

These fields return values directly without additional options.

`amount`

The monetary value of a double-entry accounting transaction line item, representing the amount debited from one general ledger account and credited to another. Each consolidated item records a single leg of a journal entry with both a debit account and credit account, where the amount is applied positively to the debit side and negatively to the credit side. This field is central to consolidated reporting and general ledger analysis, as it tracks the actual financial impact of transactions from various source documents (invoices, shipments, payments, stock changes, builds, journal entries). When summarized by account, the system automatically applies the correct sign convention: amounts appear positive for debit accounts and negative for credit accounts, ensuring proper balance sheet and income statement calculations. The amount is always stored as a currency value and formatted to two decimal places for financial precision.

Label: Amount
Sortable: No

`sourceTransaction`

Displays the original transaction that created the consolidated item. A consolidated item represents a single debit/credit pair in the general ledger, and these can originate from different types of source transactions.

The field combines the transaction type and ID to provide a formatted reference to the source. Supported source transaction types include: invoices (displaying as "Invoice [ID]"), shipments (as "Sale [ID]" or "Purchase [ID]"), journal entries (with the entry type such as "Average cost change [ID]"), builds (as "Build [ID]"), inventory variances (as "Stock change [ID]"), and payments (as "Sales payment [ID]" or similar based on type).

The field is formatted as HTML with a clickable link to view the source transaction details, making it easy to navigate from consolidated accounting entries back to their originating business documents.

Label: Source transaction
Sortable: No
Default Formatter: html

Example Query:

{
  consolidatedItem(consolidatedItemUrl: "example-url") {
    sourceTransaction    # Uses default formatter: html
    sourceTransactionRaw: sourceTransaction(formatter: "none")  # Get raw value
  }
}