Serach vendor

## API Endpoint: Search Vendor This endpoint allows users to search for vendors based on a query string. The search is performed using the vendor's name or related keywords, and it returns a list of matching vendors along with their details. ### Request - **Method:** GET - **URL:** `{{host}}/apis/external/search/searchVendor` - **Query Parameters:** - `q` (string): The search query for the vendor name. This parameter is required and should be URL-encoded. ### Example Request ``` GET {{host}}/apis/external/search/searchVendor?q=UJJIVAN SMALL FINANCE BANK LIMITED ``` ### Response The response is a JSON object containing the following structure: - `vendors` (array): A list of vendor objects that match the search criteria. - Each vendor object contains: - `id` (integer): Unique identifier for the vendor. - `title` (string): Title of the vendor. - `tradeName` (string): Trade name of the vendor. - `currency` (string): Currency used by the vendor. - `code` (string): Vendor code. - `email` (string): Email address of the vendor. - `mobile` (string): Mobile number of the vendor. - `vendor` (boolean): Indicates if the entity is a vendor. - `customer` (boolean): Indicates if the entity is a customer. - `gstin` (string): GST identification number. - `bank` (object): Bank details of the vendor. - `accountId` (string): Bank account ID. - `ifsc` (string): IFSC code of the bank. - `account` (string): Bank account number. - `name` (string): Name associated with the bank account. - `email` (string): Email associated with the bank account. - `bankName` (string): Name of the bank. - `branchName` (string): Name of the branch. - `customTags` (object): Any custom tags associated with the bank. - `bankAndVendorNameMatch` (boolean): Indicates if the bank name matches the vendor name. - `valid` (boolean): Indicates if the bank details are valid. - `validSyncedAt` (integer): Timestamp of the last validation sync. - `data` (array): Additional data related to the vendor. - Each entry contains: - `key` (string): Key for the data entry. - `id` (string): Identifier for the data entry. - `value` (string): Value for the data entry. - `encrypt` (boolean): Indicates if the value is encrypted. - `pan` (string): PAN number of the vendor. - `vendorId` (string): Unique vendor ID. - `connection` (string): Connection details. - `validPan` (boolean): Indicates if the PAN is valid. - `validAccount` (boolean): Indicates if the bank account is valid. - `validGst` (boolean): Indicates if the GST is valid. - `address` (object): Address details of the vendor. - Contains fields like `id`, `title`, `address`, `city`, `state`, `country`, `pincode`, and validation flags for GST and PAN. - `msme` (object): MSME details if applicable. - Contains fields like `msmeId` and `certificate`. - `paymentTerms` (object): Payment terms associated with the vendor. - `createdAt` (integer): Timestamp of when the vendor was created. - `updatedAt` (integer): Timestamp of when the vendor was last updated. - `basicOnboarding` (boolean): Indicates if basic onboarding is completed. - `total` (integer): Total number of vendors matching the search. - `currentPage` (integer): Current page number of the results. - `totalPages` (integer): Total number of pages available for the results. ### Example Response ``` json { "vendors": [ { "id": 239204, "title": "UJJIVAN SMALL FINANCE BANK LIMITED", "tradeName": "UJJIVAN SMALL FINANCE BANK LIMITED", "currency": "INR", "code": "CONTACT-KARANDEVENV-0000068", "email": "asdfghnm@sdfgh.dsfgh", "mobile": "1234567890", "vendor": true, "customer": true, "gstin": "30AABCU9603R1Z0", "bank": { "accountId": "5319f07d-9d65-4253-9666-770cc8e11fe1", "ifsc": "ICIC0006784", "account": "1234567890123456", "name": "tfyhj", "email": "asdfghnm@sdfgh.dsfgh", "bankName": "ICICI Bank", "branchName": "JAIPUR, STXAVIER SCHOOL", "customTags": {}, "bankAndVendorNameMatch": true, "forms": {}, "valid": false, "validSyncedAt": 1749820234200 }, "data": [ { "key": "CUSTOMADDRESS", "id": "test pr line item", "value": "new", "encrypt": false } ], "pan": "AABCU9603R", "vendorId": "CONTACT-KARANDEVENV-0000068", "connection": "", "validPan": false, "validAccount": false, "validGst": false, "address": { "id": "6c0be4d8-458e-4f9d-acd0-af764e1acb5f", "title": "No.CL 1 and 2 Suvidha Complex", "address": "No.CL 1 and 2 Suvidha Complex", "city": "Vasco da Gama", "state": "Goa", "country": "INDIA", "pincode": "403802", "gstin": "30AABCU9603R1Z0", "gstinValid": false, "panValid": false, "businessAddress": false, "attrs": { "test pr line item": "new" }, "forms": [], "locationId": "", "filterKey": "", "bankIds": [] }, "msme": { "msmeId": "", "certificate": "" }, "paymentTerms": {}, "createdAt": 1730809191802, "updatedAt": 1730890423845, "basicOnboarding": false }, { "id": 239205, "title": "UJJIVAN SMALL FINANCE BANK LIMITED", "tradeName": "UJJIVAN SMALL FINANCE BANK LIMITED", "currency": "INR", "code": "CONTACT-KARANDEVENV-0000069", "email": "karan.kumar@antrepriz.com", "mobile": "1234567890", "vendor": true, "customer": true, "gstin": "24AABCU9603R1ZT", "bank": { "accountId": "91af1c67-c2a0-4436-b36d-d790be0bad98", "ifsc": "ICIC0006784", "account": "678401503700", "name": "RAVIN .", "email": "karan.kumar@antrepriz.com", "bankName": "ICICI Bank", "branchName": "JAIPUR, STXAVIER SCHOOL", "customTags": {}, "bankAndVendorNameMatch": true, "forms": {}, "valid": false, "validSyncedAt": 1749820234200 }, "data": [], "pan": "AABCU9603R", "vendorId": "CONTACT-KARANDEVENV-0000069", "connection": "", "validPan": false, "validAccount": false, "validGst": false, "address": { "id": "e35f5af9-d914-4915-9419-af4706668d31", "title": "UG1-6, Shrinath Complex,, 4428-UDHANA, Opp. Dream Honda Showroom, Udhana Main Road, Udhana, Surat, Surat, Gujarat, 394210", "address": "UG1-6, Shrinath Complex,, 4428-UDHANA, Opp. Dream Honda Showroom, Udhana Main Road, Udhana, Surat, Surat, Gujarat, 394210", "city": "Surat", "state": "Gujarat", "country": "India", "pincode": "394210", "gstin": "24AABCU9603R1ZT", "gstinValid": false, "panValid": false, "businessAddress": false, "attrs": {}, "forms": [], "locationId": "", "filterKey": "", "bankIds": [] }, "msme": { "msmeId": "", "certificate": "" }, "paymentTerms": {}, "createdAt": 1730955605899, "updatedAt": 1730965146347, "basicOnboarding": true }, { "id": 239206, "title": " UJJIVAN SMALL FINANCE BANK LIMITED", "tradeName": " UJJIVAN SMALL FINANCE BANK LIMITED", "currency": "INR", "code": "CONTACT-KARANDEVENV-0000070", "email": "ewrfgh@asdfg.in", "mobile": "1223456789", "vendor": true, "customer": true, "gstin": "24AABCU9603R1ZT", "bank": { "accountId": "9a06d832-a6ef-4333-b850-368dad3d49b7", "ifsc": "ICIC0006784", "account": "678401503700", "name": "RAVIN .", "email": "ewrfgh@asdfg.in", "bankName": "ICICI Bank", "branchName": "JAIPUR, STXAVIER SCHOOL", "customTags": {}, "bankAndVendorNameMatch": true, "forms": {}, "valid": false, "validSyncedAt": 1749820234207 }, "data": [], "pan": "AABCU9603R", "vendorId": "CONTACT-KARANDEVENV-0000070", "connection": "", "validPan": false, "validAccount": false, "validGst": false, "address": { "id": "03202864-2d9a-4104-b4ec-ae391fd1d11d", "title": "Shop No. 17 18 4465-Nava Vadaj Branch", "address": "Shop No. 17 18 4465-Nava Vadaj Branch", "city": "Ahmedabad", "state": "Gujarat", "country": "India", "pincode": "382480", "gstin": "24AABCU9603R1ZT", "gstinValid": false, "panValid": false, "businessAddress": false, "attrs": {}, "forms": [], "locationId": "", "filterKey": "", "bankIds": [] }, "msme": { "msmeId": "", "certificate": "" }, "paymentTerms": {}, "createdAt": 1730955732617, "updatedAt": 1730955732875, "basicOnboarding": true }, { "id": 239208, "title": "UJJIVAN SMALL FINANCE BANK LIMITED", "tradeName": "UJJIVAN SMALL FINANCE BANK LIMITED", "currency": "INR", "code": "CONTACT-KARANDEVENV-0000072", "email": "karan.kumar@antrepriz.com", "mobile": "9694961891", "vendor": true, "customer": true, "gstin": "24AABCU9603R1ZT", "bank": { "accountId": "e4e5b13b-691f-4d77-8a7a-841753186fdd", "ifsc": "ICIC0006784", "account": "678401503700", "name": "RAVIN .", "email": "karan.kumar@antrepriz.com", "bankName": "ICICI Bank", "branchName": "JAIPUR, STXAVIER SCHOOL", "customTags": {}, "bankAndVendorNameMatch": true, "forms": {}, "valid": true, "validSyncedAt": 1749820234208 }, "data": [], "pan": "AABCU9603R", "vendorId": "CONTACT-KARANDEVENV-0000072", "connection": "", "validPan": false, "validAccount": true, "validGst": false, "address": { "id": "1b55def1-29cc-417e-ac8b-9fa00e8cea3b", "title": "Shop No. 17 18 4465-Nava Vadaj Branch", "address": "Shop No. 17 18 4465-Nava Vadaj Branch", "city": "Ahmedabad", "state": "Gujarat", "country": "India", "pincode": "382476", "gstin": "24AABCU9603R1ZT", "gstinValid": false, "panValid": false, "businessAddress": false, "attrs": {}, "forms": [], "locationId": "", "filterKey": "", "bankIds": [] }, "msme": { "msmeId": "NA", "certificate": "NA" }, "paymentTerms": {}, "createdAt": 1730960263892, "updatedAt": 1730962464487, "basicOnboarding": true }, { "id": 239209, "title": "Ujjivan Small Finance Bank Limited", "tradeName": "Ujjivan Small Finance Bank Limited", "currency": "INR", "code": "CONTACT-KARANDEVENV-0000073", "email": "karan.kumar@antrepriz.com", "mobile": "9694961891", "vendor": true, "customer": true, "gstin": "32AABCU9603R1ZW", "bank": { "accountId": "c8b41a64-c661-4690-92bf-3317609aa521", "ifsc": "ICIC0006784", "account": "1234567890123456I", "name": "tfgybhjnkm", "email": "karan.kumar@antrepriz.com", "bankName": "ICICI Bank", "branchName": "JAIPUR, STXAVIER SCHOOL", "customTags": {}, "bankAndVendorNameMatch": true, "forms": {}, "valid": false, "validSyncedAt": 1735279630988 }, "data": [], "pan": "EAQPB9098R", "vendorId": "CONTACT-KARANDEVENV-0000073", "connection": "", "validPan": false, "validAccount": false, "validGst": false, "address": { "id": "3d4d01ec-ce69-4491-86d0-66c2d5033c0b", "title": "No. 67/2926 1 Ernakulum - North 1193", "address": "No. 67/2926 1 Ernakulum - North 1193", "city": "ERNAKULAM", "state": "KERALA", "country": "India", "pincode": "682018", "gstin": "32AABCU9603R1ZW", "gstinValid": false, "panValid": false, "businessAddress": false, "attrs": {}, "forms": [], "locationId": "", "filterKey": "", "bankIds": [] }, "msme": { "msmeId": "NA", "certificate": "NA" }, "paymentTerms": {}, "createdAt": 1730961167035, "updatedAt": 1735534118181, "basicOnboarding": true }, { "id": 239210, "title": "UJJIVAN SMALL FINANCE BANK LIMITED", "tradeName": "UJJIVAN SMALL FINANCE BANK LIMITED", "currency": "INR", "code": "CONTACT-KARANDEVENV-0000074", "email": "karan.kumar@antrepriz.com", "mobile": "9694961891", "vendor": true, "customer": true, "gstin": "24AABCU9603R1ZT", "bank": { "accountId": "8cc3ba68-986d-4a00-81aa-93080265eef5", "ifsc": "ICIC0006784", "account": "678401503700", "name": "RAVIN .", "email": "karan.kumar@antrepriz.com", "bankName": "ICICI Bank", "branchName": "JAIPUR, STXAVIER SCHOOL", "customTags": {}, "bankAndVendorNameMatch": true, "forms": {}, "valid": true, "validSyncedAt": 1749820234208 }, "data": [], "pan": "AABCU9603R", "vendorId": "CONTACT-KARANDEVENV-0000074", "connection": "", "validPan": false, "validAccount": true, "validGst": false, "address": { "id": "6b5bb494-0a76-4f48-a243-f7f3fb0ab46d", "title": "Shop No. 17 18 4465-Nava Vadaj Branch", "address": "Shop No. 17 18 4465-Nava Vadaj Branch", "city": "Ahmedabad", "state": "Gujarat", "country": "India", "pincode": "382480", "gstin": "24AABCU9603R1ZT", "gstinValid": false, "panValid": false, "businessAddress": false, "attrs": {}, "forms": [], "locationId": "", "filterKey": "", "bankIds": [] }, "msme": { "msmeId": "NA", "certificate": "NA" }, "paymentTerms": {}, "createdAt": 1730965775308, "updatedAt": 1730965775911, "basicOnboarding": true }, { "id": 239211, "title": "UJJIVAN SMALL FINANCE BANK LIMITED", "tradeName": "UJJIVAN SMALL FINANCE BANK LIMITED", "currency": "INR", "code": "CONTACT-KARANDEVENV-0000075", "email": "karan.kumar@antrepriz.com", "mobile": "9694961891", "vendor": true, "customer": true, "gstin": "06AABCU9603R1ZR", "bank": { "accountId": "4e194f4e-33af-4213-a085-c08f058ffa09", "ifsc": "ICIC0006784", "account": "1234567890123456", "name": "rtyjkm", "email": "karan.kumar@antrepriz.com", "bankName": "ICICI Bank", "branchName": "JAIPUR, STXAVIER SCHOOL", "customTags": {}, "bankAndVendorNameMatch": true, "forms": {}, "valid": false, "validSyncedAt": 1749820234208 }, "data": [], "pan": "AABCU9603R", "vendorId": "CONTACT-KARANDEVENV-0000075", "connection": "", "validPan": false, "validAccount": false, "validGst": false, "address": { "id": "f17114bd-d5a2-498b-a32e-2d7a70581c92", "title": "Plot No.128, 2267 SIRSA", "address": "Plot No.128, 2267 SIRSA", "city": "Sirsa", "state": "Haryana", "country": "India", "pincode": "125055", "gstin": "06AABCU9603R1ZR", "gstinValid": false, "panValid": false, "businessAddress": false, "attrs": {}, "forms": [], "locationId": "", "filterKey": "", "bankIds": [] }, "msme": { "msmeId": "NA", "certificate": "NA" }, "paymentTerms": {}, "createdAt": 1730965915147, "updatedAt": 1730965915495, "basicOnboarding": true }, { "id": 239213, "title": "Ujjivan Small Finance Bank Limited", "tradeName": "Ujjivan Small Finance Bank Limited", "currency": "INR", "code": "CONTACT-KARANDEVENV-0000077", "email": "karan.kumar@antrepriz.com", "mobile": "9694961891", "vendor": true, "customer": true, "gstin": "32AABCU9603R1ZW", "bank": { "accountId": "b117f4bc-1354-4dcc-b855-9445e4f7daf0", "ifsc": "ICIC0006784", "account": "1234567890123456", "name": "tfgybhjnk", "email": "karan.kumar@antrepriz.com", "bankName": "ICICI Bank", "branchName": "JAIPUR, STXAVIER SCHOOL", "customTags": {}, "bankAndVendorNameMatch": true, "forms": {}, "valid": false, "validSyncedAt": 1749820234208 }, "data": [], "pan": "AABCU9603R", "vendorId": "CONTACT-KARANDEVENV-0000077", "connection": "", "validPan": false, "validAccount": false, "validGst": false, "address": { "id": "98066ccc-be93-4d14-9a90-29fc741a3e7e", "title": "No. 67/2926 1 Ernakulum - North 1193", "address": "No. 67/2926 1 Ernakulum - North 1193", "city": "ERNAKULAM", "state": "KERALA", "country": "INDIA", "pincode": "682018", "gstin": "32AABCU9603R1ZW", "gstinValid": false, "panValid": false, "businessAddress": false, "attrs": { "test3": "last try", "test pr line item": "edit" }, "forms": [], "locationId": "", "filterKey": "", "bankIds": [] }, "msme": { "msmeId": "NA", "certificate": "NA" }, "paymentTerms": {}, "createdAt": 1730971861046, "updatedAt": 1730971965672, "basicOnboarding": true }, { "id": 239215, "title": "Ujjivan Small Finance Bank Limited", "tradeName": "Ujjivan Small Finance Bank Limited", "currency": "INR", "code": "CONTACT-KARANDEVENV-0000079", "email": "karan.kumar@antrepriz.com", "mobile": "9694961891", "vendor": true, "customer": true, "gstin": "32AABCU9603R1ZW", "bank": { "accountId": "b117f4bc-1354-4dcc-b855-9445e4f7daf0", "ifsc": "ICIC0006784", "account": "1234567890123456", "name": "tfgybhjnk", "email": "karan.kumar@antrepriz.com", "bankName": "ICICI Bank", "branchName": "JAIPUR, STXAVIER SCHOOL", "customTags": {}, "bankAndVendorNameMatch": true, "forms": {}, "valid": false, "validSyncedAt": 1734926012395 }, "data": [], "pan": "AABCU9603R", "vendorId": "CONTACT-KARANDEVENV-0000079", "connection": "", "validPan": false, "validAccount": false, "validGst": false, "address": { "id": "98066ccc-be93-4d14-9a90-29fc741a3e7e", "title": "No. 67/2926 1 Ernakulum - North 1193", "address": "No. 67/2926 1 Ernakulum - North 1193", "city": "ERNAKULAM", "state": "KERALA", "country": "India", "pincode": "682018", "gstin": "32AABCU9603R1ZW", "gstinValid": false, "panValid": false, "businessAddress": false, "attrs": {}, "forms": [], "locationId": "", "filterKey": "", "bankIds": [] }, "msme": { "msmeId": "NA", "certificate": "NA" }, "paymentTerms": {}, "createdAt": 1730982553692, "updatedAt": 1745233728402, "basicOnboarding": true } ], "total": 0, "currentPage": 0, "totalPages": 0 } ```