Item cross references

An item cross reference associates an inventory item with a specific customer or vendor, or with another inventory item.

When an inventory item is associated with a customer or vendor (known as an external cross-reference), the customer or vendor can provide their own identifiers for inventory items that can be used in transactions.

When an inventory item is associated with another inventory item (known as an internal cross-reference), you can provide an alternate item to substitute, upgrade, downgrade, or complement that item in Order Entry transactions in Sage Intacct. For more information, see Item cross references in the Sage Intacct Help Center.

List item cross references

get/objects/inventory-control/item-cross-reference

Returns a collection with a key, ID, and link for each item cross reference.

Permissions and other requirements
SubscriptionInventory Control, Order Entry, Purchasing
User typeEmployee, Business, Project Manager, Warehouse
PermissionsList, View Item cross references
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "1",
      • "href": "/objects/inventory-control/item-cross-reference/1"
      },
    • {
      • "key": "2",
      • "id": "2",
      • "href": "/objects/inventory-control/item-cross-reference/2"
      },
    • {
      • "key": "3",
      • "id": "3",
      • "href": "/objects/inventory-control/item-cross-reference/3"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": 101,
    • "previous": null
    }
}
Create an item cross reference
post/objects/inventory-control/item-cross-reference
Creates a new item cross reference.



Permissions and other requirements



SubscriptionInventory Control, Order Entry


User typeBusiness


PermissionsAdd, List, View Item cross references







SecurityOAuth2 
Request 
Request Body schema: application/json
referenceType
required
string
Reference type. Use vendor or customer for an external cross reference. Use substitute, upgrade, downgrade, or complement for an internal cross reference.


 Enum: "complement" "customer" "downgrade" "substitute" "upgrade" "vendor"  
 Example:  "substitute"
required
object
Inventory item to create the cross reference for.


 
 Example:  {"key":"649"}
key
string
System-assigned key for the item.


 
 Example:  "649"
id
string
ID for the item.


 
 Example:  "Logitech-MK825"
itemAliasId
string or null  <= 100 characters 
 Default:  null
Required for an external cross reference. Identifier for the item as understood by the given vendor or customer. Must be unique for the combination of vendor/item or customer/item.


 
 Example:  "Logitech - MK825"
itemAliasDescription
string or null  <= 50 characters 
 Default:  null
Description of the item alias for the cross reference.


 
 Example:  "Logitech - MK825 Wireless Keyboard and Mouse"
object
Valid unit of measure for the item.


 
key
string or null
System-assigned key for the unit of measure.


 
 Example:  "21"
id
string or null
Valid unit of measure ID for the item.


 
 Example:  "EACH"
object
An alternate item. This field is required when using an internal referenceType, such as substitute or upgrade.


 
key
string or null
System-assigned key for the alternate item.


 
 Example:  "22"
id
string or null
ID for the alternate item.


 
 Example:  "Logitech-MK850"
object
The customer ID is required if referenceType is customer.


 
key
string or null
System-assigned key for the customer.


 
 Example:  "11"
id
string or null
Customer ID, which is required if referenceType is customer.


 
 Example:  "C00023"
object
The vendor ID is required if referenceType is vendor.


 
key
string or null
System-assigned key for the vendor.


 
 Example:  "22"
id
string or null
Vendor ID, which is required if referenceType is vendor.


 
 Example:  "V0001"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "item": {
    • "key": "649"
    },
  • "alternateItem": {
    • "key": "64"
    },
  • "unitOfMeasure": {
    • "key": "3"
    },
  • "referenceType": "substitute"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "6",
    • "id": "6",
    • "href": "/objects/inventory-control/item-cross-reference/6"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get an item cross reference
get/objects/inventory-control/item-cross-reference/{key}
Returns detailed information for a specified item cross reference.



Permissions and other requirements



SubscriptionInventory Control, Order Entry, Purchasing


User typeEmployee, Business, Project Manager, Warehouse


