DC_Vendor


Click here for a complete list of operations.

GetVendors

Get Vendors List available for the user

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
VendorType:
VendorDescriptionContains:
PayToDefaultContains:
CustomContains:
ShowHiddenVendors:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /Web1243/services/DC_Vendor.asmx HTTP/1.1
Host: rmhs.rmdatacentral.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://restaurantmagic.com/services/GetVendors"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="http://restaurantmagic.com/services">
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
    <AuthenticationKey xmlns="http://restaurantmagic.com/services">
      <IntegrationKey>string</IntegrationKey>
    </AuthenticationKey>
  </soap:Header>
  <soap:Body>
    <GetVendors xmlns="http://restaurantmagic.com/services">
      <VendorType>string</VendorType>
      <VendorDescriptionContains>string</VendorDescriptionContains>
      <PayToDefaultContains>string</PayToDefaultContains>
      <CustomContains>string</CustomContains>
      <ShowHiddenVendors>string</ShowHiddenVendors>
    </GetVendors>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetVendorsResponse xmlns="http://restaurantmagic.com/services">
      <GetVendorsResult>
        <TVendor>
          <ID>string</ID>
          <VendorDescription>string</VendorDescription>
          <VendorType>string</VendorType>
          <Hide>boolean</Hide>
          <PayToDefault>string</PayToDefault>
          <LiabilityAccount>string</LiabilityAccount>
          <CheckAccount>string</CheckAccount>
          <Recommended>boolean</Recommended>
          <EnablePriceControl>boolean</EnablePriceControl>
          <AutoInvoiceNumber>boolean</AutoInvoiceNumber>
          <ProducionKitchenUnit>string</ProducionKitchenUnit>
          <EnableB2B>boolean</EnableB2B>
          <B2BIntegrationDefault>string</B2BIntegrationDefault>
          <B2BVendorGlobalCode>string</B2BVendorGlobalCode>
          <B2BAutoImport>boolean</B2BAutoImport>
          <PermissionRegularInvoice>boolean</PermissionRegularInvoice>
          <PermissionManualCheck>boolean</PermissionManualCheck>
          <PermissionPaidIn>boolean</PermissionPaidIn>
          <PermissionPaidOut>boolean</PermissionPaidOut>
          <PermissionCreditMemo>boolean</PermissionCreditMemo>
          <PermissionPurchaseOrder>boolean</PermissionPurchaseOrder>
          <PermissionAPVoucher>boolean</PermissionAPVoucher>
          <CreditAuthorizationRequired>boolean</CreditAuthorizationRequired>
          <ReturnReasonCodeRequired>boolean</ReturnReasonCodeRequired>
          <ContactName>string</ContactName>
          <ContactWork>string</ContactWork>
          <ContactCell>string</ContactCell>
          <ContactFax>string</ContactFax>
          <ContactEmail>string</ContactEmail>
          <ContactWebSite>string</ContactWebSite>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <AddressCity>string</AddressCity>
          <AddressState>string</AddressState>
          <AddressCountry>string</AddressCountry>
          <AddressZip>string</AddressZip>
          <Custom1>string</Custom1>
          <Custom2>string</Custom2>
          <Custom3>string</Custom3>
          <Lock>boolean</Lock>
        </TVendor>
        <TVendor>
          <ID>string</ID>
          <VendorDescription>string</VendorDescription>
          <VendorType>string</VendorType>
          <Hide>boolean</Hide>
          <PayToDefault>string</PayToDefault>
          <LiabilityAccount>string</LiabilityAccount>
          <CheckAccount>string</CheckAccount>
          <Recommended>boolean</Recommended>
          <EnablePriceControl>boolean</EnablePriceControl>
          <AutoInvoiceNumber>boolean</AutoInvoiceNumber>
          <ProducionKitchenUnit>string</ProducionKitchenUnit>
          <EnableB2B>boolean</EnableB2B>
          <B2BIntegrationDefault>string</B2BIntegrationDefault>
          <B2BVendorGlobalCode>string</B2BVendorGlobalCode>
          <B2BAutoImport>boolean</B2BAutoImport>
          <PermissionRegularInvoice>boolean</PermissionRegularInvoice>
          <PermissionManualCheck>boolean</PermissionManualCheck>
          <PermissionPaidIn>boolean</PermissionPaidIn>
          <PermissionPaidOut>boolean</PermissionPaidOut>
          <PermissionCreditMemo>boolean</PermissionCreditMemo>
          <PermissionPurchaseOrder>boolean</PermissionPurchaseOrder>
          <PermissionAPVoucher>boolean</PermissionAPVoucher>
          <CreditAuthorizationRequired>boolean</CreditAuthorizationRequired>
          <ReturnReasonCodeRequired>boolean</ReturnReasonCodeRequired>
          <ContactName>string</ContactName>
          <ContactWork>string</ContactWork>
          <ContactCell>string</ContactCell>
          <ContactFax>string</ContactFax>
          <ContactEmail>string</ContactEmail>
          <ContactWebSite>string</ContactWebSite>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <AddressCity>string</AddressCity>
          <AddressState>string</AddressState>
          <AddressCountry>string</AddressCountry>
          <AddressZip>string</AddressZip>
          <Custom1>string</Custom1>
          <Custom2>string</Custom2>
          <Custom3>string</Custom3>
          <Lock>boolean</Lock>
        </TVendor>
      </GetVendorsResult>
    </GetVendorsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /Web1243/services/DC_Vendor.asmx HTTP/1.1
