Skip to main content

Sample OData Queries

Sample OData queries for retrieving filtered data from the Outbound Data Feed.

Written by Shem Bogusz
Updated today

This article provides practical OData query examples to help you filter and retrieve data effectively from the Outbound Data Feed. These examples demonstrate common filtering patterns you can use in BI tools or custom integrations.

OData Query Format

Each query follows the same structure:

{FeedUrl}/{Entity}?$filter=...

Where:

  • FeedUrl: your workspace’s Outbound Data Feed URL

  • Entity: the table you want to query (e.g., OrganisationAccountActual)

  • $filter: optional filter expression

  • $select: optional list of fields to return

  • $orderby: optional sort order

  • $top / $skip: optional paging controls

The Outbound Data Feed implements the most commonly used OData query parameters, included above. Some advanced OData features are not supported including but not limited to: $expand, $apply, $search, $count.

Filtering by Organisation

Notes

  • Query the Organisation entity to retrieve the OrganisationId

  • If no Organisation filter is provided results include all Organisations in the workspace

    • Therefore, we recommend using this filter early to reduce the size of datasets

  • OrganisationId is then present in all Actual, Budget and Forecast entities

Filter for a single organisation

Return actuals for OrganisationId = 0.

{FeedUrl}/OrganisationAccountActual?$filter=
    OrganisationId eq 00000000-0000-0000-0000-000000000000

Filter by multiple organisations

The in() method is not currently support for guid data types. Therefore, or expressions are required to include more than one OrganisationId. 

{FeedUrl}/OrganisationAccountActual?$filter=
    (OrganisationId eq 00000000-0000-0000-0000-000000000000
    or OrganisationId eq 11111111-1111-1111-1111-111111111111)

Filtering by Period

Notes

  • If no Period filter is provided results are limited to the current calendar year

  • For consistent joins use the same filter on all entities

  • The Period value is always the last day of the month

  • Period is present in all Actual, Budget and Forecast entities

Filter for a single period

Returns actuals for Jan 2026.

{FeedUrl}/OrganisationAccountActual?$filter=Period eq 2026-01-31

Filter for a period range

Return actuals from July 2024 to June 2026.

{FeedUrl}/OrganisationAccountActual?$filter=
    Period ge 2024-07-01 and Period le 2026-06-30

Query the Periods Entity

Query the Periods entity to include a shared Period dimension in your BI model, ensuring it has the same filter as all other entities.

{FeedUrl}/Period?$filter=Period ge 2024-07-01 and Period le 2026-06-30

Combine Multiple Filters

Notes

  • Combine multiple filters with and

  • Combine filters to reduce data sets by retrieving only the required data

  • For example, combine OrganisationId, Period and any other dimension such as but not limited to BusinessUnitCategoryId or BusinessUnitId

Filter by Organisation and Period

Return actuals from July 2024 to June 2026 on OrganisationId = 0 and 1.

{FeedUrl}/OrganisationAccountActual?$filter=
    (OrganisationId eq 00000000-0000-0000-0000-000000000000 
    or OrganisationId eq 11111111-1111-1111-1111-111111111111)
    and Period ge 2024-07-31 
    and Period le 2025-06-30

Did this answer your question?