GetClientSqlWhereBuilder Method

Member of finDocumentFunctions
Get an ISSqlWhereBuilder for selecting Client records based upon Standard Parameters.

<para> The following Standard Parameters are recognised (depending on licence settings): <list> <item>Clients (Range)</item> <item>ActiveOnly (Boolean)</item> <item>WebOnly (Boolean)</item> <item>Branches (Range) - optional</item> <item>ClientGroups (Range)</item> <item>ClientTypes (Range)</item> <item>Entities (Range) - optional</item> <item>TaxCategories (Range)</item> </list> </para> <para> The following Standard Parameters are recognised but ignored since they have no meaning in this context: <list> <item>DateAsAt (Date)</item> <item>DateRange (DateRange)</item> </list> </para> <para> In addition, the SQL Where will also contain restrictions based upon any of the current User's filters. </para>

Syntax

finDocumentFunctions.GetClientSqlWhereBuilder(parameters, [includeBranchRange], [includeEntityRange])

Parameters

NameTypeOptionalByRefDescription
parameters ISKeyValueList The Parameters.
includeBranchRange Boolean Optional Indicates whether to include or ignore the Branch Range. If omitted, a value of True is assumed.
includeEntityRange Boolean Optional Indicates whether to include or ignore the Entity Range. If omitted, a value of True is assumed.

Return Value

ISSqlWhereBuilder

A ISSqlWhereBuilder value.

Member of:
finDocumentFunctions
Namespace:
Intersoft.finSupport6
Assembly:
finSupport6, Version=6.0.3
Target Framework:
.NET 9.0