Host: rmhs.rmdatacentral.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <AuthenticationHeader xmlns="http://restaurantmagic.com/services">
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
    <AuthenticationKey xmlns="http://restaurantmagic.com/services">
      <IntegrationKey>string</IntegrationKey>
    </AuthenticationKey>
  </soap12:Header>
  <soap12:Body>
    <GetVendors xmlns="http://restaurantmagic.com/services">
      <VendorType>string</VendorType>
      <VendorDescriptionContains>string</VendorDescriptionContains>
      <PayToDefaultContains>string</PayToDefaultContains>
      <CustomContains>string</CustomContains>
      <ShowHiddenVendors>string</ShowHiddenVendors>
    </GetVendors>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetVendorsResponse xmlns="http://restaurantmagic.com/services">
      <GetVendorsResult>
        <TVendor>
          <ID>string</ID>
          <VendorDescription>string</VendorDescription>
          <VendorType>string</VendorType>
          <Hide>boolean</Hide>
          <PayToDefault>string</PayToDefault>
          <LiabilityAccount>string</LiabilityAccount>
          <CheckAccount>string</CheckAccount>
          <Recommended>boolean</Recommended>
          <EnablePriceControl>boolean</EnablePriceControl>
          <AutoInvoiceNumber>boolean</AutoInvoiceNumber>
          <ProducionKitchenUnit>string</ProducionKitchenUnit>
          <EnableB2B>boolean</EnableB2B>
          <B2BIntegrationDefault>string</B2BIntegrationDefault>
          <B2BVendorGlobalCode>string</B2BVendorGlobalCode>
          <B2BAutoImport>boolean</B2BAutoImport>
          <PermissionRegularInvoice>boolean</PermissionRegularInvoice>
          <PermissionManualCheck>boolean</PermissionManualCheck>
          <PermissionPaidIn>boolean</PermissionPaidIn>
          <PermissionPaidOut>boolean</PermissionPaidOut>
          <PermissionCreditMemo>boolean</PermissionCreditMemo>
          <PermissionPurchaseOrder>boolean</PermissionPurchaseOrder>
          <PermissionAPVoucher>boolean</PermissionAPVoucher>
          <CreditAuthorizationRequired>boolean</CreditAuthorizationRequired>
          <ReturnReasonCodeRequired>boolean</ReturnReasonCodeRequired>
          <ContactName>string</ContactName>
          <ContactWork>string</ContactWork>
          <ContactCell>string</ContactCell>
          <ContactFax>string</ContactFax>
          <ContactEmail>string</ContactEmail>
          <ContactWebSite>string</ContactWebSite>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <AddressCity>string</AddressCity>
          <AddressState>string</AddressState>
          <AddressCountry>string</AddressCountry>
          <AddressZip>string</AddressZip>
          <Custom1>string</Custom1>
          <Custom2>string</Custom2>
          <Custom3>string</Custom3>
          <Lock>boolean</Lock>
        </TVendor>
        <TVendor>
          <ID>string</ID>
          <VendorDescription>string</VendorDescription>
          <VendorType>string</VendorType>
          <Hide>boolean</Hide>
          <PayToDefault>string</PayToDefault>
          <LiabilityAccount>string</LiabilityAccount>
          <CheckAccount>string</CheckAccount>
          <Recommended>boolean</Recommended>
          <EnablePriceControl>boolean</EnablePriceControl>
          <AutoInvoiceNumber>boolean</AutoInvoiceNumber>
          <ProducionKitchenUnit>string</ProducionKitchenUnit>
          <EnableB2B>boolean</EnableB2B>
          <B2BIntegrationDefault>string</B2BIntegrationDefault>
          <B2BVendorGlobalCode>string</B2BVendorGlobalCode>
          <B2BAutoImport>boolean</B2BAutoImport>
          <PermissionRegularInvoice>boolean</PermissionRegularInvoice>
          <PermissionManualCheck>boolean</PermissionManualCheck>
          <PermissionPaidIn>boolean</PermissionPaidIn>
          <PermissionPaidOut>boolean</PermissionPaidOut>
          <PermissionCreditMemo>boolean</PermissionCreditMemo>
          <PermissionPurchaseOrder>boolean</PermissionPurchaseOrder>
          <PermissionAPVoucher>boolean</PermissionAPVoucher>
          <CreditAuthorizationRequired>boolean</CreditAuthorizationRequired>
          <ReturnReasonCodeRequired>boolean</ReturnReasonCodeRequired>
          <ContactName>string</ContactName>
          <ContactWork>string</ContactWork>
          <ContactCell>string</ContactCell>
          <ContactFax>string</ContactFax>
          <ContactEmail>string</ContactEmail>
          <ContactWebSite>string</ContactWebSite>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <AddressCity>string</AddressCity>
          <AddressState>string</AddressState>
          <AddressCountry>string</AddressCountry>
          <AddressZip>string</AddressZip>
          <Custom1>string</Custom1>
          <Custom2>string</Custom2>
          <Custom3>string</Custom3>
          <Lock>boolean</Lock>
        </TVendor>
      </GetVendorsResult>
    </GetVendorsResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /Web1243/services/DC_Vendor.asmx/GetVendors?VendorType=string&VendorDescriptionContains=string&PayToDefaultContains=string&CustomContains=string&ShowHiddenVendors=string HTTP/1.1
