Read Vendor

Parameters

Path Params
yourCompany:	string The Company name need to passed in the base URL.For eg. if you enter xyzcompany name, the url https://{yourCompany}.agiliron.net/agiliron/api-40.php/Vendor will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/Vendor

Query Params
filter:	string In this parameter fieldname needs to be provided with condition and value to fetch related details.for eg. VendorName,eq,Vendor name To fetch Vendor with vendorname equal to Robert Smith and custom field(Test CheckBox) value is no or off, the following url must be used https://xyzcompany.agiliron.net/agiliron/api-40/Vendor?filter=VendorName,eq,Robert Smith;Test CheckBox,eq,no&key=xyzkey To fetch Vendor with created date between 01-15-2020 to 01-31-2020 (Use \| between two dates), the following url must be used https://xyzcompany.agiliron.net/agiliron/api-40/Vendor?filter=CreatedTime,bt,01-15-2020 \| 01-31-2020&key=xyzkey To fetch Vendor with created datetime between 01-15-2020 01:03:10 to 01-31-2020 20:00:00 (Use \| between two dates), the following url must be used https://xyzcompany.agiliron.net/agiliron/api-40/Vendor?filter=CreatedTime,bt,01-15-2020 01:03:10\| 01-31-2020 20:00:00&key=xyzkey To fetch Vendor with Type 'Vendor' OR 'Other' (Use OR between two values), the follwing url must be used https://xyzcompany.agiliron.net/agiliron/api-40/Vendor?filter=Status,eq,Vendor OR Other&key=xyzkey To fetch Vendor with VendorId equal to 3422, the following url must be used https://xyzcompany.agiliron.net/agiliron/api-40/Vendor?filter=VendorId,eq,3422&key=xyzkey List of condition abbrevations to be used: "cs": contain string (string contains value) "sw": start with (string starts with value) "ew": end with (string end with value) "neq": not equal (string or number should not match) "eq": equal (string or number matches exactly) "lt": lower than (number is lower than value) "le": lower or equal (number is lower than or equal to value) "ge": greater or equal (number is higher than or equal to value) "gt": greater than (number is higher than value) "bt": between (number is between two comma separated values)
customview:	string In this parameter customview name needs to be provided to fetch related details.For eg. To fetch Vendor customview with name as ABC Customview, the following url must be used https://xyzcompany.agiliron.net/agiliron/api-40/Vendor?customview=ABC Customview&key=xyzkey
page:	int Page number needs to be passed in this variable ,to paginate the response.For eg. To fetch Vendor with vendorname equal to Robert Smith and custom field(Test CheckBox) value is no or off and page equal to 10, the following url must be used https://xyzcompany.agiliron.net/agiliron/api-40/Vendor?filter=VendorName,eq,Robert Smith;Test CheckBox,eq,no&page=10&key=xyzkey
pageSize:	int In this parameter pageSize number needs to be provided to fetch related page details.For eg. To fetch Vendor with vendorname equal to Robert Smith and custom field(Test CheckBox) value is no or off and page size equal to 10, the following url must be used https://xyzcompany.agiliron.net/agiliron/api-40/Vendor?filter=VendorName,eq,Robert Smith;Test CheckBox,eq,no&pageSize=10&key=xyzkey

Header Params
Accept:	string Response header need to be passed for eg. application/json or application/xml.

Query Auth
key:	string API key needs to be passed in this variable.The option to enter API key will appear when you click on Try it button.This will be the first option in AUTHENTICATION block.Default is SET to 0.

Header Auth
apiKey:	string Dedicated API key needs to be passed in this variable via header.The option to enter API key will appear when you click on Try it button.This will be the second option in AUTHENTICATION block.Default is SET to 0.

Sample Code

