Read PriceBook

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/PriceBook will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/PriceBook

Query Params
filter:	string In this parameter fieldname needs to be provided with condition and value to fetch related details.for eg. PriceBookName,eq,Default PriceBook To fetch PriceBook with PriceBook Name equal to New PriceBook, the following url must be used<https://xyzcompany.agiliron.net/agiliron/api-40/PriceBook?filter=PriceBook,eq,New PriceBook&key=xyzkey> To fetch PriceBook with created date between 01-15-2020 to 01-31-2020 (Use \| between two dates), the following url must be usedhttps://xyzcompany.agiliron.net/agiliron/api-40/PriceBook?filter=CreatedTime,bt,01-15-2020 \| 01-31-2020&key=xyzkey To fetch WorkOrders 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 usedhttps://xyzcompany.agiliron.net/agiliron/api-40/WorkOrders?filter=CreatedTime,bt,01-15-2020 01:03:10\| 01-31-2020 20:00:00&key=xyzkey To fetch PriceBook with PriceBookId equal to 3422, the following url must be usedhttps://xyzcompany.agiliron.net/agiliron/api-40/PriceBook?filter=PriceBookId,eq,3422&key=xyzkeyList 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 PriceBook customview with name as ABC Customview, the following url must be used https://xyzcompany.agiliron.net/agiliron/api-40/PriceBook?customview=ABC Customview&key=xyzkey
page:	int Page number needs to be passed in this variable ,to paginate the response.For eg. To fetch PriceBook with subject equal to New PriceBook 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/PriceBook?filter=PriceBookName,eq,NewPriceBook;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 PriceBook with PriceBookName equal to New PriceBook 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/PriceBook?filter=PriceBook,eq,New PriceBook;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

{
    "Pricebooks": {
        "PriceBook": {
            "PriceBookId": "142993",
            "PriceBookName": "Default PriceBook",
            "Active": "Yes",
            "IsSpecialPriceBook": "No",
            "IsVendorPriceBook": "No",
            "IsVolumePriceBook": "No",
            "SpecialsStartDate": "00-00-0000",
            "SpecialsEndDate": "00-00-0000",
            "DefaultCurrency": "US Dollar",
            "Description": "Description Goes Here.",
            "CreatedTime": "03-18-2025 11:44:57",
            "CreatedTimeUTC": "03-18-2025 06:14:57",
            "ModifiedTime": "03-18-2025 11:45:10",
            "ModifiedTimeUTC": "03-18-2025 06:15:10"
        },
        "TotalRecords": "1",
        "CurrentPage": "1",
        "TotalPages": "1",
        "PageSize": "50"
    }
}

<Pricebooks>
		<PriceBook>
			<PriceBookId>142993</PriceBookId>
			<PriceBookName>Default PriceBook</PriceBookName>
			<Active>Yes</Active>
			<IsSpecialPriceBook>No</IsSpecialPriceBook>
			<IsVendorPriceBook>No</IsVendorPriceBook>
			<IsVolumePriceBook>No</IsVolumePriceBook>
			<SpecialsStartDate>00-00-0000</SpecialsStartDate>
			<SpecialsEndDate>00-00-0000</SpecialsEndDate>
			<DefaultCurrency>US Dollar</DefaultCurrency>
			<Description>Description Goes Here.</Description>
			<CreatedTime>03-18-2025 11:44:57</CreatedTime>
			<CreatedTimeUTC>03-18-2025 06:14:57</CreatedTimeUTC>
			<ModifiedTime>03-18-2025 11:45:10</ModifiedTime>
			<ModifiedTimeUTC>03-18-2025 06:15:10</ModifiedTimeUTC>
		</PriceBook>
		<TotalRecords>1</TotalRecords>
		<CurrentPage>1</CurrentPage>
		<TotalPages>1</TotalPages>
		<PageSize>50</PageSize>
	</Pricebooks>

WADL

<?xml version="1.0" encoding="utf-8"?>
<application>
   <resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
     <resource path="PriceBook"> 
       <method name="GET">
         <request>
           <param name="key" type="xsd:string" style="query" required="true"/>
           <param name="PriceBookName" type="xsd:string" style="query" required="true"/>
           <param name="Filter" type="xsd:string" style="query"/>			
         </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>