SearchParam

Used to create a unique search parameter.

Description

This object is used to create a search parameter for methods such as searchTransactions and searchCustomers.

It consists of three properties: the name of the field you are searching on, the type of comparison to make, and the value. Since each method uses a unique set of search parameters, check the documentation of each method for a list of valid field names. A complete list of all methods using this object can be found below.

Properties

Type	Name	Description
string	Field	Name of field you are searching.
string	Type	Type of comparison to make. Options are: gt - greater than, lt - less than, eq - equals, contains - partial match
string	Value	Value to search on

Places Used

• searchTransactions
• searchTransactionsCustom
• searchBatches
• searchCustomers
• searchMerchants

Examples

.NET VB

    Dim search(0) As newtek.SearchParam

            search(0) = New newtek.SearchParam()

            search(0).Field = "Created"
            search(0).Type = "Contains"
            search(0).Value = "2010-09-09"

.NET C

    newtek.SearchParam[] search = new newtek.SearchParam[2];
                search[0] = new newtek.SearchParam();
                search[1] = new newtek.SearchParam();

                search[0].Field = "Amount";
                search[0].Type = "eq";
                search[0].Value = "12.00";

                search[1].Field = "Created";
                search[1].Type = "gt";
                search[1].Value = "2010-08-08";