{
	"Vendors": {
		"Vendor": [{
			"VendorId": "3422",
			"VendorName": "Test New Vendor",
			"AccountNumber": "659846",
			"ParentCompany": "Test New Vendor",
			"PrimaryContact": "Contact1",
			"OtherPhone": "56984663",
			"OtherEmail": "[email protected]",
			"Category": "Other",
			"Fax": "5689746",
			"Website": "www.abc.com",
			"Rating": "Good",
			"AssignedToUser": "admin",
			"Type": "Vendor",
			"TaxAuthority": "Indiana State",
			"CreditLimit": "1000.000",
			"CreditLimitExpires": "01-24-2020",
			"PriceBook": "Test New Vendor - Vendor",
			"DefaultCurrency": "USD",
			"Discount": "10",
			"PaymentMethod": "Cash",
			"TermsAndConditions": "",
			"Carrier": "Not Specified25",
			"ShippingMethod": "???",
			"DeliverTo": "OAK",
			"Street": "1515 Clay Street",
			"City": "Oakland",
			"Postcode": "94624",
			"State": "CA",
			"Country": "United States",
			"Telephone": "56412356",
			"Email": "[email protected]",
			"Description": "The Description Goes here.",
			"CreatedTime": "01-24-2020 05:19:56",
			"CreatedTimeUTC": "01-24-2020 15:01:35",
			"ModifiedTime": "01-24-2020 05:19:56",
			"ModifiedTimeUTC": "01-24-2020 15:05:56",
			"VendorCustomFields": {
				"CustomField": [{
						"Name": "CustomFied1",
						"Value": "Custom info 1"
					},
					{
						"Name": "CustomFied2",
						"Value": "Custom info 2"
					}
				]
			}
		}],
		"TotalRecords": "1",
		"CurrentPage": "1",
		"TotalPages": "1",
		"PageSize": "50"
	}
}

<Vendors>
    <Vendor>
      	<VendorId>3422</VendorId>
        <VendorName>Test New Vendor</VendorName>
        <AccountNumber>659846</AccountNumber>
        <ParentCompany>Test New Vendor</ParentCompany>
        <PrimaryContact>Contact1</PrimaryContact>
        <OtherPhone>56984663</OtherPhone>
        <OtherEmail>[email protected]</OtherEmail>
        <Category>Other</Category>
        <Fax>5689746</Fax>
        <Website>www.abc.com</Website>
        <Rating>Good</Rating>
        <AssignedToUser>admin</AssignedToUser>
        <Type>Vendor</Type>
        <TaxAuthority>Indiana State</TaxAuthority>
        <CreditLimit>1000.000</CreditLimit>
        <CreditLimitExpires>01-24-2020</CreditLimitExpires>
        <PriceBook>Test New Vendor - Vendor</PriceBook>
        <DefaultCurrency>USD</DefaultCurrency>
        <Discount>10</Discount>
        <PaymentMethod>Cash</PaymentMethod>
        <TermsAndConditions></TermsAndConditions>
        <Carrier>Not Specified25</Carrier>
        <ShippingMethod>???</ShippingMethod>
        <DeliverTo>OAK</DeliverTo>
        <Street>1515 Clay Street</Street>
        <City>Oakland</City>
        <Postcode>94624</Postcode>
        <State>CA</State>
        <Country>United States</Country>
        <Telephone>56412356</Telephone>
        <Email>[email protected]</Email>
        <Description>The Description Goes here.</Description>
      	<CreatedTime>01-24-2020 05:19:56</CreatedTime>
      	<CreatedTimeUTC>01-24-2020 15:01:35</CreatedTimeUTC>
        <ModifiedTime>01-24-2020 05:19:56</ModifiedTime>
      	<ModifiedTimeUTC>01-24-2020 15:05:56</ModifiedTimeUTC>
        <VendorCustomFields>
            <CustomField>
                <Name>CustomFied1</Name>
                <Value>Custom info 1</Value>
            </CustomField>
            <CustomField>
                <Name>CustomFied2</Name>
                <Value>Custom info 2</Value>
            </CustomField>
        </VendorCustomFields>
    </Vendor>
  	<TotalRecords>1</TotalRecords>
    <CurrentPage>1</CurrentPage>
    <TotalPages>1</TotalPages>
    <PageSize>50</PageSize>
</Vendors>

WADL

<?xml version="1.0" encoding="utf-8"?>
<application>
   <resources base="https://{yourCompany}.agiliron.net/agiliron/api-40">
     <resource path="Vendor"> 
       <method name="GET">
	   <resource path="{VendorId/VendorName/Email}">
         <request>
           <param name="key" type="xsd:string" style="query" required="true"/>	
         </request> 
         <response status="200"> 
            <representation mediaType="application/xml" element="yn:ResultSet"/> 
         </response> 
         <response status="400"> 
            <representation mediaType="application/xml" element="ya:Error"/> 
         </response> 
       </method> 
     </resource> 
   </resources>
 </application>