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.

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.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
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.


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


 
 Example:  99
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.


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


 
 Example:  99
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.


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


 
 Example:  99
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
    }
}