Stockable kit documents

Component items in a stockable kit are assembled together to make it an inventoried item. Stockable kit documents provide a record of stockable kit build and disassembly transactions.

When stockable kits are built, the inventory of the components added to the stockable kit is reduced and the number of stockable kits is increased. When stockable kits are disassembled, the inventory of the components removed from the stockable kit is increased and the number of stockable kits is decreased.

For more information, see Kits in the Sage Intacct Help Center.

List stockable kit documents

get/objects/inventory-control/stockable-kit-document

Returns a collection with a key, ID, and link for each stockable kit document. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

Permissions and other requirements
SubscriptionInventory
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View Inventory documents
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "118",
      • "id": "Disassemble Kits-SK-000311",
      • "href": "/objects/inventory-control/stockable-kit-document/118"
      },
    • {
      • "key": "161",
      • "id": "Build Kits-SM002",
      • "href": "/objects/inventory-control/stockable-kit-document/161"
      },
    • {
      • "key": "130",
      • "id": "Disassemble Kits-US1",
      • "href": "/objects/inventory-control/stockable-kit-document/130"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a stockable kit document
post/objects/inventory-control/stockable-kit-document
Creates a new stockable kit document.



Permissions and other requirements



SubscriptionInventory


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View, Add Inventory documents







SecurityOAuth2 
Request 
Request Body schema: application/json
required
transactionDate
required
string <date> 
Date that the transaction occurred.


 
 Example:  "2024-01-01"
required
object
Transaction definition associated with this transaction.


 
key
string
Unique key for the transaction definition.


 
 Example:  "41"
id
string
Name for the transaction definition.


 
 Example:  "Build Kits"
updatesInventory
string
If the transaction updates inventory, indicates whether quantity, value, or both are updated.


 Enum: "no" "quantity" "quantityAndValue" "value"  
 Example:  "quantityAndValue"
increaseOrDecreaseInventory
string
If the transaction updates inventory, indicates whether it increases or decreases inventory.


 Enum: "decrease" "increase"  
 Example:  "increase"
documentNumber
string
If a numbering sequence is not configured for Inventory Control documents, you must specify a document number.


 
 Example:  "BldKit-000906-doc"
state
string
 Default:  "draft"
Status of the transaction.


 Enum: "converted" "draft" "inProgress" "pending"  
 Example:  "pending"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
referenceNumber
string
User-assigned reference number for the stockable kit document.


 
 Example:  "BUILD-1002"
memo
string
Stockable kit document notes.


 
 Example:  "2024-01-10 assembly"
object
Exchange rate details used to calculate the base amount.


 
date
string <date> 
Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid.


 
 Example:  "2024-01-23"
rate
string <decimal-precision-4> 
Exchange rate used to calculate the base amount from the transaction amount.


 
 Example:  "1.0789"
typeId
string
Exchange rate type used to calculate the base amount from the transaction amount.


 
 Example:  "1"
typeName
string
The name of exchange rate type.


 
 Example:  "Intacct Daily Rate"
lastPrintedDate
string or null <date> 
Date that the document was last printed.


 
 Example:  "24-01-15"
baseCurrency
string
Base currency for the transaction.


 
 Example:  "USD"
txnCurrency
string
Currency used for the transaction.


 
 Example:  "USD"
object
The source transaction from which the inventory document was created.


 
key
string
Unique key for the source document.


 
 Example:  "23"
id
string
Unique ID for the source document.


 
 Example:  "Build Kits-BldKit-000906-doc"
object
Supporting document for this inventory transaction.


 
key
string
Unique key for the attachment.


 
 Example:  "23"
id
string
Unique ID for the attachment.


 
 Example:  "Build Kits attachment"
object
The last user who printed this document


 
key
string
Unique key for the user.


 
 Example:  "23"
id
string
Unique name of the user.


 
 Example:  "John Smith"
Array of objects
Lines of the stockable kit document.


 
 Array 
unitQuantity
required
string <decimal-precision-10> 
Unit quantity associated with the line item.


 
 Example:  "100"
memo
string
Text to appear on the printed document for the line item.


 
 Example:  "Bicycle wheels"
lineDescription
string
Description of the line item.


 
 Example:  "Bicycle wheels 0112"
object
The unit of measure for the line item.


 
quantity
string <decimal-precision-10> 
Base unit quantity associated with the line item.


 
 Example:  "100"
txnCurrency
string
Currency used for the line item transaction.


 
 Example:  "USD"
baseCurrency
string
Base currency for the line item transaction.


 
 Example:  "USD"
Array of objects
List of warehouse inventory details including serial number, aisle, bin, and row for the line item.


 
object
The stockable kit document that contains the line item.


 
object
 
object
The Build Kits document that has been disassembled. (Applies only to Disassemble Kits documents.)


 
object
Document line in the source Build Kits document that has been disassembled. (Applies only to Disassemble Kits documents.)


 
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Array of objects
Lines of the stockable kit document history.


 
 Array 
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "txnDefinition": {
    • "id": "Build Kits"
    },
  • "state": "pending",
  • "transactionDate": "2025-02-05",
  • "documentNumber": "SM001",
  • "referenceNumber": "REFF NUM",
  • "lines": [
    • {
      • "unitOfMeasure": {
        },
      • "unitQuantity": "1",
      • "trackingDetail": [
        ],
      • "dimensions": {
        }
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "159",
    • "id": "Build Kits-SM001",
    • "href": "/objects/inventory-control/stockable-kit-document/159"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a stockable kit document
get/objects/inventory-control/stockable-kit-document/{key}
Returns detailed information for a specified stockable kit document.



Permissions and other requirements



SubscriptionInventory


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View Inventory documents







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the stockable kit document.


 
 Example:  118
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "119",
    • "documentNumber": "BldKit-000879-doc",
    • "id": "Build Kits-BldKit-000879-doc",
    • "sourceDocument": {
      • "id": null,
      • "key": null
      },
    • "state": "pending",
    • "transactionDate": "2024-03-12",
    • "audit": {
      • "createdDateTime": "2024-03-12T20:21:07Z",
      • "createdByUser": {
        },
      • "createdBy": "1",
      • "modifiedByUser": {
        },
      • "modifiedBy": "1",
      • "modifiedDateTime": "2024-03-12T20:21:27Z"
      },
    • "referenceNumber": "ESC15738925-02-StockableKit",
    • "documentType": "Build Kits",
    • "txnDefinition": {
      • "documentType": "Build Kits",
      • "id": "Build Kits",
      • "key": "127",
      • "txnDefinitionTemplateClass": "INVOICE",
      • "updatesInventory": "quantityAndValue",
      • "increaseOrDecreaseInventory": "increase",
      • "href": "/objects/inventory-control/txn-definition::Build%20Kits/127"
      },
    • "memo": null,
    • "lineDescription": "ESC15738925-02-StockableKit",
    • "postingSummary": {
      • "id": "29",
      • "key": "29",
      • "href": "/objects/inventory-control/posting-summary/29"
      },
    • "journalEntry": {
      • "id": "1055",
      • "key": "1055",
      • "href": "/objects/inventory-control/journal-entry/1055"
      },
    • "isPrinted": false,
    • "subTotal": "0.00",
    • "total": "0.00",
    • "txnCurrency": "USD",
    • "exchangeRate": {
      • "date": "2024-03-12",
      • "rate": "1.0000",
      • "typeId": null,
      • "typeName": null
      },
    • "subtotalInTxnCurrency": "0.00",
    • "totalInTxnCurrency": "0.00",
    • "baseCurrency": "USD",
    • "lastPrintedDate": null,
    • "printedBy": {
      • "key": null,
      • "id": null
      },
    • "buildState": "built",
    • "entity": {
      • "key": null,
      • "id": null,
      • "name": null
      },
    • "lines": [
      • {
        }
      ],
    • "history": [
      • {
        }
      ],
    • "attachment": {
      • "id": null,
      • "key": null
      },
    • "href": "/objects/inventory-control/stockable-kit-document/119"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a stockable kit document
patch/objects/inventory-control/stockable-kit-document/{key}
Updates an existing stockable kit document by setting field values. Any fields not provided remain unchanged.



Permissions and other requirements



SubscriptionInventory


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View, Edit Inventory documents







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the stockable kit document.


 
 Example:  118
Request Body schema: application/json
state
string
 Default:  "draft"
Status of the transaction.


 Enum: "converted" "draft" "inProgress" "pending"  
 Example:  "pending"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
referenceNumber
string
User-assigned reference number for the stockable kit document.


 
 Example:  "BUILD-1002"
memo
string
Stockable kit document notes.


 
 Example:  "2024-01-10 assembly"
object
Exchange rate details used to calculate the base amount.


 
date
string <date> 
Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid.


 
 Example:  "2024-01-23"
rate
string <decimal-precision-4> 
Exchange rate used to calculate the base amount from the transaction amount.


 
 Example:  "1.0789"
typeId
string
Exchange rate type used to calculate the base amount from the transaction amount.


 
 Example:  "1"
typeName
string
The name of exchange rate type.


 
 Example:  "Intacct Daily Rate"
transactionDate
string <date> 
Date that the transaction occurred.


 
 Example:  "2024-01-01"
lastPrintedDate
string or null <date> 
Date that the document was last printed.


 
 Example:  "24-01-15"
baseCurrency
string
Base currency for the transaction.


 
 Example:  "USD"
txnCurrency
string
Currency used for the transaction.


 
 Example:  "USD"
object
Transaction definition associated with this transaction.


 
key
string
Unique key for the transaction definition.


 
 Example:  "41"
updatesInventory
string
If the transaction updates inventory, indicates whether quantity, value, or both are updated.


 Enum: "no" "quantity" "quantityAndValue" "value"  
 Example:  "quantityAndValue"
increaseOrDecreaseInventory
string
If the transaction updates inventory, indicates whether it increases or decreases inventory.


 Enum: "decrease" "increase"  
 Example:  "increase"
object
Supporting document for this inventory transaction.


 
key
string
Unique key for the attachment.


 
 Example:  "23"
id
string
Unique ID for the attachment.


 
 Example:  "Build Kits attachment"
object
The last user who printed this document


 
key
string
Unique key for the user.


 
 Example:  "23"
id
string
Unique name of the user.


 
 Example:  "John Smith"
Array of objects
Lines of the stockable kit document.


 
 Array 
memo
string
Text to appear on the printed document for the line item.


 
 Example:  "Bicycle wheels"
lineDescription
string
Description of the line item.


 
 Example:  "Bicycle wheels 0112"
object
The unit of measure for the line item.


 
unitQuantity
string <decimal-precision-10> 
Unit quantity associated with the line item.


 
 Example:  "100"
quantity
string <decimal-precision-10> 
Base unit quantity associated with the line item.


 
 Example:  "100"
txnCurrency
string
Currency used for the line item transaction.


 
 Example:  "USD"
baseCurrency
string
Base currency for the line item transaction.


 
 Example:  "USD"
Array of objects
List of warehouse inventory details including serial number, aisle, bin, and row for the line item.


 
object
The stockable kit document that contains the line item.


 
object
 
object
The Build Kits document that has been disassembled. (Applies only to Disassemble Kits documents.)


 
object
Document line in the source Build Kits document that has been disassembled. (Applies only to Disassemble Kits documents.)


 
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Array of objects
Lines of the stockable kit document history.


 
 Array 
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "referenceNumber": "AddNewLine-02",
  • "lines": [
    • {
      • "unitOfMeasure": {
        },
      • "unitQuantity": "1",
      • "trackingDetail": [
        ],
      • "dimensions": {
        }
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "161",
    • "id": "Build Kits-SM002",
    • "href": "/objects/inventory-control/stockable-kit-document/161"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a stockable kit document
delete/objects/inventory-control/stockable-kit-document/{key}
Deletes a stockable kit document.



Permissions and other requirements



SubscriptionInventory


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View, Delete Inventory documents







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the stockable kit document.


 
 Example:  118
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 stockable kit documents
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:  "inventory-control/stockable-kit-document"
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 has (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 result set, 4000 maximum.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "inventory-control/stockable-kit-document",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "id",
    • "href",
    • "state",
    • "transactionDate",
    • "txnDefinition.increaseOrDecreaseInventory",
    • "buildState"
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "id": "Disassemble Kits-DisKit-000071-doc",
      • "href": "/objects/inventory-control/stockable-kit-document/1283",
      • "state": "pending",
      • "transactionDate": "2024-07-13",
      • "txnDefinition.increaseOrDecreaseInventory": "decrease",
      • "buildState": "disassembled"
      },
    • {
      • "id": "Disassemble Kits-DisKit-000260-doc",
      • "href": "/objects/inventory-control/stockable-kit-document/2236",
      • "state": "pending",
      • "transactionDate": "2024-01-05",
      • "txnDefinition.increaseOrDecreaseInventory": "decrease",
      • "buildState": "disassembled"
      },
    • {
      • "id": "Disassemble Kits-DisKit-000261-doc",
      • "href": "/objects/inventory-control/stockable-kit-document/2238",
      • "state": "pending",
      • "transactionDate": "2024-05-10",
      • "txnDefinition.increaseOrDecreaseInventory": "decrease",
      • "buildState": "disassembled"
      },
    • {
      • "id": "Disassemble Kits-DisKit-000262-doc",
      • "href": "/objects/inventory-control/stockable-kit-document/2240",
      • "state": "pending",
      • "transactionDate": "2024-02-25",
      • "txnDefinition.increaseOrDecreaseInventory": "decrease",
      • "buildState": "disassembled"
      }
    ],
  • "ia::meta": {
    • "totalCount": 4,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}