SearchEntities
Facilitates entity searches in QuickBooks by various attributes, streamlining entity identification.
Input
| Name | Type | Description |
| Entity | String | Specifies the type of QuickBooks entity to search, such as customers, vendors, or transactions. Use this to narrow down the scope of your search.
使用できる値は次のとおりです。Vendor, Employee, Bill, Invoice, CreditMemo, VendorCredit, SalesReceipt, PurchaseOrder, CCCredit, CCCharge, Customer, Estimate, SalesOrder, TimeTracking, ReceivePayment, JournalEntry, Item, Account, Deposit, InventoryAdjustment, PriceLevel, Class, CustomerType, JobType, PaymentMethod, PayrollItemWage, SalesTaxCode, ShipMethod, SalesRep, VendorType, BillToPay, ItemAssembliesCanBuild, ListDeleted, Preferences, ReceivePaymentToDeposit, SalesTaxPaymentCheck, TxnDeleted, ItemReceipt, BillPaymentCheck, BillPaymentCharge, StatementCharge, VehicleMileage, OtherTransaction, OtherList デフォルト値はVendorです。 |
| Name | String | The specific name or partial name to search for within the selected entity. Combine this with NameMatch to refine the results. |
| NameMatch | String | Defines the matching strategy for the search. Options can include exact match, partial match, or other predefined patterns to locate relevant records.
使用できる値は次のとおりです。EXACT, CONTAINS, STARTSWITH, ENDSWITH, RANGEEND, RANGESTART デフォルト値はEXACTです。 |
| StartModifiedDate | String | Filters records to include only those modified on or after this date. Acceptable date formats are MM-DD-YY, MM-DD-YYYY, MM/DD/YY, and MM/DD/YYYY. Dates in these formats are automatically converted to the standard YYYY-MM-DD format. |
| EndModifiedDate | String | Filters records to include only those modified on or before this date. Acceptable date formats are MM-DD-YY, MM-DD-YYYY, MM/DD/YY, and MM/DD/YYYY. Dates in these formats are automatically converted to the standard YYYY-MM-DD format. |
| MinBalance | String | Specifies the minimum balance for records to be included in the results. Only records with balances equal to or greater than this value are returned. |
| MaxBalance | String | Specifies the maximum balance for records to be included in the results. Only records with balances less than or equal to this value are returned. |
| MaxResults | String | Limits the number of records returned by the search to the specified maximum. Use this to control the size of the result set. |
| OtherEntity | String | Allows searching for entities not covered by the Entity field. For example, specify 'ItemService' to search for service items. When using this field, set Entity to 'OtherList'. |
Result Set Columns
| Name | Type | Description |
| XMLEntry | String | Provides a single result from the search in raw XML format. This is particularly useful for detailed inspection or further processing of the data. |
| * | String | The output structure depends on the entity being queried. It might include detailed records, summaries, or additional metadata relevant to the search. |