Customer item cross references

Customer item cross references match the customer identifier for an item to the item ID your company uses, which makes transaction entry easier and more robust.

List customer item cross references

get/objects/accounts-receivable/customer-item-cross-reference

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

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
null
Create a customer item cross reference
post/objects/accounts-receivable/customer-item-cross-reference
Creates a new customer item cross reference.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
Customer.


 
key
string
Customer key


 
id
string
Customer ID


 
name
string
 
object
 
key
string
Item key


 
id
string
Item ID


 
 Example:  null
name
string
 
 Example:  null
referenceType
string
 Default:  "customer"
Reference type


 Value: "customer"  
 Example:  "customer"
itemAliasId
string
Cross-reference item ID


 
 Example:  null
itemAliasDescription
string
Cross-reference item description


 
 Example:  null
unit
string
Unit


 
 Example:  null
referenceTypeContext
string
Reference type Context


 Enum: "external" "internal"  
 Example:  null
Responses 
201
Created


400
Bad Request


Request samples 
application/json
null
Response samples 
application/json
null
Get a customer item cross reference
get/objects/accounts-receivable/customer-item-cross-reference/{key}
Returns detailed information for a specified customer item cross reference.


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


 
 Example:  168
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
null
Update a customer item cross reference
patch/objects/accounts-receivable/customer-item-cross-reference/{key}
Updates an existing customer 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 customer item cross reference.


 
 Example:  168
Request Body schema: application/json
object
Customer.


 
key
string
Customer key


 
id
string
Customer ID


 
name
string
 
object
 
key
string
Item key


 
id
string
Item ID


 
 Example:  null
name
string
 
 Example:  null
referenceType
string
 Default:  "customer"
Reference type


 Value: "customer"  
 Example:  "customer"
itemAliasId
string
Cross-reference item ID


 
 Example:  null
itemAliasDescription
string
Cross-reference item description


 
 Example:  null
unit
string
Unit


 
 Example:  null
referenceTypeContext
string
Reference type Context


 Enum: "external" "internal"  
 Example:  null
Responses 
200
OK


400
Bad Request


Request samples 
application/json
null
Response samples 
application/json
null
Delete a customer item cross reference
delete/objects/accounts-receivable/customer-item-cross-reference/{key}
Deletes a customer item cross reference.


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


 
 Example:  168
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 customer item cross references
post/services/core/query
Use the query service to find customer item cross references that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


Request samples