Host: rmhs.rmdatacentral.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfTVendor xmlns="http://restaurantmagic.com/services">
  <TVendor>
    <ID>string</ID>
    <VendorDescription>string</VendorDescription>
    <VendorType>string</VendorType>
    <Hide>boolean</Hide>
    <PayToDefault>string</PayToDefault>
    <LiabilityAccount>string</LiabilityAccount>
    <CheckAccount>string</CheckAccount>
    <Recommended>boolean</Recommended>
    <EnablePriceControl>boolean</EnablePriceControl>
    <AutoInvoiceNumber>boolean</AutoInvoiceNumber>
    <ProducionKitchenUnit>string</ProducionKitchenUnit>
    <EnableB2B>boolean</EnableB2B>
    <B2BIntegrationDefault>string</B2BIntegrationDefault>
    <B2BVendorGlobalCode>string</B2BVendorGlobalCode>
    <B2BAutoImport>boolean</B2BAutoImport>
    <PermissionRegularInvoice>boolean</PermissionRegularInvoice>
    <PermissionManualCheck>boolean</PermissionManualCheck>
    <PermissionPaidIn>boolean</PermissionPaidIn>
    <PermissionPaidOut>boolean</PermissionPaidOut>
    <PermissionCreditMemo>boolean</PermissionCreditMemo>
    <PermissionPurchaseOrder>boolean</PermissionPurchaseOrder>
    <PermissionAPVoucher>boolean</PermissionAPVoucher>
    <CreditAuthorizationRequired>boolean</CreditAuthorizationRequired>
    <ReturnReasonCodeRequired>boolean</ReturnReasonCodeRequired>
    <ContactName>string</ContactName>
    <ContactWork>string</ContactWork>
    <ContactCell>string</ContactCell>
    <ContactFax>string</ContactFax>
    <ContactEmail>string</ContactEmail>
    <ContactWebSite>string</ContactWebSite>
    <Address1>string</Address1>
    <Address2>string</Address2>
    <AddressCity>string</AddressCity>
    <AddressState>string</AddressState>
    <AddressCountry>string</AddressCountry>
    <AddressZip>string</AddressZip>
    <Custom1>string</Custom1>
    <Custom2>string</Custom2>
    <Custom3>string</Custom3>
    <Lock>boolean</Lock>
  </TVendor>
  <TVendor>
    <ID>string</ID>
    <VendorDescription>string</VendorDescription>
    <VendorType>string</VendorType>
    <Hide>boolean</Hide>
    <PayToDefault>string</PayToDefault>
    <LiabilityAccount>string</LiabilityAccount>
    <CheckAccount>string</CheckAccount>
    <Recommended>boolean</Recommended>
    <EnablePriceControl>boolean</EnablePriceControl>
    <AutoInvoiceNumber>boolean</AutoInvoiceNumber>
    <ProducionKitchenUnit>string</ProducionKitchenUnit>
    <EnableB2B>boolean</EnableB2B>
    <B2BIntegrationDefault>string</B2BIntegrationDefault>
    <B2BVendorGlobalCode>string</B2BVendorGlobalCode>
    <B2BAutoImport>boolean</B2BAutoImport>
    <PermissionRegularInvoice>boolean</PermissionRegularInvoice>
    <PermissionManualCheck>boolean</PermissionManualCheck>
    <PermissionPaidIn>boolean</PermissionPaidIn>
    <PermissionPaidOut>boolean</PermissionPaidOut>
    <PermissionCreditMemo>boolean</PermissionCreditMemo>
    <PermissionPurchaseOrder>boolean</PermissionPurchaseOrder>
    <PermissionAPVoucher>boolean</PermissionAPVoucher>
    <CreditAuthorizationRequired>boolean</CreditAuthorizationRequired>
    <ReturnReasonCodeRequired>boolean</ReturnReasonCodeRequired>
    <ContactName>string</ContactName>
    <ContactWork>string</ContactWork>
    <ContactCell>string</ContactCell>
    <ContactFax>string</ContactFax>
    <ContactEmail>string</ContactEmail>
    <ContactWebSite>string</ContactWebSite>
    <Address1>string</Address1>
    <Address2>string</Address2>
    <AddressCity>string</AddressCity>
    <AddressState>string</AddressState>
    <AddressCountry>string</AddressCountry>
    <AddressZip>string</AddressZip>
    <Custom1>string</Custom1>
    <Custom2>string</Custom2>
    <Custom3>string</Custom3>
    <Lock>boolean</Lock>
  </TVendor>
