{"_id":"5632a5ea49e16d0d0012249a","__v":0,"githubsync":"","user":"55b932ba8fd1a02b00f496c8","project":"55b933b3146ef121002158d3","category":{"_id":"5632a5e749e16d0d0012244d","__v":1,"pages":["5632a5ea49e16d0d00122481","5632a5ea49e16d0d00122482","5632a5ea49e16d0d00122483","5632a5ea49e16d0d00122484","5632a5ea49e16d0d00122485","5632a5ea49e16d0d00122486","5632a5ea49e16d0d00122487","5632a5ea49e16d0d00122488","5632a5ea49e16d0d00122489","5632a5ea49e16d0d0012248a","5632a5ea49e16d0d0012248b","5632a5ea49e16d0d0012248c","5632a5ea49e16d0d0012248d","5632a5ea49e16d0d0012248e","5632a5ea49e16d0d0012248f","5632a5ea49e16d0d00122490","5632a5ea49e16d0d00122491","5632a5ea49e16d0d00122492","5632a5ea49e16d0d00122493","5632a5ea49e16d0d00122494","5632a5ea49e16d0d00122495","5632a5ea49e16d0d00122496","5632a5ea49e16d0d00122497","5632a5ea49e16d0d00122498","5632a5ea49e16d0d00122499","5632a5ea49e16d0d0012249a","5632a5ea49e16d0d0012249b","5632a5ea49e16d0d0012249c","5632a5ea49e16d0d0012249d","5632a5ea49e16d0d0012249e","5632a5ea49e16d0d0012249f","5632a5ea49e16d0d001224a0","5632a5ea49e16d0d001224a1","5632a5ea49e16d0d001224a2","5632a5ea49e16d0d001224a3","5632a5ea49e16d0d001224a4","5632a5ea49e16d0d001224a5","5632a5ea49e16d0d001224a6","5632a5ea49e16d0d001224a7"],"project":"55b933b3146ef121002158d3","version":"5632a5e549e16d0d00122443","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-04T17:34:02.800Z","from_sync":false,"order":12,"slug":"objects","title":"Objects"},"version":{"_id":"5632a5e549e16d0d00122443","__v":6,"project":"55b933b3146ef121002158d3","createdAt":"2015-10-29T23:04:05.701Z","releaseDate":"2015-10-29T23:04:05.701Z","categories":["5632a5e749e16d0d00122444","5632a5e749e16d0d00122445","5632a5e749e16d0d00122446","5632a5e749e16d0d00122447","5632a5e749e16d0d00122448","5632a5e749e16d0d00122449","5632a5e749e16d0d0012244a","5632a5e749e16d0d0012244b","5632a5e749e16d0d0012244c","5632a5e749e16d0d0012244d","5632a5e749e16d0d0012244e","5632a5e749e16d0d0012244f","5632a5e749e16d0d00122450","5632b179df556c0d00cd095b","564e13053b2b4a19000cd69b","59caa9df65accc001a489c95","59cab50965accc001a489d28","59cadd464ab7b70024378e74"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-04T17:57:50.579Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":24,"body":"Used to create a unique search parameter.\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis object is used to create a search parameter for methods such as [searchTransactions](/docs/searchtransactions) and [searchCustomers](/docs/searchcustomers).\nIt 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.\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Properties\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Type\",\n    \"h-1\": \"Name\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"string\",\n    \"0-1\": \"Field\",\n    \"0-2\": \"Name of field you are searching.\",\n    \"1-0\": \"string\",\n    \"1-1\": \"Type\",\n    \"1-2\": \"Type of comparison to make. Options are: gt - greater than, lt - less than, eq - equals, contains - partial match\",\n    \"2-0\": \"string\",\n    \"2-1\": \"Value\",\n    \"2-2\": \"Value to search on\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples\"\n}\n[/block]\n## Visual Basic (.Net) \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Dim search(0) As eBizCharge.SearchParam\\n       search(0) = New eBizCharge.SearchParam()\\n       search(0).Field = \\\"Created\\\"\\n       search(0).Type = \\\"Contains\\\"\\n       search(0).Value = \\\"2010-09-09\\\"\",\n      \"language\": \"asp\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"eBizCharge.SearchParam[] search = new eBizCharge.SearchParam[2];\\n           search[0] = new eBizCharge.SearchParam();\\n           search[1] = new eBizCharge.SearchParam();\\n           search[0].Field = \\\"Amount\\\";\\n           search[0].Type = \\\"eq\\\";\\n           search[0].Value = \\\"12.00\\\";\\n           search[1].Field = \\\"Created\\\";\\n           search[1].Type = \\\"gt\\\";\\n           search[1].Value = \\\"2010-08-08\\\";\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"searchparam","type":"basic","title":"SearchParam"}
Used to create a unique search parameter. [block:api-header] { "type": "basic", "title": "Description" } [/block] This object is used to create a search parameter for methods such as [searchTransactions](/docs/searchtransactions) and [searchCustomers](/docs/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. [block:api-header] { "type": "basic", "title": "Properties" } [/block] [block:parameters] { "data": { "h-0": "Type", "h-1": "Name", "h-2": "Description", "0-0": "string", "0-1": "Field", "0-2": "Name of field you are searching.", "1-0": "string", "1-1": "Type", "1-2": "Type of comparison to make. Options are: gt - greater than, lt - less than, eq - equals, contains - partial match", "2-0": "string", "2-1": "Value", "2-2": "Value to search on" }, "cols": 3, "rows": 3 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## Visual Basic (.Net) [block:code] { "codes": [ { "code": "Dim search(0) As eBizCharge.SearchParam\n search(0) = New eBizCharge.SearchParam()\n search(0).Field = \"Created\"\n search(0).Type = \"Contains\"\n search(0).Value = \"2010-09-09\"", "language": "asp" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "eBizCharge.SearchParam[] search = new eBizCharge.SearchParam[2];\n search[0] = new eBizCharge.SearchParam();\n search[1] = new eBizCharge.SearchParam();\n search[0].Field = \"Amount\";\n search[0].Type = \"eq\";\n search[0].Value = \"12.00\";\n search[1].Field = \"Created\";\n search[1].Type = \"gt\";\n search[1].Value = \"2010-08-08\";", "language": "csharp" } ] } [/block]