PermissionsList, View Item cross references







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the item cross reference.


 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "6",
    • "id": "6",
    • "referenceType": "substitute",
    • "referenceTypeContext": "internal",
    • "item": {
      • "key": "649",
      • "id": "Logitech-MK830",
      • "name": "MK830 Keyboard and Mouse Combo",
      • "href": "/objects/inventory-control/item/649"
      },
    • "alternateItem": {
      • "key": "64",
      • "id": "Logitech-MK825",
      • "name": "MK825 Keyboard and Mouse Combo",
      • "href": "/objects/inventory-control/item/64"
      },
    • "vendor": {
      • "key": null,
      • "id": null,
      • "name": null
      },
    • "customer": {
      • "key": null,
      • "id": null,
      • "name": null
      },
    • "itemAliasId": null,
    • "itemAliasDescription": null,
    • "unitOfMeasure": {
      • "key": "3",
      • "id": "Each",
      • "href": "/objects/inventory-control/unit-of-measure/3"
      },
    • "href": "/objects/inventory-control/item-cross-reference/6",
    • "audit": {
      • "createdDateTime": "2023-11-09T06:20:34Z",
      • "modifiedDateTime": "2023-11-09T07:02:22Z",
      • "createdBy": "1",
      • "modifiedBy": "22"
      },
    • "ia::meta": {
      • "totalCount": 1,
      • "totalSuccess": 1,
      • "totalError": 0
      }
    }
}
Update an item cross reference
patch/objects/inventory-control/item-cross-reference/{key}
Updates an existing item cross reference by setting field values. Any fields not provided remain unchanged.



Permissions and other requirements



SubscriptionInventory Control, Order Entry


User typeBusiness


PermissionsEdit, List, View Item cross references







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the item cross reference.


 
Request Body schema: application/json
itemAliasId
string or null  <= 100 characters 
 Default:  null
Required for an external cross reference. Identifier for the item as understood by the given vendor or customer. Must be unique for the combination of vendor/item or customer/item.


 
 Example:  "Logitech - MK825"
itemAliasDescription
string or null  <= 50 characters 
 Default:  null
Description of the item alias for the cross reference.


 
 Example:  "Logitech - MK825 Wireless Keyboard and Mouse"
object
Valid unit of measure for the item.


 
key
string or null
System-assigned key for the unit of measure.


 
 Example:  "21"
id
string or null
Valid unit of measure ID for the item.


 
 Example:  "EACH"
object
An alternate item. This field is required when using an internal referenceType, such as substitute or upgrade.


 
key
string or null
System-assigned key for the alternate item.


 
 Example:  "22"
id
string or null
ID for the alternate item.


 
 Example:  "Logitech-MK850"
object
The customer ID is required if referenceType is customer.


 
key
string or null
System-assigned key for the customer.


 
 Example:  "11"
id
string or null
Customer ID, which is required if referenceType is customer.


 
 Example:  "C00023"
object
Inventory item to create the cross reference for.


 
key
string
System-assigned key for the item.


 
 Example:  "13"
id
string
ID for the item.


 
 Example:  "Logitech-MK825"
object
The vendor ID is required if referenceType is vendor.


 
key
string or null
System-assigned key for the vendor.


 
 Example:  "22"
id
string or null
Vendor ID, which is required if referenceType is vendor.


 
 Example:  "V0001"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "alternateItem": {
    • "key": "10"
    },
  • "unitOfMeasure": {
    • "key": "3"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "6",
    • "id": "6",
    • "href": "/objects/inventory-control/item-cross-reference/6"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete an item cross reference
delete/objects/inventory-control/item-cross-reference/{key}
Deletes an item cross reference. An item cross reference can be deleted if it hasn't been used in a transaction. Deleting an item cross reference removes it from the system so that it cannot be recovered.



Permissions and other requirements



SubscriptionInventory Control, Order Entry


User typeBusiness


PermissionsEdit, List, View Item cross references







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the item cross reference.


 
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}
Query item cross references
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "inventory-control/item-cross-reference"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the response.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "inventory-control/item-cross-reference",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "id",
    • "referenceType",
    • "item.id",
    • "alternateItem.id",
    • "alternateItem.name",
    • "href"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "id": "3",
      • "referenceType": "upgrade",
      • "item.id": "Monitor",
      • "alternateItem.id": "21Mon",
      • "alternateItem.name": "21\" Monitor",
      • "href": "/objects/inventory-control/item-cross-reference/3"
      },
    • {
      • "id": "4",
      • "referenceType": "substitute",
      • "item.id": "Widgets",
      • "alternateItem.id": "3Widgets",
      • "alternateItem.name": "Widget Trio",
      • "href": "/objects/inventory-control/item-cross-reference/4"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}