The Outbound Data Feed exposes a set of OData entities representing organisations, accounts, business units, metrics, and monthly values. Each entity includes defined fields, data types, and key relationships to support modelling in external BI or integration tools. This page documents all available entities and their fields.
The Outbound Data Feed URL is scoped to a single workspace, and all entities returned by the feed contain only the organisations, business units, accounts, and data belonging to that workspace.
Organisation
Represents all organisations contained within the connected workspace.
Field | Type | Description |
OrganisationId | guid | Primary key identifying the organisation |
Name | string | Contains the organisation display name |
IsActive | boolean | Indicates whether the organisation is active in the workspace |
BusinessUnitCategory
Represents all business unit categories (dimensions) defined within each organisation in the workspace.
Field | Type | Description |
BusinessUnitCategoryId | guid | Primary key identifying the business unit category |
OrganisationId | guid | Foreign key linking to |
Name | string | Contains the category display name |
Is Active | boolean | Indicates whether the category is active and syncing data from the source system |
BusinessUnit
Represents all business units belonging to each category across all organisations in the workspace.
Field | Type | Description |
BusinessUnitId | guid | Primary key identifying the business unit |
OrganisationId | guid | Foreign key linking to |
BusinessUnitCategoryId | guid | Foreign key linking to |
Number | string | Contains the business unit external code or number, which may be null and is not guaranteed to be unique |
Name | string | Contains the business unit display name |
IsActive | boolean | Indicates whether the business unit is active or disabled in the organisation |
Account
Represents the chart of accounts from all organisations in the workspace.
Field | Type | Description |
AccountId | guid | Primary key identifying the account |
OrganisationId | guid | Foreign key linking to |
AccountType | string | Defines the account type (Asset, Liability, Equity, Income, Cost of Sales, Expense, Other Income, Other Expense) |
Number | string | Contains the account external code or number, which may be null and is not guaranteed to be unique |
Name | string | Contains the account display name |
IsActive | boolean | Indicates whether the account is active or disabled in the organisation |
Metric
Represents the metrics contained within the connected workspace.
Field | Type | Description |
MetricId | guid | Primary key identifying the metric |
Name | string | Contains the metric display name |
TargetType | string | Defines whether higher or lower values represent better performance for the metric (Higher, Lower) |
BudgetVersion
Represents the budget versions for each organisation in the workspace.
Field | Type | Description |
BudgetVersionId | guid | Primary key identifying the budget version |
OrganisationId | guid | Foreign key linking to
|
Name | string | Contains the budget version display name |
Type | string | Defines the budget version type (Budget, Scenario) |
IsActive | boolean | Indicates whether the budget version is active or disabled in the organisation |
Periods
To simplify filtering by Period in BI tools, we provide a dedicated Periods entity. All period‑based entities align to this by using the last day of the month as the period value.
Field | Type | Description |
Period | date | Contains a monthly period |
OrganisationAccountActual
Contains monthly actual account movements and closing balances for each organisation in the workspace.
Notes
If no
Periodfilter is provided, only the current calendar year is returnedPeriods are recorded as the last day of the month
PeriodMovement&ClosingBalancevalues use the debit‑positive / credit‑negative convention
Field | Type | Description |
OrganisationId | guid | Foreign key linking to
|
AccountId | guid | Foreign key linking to
|
Period | date | Contains the month of the movement or closing balance |
PeriodMovement | decimal | Contains the account movement for the period |
ClosingBalance | decimal | Contains the account closing balance for the period |
BusinessUnitAccountActual
Contains monthly actual account movements and closing balances for each business unit across all organisations in the workspace.
Notes
If no
Periodfilter is provided, only the current calendar year is returnedPeriods are recorded as the last day of the month
PeriodMovement&ClosingBalancevalues use the debit‑positive / credit‑negative convention
Field | Type | Description |
OrganisationId | guid | Foreign key linking to
|
BusinessUnitCategoryId | guid | Foreign key linking to |
BusinessUnitId | guid | Foreign key linking to |
AccountId | guid | Foreign key linking to Account.AccountId |
Period | date | Contains the month of the movement or closing balance |
PeriodMovement | decimal | Contains the movement for the period |
ClosingBalance | decimal | Contains the closing balance for the period |
OrganisationAccountBudget
Contains monthly budgeted account movements and closing balances for each organisation and budget version in the workspace.
Notes
If no
Periodfilter is provided, only the current calendar year is returnedIf no
BudgetVersionIdfilter is provided, the Main Budget Version is returnedAll budget values are calculated from the start of the query period range assuming the Last Actuals Period is the month immediately before the query period range
To calculate forecast amounts, change the start period to shift the assumed Actuals starting point
Combine multiple queries to produce different forecast results
Periods are recorded as the last day of the month
PeriodMovement&ClosingBalancevalues use the debit‑positive / credit‑negative convention
Field | Type | Description |
OrganisationId | guid | Foreign key linking to
|
BudgetVersionId | guid | Foreign key linking to |
AccountId | guid | Foreign key linking to
|
Period | date | Contains the month of the movement or closing balance |
PeriodMovement | decimal | Contains the movement for the period |
ClosingBalance | decimal | Contains the closing balance for the period |
OrganisationCashflowForecast
Contains monthly cashflow forecast amounts for each organisation and budget version in the workspace.
Notes
If no
Periodfilter is provided, 12 months are returned starting from the current calendar monthIf no
BudgetVersionIdfilter is provided, the Main Budget Version is returnedAll forecast values are calculated from the start of the query period range assuming the Last Actuals Period is the month immediately before the query period range
Change the start period to shift the assumed Actuals starting point
Combine multiple queries to produce different forecast results
Periods are recorded as the last day of the month
Amountvalues use the inflows‑positive and outflows‑negative conventionNominated bank accounts are excluded from this entity
Use
OrganisationAccountBudget.ClosingBalanceto obtain Bank at End results
Field | Type | Description |
OrganisationId | guid | Foreign key linking to
|
BudgetVersionId | guid | Foreign key linking to |
AccountId | guid | Foreign key linking to
|
Period | date | Contains the month of the forecast amount |
Amount | decimal | Contains the cashflow forecast amount |
BusinessUnitAccountBudget
Contains monthly budgeted account movements and closing balances for each business unit across all organisations and budget versions in the workspace.
Notes
If no
Periodfilter is provided, only the current calendar year is returnedIf no
BudgetVersionIdfilter is provided, the Main Budget Version is returnedAll budget values are calculated from the start of the query period range assuming the Last Actuals Period is the month immediately before the query period range
To calculate forecast amounts, change the start period to shift the assumed Actuals starting point
Combine multiple queries to produce different forecast results
Periods are recorded as the last day of the month
PeriodMovement&ClosingBalancevalues use the debit‑positive / credit‑negative convention
Field | Type | Description |
OrganisationId | guid | Foreign key linking to
|
BudgetVersionId | guid | Foreign key linking to |
BusinessUnitCategoryId | guid | Foreign key linking to |
BusinessUnitId | guid | Foreign key linking to |
AccountId | guid | Foreign key linking to Account.AccountId |
Period | date | Contains the month of the movement or closing balance |
PeriodMovement | decimal | Contains the movement for the period |
ClosingBalance | decimal | Contains the closing balance for the period |
OrganisationMetricActual
Contains monthly metric amounts for each organisation in the workspace, including non‑financial and driver values.
Notes
If no
Periodfilter is provided, only the current calendar year is returnedPeriods are recorded as the last day of the month
Field | Type | Description |
OrganisationId | guid | Foreign key linking to
|
MetricId | guid | Foreign key linking to
|
Period | date | Contains the month of the metric amount |
Amount | decimal | Contains the metric amount for the period |
BusinessUnitMetricActual
Contains monthly metric amounts for each organisation in the workspace, including non‑financial and driver values for each business unit across all organisations in the workspace.
Notes
If no
Periodfilter is provided, only the current calendar year is returnedPeriods are recorded as the last day of the month
Field | Type | Description |
OrganisationId | guid | Foreign key linking to
|
BusinessUnitCategoryId | guid | Foreign key linking to |
BusinessUnitId | guid | Foreign key linking to |
MetricId | guid | Foreign key linking to
|
Period | date | Contains the month of the metric amount |
Amount | decimal | Contains the metric amount for the period |
OrganisationMetricBudget
Contains monthly budgeted metric amounts, including non‑financial and driver values for each organisation and budget version in the workspace.
Notes
If no
Periodfilter is provided, only the current calendar year is returnedIf no
BudgetVersionIdfilter is provided, the Main Budget Version is returned
Field | Type | Description |
OrganisationId | guid | Foreign key linking to
|
BudgetVersionId | guid | Foreign key linking to |
MetricId | guid | Foreign key linking to
|
Period | date | Contains the month of the metric amount |
Amount | decimal | Contains the metric amount for the period |
BusinessUnitMetricBudget
Contains monthly budgeted metric amounts, including non‑financial and driver values for each business unit across all organisations and budget versions in the workspace.
Notes
If no
Periodfilter is provided, only the current calendar year is returnedIf no
BudgetVersionIdfilter is provided, the Main Budget Version is returnedPeriods are recorded as the last day of the month
Field | Type | Description |
OrganisationId | guid | Foreign key linking to
|
BudgetVersionId | guid | Foreign key linking to |
BusinessUnitCategoryId | guid | Foreign key linking to |
BusinessUnitId | guid | Foreign key linking to |
MetricId | guid | Foreign key linking to
|
Period | date | Contains the month of the metric amount |
Amount | decimal | Contains the metric amount for the period |