GET api/vendors/{id}

Get Vendor by id

Request Information

URI Parameters

Name	Description	Type	Additional information
id	VendorId	integer	Required

Body Parameters

None.

Response Information

Resource Description

Vendor

VendorDetailViewModel

Name	Description	Type	Additional information
FederalTaxId	Federal Tax Id	string	None.
Irs1099ClassId	Irs 1099 Class Id	integer	None.
IsDirectCredit	Is direct credit	boolean	None.
IsPartner	Is partner	boolean	None.
IsInsuranceRequired	Is insurance required	boolean	None.
GlExpenseAccount	GL Expense Account	string	None.
GlSubAccountId	Gl sub account id	integer	None.
ComplianceInsurances		Collection of ComplianceInsuranceViewModel	None.
VendorCompliances		Collection of VendorComplianceDetailViewModel	None.
Id	Vendor Id	integer	None.
Name	Name	string	None.
Phone	Phone Number	string	None.
FaxNumber	Fax Number	string	None.
Contact	Contact Name	string	None.
Email	Email	string	None.
LegalName	Legal Name	string	None.
IsActive	Is Active	boolean	None.
VendorCode	Vendor Code	string	None.
IsSeparateChecks	Is Separate Checks	boolean	None.
IsAllowDuplicateInvoices	Allowes duplicate invoices	boolean	None.
TypeDescription	Description of the vendor's type.	string	None.
VendorServiceId	Vendor service id	integer	None.
Is1099	Is 1099	boolean	None.
HasMetersAssigned	Flag to show if vendor has utility meters assigned	boolean	None.
VendorTypeId	Vendor type	integer	None.
Address	Address	AddressViewModel	None.
PhysicalAddress	Physical Address	AddressBaseViewModel	None.
PhysicalAddressSameAsMailingAddress	Physical Address Same As Mailing Address	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "federalTaxId": "sample string 1",
  "irs1099ClassId": 1,
  "isDirectCredit": true,
  "isPartner": true,
  "isInsuranceRequired": true,
  "glExpenseAccount": "sample string 5",
  "glSubAccountId": 1,
  "complianceInsurances": [
    {
      "insuranceTypeId": 1,
      "expirationDate": "2025-04-03T18:10:45.2900311-04:00",
      "complianceInsuranceId": 3,
      "insuranceTypeName": "sample string 4"
    },
    {
      "insuranceTypeId": 1,
      "expirationDate": "2025-04-03T18:10:45.2900311-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": "2025-04-03T18:10:45.2900311-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": "2025-04-03T18:10:45.2900311-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
}

application/xml, text/xml

Sample:

<VendorDetailViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <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:d2p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">
    <d2p1:Address1>sample string 1</d2p1:Address1>
    <d2p1:Address2>sample string 2</d2p1:Address2>
    <d2p1:City>sample string 3</d2p1:City>
    <d2p1:Country>sample string 6</d2p1:Country>
    <d2p1:State>sample string 4</d2p1:State>
    <d2p1:ZipCode>sample string 5</d2p1: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>2025-04-03T18:10:45.2900311-04:00</ExpirationDate>
      <InsuranceTypeId>1</InsuranceTypeId>
      <InsuranceTypeName>sample string 4</InsuranceTypeName>
    </ComplianceInsuranceViewModel>
    <ComplianceInsuranceViewModel>
      <ComplianceInsuranceId>3</ComplianceInsuranceId>
      <ExpirationDate>2025-04-03T18:10:45.2900311-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>2025-04-03T18:10:45.2900311-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>2025-04-03T18:10:45.2900311-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>