GET api/v2/vendors/search

Search vendors based on query parameters

Request Information

URI Parameters

Name	Type	Additional information
FederalTaxId	string	None.
IsFederalTaxIdExactMatch	boolean	None.
Vendor	string	None.
Type	integer	None.
Active	boolean	None.
Inactive	boolean	None.
ServiceType	integer	None.
IsEntityLinked	boolean	None.
LinkedEntitySuperEntityId	integer	None.
Address	AddressViewModel	None.
PageSize	integer	None.
PageNumber	integer	None.
SortInformation	SortInformationViewModel	Required

Body Parameters

None.

Response Information

Resource Description

VendorInquiryResultViewModel

Name	Description	Type	Additional information
Items		Collection of VendorInquiryResultItemViewModel	None.
TotalCount		integer	None.

Response Formats

application/json, text/json

Sample:

{
  "items": [
    {
      "id": 1,
      "vendorId": 2,
      "vendorDisplayName": "sample string 3",
      "address": "sample string 4",
      "type": "sample string 5",
      "federalTaxID": "sample string 6",
      "status": "sample string 7",
      "vendorLegalName": "sample string 8",
      "vendorService": "sample string 9"
    },
    {
      "id": 1,
      "vendorId": 2,
      "vendorDisplayName": "sample string 3",
      "address": "sample string 4",
      "type": "sample string 5",
      "federalTaxID": "sample string 6",
      "status": "sample string 7",
      "vendorLegalName": "sample string 8",
      "vendorService": "sample string 9"
    }
  ],
  "totalCount": 1
}

application/xml, text/xml

Sample:

<VendorInquiryResultViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Vendor">
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Vendor" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
    <d2p1:VendorInquiryResultItemViewModel>
      <d2p1:Address>sample string 4</d2p1:Address>
      <d2p1:FederalTaxID>sample string 6</d2p1:FederalTaxID>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Status>sample string 7</d2p1:Status>
      <d2p1:Type>sample string 5</d2p1:Type>
      <d2p1:VendorDisplayName>sample string 3</d2p1:VendorDisplayName>
      <d2p1:VendorId>2</d2p1:VendorId>
      <d2p1:VendorLegalName>sample string 8</d2p1:VendorLegalName>
      <d2p1:VendorService>sample string 9</d2p1:VendorService>
    </d2p1:VendorInquiryResultItemViewModel>
    <d2p1:VendorInquiryResultItemViewModel>
      <d2p1:Address>sample string 4</d2p1:Address>
      <d2p1:FederalTaxID>sample string 6</d2p1:FederalTaxID>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Status>sample string 7</d2p1:Status>
      <d2p1:Type>sample string 5</d2p1:Type>
      <d2p1:VendorDisplayName>sample string 3</d2p1:VendorDisplayName>
      <d2p1:VendorId>2</d2p1:VendorId>
      <d2p1:VendorLegalName>sample string 8</d2p1:VendorLegalName>
      <d2p1:VendorService>sample string 9</d2p1:VendorService>
    </d2p1:VendorInquiryResultItemViewModel>
  </Items>
  <TotalCount xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">1</TotalCount>
</VendorInquiryResultViewModel>