GET api/Vendors

Get vendors based on search parameters

Request Information

URI Parameters

Name	Type	Additional information
FederalTaxId	string	Required
PageSize	integer	None.
PageNumber	integer	None.
SortInformation	SortInformationViewModel	Required

Body Parameters

None.

Response Information

Resource Description

VendorSearchResultViewModel

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

Response Formats

application/json, text/json

Sample:

{
  "items": [
    {
      "federalTaxId": "sample string 1",
      "irs1099ClassId": 1,
      "isDirectCredit": true,
      "isPartner": true,
      "isInsuranceRequired": true,
      "glExpenseAccount": "sample string 5",
      "glSubAccountId": 1,
      "complianceInsurances": [
        {
          "insuranceTypeId": 1,
          "expirationDate": "2024-10-14T08:18:34.5660112-04:00",
          "complianceInsuranceId": 3,
          "insuranceTypeName": "sample string 4"
        },
        {
          "insuranceTypeId": 1,
          "expirationDate": "2024-10-14T08:18:34.5660112-04:00",
          "complianceInsuranceId": 3,
          "insuranceTypeName": "sample string 4"
        }
      ],
      "vendorCompliances": [
        {
          "countryName": "sample string 1",
          "stateName": "sample string 2",
          "workflowStatus": "sample string 3",
          "complianceType": "sample string 4",
          "complianceStatus": "sample string 5",
          "vendorComplianceId": 6,
          "vendorId": 7,
          "complianceDate": "2024-10-14T08:18:34.5660112-04:00",
          "workflowStatusId": 1,
          "complianceTypeId": 1,
          "allowWorkOrders": true,
          "complianceStatusId": 10,
          "stateCode": "sample string 11",
          "countryCode": "sample string 12"
        },
        {
          "countryName": "sample string 1",
          "stateName": "sample string 2",
          "workflowStatus": "sample string 3",
          "complianceType": "sample string 4",
          "complianceStatus": "sample string 5",
          "vendorComplianceId": 6,
          "vendorId": 7,
          "complianceDate": "2024-10-14T08:18:34.5660112-04:00",
          "workflowStatusId": 1,
          "complianceTypeId": 1,
          "allowWorkOrders": true,
          "complianceStatusId": 10,
          "stateCode": "sample string 11",
          "countryCode": "sample string 12"
        }
      ],
      "id": 6,
      "name": "sample string 7",
      "phone": "sample string 8",
      "faxNumber": "sample string 9",
      "contact": "sample string 10",
      "email": "sample string 11",
      "legalName": "sample string 12",
      "isActive": true,
      "vendorCode": "sample string 14",
      "isSeparateChecks": true,
      "isAllowDuplicateInvoices": true,
      "typeDescription": "sample string 17",
      "vendorServiceId": 1,
      "is1099": true,
      "hasMetersAssigned": true,
      "vendorTypeId": 20,
      "address": {
        "addressId": 1,
        "address1": "sample string 2",
        "address2": "sample string 3",
        "city": "sample string 4",
        "state": "sample string 5",
        "zipCode": "sample string 6",
        "country": "sample string 7"
      },
      "physicalAddress": {
        "address1": "sample string 1",
        "address2": "sample string 2",
        "city": "sample string 3",
        "state": "sample string 4",
        "zipCode": "sample string 5",
        "country": "sample string 6"
      },
      "physicalAddressSameAsMailingAddress": true
    },
    {
      "federalTaxId": "sample string 1",
      "irs1099ClassId": 1,
      "isDirectCredit": true,
      "isPartner": true,
      "isInsuranceRequired": true,
      "glExpenseAccount": "sample string 5",
      "glSubAccountId": 1,
      "complianceInsurances": [
        {
          "insuranceTypeId": 1,
          "expirationDate": "2024-10-14T08:18:34.5660112-04:00",
          "complianceInsuranceId": 3,
          "insuranceTypeName": "sample string 4"
        },
        {
          "insuranceTypeId": 1,
          "expirationDate": "2024-10-14T08:18:34.5660112-04:00",
          "complianceInsuranceId": 3,
          "insuranceTypeName": "sample string 4"
        }
      ],
      "vendorCompliances": [
        {
          "countryName": "sample string 1",
          "stateName": "sample string 2",
          "workflowStatus": "sample string 3",
          "complianceType": "sample string 4",
          "complianceStatus": "sample string 5",
          "vendorComplianceId": 6,
          "vendorId": 7,
          "complianceDate": "2024-10-14T08:18:34.5660112-04:00",
          "workflowStatusId": 1,
          "complianceTypeId": 1,
          "allowWorkOrders": true,
          "complianceStatusId": 10,
          "stateCode": "sample string 11",
          "countryCode": "sample string 12"
        },
        {
          "countryName": "sample string 1",
          "stateName": "sample string 2",
          "workflowStatus": "sample string 3",
          "complianceType": "sample string 4",
          "complianceStatus": "sample string 5",
          "vendorComplianceId": 6,
          "vendorId": 7,
          "complianceDate": "2024-10-14T08:18:34.5660112-04:00",
          "workflowStatusId": 1,
          "complianceTypeId": 1,
          "allowWorkOrders": true,
          "complianceStatusId": 10,
          "stateCode": "sample string 11",
          "countryCode": "sample string 12"
        }
      ],
      "id": 6,
      "name": "sample string 7",
      "phone": "sample string 8",
      "faxNumber": "sample string 9",
      "contact": "sample string 10",
      "email": "sample string 11",
      "legalName": "sample string 12",
      "isActive": true,
      "vendorCode": "sample string 14",
      "isSeparateChecks": true,
      "isAllowDuplicateInvoices": true,
      "typeDescription": "sample string 17",
      "vendorServiceId": 1,
      "is1099": true,
      "hasMetersAssigned": true,
      "vendorTypeId": 20,
      "address": {
        "addressId": 1,
        "address1": "sample string 2",
        "address2": "sample string 3",
        "city": "sample string 4",
        "state": "sample string 5",
        "zipCode": "sample string 6",
        "country": "sample string 7"
      },
      "physicalAddress": {
        "address1": "sample string 1",
        "address2": "sample string 2",
        "city": "sample string 3",
        "state": "sample string 4",
        "zipCode": "sample string 5",
        "country": "sample string 6"
      },
      "physicalAddressSameAsMailingAddress": true
    }
  ],
  "totalCount": 1
}

