SI.XQUERYFILTER

Created by Velixo Team, Modified on Thu, 26 Jun at 9:04 AM by Velixo Team

Applies to:

  • Velixo NX 2025.6 or higher
  • Dynamics 365 Business Central


TABLE OF CONTENTS

Introduction


The SI.QUERYFILTER function returns a string that can be used as input for the Filter parameter in the SI.XQUERY function.



Syntax


=SI.XQUERYFILTER(ConnectionName, Object, Column1, Criteria1, …, ColumnN, CriteriaN)

 

Parameters

Parameter

Required/Optional

Description

ConnectionName

Required

The name of the connection, as specified in the Connection Manager

Object

Required

Sage Intacct REST object name. For instance, accounts-payable/adjustment

Please use SI.XEXPANDOBJECTRANGE to explore available objects.

Column

Required

Name of the object field you wish to filter

Criteria

Required

A criterion or set of criteria that you want your filtered results to meet.

Criteria can be one of the following:

  • a value – the parameter should be equal to the value

  • an Excel comparison operator (<>, >, <, =, >=, <=), followed by a value

The parameter can be a single value, an array of values, or a range of cells.
If the parameter is an array or a range of cells, each value will be considered an alternative and joined via a logical OR as part of a bracketed group.

ColumnN

Optional

Another name of an object field you wish to filter

CriteriaN

Optional

Another criterion or set of criteria that you want your filtered results to meet


Output


The function returns a string containing a valid filter, ready for use with the SI.XQUERY function.


Example


You need a filter that returns all unposted WIP periods ending in Q1 2026.


First, find the object name. You can use the SI.XEXPANDOBJECTRANGE function to find the name of the WIP period object. It is construction-forecasting/wip-period.


Then, you can use the SI.XOBJECTDEFINITION function to retrieve all properties available for the object. In this case, you are interested in the periodEndDate and state fields.


Providing this information, you can arrive at the following formula:

=SI.XQUERYFILTER("Sage","construction-forecasting/wip-period","periodEndDate",">= '2026-01-01'","periodEndDate","<= '2026-03-31'", "state", "unposted")

When executed, it returns the following filter, ready to use with the SI.XQUERY function:


Below, you can see the filter used with the SI.XQUERY function:

 



Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article