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.
Returns a collection with a key, ID, and link for each item cross reference.
Subscription | Inventory Control, Order Entry, Purchasing |
---|---|
User ype | Employee, Business, Project Manager, Warehouse |
Permissions | List, View Item cross references |
OK
Bad Request
{- "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
}
}
Creates a new item cross reference.
Subscription | Inventory Control, Order Entry |
---|---|
User ype | Business |
Permissions | Add, List, View Item cross references |
referenceType required | string Reference type. Use Example: "substitute" | ||||
required | object Inventory item to create the cross reference for. Example: {"key":"649"} | ||||
| |||||
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. | |||||
| |||||
object An alternate item. This field is required when using an internal | |||||
| |||||
object The customer ID is required if | |||||
| |||||
object The vendor ID is required if | |||||
|
Created
Bad Request
{- "item": {
- "key": "649"
}, - "alternateItem": {
- "key": "64"
}, - "unitOfMeasure": {
- "key": "3"
}, - "referenceType": "substitute"
}
{- "ia::result": {
- "key": "6",
- "id": "6",
- "href": "/objects/inventory-control/item-cross-reference/6"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns detailed information for a specified item cross reference.
Subscription | Inventory Control, Order Entry, Purchasing |
---|---|
User ype | Employee, Business, Project Manager, Warehouse |
Permissions | List, View Item cross references |
key required | string System-assigned unique key for the item cross reference. |
OK
Bad Request
{- "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
}
}
}
Updates an existing item cross reference by setting field values. Any fields not provided remain unchanged.
Subscription | Inventory Control, Order Entry |
---|---|
User ype | Business |
Permissions | Edit, List, View Item cross references |
key required | string System-assigned unique key for the item cross reference. |
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. | |||||
| |||||
object An alternate item. This field is required when using an internal | |||||
| |||||
object The customer ID is required if | |||||
| |||||
object Inventory item to create the cross reference for. | |||||
| |||||
object The vendor ID is required if | |||||
|
OK
Bad Request
{- "alternateItem": {
- "key": "10"
}, - "unitOfMeasure": {
- "key": "3"
}
}
{- "ia::result": {
- "key": "6",
- "id": "6",
- "href": "/objects/inventory-control/item-cross-reference/6"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
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.
Subscription | Inventory Control, Order Entry |
---|---|
User ype | Business |
Permissions | Edit, List, View Item cross references |
key required | string System-assigned unique key for the item cross reference. |
No Content
Bad Request
{- "ia::error": {
- "code": "invalidRequest",
- "message": "Malformed URL",
- "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
- "details": [
- {
- "code": "invalidRequest",
- "message": "The content type is not valid",
- "correction": "TODO"
}
]
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "inventory-control/item-cross-reference" | ||||||||
fields | Array of strings List of fields to include in the response. Can be any combination of these:
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 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
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the For example,
| |||||||||
filterExpression | string Default: "and" Logical operators to apply when there are multiple filter conditions. The conditions in the Shortcuts:
Example: "(1 and 2) or 3" | ||||||||
| |||||||||
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
| |||||||||
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 |
OK
Bad Request
{- "object": "inventory-control/item-cross-reference",
- "filters": [
- {
- "$eq": {
- "referenceTypeContext": "internal"
}
}
], - "fields": [
- "id",
- "referenceType",
- "item.id",
- "alternateItem.id",
- "alternateItem.name",
- "href"
], - "orderBy": [
- {
- "id": "asc"
}
]
}
{- "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
}
}