Aggregate

Aggregate summarises enriched customer transactions into structured data that supports affordability analysis, cashflow review, and financial behaviour assessment.

Retrieving this report

Aggregate is returned as the aggregate entry of the report bundle - one call returns it alongside Completeness and Risk Score. Check the entry's status before reading its data; the fields below describe that data payload.

Interpreting results for credit

• Use hierarchy to understand where a node sits in the report structure: top-level sections, nested subtables, individual rows, and totals
• Use type to determine how to parse values - for example as an array of child nodes, a time series object, or a key-value object
• Compare income and expense node values across the assessed period to inform serviceability calculations
• Read Aggregate alongside Completeness in the same bundle - low data coverage can distort aggregated totals and reduce confidence in the figures

Response fields

The data payload contains a tables array of aggregation nodes. Each node contains:

Field	Description
id	Unique identifier for the aggregation node
name	Human-readable label for the aggregation category, when available
hierarchy	Structural role of the node in the aggregation output: table, subtable, row, or total
type	Data shape of the node's values field: objectArray, timeseries, or keyValue
values	Aggregated values for the node. The structure depends on the node type (see below)

The shape of values depends on type:

• objectArray - values is an array of child nodes (recursive nesting)
• timeseries - values is an object keyed by "yyyy-MM" month with numeric amounts (or null where no value exists), plus a total key
• keyValue - values is an object of key/value pairs; values are mixed types (strings, numbers, dates, nulls)

Next steps

• Reports - How to retrieve this report and read its status
• Completeness - Validate data coverage before relying on aggregated totals
• Risk Score - Add a risk signal to complement affordability analysis
• API Reference - Full endpoint schema and parameter details