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.
Returns a collection with a key, ID, and link for each customer item cross reference.
OK
Bad Request
null
Creates a new customer item cross reference.
object Customer. | |||||||
| |||||||
object | |||||||
| |||||||
referenceType | string Default: "customer" Reference type 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 Example: null |
Created
Bad Request
null
null
Returns detailed information for a specified customer item cross reference.
key required | string System-assigned unique key for the customer item cross reference. |
OK
Bad Request
null
Updates an existing customer item cross reference by setting field values. Any fields not provided remain unchanged.
key required | string System-assigned unique key for the customer item cross reference. |
object Customer. | |||||||
| |||||||
object | |||||||
| |||||||
referenceType | string Default: "customer" Reference type 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 Example: null |
OK
Bad Request
null
null
Deletes a customer item cross reference.
key required | string System-assigned unique key for the customer 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: "accounts-receivable/customer-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": "accounts-payable/vendor",
- "fields": [
- "id",
- "name",
- "status",
- "href"
], - "filters": [
- {
- "$eq": {
- "status": "active"
}
}, - {
- "$eq": {
- "billingType": "openItem"
}
}
], - "filterExpression": "1 and 2",
- "orderBy": [
- {
- "id": "asc"
}
]
}
{- "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
}
}