NEW!

An item cross reference enables you to associate one of your company’s inventory items with a specific customer or vendor so that you can include their identifier for that item during transactions.


Get Item Cross Reference Object Definition

lookup

List all the fields and relationships for the item cross reference object:

<lookup>
    <object>ITEMCROSSREF</object>
</lookup>

Parameters

Name Required Type Description
object Required string Use ITEMCROSSREF
docparid Optional string Used to indicate the document type, such as Inventory Transfer, Sales Order, Purchase Order and so forth . You must use this to take advantage of any custom fields on the specified document type.

List Item Cross References

query

List the item ID and reference type for each cross reference:

<query>
    <object>ITEMCROSSREF</object>
    <select>
        <field>ITEMID</field>
        <field>REFTYPE</field>
    </select>
</query>

Parameters

Name Required Type Description
object Required string Use ITEMCROSSREF
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)
docparid Optional string Document type, such as Sales Order, Purchase Order, or Inventory Transfer

List Item Cross References (Legacy)

readByQuery

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

Parameters

Name Required Type Description
object Required string Use ITEMCROSSREF
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 Item Cross Reference

read

<read>
    <object>ITEMCROSSREF</object>
    <keys>101</keys>
    <fields>*</fields>
</read>

Parameters

Name Required Type Description
object Required string Use ITEMCROSSREF
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.

Create Item Cross Reference

create

Create a cross reference to associate inventory item L-12 with the Acme vendor and use their alias name, BL-01, for that item:

<create>
    <ITEMCROSSREF>
        <REFTYPE>Vendor</REFTYPE>
        <ITEMID>L-12</ITEMID>
        <VENDORID>Acme</VENDORID>
        <ITEMALIASID>BL-01</ITEMALIASID>
        <ITEMALIASDESC>Base laptop</ITEMALIASDESC>
    </ITEMCROSSREF>
</create>

Parameters

Name Required Type Description
ITEMCROSSREF Required object Object to create

ITEMCROSSREF

Name Required Type Description
REFTYPE Required string Reference type, such as Vendor or Customer
ITEMID Required string ID of the inventory item for the cross reference
VENDORID Optional string Vendor ID, which is required if using a Vendor reference type
CUSTOMERID Optional string Customer ID, which is required if using a Customer reference type
ITEMALIASID Required string Identifier for the item as understood by the given vendor or customer. Must be unique for the combination of vendor/item or customer/item.
ITEMALIASDESC Optional string Description of the cross reference
UNIT Optional string Valid unit of measure for the item

Update Item Cross Reference

update

Update the description for the item cross reference:

<update>
    <ITEMCROSSREF>
        <RECORDNO>101</RECORDNO>
        <ITEMALIASDESC>Base laptop 2</ITEMALIASDESC>
    </ITEMCROSSREF>
</update>

Parameters

Name Required Type Description
ITEMCROSSREF Required object Object to update

ITEMCROSSREF

Name Required Type Description
RECORDNO Required integer Record number of the item cross reference
ITEMALIASID Optional string Alias for the item as understood by the relevant vendor or customer. Must be unique for the combination of vendor/item or customer/item.
ITEMALIASDESC Optional string Description of the cross reference
UNIT Optional string Valid unit of measure for the item

Delete Item Cross Reference

delete

<delete>
    <object>ITEMCROSSREF</object>
    <keys>101</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use ITEMCROSSREF
keys Required string Item cross reference RECORDNO to delete

Provide feedback