Read PriceBook
Retrieves the details of a PriceBook object that has been previously created.
Parameters
Path Params | |
---|---|
yourCompany: | string |
Query Params | |
---|---|
filter: | string
|
customview: | string https://xyzcompany.agiliron.net/agiliron/api-40/PriceBook?customview=ABC Customview&key=xyzkey |
page: | int https://xyzcompany.agiliron.net/agiliron/api-40/PriceBook?filter=PriceBookName,eq,NewPriceBook;Test CheckBox,eq,no&page=10&key=xyzkey |
pageSize: | int 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 |
Query Auth | |
---|---|
key: | string |
Header Auth | |
---|---|
apiKey: | string |
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>
Updated about 2 hours ago