QuickBooks Integrator 2020 Kotlin Edition

Questions / Feedback?

SearchCriteria Type

Criteria used to limit a search to specific set of transactions.

Remarks

This type is used by the ObjSearch component, and describes the transactions the user is looking for.

Fields

AccountId
String?

An account name to search for in a transaction. Limits the search to transactions associated with the account specified by AccountId.

Only applicable to searches for transaction objects and BillToPay queries.

AccountName
String?

An account name to search for in a transaction. Limits the search to transactions associated with the account specified by AccountName. For example, if searching for a CCCredit AccountName would be the full name of a credit card.

Only applicable to searches for transaction objects and BillToPay queries.

AccountType
AccountTypeTypes

Search by the type of QuickBooks account.

Only applicable to account queries.

ActiveStatus
TActiveStatus

Limits the search to active or inactive records only. May be used to limit the search to active or inactive records only.

The following values are permitted:

asUnspecified0
asActiveOnly1
asInactiveOnly2
asAll3

Only applicable to searches for entity objects.

EntityId
String?

Limits the search to transactions associated with the entity specified by EntityId. Note that you may use EntityName OR EntityId to search, but you may not use both.

Only applicable to searches for transaction objects, with the following exceptions: BillToPay queries map this to the PayeeEntityId field, and ItemAssembliesCanBuild queries map this to the ItemInventoryAssemblyId field.

EntityName
String?

An entity name to search for in a transaction. Limits the search to transactions associated with the entity specified by EntityName. For example, if searching for an Invoice EntityName would be the full name of a Customer.

Only applicable to searches for transaction objects, with the following exceptions: BillToPay queries map this to the PayeeEntityName field, and ItemAssembliesCanBuild queries map this to the ItemInventoryAssemblyName field.

ItemType
SearchItemTypes

The type of item to search for. Applies only to searches for items. If set to itAll (the default) the component will search for all types of items.

ModifiedDateEnd
String?

Latest modified date to search for. Limits the search to records modified on or before this date.

This is also used as the Deleted date range filter for qtListDeletedQuery and qtTxnDeletedQuery query types.

The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format.

When setting the value of a date property, the formats MM-DD-YY, MM-DD-YYYY, MM/DD/YY, and MM/DD/YYYY are also acceptable. Dates in these formats will be automatically parsed and stored in YYYY-MM-DD format.

This field may also be set using the DateTime format. This format for specifying date and time is"CCCC-MM-DDThh:mm:ss+hh:mm" or "CCCC-MM-DDThh:mm:ss-hh:mm" where CCCC is the four-digit year, MM is the month, DD is the day, the character T is a separator, hh is the hour, mm is the minute, ss is the second, and hh:mm is the difference between the local time of the client and UTC (Universal Coordinated Time). For example, "2011-01-19T15:43:21-05:00" is January first, 2011 3:43:21 PM, Eastern Standard Time. The timezone differential is optional, if omitted Quickbooks will use the System's time zone.

ModifiedDateStart
String?

Earliest modified date to search for. Limits the search to records modified on or after this date.

This is also used as the Deleted date range filter for qtListDeletedQuery and qtTxnDeletedQuery query types.

The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format.

When setting the value of a date property, the formats MM-DD-YY, MM-DD-YYYY, MM/DD/YY, and MM/DD/YYYY are also acceptable. Dates in these formats will be automatically parsed and stored in YYYY-MM-DD format.

This field may also be set using the DateTime format. This format for specifying date and time is"CCCC-MM-DDThh:mm:ss+hh:mm" or "CCCC-MM-DDThh:mm:ss-hh:mm" where CCCC is the four-digit year, MM is the month, DD is the day, the character T is a separator, hh is the hour, mm is the minute, ss is the second, and hh:mm is the difference between the local time of the client and UTC (Universal Coordinated Time). For example, "2011-01-19T15:43:21-05:00" is January first, 2011 3:43:21 PM, Eastern Standard Time. The timezone differential is optional, if omitted Quickbooks will use the System's time zone.

NameContains
String?

String which names are to contain. Limits the search to records with names which contain the string NameContains.

If NameContains is specified none of the other Name properties may be specified.

Only applicable to searches for entity objects.

NameEndsWith
String?

String which names are to end with. Limits the search to records with names which end with the string specified by NameEndsWith.

If NameEndsWith is specified none of the other Name properties may be specified.

Only applicable to searches for entity objects.

NameRangeEnd
String?

Ending point of a name range. Limits the search to records with names lexicographically lower than or equal to NameRangeEnd.