</ArrayOfTVendor>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /Web1243/services/DC_Vendor.asmx/GetVendors HTTP/1.1
Host: rmhs.rmdatacentral.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

VendorType=string&VendorDescriptionContains=string&PayToDefaultContains=string&CustomContains=string&ShowHiddenVendors=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfTVendor xmlns="http://restaurantmagic.com/services">
  <TVendor>
    <ID>string</ID>
    <VendorDescription>string</VendorDescription>
    <VendorType>string</VendorType>
    <Hide>boolean</Hide>
    <PayToDefault>string</PayToDefault>
    <LiabilityAccount>string</LiabilityAccount>
    <CheckAccount>string</CheckAccount>
    <Recommended>boolean</Recommended>
    <EnablePriceControl>boolean</EnablePriceControl>
    <AutoInvoiceNumber>boolean</AutoInvoiceNumber>
    <ProducionKitchenUnit>string</ProducionKitchenUnit>
    <EnableB2B>boolean</EnableB2B>
    <B2BIntegrationDefault>string</B2BIntegrationDefault>
    <B2BVendorGlobalCode>string</B2BVendorGlobalCode>
    <B2BAutoImport>boolean</B2BAutoImport>
    <PermissionRegularInvoice>boolean</PermissionRegularInvoice>
    <PermissionManualCheck>boolean</PermissionManualCheck>
    <PermissionPaidIn>boolean</PermissionPaidIn>
    <PermissionPaidOut>boolean</PermissionPaidOut>
    <PermissionCreditMemo>boolean</PermissionCreditMemo>
    <PermissionPurchaseOrder>boolean</PermissionPurchaseOrder>
    <PermissionAPVoucher>boolean</PermissionAPVoucher>
    <CreditAuthorizationRequired>boolean</CreditAuthorizationRequired>
    <ReturnReasonCodeRequired>boolean</ReturnReasonCodeRequired>
    <ContactName>string</ContactName>
    <ContactWork>string</ContactWork>
    <ContactCell>string</ContactCell>
    <ContactFax>string</ContactFax>
    <ContactEmail>string</ContactEmail>
    <ContactWebSite>string</ContactWebSite>
    <Address1>string</Address1>
    <Address2>string</Address2>
    <AddressCity>string</AddressCity>
    <AddressState>string</AddressState>
    <AddressCountry>string</AddressCountry>
    <AddressZip>string</AddressZip>
    <Custom1>string</Custom1>
    <Custom2>string</Custom2>
    <Custom3>string</Custom3>
    <Lock>boolean</Lock>
  </TVendor>
  <TVendor>
    <ID>string</ID>
    <VendorDescription>string</VendorDescription>
    <VendorType>string</VendorType>
    <Hide>boolean</Hide>
    <PayToDefault>string</PayToDefault>
    <LiabilityAccount>string</LiabilityAccount>
    <CheckAccount>string</CheckAccount>
    <Recommended>boolean</Recommended>
    <EnablePriceControl>boolean</EnablePriceControl>
    <AutoInvoiceNumber>boolean</AutoInvoiceNumber>
    <ProducionKitchenUnit>string</ProducionKitchenUnit>
    <EnableB2B>boolean</EnableB2B>
    <B2BIntegrationDefault>string</B2BIntegrationDefault>
    <B2BVendorGlobalCode>string</B2BVendorGlobalCode>
    <B2BAutoImport>boolean</B2BAutoImport>
    <PermissionRegularInvoice>boolean</PermissionRegularInvoice>
    <PermissionManualCheck>boolean</PermissionManualCheck>
    <PermissionPaidIn>boolean</PermissionPaidIn>
    <PermissionPaidOut>boolean</PermissionPaidOut>
    <PermissionCreditMemo>boolean</PermissionCreditMemo>
    <PermissionPurchaseOrder>boolean</PermissionPurchaseOrder>
    <PermissionAPVoucher>boolean</PermissionAPVoucher>
    <CreditAuthorizationRequired>boolean</CreditAuthorizationRequired>
    <ReturnReasonCodeRequired>boolean</ReturnReasonCodeRequired>
    <ContactName>string</ContactName>
    <ContactWork>string</ContactWork>
    <ContactCell>string</ContactCell>
    <ContactFax>string</ContactFax>
    <ContactEmail>string</ContactEmail>
    <ContactWebSite>string</ContactWebSite>
    <Address1>string</Address1>
    <Address2>string</Address2>
    <AddressCity>string</AddressCity>
    <AddressState>string</AddressState>
    <AddressCountry>string</AddressCountry>
    <AddressZip>string</AddressZip>
    <Custom1>string</Custom1>
    <Custom2>string</Custom2>
    <Custom3>string</Custom3>
    <Lock>boolean</Lock>
  </TVendor>
</ArrayOfTVendor>