GET api/entities/{entityId}/vendors?activeOnly={activeOnly}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
entityId |
|
integer |
Required |
activeOnly |
|
boolean |
Default value is True |
Body Parameters
None.
Response Information
Resource Description
VendorViewModelName | Description | Type | Additional information |
---|---|---|---|
Id |
Vendor Id |
integer |
None. |
Name |
Name |
string |
None. |
Phone |
Phone Number |
string |
None. |
FaxNumber |
Fax Number |
string |
None. |
Contact |
Contact Name |
string |
None. |
|
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
{ "id": 1, "name": "sample string 2", "phone": "sample string 3", "faxNumber": "sample string 4", "contact": "sample string 5", "email": "sample string 6", "legalName": "sample string 7", "isActive": true, "vendorCode": "sample string 9", "isSeparateChecks": true, "isAllowDuplicateInvoices": true, "typeDescription": "sample string 12", "vendorServiceId": 1, "is1099": true, "hasMetersAssigned": true, "vendorTypeId": 15, "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
<VendorViewModel 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 5</Contact> <Email>sample string 6</Email> <FaxNumber>sample string 4</FaxNumber> <HasMetersAssigned>true</HasMetersAssigned> <Id>1</Id> <Is1099>true</Is1099> <IsActive>true</IsActive> <IsAllowDuplicateInvoices>true</IsAllowDuplicateInvoices> <IsSeparateChecks>true</IsSeparateChecks> <LegalName>sample string 7</LegalName> <Name>sample string 2</Name> <Phone>sample string 3</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 12</TypeDescription> <VendorCode>sample string 9</VendorCode> <VendorServiceId>1</VendorServiceId> <VendorTypeId>15</VendorTypeId> </VendorViewModel>