application/xml, text/xml

Sample:

<VendorSearchResultViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Vendor">
  <Items xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
    <VendorDetailViewModel>
      <Address>
        <Address1 xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 2</Address1>
        <Address2 xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 3</Address2>
        <City xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 4</City>
        <Country xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 7</Country>
        <State xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 5</State>
        <ZipCode xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 6</ZipCode>
        <AddressId>1</AddressId>
      </Address>
      <Contact>sample string 10</Contact>
      <Email>sample string 11</Email>
      <FaxNumber>sample string 9</FaxNumber>
      <HasMetersAssigned>true</HasMetersAssigned>
      <Id>6</Id>
      <Is1099>true</Is1099>
      <IsActive>true</IsActive>
      <IsAllowDuplicateInvoices>true</IsAllowDuplicateInvoices>
      <IsSeparateChecks>true</IsSeparateChecks>
      <LegalName>sample string 12</LegalName>
      <Name>sample string 7</Name>
      <Phone>sample string 8</Phone>
      <PhysicalAddress xmlns:d4p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">
        <d4p1:Address1>sample string 1</d4p1:Address1>
        <d4p1:Address2>sample string 2</d4p1:Address2>
        <d4p1:City>sample string 3</d4p1:City>
        <d4p1:Country>sample string 6</d4p1:Country>
        <d4p1:State>sample string 4</d4p1:State>
        <d4p1:ZipCode>sample string 5</d4p1:ZipCode>
      </PhysicalAddress>
      <PhysicalAddressSameAsMailingAddress>true</PhysicalAddressSameAsMailingAddress>
      <TypeDescription>sample string 17</TypeDescription>
      <VendorCode>sample string 14</VendorCode>
      <VendorServiceId>1</VendorServiceId>
      <VendorTypeId>20</VendorTypeId>
      <ComplianceInsurances>
        <ComplianceInsuranceViewModel>
          <ComplianceInsuranceId>3</ComplianceInsuranceId>
          <ExpirationDate>2024-10-14T08:18:34.5660112-04:00</ExpirationDate>
          <InsuranceTypeId>1</InsuranceTypeId>
          <InsuranceTypeName>sample string 4</InsuranceTypeName>
        </ComplianceInsuranceViewModel>
        <ComplianceInsuranceViewModel>
          <ComplianceInsuranceId>3</ComplianceInsuranceId>
          <ExpirationDate>2024-10-14T08:18:34.5660112-04:00</ExpirationDate>
          <InsuranceTypeId>1</InsuranceTypeId>
          <InsuranceTypeName>sample string 4</InsuranceTypeName>
        </ComplianceInsuranceViewModel>
      </ComplianceInsurances>
      <FederalTaxId>sample string 1</FederalTaxId>
      <GlExpenseAccount>sample string 5</GlExpenseAccount>
      <GlSubAccountId>1</GlSubAccountId>
      <Irs1099ClassId>1</Irs1099ClassId>
      <IsDirectCredit>true</IsDirectCredit>
      <IsInsuranceRequired>true</IsInsuranceRequired>
      <IsPartner>true</IsPartner>
      <VendorCompliances>
        <VendorComplianceDetailViewModel>
          <AllowWorkOrders>true</AllowWorkOrders>
          <ComplianceStatusId>10</ComplianceStatusId>
          <ComplianceTypeId>1</ComplianceTypeId>
          <CountryCode>sample string 12</CountryCode>
          <StateCode>sample string 11</StateCode>
          <WorkflowStatusId>1</WorkflowStatusId>
          <ComplianceDate>2024-10-14T08:18:34.5660112-04:00</ComplianceDate>
          <VendorComplianceId>6</VendorComplianceId>
          <VendorId>7</VendorId>
          <ComplianceStatus>sample string 5</ComplianceStatus>
          <ComplianceType>sample string 4</ComplianceType>
          <CountryName>sample string 1</CountryName>
          <StateName>sample string 2</StateName>
          <WorkflowStatus>sample string 3</WorkflowStatus>
        </VendorComplianceDetailViewModel>
        <VendorComplianceDetailViewModel>
          <AllowWorkOrders>true</AllowWorkOrders>
          <ComplianceStatusId>10</ComplianceStatusId>
          <ComplianceTypeId>1</ComplianceTypeId>
          <CountryCode>sample string 12</CountryCode>
          <StateCode>sample string 11</StateCode>
          <WorkflowStatusId>1</WorkflowStatusId>
          <ComplianceDate>2024-10-14T08:18:34.5660112-04:00</ComplianceDate>
          <VendorComplianceId>6</VendorComplianceId>
          <VendorId>7</VendorId>
          <ComplianceStatus>sample string 5</ComplianceStatus>
          <ComplianceType>sample string 4</ComplianceType>
          <CountryName>sample string 1</CountryName>
          <StateName>sample string 2</StateName>
          <WorkflowStatus>sample string 3</WorkflowStatus>
        </VendorComplianceDetailViewModel>
      </VendorCompliances>
    </VendorDetailViewModel>
    <VendorDetailViewModel>
      <Address>
        <Address1 xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 2</Address1>
        <Address2 xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 3</Address2>
        <City xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 4</City>
        <Country xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 7</Country>
        <State xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 5</State>
        <ZipCode xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 6</ZipCode>
        <AddressId>1</AddressId>
      </Address>
      <Contact>sample string 10</Contact>
      <Email>sample string 11</Email>
      <FaxNumber>sample string 9</FaxNumber>
      <HasMetersAssigned>true</HasMetersAssigned>
      <Id>6</Id>
      <Is1099>true</Is1099>
      <IsActive>true</IsActive>
      <IsAllowDuplicateInvoices>true</IsAllowDuplicateInvoices>
      <IsSeparateChecks>true</IsSeparateChecks>
      <LegalName>sample string 12</LegalName>
      <Name>sample string 7</Name>
      <Phone>sample string 8</Phone>
      <PhysicalAddress xmlns:d4p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">
        <d4p1:Address1>sample string 1</d4p1:Address1>
        <d4p1:Address2>sample string 2</d4p1:Address2>
        <d4p1:City>sample string 3</d4p1:City>
        <d4p1:Country>sample string 6</d4p1:Country>
        <d4p1:State>sample string 4</d4p1:State>
        <d4p1:ZipCode>sample string 5</d4p1:ZipCode>
      </PhysicalAddress>
      <PhysicalAddressSameAsMailingAddress>true</PhysicalAddressSameAsMailingAddress>
      <TypeDescription>sample string 17</TypeDescription>
      <VendorCode>sample string 14</VendorCode>
      <VendorServiceId>1</VendorServiceId>
      <VendorTypeId>20</VendorTypeId>
      <ComplianceInsurances>
        <ComplianceInsuranceViewModel>
          <ComplianceInsuranceId>3</ComplianceInsuranceId>
          <ExpirationDate>2024-10-14T08:18:34.5660112-04:00</ExpirationDate>
          <InsuranceTypeId>1</InsuranceTypeId>
          <InsuranceTypeName>sample string 4</InsuranceTypeName>
        </ComplianceInsuranceViewModel>
        <ComplianceInsuranceViewModel>
          <ComplianceInsuranceId>3</ComplianceInsuranceId>
          <ExpirationDate>2024-10-14T08:18:34.5660112-04:00</ExpirationDate>
          <InsuranceTypeId>1</InsuranceTypeId>
          <InsuranceTypeName>sample string 4</InsuranceTypeName>
        </ComplianceInsuranceViewModel>
      </ComplianceInsurances>
      <FederalTaxId>sample string 1</FederalTaxId>
      <GlExpenseAccount>sample string 5</GlExpenseAccount>
      <GlSubAccountId>1</GlSubAccountId>
      <Irs1099ClassId>1</Irs1099ClassId>
      <IsDirectCredit>true</IsDirectCredit>
      <IsInsuranceRequired>true</IsInsuranceRequired>
      <IsPartner>true</IsPartner>
      <VendorCompliances>
        <VendorComplianceDetailViewModel>
          <AllowWorkOrders>true</AllowWorkOrders>
          <ComplianceStatusId>10</ComplianceStatusId>
          <ComplianceTypeId>1</ComplianceTypeId>
          <CountryCode>sample string 12</CountryCode>
          <StateCode>sample string 11</StateCode>
          <WorkflowStatusId>1</WorkflowStatusId>
          <ComplianceDate>2024-10-14T08:18:34.5660112-04:00</ComplianceDate>
          <VendorComplianceId>6</VendorComplianceId>
          <VendorId>7</VendorId>
          <ComplianceStatus>sample string 5</ComplianceStatus>
          <ComplianceType>sample string 4</ComplianceType>
          <CountryName>sample string 1</CountryName>
          <StateName>sample string 2</StateName>
          <WorkflowStatus>sample string 3</WorkflowStatus>
        </VendorComplianceDetailViewModel>
        <VendorComplianceDetailViewModel>
          <AllowWorkOrders>true</AllowWorkOrders>
          <ComplianceStatusId>10</ComplianceStatusId>
          <ComplianceTypeId>1</ComplianceTypeId>
          <CountryCode>sample string 12</CountryCode>
          <StateCode>sample string 11</StateCode>
          <WorkflowStatusId>1</WorkflowStatusId>
          <ComplianceDate>2024-10-14T08:18:34.5660112-04:00</ComplianceDate>
          <VendorComplianceId>6</VendorComplianceId>
          <VendorId>7</VendorId>
          <ComplianceStatus>sample string 5</ComplianceStatus>
          <ComplianceType>sample string 4</ComplianceType>
          <CountryName>sample string 1</CountryName>
          <StateName>sample string 2</StateName>
          <WorkflowStatus>sample string 3</WorkflowStatus>
        </VendorComplianceDetailViewModel>
      </VendorCompliances>
    </VendorDetailViewModel>
  </Items>
  <TotalCount xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">1</TotalCount>
</VendorSearchResultViewModel>