Components are items included in a kit. Kits are common combinations of items that can be ordered and invoiced as a single item to simplify data entry. Kits can include inventory items, non-inventory items, and other kits.
Returns a collection with a key, ID, and link for each kit component.
OK
Bad Request
{- "ia::result": [
- {
- "key": "1",
- "id": "1",
- "href": "/object/kit-component/1"
}, - {
- "key": "2",
- "id": "2",
- "href": "/object/kit-component/2"
}
], - "ia::meta": {
- "totalCount": 2,
- "start": 1,
- "pageSize": 100,
- "next": 101,
- "previous": null
}
}
Creates a new kit component.
required | object Kit is item of type kit or stockable kit. | ||||
| |||||
required | object Components are items to be ordered and invoiced as a single item (i.e. kit or stockable kit). | ||||
| |||||
numberOfUnits required | number Number of component units required in this kit. Example: 1 | ||||
revenuePercentage | number [ 0 .. 100 ] When item sold as part of Kit, the revenue part of the each item will calculated based on the given percentage. Example: 10 | ||||
defaultDeliveryStatus | string Default: "delivered" Default that will indicate the most common delivery status of this item when it's sold. Example: "delivered" | ||||
defaultDeferralStatus | string Default: "deferUntilItemIsDelivered" Choose whether to defer until this item is delivered or until the entire bundle is delivered. Example: "deferUntilItemIsDelivered" | ||||
lineNumber | integer Line number of Kit Component on Kit. If not provided, the system automatically assigns a unique line number. If the user specifies the linenumber already used, the application will push set other lines to unique numbers. Example: 1 |
Created
Bad Request
{- "kit": {
- "key": "1"
}, - "component": {
- "key": "2"
}, - "revenuePercentage": 90,
- "defaultDeliveryStatus": "undelivered",
- "defaultDeferralStatus": "deferUntilItemIsDelivered",
- "numberOfUnits": 1
}
{- "ia::result": {
- "key": "1",
- "id": "1",
- "href": "/objects/inventory-control/kit-component/1"
}, - "ia::meta": {
- "totalCount": 1
}
}
Returns detailed information for a specified kit component.
key required | string System-assigned key for the kit-component. Example: 1 |
OK
Bad Request
{- "ia::result": {
- "key": "1",
- "id": "1",
- "kit": {
- "key": "27",
- "id": "Kit_1",
- "href": "/objects/inventory-control/item/27"
}, - "component": {
- "key": "10",
- "id": "Prnt_Paper",
- "name": "Paper for Printer",
- "costMethod": "standard",
- "itemType": "inventory",
- "unitOfMeasure": "10 Pack",
- "standardCost": "100",
- "href": "/objects/inventory-control/item/10"
}, - "numberOfUnits": 1,
- "revenuePercentage": 10,
- "defaultDeliveryStatus": "delivered",
- "defaultDeferralStatus": "deferUntilItemIsDelivered",
- "lineNumber": 1,
- "href": "/objects/inventory-control/kit-component/1"
}, - "ia::meta": {
- "totalCount": 1
}
}
Updates an existing kit component by setting field values. Any fields not provided remain unchanged.
key required | string System-assigned key for the kit-component. Example: 1 |
object Kit is item of type kit or stockable kit. | |||||
| |||||
object Components are items to be ordered and invoiced as a single item (i.e. kit or stockable kit). | |||||
| |||||
numberOfUnits | number Number of component units required in this kit. Example: 1 | ||||
revenuePercentage | number [ 0 .. 100 ] When item sold as part of Kit, the revenue part of the each item will calculated based on the given percentage. Example: 10 | ||||
defaultDeliveryStatus | string Default: "delivered" Default that will indicate the most common delivery status of this item when it's sold. Example: "delivered" | ||||
defaultDeferralStatus | string Default: "deferUntilItemIsDelivered" Choose whether to defer until this item is delivered or until the entire bundle is delivered. Example: "deferUntilItemIsDelivered" | ||||
lineNumber | integer Line number of Kit Component on Kit. If not provided, the system automatically assigns a unique line number. If the user specifies the linenumber already used, the application will push set other lines to unique numbers. Example: 1 |
OK
Bad Request
{- "component": {
- "key": "10"
}, - "numberOfUnits": 1
}
{- "ia::result": {
- "key": "1",
- "id": "1",
- "href": "/objects/inventory-control/kit-component/1"
}, - "ia::meta": {
- "totalCount": 1
}
}
Deletes a kit component.
key required | string System-assigned key for the kit-component. Example: 1 |
No Content
Bad Request
{- "ia::result": {
- "ia::error": {
- "code": "invalidRequest",
- "message": "A POST request requires a payload",
- "errorId": "REST-1028",
- "additionalInfo": {
- "messageId": "IA.REQUEST_REQUIRES_A_PAYLOAD",
- "placeholders": {
- "OPERATION": "POST"
}, - "propertySet": { }
}, - "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
}
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 0,
- "totalError": 1
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "inventory-control/kit-component" | ||||||||
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
}
}