A Purchasing price list contains the names of price lists in Purchasing.


Get Purchasing Price List Object Definition

lookup

List all the fields and relationships for the purchasing price list object:

<lookup>
    <object>POPRICELIST</object>
</lookup>

Parameters

Name Required Type Description
object Required string Use POPRICELIST

List Purchasing Price Lists

query

List the record number and name for each purchasing price list:

<query>
    <object>POPRICELIST</object>
    <select>
        <field>RECORDNO</field>
        <field>NAME</field>
    </select>
</query>

Parameters

Name Required Type Description
object Required string Use POPRICELIST
select Required sequence One or more field names and an optional aggregate function such as count or sum. Returning all fields is not supported.
filter Optional object Query filter expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL).
orderby Optional object Provide an order element with a field name and choose an ascending or descending sort order, for example:
<order>
        <field>RECORDNO</field>
        <descending/>
</order>
options Optional object Set the caseinsensitive element to true for a case-insensitive query:
    <caseinsensitive>true</caseinsensitive>
In a multi-entity company, set the showprivate element to true to query data in private entities:
   <showprivate>true</showprivate>
pagesize Optional integer Custom page size between 1 and 2000 items (Default: 100)
offset Optional integer Point at which to start indexing into records (Default: 0)

List Purchasing Price Lists (Legacy)

readByQuery

<readByQuery>
    <object>POPRICELIST</object>
    <fields>*</fields>
    <query></query>
    <pagesize>100</pagesize>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use POPRICELIST
fields Optional string Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.
query Required string SQL-like query based on fields on the object. The following operators are supported: <, >, >=, <=, =, like, not like, in, not in, IS NOT NULL, IS NULL, AND, OR. Illegal XML characters must be properly encoded, and single quotes must be escaped with backslashes ('Jane\'s Deli'). Joins are not supported.
pagesize Optional integer Custom page size between 1 and 1000 items (Default: 100)

Get Purchasing Price List

read

<read>
    <object>POPRICELIST</object>
    <keys>1</keys>
    <fields>*</fields>
</read>

Parameters

Name Required Type Description
object Required string Use POPRICELIST
keys Required string Object RECORDNO to get
fields Optional string Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.

Get Purchasing Price List by Name

readByName

<readByName>
    <object>POPRICELIST</object>
    <keys>Full Time</keys>
    <fields>*</fields>
</readByName>

Parameters

Name Required Type Description
object Required string Use POPRICELIST
keys Required string Object NAME to get
fields Optional string Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.

Create Purchasing Price List (Legacy)

create_popricelist

<create_popricelist>
    <name>Special Purchasing price list</name>
</create_popricelist>

Parameters

Name Required Type Description
name Required string Price list name to create
datefrom Optional object Date from
dateto Optional object Date to
status Optional string Status. Use active for Active otherwise use inactive for Inactive. (Default: active)

datefrom

Name Required Type Description
year Required string Year yyyy
month Required string Month mm
day Required string Day dd

dateto

Name Required Type Description
year Required string Year yyyy
month Required string Month mm
day Required string Day dd

Update Purchasing Price List (Legacy)

update_popricelist

<update_popricelist name="Special Purchasing price list">
    <status>active</status>
</update_popricelist>

Parameters

Name Required Type Description
name Required string Price list name to update
datefrom Optional object Date from
dateto Optional object Date to
status Optional string Status. Use active for Active otherwise use inactive for Inactive

datefrom

Name Required Type Description
year Required string Year yyyy
month Required string Month mm
day Required string Day dd

dateto

Name Required Type Description
year Required string Year yyyy
month Required string Month mm
day Required string Day dd

Delete Purchasing Price List (Legacy)

delete_popricelist

<delete_popricelist name="Special Purchasing price list"></delete_popricelist>

Parameters

Name Required Type Description
name Required string Price list name to delete

Provide feedback