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.

Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

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.

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.

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.

Responses
204

No Content

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::error": {
    • "code": "invalidRequest",
    • "message": "Malformed URL",
    • "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
    • "details": [
      • {
        }
      ]
    }
}

Query customer 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: "accounts-receivable/customer-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": "accounts-payable/vendor",
  • "fields": [
    • "id",
    • "name",
    • "status",
    • "href"
    ],
  • "filters": [
    • {
      • "$eq": {
        }
      },
    • {
      • "$eq": {
        }
      }
    ],
  • "filterExpression": "1 and 2",
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples
application/json
{
  • "ia::result": [
    • {
      • "id": "Vend-00002",
      • "name": "Test vendor",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/85"
      },
    • {
      • "id": "VEND-00010",
      • "name": "Design Works",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/111"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}