Inventory total details provide visibility into all the inventory totals your organization uses, including onhand, onhold, onorder, damaged, requisitioned, scrap/spoilage, or custom totals.

NEW!


List Inventory Total Details

readByQuery

Lists inventory total details:

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

Lists inventory total details for scrap or damaged items:

<readByQuery>
    <object>inventorytotaldetail</object>
    <query>TOTALNAME='SCRAP OR SPOILAGE' OR TOTALNAME='DAMAGED'</query>
    <fields>*</fields>
    <pagesize>100</pagesize>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use INVENTORYTOTALDETAIL
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. Illegal XML characters must be properly encoded. The following SQL operators are supported: <, >, >=, <=, =, like, not like, in, not in. When doing NULL comparisons: IS NOT NULL, IS NULL. Multiple fields may be matched using the AND and OR operators. Joins are not supported. Single quotes in any operands must be escaped with a backslash - For example, the value Erik's Deli would become Erik\'s Deli.
pagesize Optional integer Custom page size between 1 and 1000 items (Default: 100)

Response

inventorytotaldetail

The above function returns data structured like this:

<inventorytotaldetail>
    <ID>12535</ID>
    <ITEMID>AT-008</ITEMID>
    <WAREHOUSEKEY>1</WAREHOUSEKEY>
    <DOCUMENTID>Inventory Damaged Goods-ADJ0003</DOCUMENTID>
    <TOTALKEY>55</TOTALKEY>
    <TOTALNAME>DAMAGED</TOTALNAME>
    <UNIT>Each</UNIT>
    <QUANTITY>1</QUANTITY>
    <LOCATIONKEY>1</LOCATIONKEY>
    <DEPTKEY></DEPTKEY>
    <WHENCREATED>10/01/2019</WHENCREATED>
    <EFFECTONINVENTORY>Quantity &amp; Value</EFFECTONINVENTORY>
</inventorytotaldetail>

Get Inventory Total Detail

read

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

Parameters

Name Required Type Description
object Required string Use INVENTORYTOTALDETAIL
keys Required string Object ID 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.

Provide feedback