May be combined with NameRangeStart, but not with NameContains, NameStartsWith, or NameEndsWith.

Only applicable to searches for entity objects.

NameRangeStart
String?

Starting point of a name range. Limits the search to records with names lexicographically higher than or equal to NameRangeStart.

May be combined with NameRangeEnd, but not with NameContains, NameStartsWith, or NameEndsWith.

Only applicable to searches for entity objects.

NameStartsWith
String?

String which names are to start with. Limits the search to records with names which start with the string specified by NameStartsWith.

If NameStartsWith is specified none of the other Name properties may be specified.

Only applicable to searches for entity objects.

PaidStatus
TPaidStatus

Limits the search to paid or unpaid transactions only. May be used to limit the search to paid or unpaid records only.

The following values are permitted:

psUnspecified0
psAll1
psPaid2
psUnpaid3

Only applicable to searches for Bill or Invoice transaction objects.

RefNumber
String?

Exact RefNumber to search for. Limits the search to records with RefNumbers identical to RefNumber.

If RefNumber is specified, no other search criteria will be sent in the query. If you wish to narrow your results based on the RefNumber and other criteria such as ModifiedDateStart or EntityName, you will need to use the RefNumberContains, RefNumberStartsWith, RefNumberEndsWith, RefNumberRangeStart, or RefNumberRangeEnd properties.

Only applicable to searches for transaction objects.

RefNumberContains
String?

String which RefNumbers are to contain. Limits the search to records with RefNumbers which contain the string RefNumberContains.

If RefNumberContains is specified none of the other RefNumber properties may be specified.

Only applicable to searches for transaction objects.

RefNumberEndsWith
String?

String which RefNumbers are to end with. Limits the search to records with RefNumbers which end with the string specified by RefNumberEndsWith.

If RefNumberEndsWith is specified none of the other RefNumber properties may be specified.

Only applicable to searches for transaction objects.

RefNumberRangeEnd
String?

Ending point of a RefNumber range. Limits the search to records with RefNumbers lexicographically lower than or equal to RefNumberRangeEnd.

May be combined with RefNumberRangeStart, but not with RefNumberContains, RefNumberStartsWith, or RefNumberEndsWith.

Only applicable to searches for transaction objects.

RefNumberRangeStart
String?

Starting point of a RefNumber range. Limits the search to records with RefNumbers lexicographically higher than or equal to RefNumberRangeStart.

May be combined with RefNumberRangeEnd, but not with RefNumberContains, RefNumberStartsWith, or RefNumberEndsWith.

Only applicable to searches for transaction objects.

RefNumberStartsWith
String?

String which RefNumbers are to start with. Limits the search to records with RefNumbers which start with the string specified by RefNumberStartsWith.

If RefNumberStartsWith is specified none of the other RefNumber properties may be specified.

Only applicable to searches for transaction objects.

TotalBalanceMaximum
String?

A maximum balance which returned records should have. Limits the search to records with balances less than or equal to TotalBalanceMaximum.

If TotalBalanceMaximum is specified TotalBalanceMinimum may not be (this limitation is imposed by the QBXML interface).

The amount should be formatted as a string in dollars.

Only applicable to searches for entity objects.

TotalBalanceMinimum
String?

A minimum balance which returned records should have. Limits the search to records with balances greater than or equal to TotalBalanceMinimum.

If TotalBalanceMinimum is specified TotalBalanceMaximum may not be (this limitation is imposed by the QBXML interface).

The amount should be formatted as a string in dollars.

Only applicable to searches for entity objects.

TransactionDateEnd
String?

Latest transaction date to search for. Limits the search to transactions with a date on or before TransactionDateEnd.

The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format.

When setting the value of a date property, the formats MM-DD-YY, MM-DD-YYYY, MM/DD/YY, and MM/DD/YYYY are also acceptable. Dates in these formats will be automatically parsed and stored in YYYY-MM-DD format.

Only applicable to searches for transaction objects.

TransactionDateStart
String?

Earliest transaction date to search for. Limits the search to transactions with a date on or after TransactionDateStart.

The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format.

When setting the value of a date property, the formats MM-DD-YY, MM-DD-YYYY, MM/DD/YY, and MM/DD/YYYY are also acceptable. Dates in these formats will be automatically parsed and stored in YYYY-MM-DD format.

Only applicable to searches for transaction objects.

Constructors

public constructor()



Copyright (c) 2021 /n software inc. - All rights reserved.
QuickBooks Integrator 2020 Kotlin Edition - Version 20.0 [Build 7941]