search_parameters
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
search_parameters [2014/10/31 11:05] Lisa Adams |
search_parameters [2015/03/24 08:22] Jaco van Wyk [Search {Compound Queries] |
||
|---|---|---|---|
| Line 63: | Line 63: | ||
| <WRAP todo> These searches will return all clients with the request in both teh desired field and all others. For example a search for "Johannesburg" will return clients with "Johannesburg" in the city field, but also include clients with "Johannesburg" in the name, surname, company name and email address fields.</WRAP> | <WRAP todo> These searches will return all clients with the request in both teh desired field and all others. For example a search for "Johannesburg" will return clients with "Johannesburg" in the city field, but also include clients with "Johannesburg" in the name, surname, company name and email address fields.</WRAP> | ||
| + | ==== Special Client Fields ==== | ||
| + | |||
| + | ^ Special Client Fields ^ Search Query ^ Example ^ | ||
| + | | Created by import | import:number | import:013 | | ||
| + | | Not created by import | !import:number | !import:013 | | ||
| + | | With coupon code | coupon:code | coupon:BZ1234FR | | ||
| + | |Not with coupon code | !coupon:code | !coupon:DISCOUNT | | ||
| + | | Captured on day | created:yyyy-mm-dd | created:2012-08-04 | | ||
| + | | Not captured on day | !created:yyyy-mm-dd | !created:2012-08-04 | | ||
| + | | Captured before day | created<:yyyy-mm-dd | created<:2012-08-04 | | ||
| + | | Captured before and on day | created<=:yyyy-mm-dd | created<=:2012-08-04 | | ||
| + | | Captured after day | created>:yyyy-mm-dd | created>:2014-06-08 | | ||
| + | | Captured after and on day | created>=:yyyy-mm-dd | created>=:2013-03-13 | | ||
| + | | Captured on day only | created=:yyyy-mm-dd | created=:2013-09-10 | | ||
| + | |||
| + | |||
| + | ==== Services ==== | ||
| + | |||
| + | ^ Services ^ Search Query ^ Example ^ | ||
| + | | Particular service | service:"service name" | service:"funeral cover" | | ||
| + | | Not service | !service:"service name" | !service:"funeral cover" | | ||
| + | | Particular package | package:"package name" | package:startup | | ||
| + | | Not package | !package:"package name" | !package:trial | | ||
| + | |||
| + | ==== Payment Details ==== | ||
| + | |||
| + | ^ Payment Details ^ Search Query ^ Example ^ | ||
| + | | Payment method | payment:"method name" | payment:eft | | ||
| + | | Not payment method | !payment:"method name" | !payment:paypal | | ||
| + | | Particular currency | currency:abbreviation | currency:zar | | ||
| + | | Not currency | !currency:abbreviation | !currency:usd | | ||
| + | | Particular bank | bank:"bank name" | bank:"ABSA BANK" | | ||
| + | | Not bank | !bank:"bank name" | !bank:"NEDBANK" | | ||
| + | | Has credit card | has:credit_card | | | ||
| + | | Has bank account | has:bank_account | | | ||
| + | | No credit card | !has:credit_card | | | ||
| + | | No bank account | !has:bank_account | | | ||
| + | |||
| + | ==== Custom Fields ==== | ||
| + | |||
| + | ^ Custom Fields ^ Search Query ^ Example ^ | ||
| + | | Custom field | data-custom_field:value | data-batch_day:15 | | ||
| + | | Not custom field | !data-custom_field:value | !data-action_day:30 | | ||
| + | |||
| + | |||
| + | ==== Debit Batch Fields ==== | ||
| + | |||
| + | ^ Debit Batch Fields ^ Search Query ^ Example ^ | ||
| + | | All on batch | batch:number | batch:085 | | ||
| + | | All pending on batch | pending-batch:number | pending-batch:067 | | ||
| + | | All error on batch | error-batch:number | error-batch:08 | | ||
| + | | All refuted on batch | refuted-batch:number | refuted-batch:012 | | ||
| + | | All bounced on batch | bounced-batch:number | bounced-batch:013 | | ||
| + | | All paid on batch | paid-batch:number | paid-batch:134 | | ||
| + | |||
| + | <WRAP todo> You can find the batch number by going to [[https://billing.snapbill.com/batches|Billing > Manage Debit Batches]] and check the number next to the batch you want to query.</WRAP> | ||
| + | |||
| + | ==== Search Compound Queries ==== | ||
| + | |||
| + | SnapBill allows you to perform powerful compound search queries. A compound search makes us use more than one search parameter to generate highly detailed data. Below are a few examples of common compound searches to help you get started: | ||
| + | |||
| + | ^You want to find...^ Search Query ^ | ||
| + | | All suspended clients with a fishing magazine subscription, USD as currency and PayPal as payment method. | state:suspended service:"fishing magazine subscription" currency:usd payment:paypal | | ||
| + | | All deleted clients from New York. | "New York" is:dead | | ||
| + | | All active clients on debit batch number 085 with the 15th as batch day. | batch:085 data-batch_day:15 state:active | | ||
| + | |||
| + | <WRAP tip> Prefixing a search with "!" will exclude the parameter from the results. | ||
| + | Using a space in a compound search is like saying "and". | ||
| + | Most SnapBill accounts have their own unique custom fields, so check with your account manager if a search does not deliver the desired result.</WRAP> | ||
search_parameters.txt ยท Last modified: 2015/03/24 08:22 by Jaco van Wyk
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: GNU Free Documentation License 1.3
