openapi: 3.0.0
info:
title: Inventory Control
description: >
Use Inventory Control to track your merchandise and maintain and analyze
your inventory.
This subscription is fully integrated with the other Sage Intacct
subscriptions, particularly Purchasing and Order Entry.
version: '1.0'
servers:
- url: https://api.intacct.com/ia/api/v1-beta2
description: Open Beta
tags:
- name: Aisles
description: >-
An aisle is one of four optional attributes (zone, aisle, row, and bin
face) you can assign to a bin to make it easier to find in the warehouse.
x-displayName: Aisles
- name: Bin faces
description: >-
A bin face is one of four optional attributes (zone, aisle, row, and bin
face) you can assign to a bin to make it easier to find within the
warehouse.
x-displayName: Bin faces
- name: Bin sizes
description: >-
A bin size in an attribute you can assign to a bin to help determine
whether the bin is suitable for storing certain items.
x-displayName: Bin sizes
- name: Bins
description: >-
A bin identifies a specific location within a warehouse where items are or
can be stored. Bins make it easier to find items during transaction
processing.
x-displayName: Bins
- name: Items
description: >
Items are goods, services, or kits that you purchase from vendors or sell
to customers. Items are used in Inventory Control, Order Entry, and
Purchasing. The type of an item (`itemType`) affects other item
parameters.
Possible item types are:
* `inventory` - Items that will be available in inventory, sales, and
purchasing transactions.
* `nonInventory` - Items that will be available in both sales and
purchasing transactions or contracts.
* `purchaseOnlyNonInventory` - Items that will only be available in
purchasing transactions or contract expenses.
* `salesOnlyNonInventory` - Items that will only be available in sales
transactions or contracts.
* `kit` - The parent item of a (non-stockable) kit (which is assembled
from other items at the time of the order). This type is only available if
Kits is enabled in either Order Entry or Inventory Control.
* `stockableKit` - The parent item of a stockable kit (which is assembled
from other items and stored before order). This type is only available if
Stockable kits is enabled in Inventory Control.
x-displayName: Items
- name: Item GL groups
description: >-
Item GL groups are used to organize transaction definitions for posting to
the general ledger.
x-displayName: Item GL groups
- name: Item warehouse inventory information
description: >-
Warehouse inventory information is used with Inventory and Stockable Kit
items. Sage Intacct uses the information from these records in the
Inventory Reorders report.
x-displayName: Item warehouse inventory information
- name: Rows
description: >-
A row is one of four optional attributes (zone, aisle, row, and bin face)
you can assign to a bin to make it easier to find in the warehouse.
x-displayName: Rows
- name: Unit of measure groups
description: >
Unit of measure group are provided for items handled under Inventory
Control, Order Entry, and Purchasing. Intacct places related units of
measure into groups.
For example, the Count group includes related units of each, pair, and
dozen.
The unit of measure (UOM) groups that are provided with Sage Intacct
cannot be deleted. Use the Sage Intacct UOM groups as is and create custom
UOM groups.
For more information, see [About unit of measure
groups](https://www.intacct.com/ia/docs/en_US/help_action/Order_Entry/Setting_up_Order_Entry/UOM_groups/about-UOM-groups-OE.htm).
x-displayName: Unit of measure groups
- name: Units of measure
description: >
Details for a unit of measure included in a unit of measure group. Sage
Intacct places related units of measure into groups.
For example, the Count group includes related units of measure such as
each, pair, and dozen. For more information, see [About unit of measure
groups](https://www.intacct.com/ia/docs/en_US/help_action/Order_Entry/Setting_up_Order_Entry/UOM_groups/about-UOM-groups-OE.htm).
x-displayName: Units of measure
- name: Warehouses
description: >
A warehouse can be an actual warehouse, a store, or any type of stocking
location or site that requires inventory tracking and management.
Warehouse also serves as a dimension that can be set on transactions to
expand report functionality and insight. See [Define
warehouses](https://www.intacct.com/ia/docs/en_US/help_action/Inventory_Control/Setting_up_Inventory_Control/Warehouses/warehouses.htm)
for more information.
x-displayName: Warehouses
- name: Zones
description: >-
A zone is one of four optional attributes (zone, aisle, row, and bin face)
you can assign to a bin to make it easier to find in the warehouse.
x-displayName: Zones
- name: Product lines
description: >-
Product lines are groups of related products. Using product lines makes it
easier to update prices and track inventory movement. See [Product
lines](https://www.intacct.com/ia/docs/en_US/help_action/Order_Entry/Setting_up_Order_Entry/product-lines-OE.htm)
for more information.
x-displayName: Product lines
- name: Item cross references
description: >
An item cross reference associates an inventory item with a specific
customer or vendor, or with another inventory item.
When an inventory item is associated with a customer or vendor (known as
an external cross-reference), the customer or vendor can provide their own
identifiers for inventory items that can be used in transactions.
When an inventory item is associated with another inventory item (known as
an internal cross-reference), you can provide an alternate item to
substitute, upgrade, downgrade, or complement that item in Order Entry
transactions in Sage Intacct. For more information, see [Item cross
references](https://www.intacct.com/ia/docs/en_US/help_action/Order_Entry/Setting_up_Order_Entry/Items/item-cross-references-OE.htm)
in the Sage Intacct Help Center.
x-displayName: Item cross references
- name: Item landed costs
description: >
A landed cost item is a non-inventory item that represents a landed cost
expense, such as freight, insurance, customs duties, or handling fees.
This object is valid when Inventory Control is configured to enable landed
costs.
For more information, see [Landed costs
overview](https://www.intacct.com/ia/docs/en_US/help_action/Purchasing/Using_Purchasing/Landed_costs/landed-costs-overview.htm)
in the Sage Intacct Help Center.
x-displayName: Item landed costs
- name: Item vendors
description: >-
This object provides details about an item that can be purchased from a
particular vendor.
x-displayName: Item vendors
- name: Item warehouse standard costs
description: >-
Standard cost for Item for warehouse. You can record differnet standard
costs for different date ranges for item and warehouse combinations.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.
x-displayName: Item warehouse standard costs
- name: Item warehouse vendors
description: >-
Use this object to specify the vendor information you want to use in the
replenishment calculations for the item in this warehouse.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.
x-displayName: Item warehouse vendors
- name: Kit components
description: >-
Components are the items of a kit, common combination of items to be
ordered and invoiced as a single item, simplifying data entry. You can
select inventory items, non-inventory items, and/or other kits.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.
x-displayName: Kit components
- name: Lot categories
description: >-
Lot categories let you group a specific set of items that have something
in common.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.
x-displayName: Lot categories
- name: Inventory price lists
description: >-
An inventory price list is a container for price list entries.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.
x-displayName: Inventory price lists
- name: Inventory price schedules
description: >-
Inventory price schedules are pricing groups that can be assigned to one
or more customers. For example, to give discounts to a customer, assign
the customer to a price schedule associated with a special price list that
contains discounts on certain items.
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.
x-displayName: Inventory price schedules
- name: Inventory totals
description: >
Use inventory totals to keep track of the items on hand that are available
for sale. Sage Intacct is preconfigured with nine inventory totals for
tracking inventory that's damaged, in transit, on hand, on hold, on order,
requisitioned, or is scrap and spoilage. You can also create your own
inventory totals as needed.
An inventory total can be assigned to a transaction definition so that the
specified total is affected when a transaction with that definition
template is saved. For more information and a detailed example, see
[Inventory
totals](https://www.intacct.com/ia/docs/en_US/help_action/Inventory_Control/Setting_up_Inventory_Control/Inventory_totals/inventory-totals.htm)
in the Sage Intacct Help Center.
x-displayName: Inventory totals
- name: Inventory transaction definitions
description: >-
An inventory transaction definition includes the accounting rules,
workflow settings, security settings, and other characteristics for a
transaction.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.
x-displayName: Inventory transaction definitions
- name: Inventory transaction definition sources
description: >-
Inventory transaction definition source document for an inventory
transaction. This object holds all the source inventory transaction
definitions that it can be converted from.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.
x-displayName: Inventory transaction definition sources
- name: Inventory transaction definition COGS GL details
description: >-
This object holds the inventory account mapping for inventory transaction
definitions that are configured to post cost of goods (COGS) adjustments
to the General Ledger. For example, if a transaction definition is for a
cost of goods (COG) adjustment that accounts for spoilage, you might debit
the spoilage account and credit the Inventory account.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.
x-displayName: Inventory transaction definition COGS GL details
- name: Inventory transaction definition entity details
description: >-
This object contains details about which entities can create transactions
and also includes settings for each entity, such as numbering sequences
and document templates. These details and settings are applicable to
transaction definitions that are configured to create transactions at the
"Top level or entity" or "Entity only" level.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.
x-displayName: Inventory transaction definition entity details
- name: Inventory transaction definition subtotal details
description: >-
Subtotal detail for Inventory transaction definition will hold the type of
subtotal that are supported by each Transaction definition.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.
x-displayName: Inventory transaction definition subtotal details
- name: Inventory transaction definition total details
description: >-
Inventory transaction definition total details will allow users to track
the inventory running total (i.e. ONHAND, ONORDER, etc) that will be
affected by the inventory transaction definition.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.
x-displayName: Inventory transaction definition total details
- name: Warehouse groups
description: >-
A warehouse group categorizes warehouse dimension records, mainly for the
purpose of structuring financial reporting.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.
x-displayName: Warehouse groups
- name: Inventory cycles
description: >-
Create and use inventory cycles to keep track of when to take physical
inventory.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.
x-displayName: Inventory cycles
- name: Inventory Control documents
description: >-
An Inventory Control document contains information about Inventory Control
transactionsPlease 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.
x-displayName: Inventory Control documents
- name: Inventory documents
x-displayName: Inventory documents
- name: Inventory Control document lines
description: >-
Line information for Inventory transactions including opening balances and
adjustments.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.
x-displayName: Inventory Control document lines
- name: Inventory document subtotals
description: >-
Details of Subtotals, taxes, discounts, charges etc for the
transaction.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.
x-displayName: Inventory document subtotals
- name: Item groups
description: >-
An item group categorizes item dimension records, mainly for the purpose
of structuring financial reporting.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.
x-displayName: Item groups
paths:
/objects/inventory-control/aisle:
get:
summary: List aisles
description: >+
Returns up to 100 object references from the collection with a key, ID,
and link for each aisle. 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
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business, CRM, Employee,
Warehouse |
|---|
| Permissions | List, View Aisles |
|---|
tags:
- Aisles
operationId: list-inventory-control-aisle
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of aisle objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List aisles:
value:
ia::result:
- key: '145'
id: A12
href: /objects/inventory-control/aisle/145
- key: '146'
id: A14
href: /objects/inventory-control/aisle/146
- key: '147'
id: A16
href: /objects/inventory-control/aisle/147
ia::meta:
totalCount: 3
start: 1
pageSize: 100
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create an aisle
description: >+
Creates a new aisle.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Add Aisles |
|---|
tags:
- Aisles
operationId: create-inventory-control-aisle
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-aisle'
- $ref: '#/components/schemas/inventory-control-aisleRequiredProperties'
examples:
Create an aisle:
value:
id: A12
description: Aisle 12 Dishwashers
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New aisle
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Create an aisle:
value:
ia::result:
key: '145'
id: AD12
href: /objects/inventory-control/aisle/145
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/aisle/{key}:
parameters:
- schema:
type: string
example: '145'
name: key
in: path
required: true
description: System-assigned key for the aisle.
get:
summary: Get an aisle
description: >+
Returns detailed information for a specified aisle.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business, CRM, Employee,
Warehouse |
|---|
| Permissions | List, View Aisles |
|---|
tags:
- Aisles
operationId: get-inventory-control-aisle-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the aisle
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-aisle'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get an aisle:
value:
ia::result:
key: '145'
id: A12
description: Aisle 12 of dishwashers
audit:
createdDateTime: '2021-05-07T01:15:23Z'
modifiedDateTime: '2021-05-07T01:15:23Z'
createdBy: '13'
modifiedBy: '13'
href: /objects/inventory-control/aisle/145
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update an aisle
description: >+
Updates an existing aisle by setting field values. Any fields not
provided remain unchanged.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Edit Aisles |
|---|
tags:
- Aisles
operationId: update-inventory-control-aisle-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-aisle'
- type: object
properties:
id:
readOnly: true
examples:
Update a single value:
value:
description: Aisle 1 dishwashers
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated aisle
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated aisle:
value:
ia::result:
key: '145'
id: A12
href: /objects/inventory-control/aisle/145
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete an aisle
description: >+
Deletes an aisle. You can delete an aisle if it is not being used and
you no longer need it. Deleted aisles cannot be recovered.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Delete
Aisles |
|---|
tags:
- Aisles
operationId: delete-inventory-control-aisle-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/bin-face:
get:
summary: List bin faces
description: >+
Returns up to 100 object references from the collection with a key, ID,
and link for each bin face. 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
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business, CRM, Employee,
Warehouse |
|---|
| Permissions | List, View Bin Faces |
|---|
tags:
- Bin faces
operationId: list-inventory-control-bin-face
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of bin-face objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List bin faces:
value:
ia::result:
- key: '12'
id: BF11
href: /objects/inventory-control/bin-face/12
- key: '14'
id: BF22
href: /objects/inventory-control/bin-face/14
ia::meta:
totalCount: 2
start: 1
pageSize: 100
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create a bin face
description: >+
Creates a new bin face.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Add Bin
Faces |
|---|
tags:
- Bin faces
operationId: create-inventory-control-bin-face
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-bin-face'
- $ref: '#/components/schemas/inventory-control-bin-faceRequiredProperties'
examples:
Create a bin face:
value:
id: BF2
description: Bin Face 2
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New bin-face
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Create a bin face:
value:
ia::result:
key: '22'
id: BF2
href: /objects/inventory-control/bin-face/22
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/bin-face/{key}:
parameters:
- schema:
type: string
example: '1232'
name: key
in: path
required: true
description: System-assigned key for the bin-face.
get:
summary: Get a bin face
description: >+
Returns detailed information for a specified bin face.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business, CRM, Employee,
Warehouse |
|---|
| Permissions | List, View Bin Faces |
|---|
tags:
- Bin faces
operationId: get-inventory-control-bin-face-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the bin-face
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-bin-face'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get a bin face:
value:
ia::result:
key: '1232'
id: BF123
description: Bin Face 123
audit:
createdDateTime: '2021-05-07T01:15:23Z'
modifiedDateTime: '2021-05-07T01:15:23Z'
createdBy: '13'
modifiedBy: '13'
href: /objects/inventory-control/bin-face/1232
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update a bin face
description: >+
Updates an existing bin face by setting field values. Any fields not
provided remain unchanged.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Edit Bin
Faces |
|---|
tags:
- Bin faces
operationId: update-inventory-control-bin-face-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-bin-face'
- type: object
properties:
id:
readOnly: true
examples:
Update a single value:
value:
description: W1 G1 Bestsellers
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated bin-face
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated bin face:
value:
ia::result:
key: '1232'
id: BF123
href: /objects/inventory-control/bin-face/1232
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete a bin face
description: >+
Deletes a bin face.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Delete Bin
Faces |
|---|
tags:
- Bin faces
operationId: delete-inventory-control-bin-face-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/bin-size:
get:
summary: List all bin sizes
description: >+
Returns up to 100 object references from the collection with a key, ID,
and link for each bin size. 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
| Subscription | Inventory Control |
|---|
| Configuration | null |
|---|
| User ype | Business, CRM, Employee,
Warehouse |
|---|
| Permissions | List, View Bin Sizes |
|---|
tags:
- Bin sizes
operationId: list-inventory-control-bin-size
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of bin-size objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List bin sizes:
value:
ia::result:
- key: '1322'
id: BS14
href: /objects/inventory-control/bin-size/1322
- key: '1323'
id: BS13
href: /objects/inventory-control/bin-size/1323
ia::meta:
totalCount: 2
start: 1
pageSize: 100
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create a bin size
description: >+
Creates a new bin size.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Add Bin
Sizes |
|---|
tags:
- Bin sizes
operationId: create-inventory-control-bin-size
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-bin-size'
- $ref: '#/components/schemas/inventory-control-bin-sizeRequiredProperties'
examples:
Create a bin size:
value:
id: BS12
description: Bin size 12
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New bin-size
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New bin size:
value:
ia::result:
key: '1323'
id: BS12
href: /objects/inventory-control/bin-size/1323
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/bin-size/{key}:
parameters:
- schema:
type: string
example: '1324'
name: key
in: path
required: true
description: System-assigned key for the bin size.
get:
summary: Get a bin size
description: >+
Returns detailed information for a specified bin size.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business, CRM, Employee,
Warehouse |
|---|
| Permissions | List, View Bin Sizes |
|---|
tags:
- Bin sizes
operationId: get-inventory-control-bin-size-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the bin-size
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-bin-size'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get a bin size:
value:
ia::result:
key: '1324'
id: BS132
description: Bin size 132
audit:
createdDateTime: '2021-05-07T01:15:23Z'
modifiedDateTime: '2021-05-07T01:15:23Z'
createdBy: '13'
modifiedBy: '13'
href: /objects/inventory-control/bin-size/1324
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update a bin size
description: >+
Updates an existing bin size by setting field values. Any fields not
provided remain unchanged.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Edit Bin
Sizes |
|---|
tags:
- Bin sizes
operationId: update-inventory-control-bin-size-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-bin-size'
- type: object
properties:
id:
readOnly: true
examples:
Update a single value:
value:
description: Size 1 2024 dimensions
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated bin-size
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated bin size:
value:
ia::result:
key: '1324'
id: BS132
href: /objects/inventory-control/bin-size/1324
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete a bin size
description: >+
Deletes a bin size. You can delete a bin size if it is not being used
and you no longer need it.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Delete Bin
Sizes |
|---|
tags:
- Bin sizes
operationId: delete-inventory-control-bin-size-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/bin:
get:
summary: List bins
description: >+
Returns up to 100 objects from the collection with a key, ID, and link
for each bin. 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
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business, CRM, Employee,
Warehouse |
|---|
| Permissions | List, View Bins |
|---|
tags:
- Bins
operationId: list-inventory-control-bin
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of bin objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List bins:
value:
ia::result:
- key: '12'
id: Z4-A2-R3a-BF2-B10
href: /objects/inventory-control/bin/122
- key: '32'
id: Z4-A2-R3a-BF2-B11
href: /objects/inventory-control/bin/132
- key: '44'
id: Z4-A2-R3a-BF2-B12
href: /objects/inventory-control/bin/44
- key: '13'
id: Z4-A2-R3a-BF2-B13
href: /objects/inventory-control/bin/13
ia::meta:
totalCount: 4
start: 1
pageSize: 100
next: 2
previous: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create a bin
description: >+
Creates a new bin.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Add Bins |
|---|
tags:
- Bins
operationId: create-inventory-control-bin
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-bin'
- $ref: '#/components/schemas/inventory-control-binRequiredProperties'
examples:
Create a bin:
value:
id: Z4-A2-R3a-BF2-B10
description: Bin Adapters 2
sequenceNumber: '4432'
isPortable: true
warehouse:
id: WA2
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New bin
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New bin:
value:
ia::result:
key: '111'
id: Z4-A2-R3a-BF2-B10
href: /objects/inventory-control/bin/111
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/bin/{key}:
parameters:
- name: key
in: path
required: true
description: System-assigned key for the bin.
schema:
type: string
example: '111'
get:
summary: Get a bin
description: >+
Returns detailed information for a specified bin.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business, CRM, Employee,
Warehouse |
|---|
| Permissions | List, View Bins |
|---|
tags:
- Bins
operationId: get-inventory-control-bin-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the bin
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-bin'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get a bin:
value:
ia::result:
key: '111'
id: Z4-A2-R3a-BF2-B10
description: Bin of adapters 2
warehouse:
key: '2'
id: WA2
href: /objects/inventory-control/warehouse/2
aisle:
key: '13'
id: A2
href: /objects/inventory-control/aisle/13
row:
key: '23'
id: R3a
href: /objects/inventory-control/row/23
zone:
key: '12'
id: Z4
href: /objects/inventory-control/zone/12
binFace:
key: '3'
id: BF2
href: /objects/inventory-control/bin-face/3
binSize:
key: '5'
id: B10
href: /objects/inventory-control/bin-size/5
href: /objects/inventory-control/bin/111
sequenceNumber: '1221'
status: active
isPortable: false
audit:
createdDateTime: '2021-05-07T21:30:03Z'
modifiedDateTime: '2021-05-07T21:30:03Z'
createdBy: '13'
modifiedBy: '13'
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update a bin
description: >+
Updates an existing bin by setting field values. Any fields not provided
remain unchanged.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Edit Bins |
|---|
tags:
- Bins
operationId: update-inventory-control-bin-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-bin'
examples:
Update a single value:
value:
description: Bin of adapters 3
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated bin
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated bin:
value:
ia::result:
key: '2'
id: Z4-A2-R3a-BF2-B10
href: /objects/inventory-control/bin/2
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete a bin
description: >+
Deletes a bin. You can delete a bin if it is not being used and you no
longer need it.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Delete Bins |
|---|
tags:
- Bins
operationId: delete-inventory-control-bin-key
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/error-response'
security:
- OAuth2: []
/objects/inventory-control/item:
get:
summary: List items
description: >-
Returns up to 100 object references from the collection with a key, ID,
and link for each item. This operation is mostly for use in testing; use
query to find objects that meet certain criteria and to specify
properties that are returned.
tags:
- Items
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of item objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List items:
value:
ia::result:
- key: '79'
id: FVP-020
href: /objects/inventory-control/item/79
- key: '73'
id: FVP-016
href: /objects/inventory-control/item/73
- key: '70'
id: FVP-014
href: /objects/inventory-control/item/70
ia::meta:
totalCount: 2
start: 1
pageSize: 100
'400':
$ref: '#/components/responses/400error'
operationId: list-inventory-control-item
security:
- OAuth2: []
post:
summary: Create an item
description: Creates a new item.
tags:
- Items
operationId: create-inventory-control-item
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New item
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New item:
value:
ia::result:
key: '2458'
id: Dell_15_6_XPS_15_Multi_Touch
href: /objects/inventory-control/item/104
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-item'
- $ref: '#/components/schemas/inventory-control-itemRequiredProperties'
examples:
Create an item:
value:
id: Dell_15_6_XPS_15_Multi_Touch
name: Dell 15.6 XPS 15 Multi-Touch Laptop (Platinum Silver)
status: active
description: Dell 15.6 XPS 15 Multi-Touch Laptop (Platinum Silver)
costMethod: standard
notes: Dell 15.6 XPS 15 Multi-Touch Laptop (Platinum Silver)
itemType: inventory
productLine:
id: '2'
kitRevenuePosting: null
substituteItemId: ''
inventory:
shippingWeight: 120
glGroup:
id: Auto GL Group
sales:
isTaxable: true
basePrice: '1300'
taxGroup:
id: Goods Standard Rate
taxSolution:
id: United Kingdom - VAT
isAvailableForDropShip: false
isAvailableForBuyToOrder: false
allowMultipleTaxGroups: false
purchasing:
standardCost: '1200'
unitOfMeasure:
id: Count
precision:
inventoryPrecision: 10
purchasingPrecision: 10
salesPrecision: 10
upc: '23342'
tracking:
enableSerialNo: true
serialMask: ''
enableLotCategory: false
lotCategory: ''
enableBins: false
enableExpiration: false
replenishment:
enableReplenishment: true
replenishmentMethod: reorderPoint
unitOfMeasureDefault: Each
reorderPoint: 1
safetyStock: 1
reorderQuantity: 1
maximumOrderQuantity: 10
measurements:
weightUnitOfMeasure:
id: Grams
netWeight: 12
lengthWidthHeightUnitOfMeasure:
id: Centimeters
length: 12.4554
width: 12
height: 12
thicknessUnitOfMeasure:
id: Centimeters
thickness: 12
minimumThickness: 12
maximumThickness: 13
areaUnitOfMeasure:
id: Square Inch
area: 12
volumeUnitOfMeasure:
id: Cubic Centimeters
volume: 22
diameterUnitOfMeasure:
id: Centimeters
innerDiameter: 12
outerDiameter: 12
durometerUnitOfMeasure: '22'
densityUnitOfMeasure: grams per cubic centimeter
density: 22
itemDetails:
universalProductCode: 123456789123
internationalArticleNumber: 1234567891234
isSafetyItem: true
isRestrictedItem: false
isCompliantItem: false
condition: Good
engineeringAlert: Verification of Item
specification1: Dell 15.6 XPS 15
isApprovedByEngineering: true
isApprovedByQualityControl: true
isApprovedBySales: true
primaryCountryOfOrigin: USA
contractTerm:
periodsMeasuredIn: weeks
numberOfPeriods: 99
isProratedPricingAllowed: false
defaultRenewalTemplate:
id: SUBInvoiceSameAsOriginalPrcie
commercial:
brand: Dell Inspiron
subBrand: Dell 15 inch
category: Dell 15.6 XPS 15
subCategory: Dell 15.6 XPS 15
catalogReference: Dell 15.6 XPS 15 Multi
color: Platinum Silver
size1: '12'
size2: '12'
isGiftCard: true
isWebEnabled: true
webName: Dell Inspiration 15 inch LED
webShortDiscription: Dell Inspiration 15 inch LED
webLongDescription: Dell 15.6 XPS 15 Multi-Touch Laptop (Platinum Silver)
defaultConversionType: quantity
enableFulfillment: false
itemVendor:
- vendor:
key: '12'
stockNumber: '#5678901234'
leadTime: 15
demandForecastDuringLeadTime: 5
economicalOrderQuantity: 10
vendorMinimumOrderQuantity: 10
isPreferredVendor: true
warehouseInfo:
- warehouse:
key: '2'
storageArea: Bella
economicOrderQuantity: 10
reorderPoint: 1
reorderQuantity: 10
minOrderQuantity: 10
maxOrderQuantity: 100
maximumStock: 300
minimumStock: 50
safetyStock: 20
replenishmentMethod: reorderPoint
enableReplenishment: false
landedCost:
enableLandedCost: true
security:
- OAuth2: []
/objects/inventory-control/item/{key}:
parameters:
- schema:
type: string
name: key
in: path
required: true
description: System-assigned unique key for the item.
get:
summary: Get an item
description: Returns detailed information for a specified item.
tags:
- Items
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the item
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-item'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get an item:
value:
ia::result:
key: '2458'
id: Dell_15_6_XPS_15_Multi_Touch_1
status: active
isItemEnabledForMRR: false
name: Dell 15.6 XPS 15 Multi-Touch Laptop (Platinum Silver)
description: >-
12th Gen Core™ i3-1215U (10 MB cache, 6 cores, 8
threads, up to 4.40 GHz Turbo)
poDescription: >-
XPS 12th Gen Core™ i3-1215U (10 MB cache, 6 cores, 8
threads, up to 4.40 GHz Turbo)
soDescription: >-
XPS 12th Gen Core™ i3-1215U (10 MB cache, 6 cores, 8
threads, up to 4.40 GHz Turbo)
productLine:
id: '2'
key: '2'
href: /objects/inventory-control/product-line/2
contractDefault:
billingTemplate:
key: '8'
id: 100_Advance_One_time
revRecTemplate1:
key: '6'
id: Daily_Rate_Auto
href: /objects/contracts/revenue-template/6
revRecTemplate2:
key: '6'
id: Daily_Rate_Auto
href: /objects/contracts/revenue-template/6
expenseTemplate1:
key: '1'
id: Exp_Daily_Auto
href: /objects/contracts/expense-template/1
expenseTemplate2:
key: '1'
id: Exp_Daily_Auto
href: /objects/contracts/expense-template/1
isDefaultBundle: false
contractFairValueCategory:
key: '6'
id: Miscellaneous on demand services
defaultContractDeliveryStatus: delivered
defaultContractDeferralStatus: deferRevenueUntilItemIsDelivered
substituteItemId: ''
inventory:
shippingWeight: 120
glGroup:
incomeGLAccount: '1300'
expenseGLAccount: '1200'
inventoryGLAccount: '1500'
cogsGLAccount: '1200'
arGLAccountNumber: '1400'
apGLAccountNumber: '1100'
deferredRevenueGLAccountNumber: '1250'
defaultRevenueRecognitionTemplate: ''
id: Auto GL Group
autoPrintLabel: false
dateLastSold: '2023-12-15'
dateLastReceived: '2023-12-16'
sales:
isTaxable: true
taxGroup:
id: Goods Standard Rate
key: '6'
href: /objects/tax/item-tax-group/19
taxSolution:
id: United Kingdom - VAT
key: '3'
href: /objects/tax/tax-solution/3
isAvailableForDropShip: false
isAvailableForBuyToOrder: false
basePrice: '1300'
allowMultiPleTaxGroups: false
costMethod: standard
purchasing:
standardCost: '1200'
unitOfMeasureGroup:
id: Count
key: '1'
href: /objects/inventory-control/unit-of-measure-group/1
notes: Dell 15.6 XPS 15 Multi-Touch Laptop (Platinum Silver)
precision:
inventoryPrecision: 10
purchasingPrecision: 10
salesPrecision: 10
upc: '2'
itemType: inventory
tracking:
enableSerialNo: true
serialMask: ''
enableLotCategory: false
lotCategory: ''
enableBins: false
enableExpiration: false
kitRevenuePosting: null
kitRevenuePrinting: null
vsoeCategory: productSpecified
vsoeDefaultDeliveryStatus: delivered
vsoeDefaultDeferralStatus: deferUntilItemIsDelivered
contractTerm:
isStartDateAndEndDateEnabled: false
periodsMeasuredIn: weeks
numberOfPeriods: 99
isProratedPricingAllowed: false
defaultRenewalTemplate:
id: SUBInvoiceSameAsOriginalPrcie
key: '18'
landedCost:
enableLandedCost: true
audit:
createdDateTime: '2023-12-15T10:53:10Z'
modifiedDateTime: '2023-12-15T10:53:10Z'
createdBy: '1'
modifiedBy: '1'
quantityOnOrder: '2'
quantityOnHand: '2'
quantityOnHold: '1'
quantityAllocated: '0'
quantityReserved: '0'
quantityUncommitted: '0'
quantityInTransit: '0'
replenishment:
enableReplenishment: true
replenishmentMethod: reorderPoint
unitOfMeasureDefault: Each
reorderPoint: 1
safetyStock: 1
reorderQuantity: 1
maximumOrderQuantity: 10
measurements:
weightUnitOfMeasure:
id: Grams
key: '15'
href: /objects/inventory-control/unit-of-measure/15
netWeight: 500
lengthWidthHeightUnitOfMeasure:
id: inch
key: '8'
href: /objects/inventory-control/unit-of-measure/8
length: 12.4554
width: 12
height: 12
thicknessUnitOfMeasure:
id: inch
key: '8'
href: /objects/inventory-control/unit-of-measure/8
thickness: 2
minimumThickness: 1
maximumThickness: 3
areaUnitOfMeasure:
id: Square Inch
key: '37'
href: /objects/inventory-control/unit-of-measure/37
area: 12
volumeUnitOfMeasure:
id: Cubic Centimeters
key: '28'
href: /objects/inventory-control/unit-of-measure/28
volume: 22
diameterUnitOfMeasure:
id: inch
key: '8'
href: /objects/inventory-control/unit-of-measure/8
innerDiameter: 15
outerDiameter: 16
durometerUnitOfMeasure: '22'
densityUnitOfMeasure: grams per cubic centimeter
density: 22
itemDetails:
universalProductCode: 123456789123
internationalArticleNumber: 1234567891234
isSafetyItem: true
isRestrictedItem: false
isCompliantItem: false
condition: Good
engineeringAlert: Verification of Item
specification1: Dell Inspiration 15 inch LED
specification2: ''
specification3: ''
isApprovedByEngineering: true
isApprovedByQualityControl: true
isApprovedBySales: true
primaryCountryOfOrigin: USA
commercial:
brand: Dell Inspiron
subBrand: Dell 15 inch
category: Dell 15.6 XPS 15
subCategory: Dell 15.6 XPS 15
catalogReference: Dell 15.6 XPS 15 Multi
color: Silver
style: 15 inch multi touch
size1: '12'
size2: '12'
isGiftCard: false
isWebEnabled: true
webName: Dell Inspiration 15 inch LED
webShortDiscription: Dell Inspiration 15 inch LED
webLongDescription: Dell Inspiration 15 inch LED
defaultConversionType: quantity
enableFulfillment: false
isEnabledForContracts: false
itemVendor:
- id: '84'
key: '84'
item:
id: Dell_15_6_XPS_15_Multi_Touch_1
key: '2458'
href: /objects/inventory-control/item/2458
vendor:
id: vendorId-1702543576--vendorId-1702543576
key: '2386'
href: /objects/accounts-payable/vendor/2386
stockNumber: '#5678901234'
leadTime: 15
demandForecastDuringLeadTime: 5
economicalOrderQuantity: 10
vendorMinimumOrderQuantity: 10
bestPrice: '1000.00'
latestPrice: '1100.00'
unitOfMeasure:
id: Each
key: '3'
href: /objects/inventory-control/unit-of-measure/3
conversionFactor: '1'
isPreferredVendor: true
href: /objects/inventory-control/item-vendor/84
warehouseInfo:
- id: '80'
key: '80'
item:
key: '2458'
id: Dell_15_6_XPS_15_Multi_Touch_1
href: /objects/inventory-control/item/2458
warehouse:
key: '2'
id: WH02
href: /objects/inventory-control/warehouse/2
storageArea: Bella
inventoryCycle:
key: ''
id: ''
standardCost: '1200.00'
lastCost: '1500.00'
averageCost: '1450.00'
reorderMethod: null
economicOrderQuantity: 10
reorderPoint: 1
reorderQuantity: 10
minOrderQuantity: 10
maxOrderQuantity: 100
maximumStock: 300
minimumStock: 50
lastSoldDate: '2024-12-01'
lastReceivedDate: '2023-12-12'
defaultBin:
id: ''
key: ''
onOrder: 2
inTransit: 0
onHand: 2
onHold: 1
reserved: 0
allocated: 0
unCommitted: 0
warehouseLocation:
key: ''
currency: ''
id: ''
safetyStock: 20
replenishmentMethod: reorderPoint
enableReplenishment: true
standardCostEntries: []
itemWarehouseVendor: []
href: '/objects/inventory-control/item-warehouse-inventory/80'
kitComponents: []
itemLandedCost:
- id: '74'
key: '74'
item:
id: Dell_15_6_XPS_15_Multi_Touch_1
key: '2458'
href: /objects/inventory-control/item/2458
distributionMethod: count
distributionMethodBaseUnit: Each
landedCostValue: '1.000000000'
active: false
href: /objects/inventory-control/item-landed-cost/74
- id: '75'
key: '75'
item:
id: Dell_15_6_XPS_15_Multi_Touch_1
key: '2458'
href: /objects/inventory-control/item/2458
distributionMethod: volume
distributionMethodBaseUnit: Teaspoon
landedCostValue: ''
active: false
href: /objects/inventory-control/item-landed-cost/75
- id: '76'
key: '76'
item:
id: Dell_15_6_XPS_15_Multi_Touch_1
key: '2458'
href: /objects/inventory-control/item/2458
distributionMethod: weight
distributionMethodBaseUnit: Ounce
landedCostValue: ''
active: false
href: /objects/inventory-control/item-landed-cost/76
href: /objects/inventory-control/item/2458
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
operationId: get-inventory-control-item-key
security:
- OAuth2: []
patch:
summary: Update an item
description: >-
Updates an existing item by setting field values. Any fields not
provided remain unchanged.
tags:
- Items
operationId: update-inventory-control-item-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated item
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated item:
value:
ia::result:
key: '2458'
id: Dell_15_6_XPS_15_Multi_Touch
href: /objects/inventory-control/item/104
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-item'
- type: object
properties:
id:
readOnly: true
costMethod:
readOnly: true
itemType:
readOnly: true
examples:
Update an item:
value:
description: >-
12th Gen Core™ i3-1215U (10 MB cache, 6 cores, 8 threads, up
to 4.40 GHz Turbo)
itemLandedCost:
- key: '74'
distributionMethod: count
landedCostValue: '1.000000000'
active: true
security:
- OAuth2: []
delete:
summary: Delete an item
description: Deletes an item.
tags:
- Items
operationId: delete-inventory-control-item-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/item-gl-group:
get:
summary: List item GL groups
description: >+
Returns up to 100 object references from the collection with a key, ID,
and link for each item GL group. 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
| Subscription | Inventory Control |
|---|
| User ype | Business, Project Manager, Employee,
Warehouse |
|---|
| Permissions | List, View Item GL
groups |
|---|
tags:
- Item GL groups
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of item GL group objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List item GL groups:
value:
ia::result:
- key: '2'
id: OS GL Group
href: /objects/inventory-control/item-gl-group/2
- key: '3'
id: Auto GL Group
href: /objects/inventory-control/item-gl-group/3
ia::meta:
totalCount: 2
start: 1
pageSize: 100
next: 101
previous: null
'400':
$ref: '#/components/responses/400error'
operationId: list-inventory-control-item-gl-group
security:
- OAuth2: []
post:
summary: Create an item GL group
description: >+
Creates a new item GL group.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| User ype | Business, Project Manager, Employee,
Warehouse |
|---|
| Permissions | Add, Edit Item GL groups |
|---|
tags:
- Item GL groups
operationId: create-inventory-control-item-gl-group
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New item-gl-group
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New item GL group:
value:
ia::result:
key: '13'
id: Stockable Kit
href: /objects/inventory-control/item-gl-group/13
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-item-gl-group'
- $ref: '#/components/schemas/inventory-control-item-gl-groupRequiredProperties'
examples:
Create an item GL group:
value:
id: Stockable Kit
deferredRevenueGLAccount:
key: '411'
id: '1501.04'
name: Expense Account
defaultRevenueRecognitionTemplate:
key: '1'
id: '100'
security:
- OAuth2: []
/objects/inventory-control/item-gl-group/{key}:
parameters:
- schema:
type: string
name: key
in: path
required: true
example: '13'
description: System-assigned key for the item GL group.
get:
summary: Get an item GL group
description: >+
Returns detailed information for a specified item GL group.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| User ype | Business, Project Manager, Employee,
Warehouse |
|---|
| Permissions | List, View Item GL
groups |
|---|
tags:
- Item GL groups
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-item-gl-group'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get an item GL group:
value:
key: '13'
id: Stockable Kit
deferredRevenueGLAccount:
key: '411'
id: '1501.04'
name: Expense Account
href: /objects/general-ledger/account/411
defaultRevenueRecognitionTemplate:
key: '1'
id: '100'
href: '/objects/accounts-receivable/revenue-recognition-template/1'
isSystemGenerated: false
href: /objects/inventory-control/item-gl-group/13
audit:
createdDateTime: '2022-04-20T16:20:00Z'
modifiedDateTime: '2022-04-20T16:20:00Z'
createdBy: '1'
modifiedBy: '95'
'400':
description: Bad Request
operationId: get-inventory-control-item-gl-group-key
security:
- OAuth2: []
patch:
summary: Update an item GL group
description: >+
Updates an existing item GL group by setting field values. Any fields
not provided remain unchanged.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| User ype | Business, Project Manager, Employee,
Warehouse |
|---|
| Permissions | Add, Edit Item GL groups |
|---|
tags:
- Item GL groups
operationId: update-inventory-control-item-gl-group-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated item-gl-group
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated item GL group:
value:
ia::result:
key: '13'
id: Stockable Kit
href: /objects/inventory-control/item-gl-group/13
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-item-gl-group'
- $ref: '#/components/schemas/inventory-control-item-gl-groupRequiredProperties'
- type: object
properties:
id:
readOnly: true
example: Stockable Kit
examples:
Update an item GL group:
value:
id: '13'
deferredRevenueGLAccount:
key: '411'
id: '1501.04'
name: Expense Account
security:
- OAuth2: []
delete:
summary: Delete an item GL group
description: >+
Deletes a item GL group. An item GL group can be deleted if it has not
been used by any transactions or assigned to any items.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| User ype | Business, Project Manager, Employee,
Warehouse |
|---|
| Permissions | Delete Item GL groups |
|---|
tags:
- Item GL groups
operationId: delete-inventory-control-item-gl-group-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/item-warehouse-inventory:
get:
summary: List item warehouse inventory information objects
description: >+
Returns a collection with a key, ID, and link for each item warehouse
inventory information object. 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
| Subscription | Inventory Control, Order Entry,
or Purchasing |
|---|
| User ype | Business, Project Manager, Employee,
Warehouse |
|---|
| Permissions | List, View Items |
|---|
tags:
- Item warehouse inventory information
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of item-warehouse-inventory objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List item warehouse information objects:
value:
ia::result:
- key: '1'
id: '1'
href: /objects/inventory-control/item-warehouse-inventory/1
- key: '2'
id: '2'
href: /objects/inventory-control/item-warehouse-inventory/2
ia::meta:
totalCount: 2
start: 1
pageSize: 100
'400':
$ref: '#/components/responses/400error'
operationId: list-inventory-control-item-warehouse-inventory
security:
- OAuth2: []
post:
summary: Create an item warehouse inventory information object
description: >+
Creates a new item warehouse inventory information object.
Permissions and other requirements
| Subscription | Inventory Control, Order Entry,
or Purchasing |
|---|
| User ype | Business, Project Manager, Employee,
Warehouse |
|---|
| Permissions | Add, Edit Items |
|---|
tags:
- Item warehouse inventory information
operationId: create-inventory-control-item-warehouse-inventory
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New item warehouse info
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Create a new item warehouse information object:
value:
key: '1'
id: '1'
href: /objects/inventory-control/item-warehouse-inventory/1
'400':
$ref: '#/components/responses/400error'
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-item-warehouse-inventory'
- $ref: '#/components/schemas/inventory-control-item-warehouse-inventoryRequiredProperties'
examples:
New item warehouse information object:
value:
id: '1'
item:
key: '9'
id: Prnt_Paper
warehouse:
key: '1'
id: WH10001
storageArea: bin
inventoryCycle:
key: '2'
id: Daily Cycle
economicOrderQuantity: 10
standardCost: '110'
lastCost: '100'
averageCost: '100'
reorderMethod: economicQuantity
reorderPoint: 121
reorderQuantity: 10
minOrderQuantity: 10
maxOrderQuantity: 100
maximumStock: 300
minimumStock: 50
lastSoldDate: '2022-04-08'
lastReceivedDate: '2022-04-10'
safetyStock: 20
replenishmentMethod: reorderPoint
enableReplenishment: true
security:
- OAuth2: []
/objects/inventory-control/item-warehouse-inventory/{key}:
parameters:
- schema:
type: string
name: key
in: path
required: true
description: >-
System-assigned unique key for the item warehouse inventory
information.
example: '1'
get:
summary: Get item warehouse inventory information
description: >+
Returns detailed information for a specified item warehouse inventory
object.
Permissions and other requirements
| Subscription | Inventory Control, Order Entry,
or Purchasing |
|---|
| User ype | Business, Project Manager, Employee,
Warehouse |
|---|
| Permissions | List, View Items |
|---|
tags:
- Item warehouse inventory information
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the item warehouse inventory
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-item-warehouse-inventory'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get warehouse inventory information:
value:
ia::result:
key: '1'
id: '1'
item:
key: '9'
id: Prnt_Paper
href: /objects/inventory-control/item/9
warehouse:
key: '1'
id: WH10001
href: /objects/inventory-control/warehouse/1
storageArea: bin
inventoryCycle:
key: '2'
id: Daily Cycle
href: /objects/inventory-control/cycle/2
economicOrderQuantity: 10
standardCost: '110'
lastCost: '100'
averageCost: '100'
reorderMethod: economicQuantity
reorderPoint: 121
reorderQuantity: 10
minOrderQuantity: 10
maxOrderQuantity: 100
maximumStock: 300
minimumStock: 50
lastSoldDate: '2022-04-08'
lastReceivedDate: '2022-04-10'
defaults:
bin:
key: '45'
id: '45'
href: /objects/inventory-control/bin/45
warehouseCurrency:
key: '3'
id: LOC-USA-0778
currency: USD
href: /objects/location-entity/3
safetyStock: 20
replenishmentMethod: reorderPoint
enableReplenishment: true
onOrder: 100
inTransit: 50
onHand: 200
onHold: 10
reserved: 0
allocated: 0
unCommitted: 0
href: /objects/inventory-control/item-warehouse-inventory/1
audit:
createdDateTime: '2014-01-08T11:28:12Z'
modifiedDateTime: '2014-01-08T11:28:12Z'
createdBy: '1'
modifiedBy: '95'
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
operationId: get-inventory-control-item-warehouse-inventory-key
security:
- OAuth2: []
patch:
summary: Update item warehouse inventory information
description: >+
Updates an existing item warehouse inventory information object by
setting field values. Any fields not provided remain unchanged.
Permissions and other requirements
| Subscription | Inventory Control, Order Entry,
or Purchasing |
|---|
| User ype | Business, Project Manager, Employee,
Warehouse |
|---|
| Permissions | Add, Edit Items |
|---|
operationId: update-inventory-control-item-warehouse-inventory-key
tags:
- Item warehouse inventory information
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated item warehouse information:
value:
ia::result:
key: '41'
id: '41'
href: /objects/inventory-control/item-warehouse-inventory/41
ia::meta:
totalCount: 1
application/xml:
schema:
type: object
properties: {}
multipart/form-data:
schema:
type: object
properties: {}
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-item-warehouse-inventory'
- type: object
properties:
id:
readOnly: true
example: 41
item:
readOnly: true
examples:
Update a single value:
value:
storageArea: Bin 5
security:
- OAuth2: []
delete:
summary: Delete item warehouse inventory information
description: >+
Deletes an item warehouse inventory information object.
Permissions and other requirements
| Subscription | Inventory Control, Order Entry,
or Purchasing |
|---|
| User ype | Business, Project Manager, Employee,
Warehouse |
|---|
| Permissions | Delete Items |
|---|
tags:
- Item warehouse inventory information
operationId: delete-inventory-control-item-warehouse-inventory-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/row:
get:
summary: List rows
description: >+
Returns up to 100 object references from the collection with a key, ID,
and link for each row. 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
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business, CRM, Employee,
Warehouse |
|---|
| Permissions | List, View Rows |
|---|
tags:
- Rows
operationId: list-inventory-control-row
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of row objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List rows:
value:
ia::result:
- key: '354'
id: R1ADW
href: /objects/inventory-control/row/354
- key: '355'
id: R1BDW
href: /objects/inventory-control/row/355
- key: '356'
id: R2ADW
href: /objects/inventory-control/row/356
ia::meta:
totalCount: 3
start: 1
pageRow: 100
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create a row
description: >+
Creates a new row.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Add Rows |
|---|
tags:
- Rows
operationId: create-inventory-control-row
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-row'
- $ref: '#/components/schemas/inventory-control-rowRequiredProperties'
examples:
Create a row:
value:
id: R3ADW
description: Row 3A Dishwashers
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New row
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Create a row:
value:
ia::result:
key: '543'
id: R3ADW
href: /objects/inventory-control/row/543
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/row/{key}:
parameters:
- schema:
type: string
example: '354'
name: key
in: path
required: true
description: System-assigned key for the row.
get:
summary: Get a row
description: >+
Returns detailed information for a specified row.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business, CRM, Employee,
Warehouse |
|---|
| Permissions | List, View Rows |
|---|
tags:
- Rows
operationId: get-inventory-control-row-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the row
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-row'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get a row:
value:
ia::result:
key: '354'
id: R3ADW
description: Row 3 A Dishwashers
audit:
createdDateTime: '2021-05-07T01:15:23Z'
modifiedDateTime: '2021-05-07T01:15:23Z'
createdBy: '13'
modifiedBy: '13'
href: /objects/inventory-control/row/354
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update a row
description: >+
Updates an existing row by setting field values. Any fields not provided
remain unchanged.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Edit Rows |
|---|
tags:
- Rows
operationId: update-inventory-control-row-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-row'
- type: object
properties:
id:
readOnly: true
examples:
Update a single value:
value:
description: Row 3A1 Dishwashers
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated row
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Update a single value:
value:
ia::result:
key: '2'
id: R3ADW
href: /objects/inventory-control/row/2
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete a row
description: >+
Deletes a row. You can delete a row if it is not being used and you no
longer need it. Deleted rows cannot be recovered.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Delete Rows |
|---|
tags:
- Rows
operationId: delete-inventory-control-row-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/unit-of-measure-group:
get:
summary: List all unit of measure groups
description: >+
Returns up to 100 object references from the collection with a key, ID,
and link for each unit of measure group. 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
| Subscription | Inventory Control, Order Entry,
or Purchasing |
|---|
| User ype | Business, CRM, Employee,
Warehouse |
|---|
| Permissions | List, View Unit of Measure
groups |
|---|
tags:
- Unit of measure groups
operationId: list-inventory-control-unit-of-measure-group
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of unit of measure group objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List unit of measure groups:
value:
ia::result:
- key: '17'
id: Data storage
href: /objects/inventory-control/unit-of-measure-group/17
- key: '11'
id: Count
href: /objects/inventory-control/unit-of-measure-group/11
- key: '12'
id: Length
href: /objects/inventory-control/unit-of-measure-group/12
- key: '13'
id: Weight
href: /objects/inventory-control/unit-of-measure-group/13
- key: '14'
id: Volume
href: /objects/inventory-control/unit-of-measure-group/14
- key: '15'
id: Area
href: /objects/inventory-control/unit-of-measure-group/15
- key: '16'
id: Time
href: /objects/inventory-control/unit-of-measure-group/16
ia::meta:
totalCount: 7
start: 1
pageSize: 100
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create a unit of measure group
description: >+
Creates a new custom unit of measure group.
Permissions and other requirements
| Subscription | Inventory Control, Order Entry,
or Purchasing |
|---|
| Configuration | Inventory Control, Order Entry,
or Purchasing must be enabled for custom units of measure to add, edit,
or delete unit of measure groups. |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Add Unit of Measure
groups |
|---|
tags:
- Unit of measure groups
operationId: create-inventory-control-unit-of-measure-group
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-unit-of-measure-group'
- $ref: '#/components/schemas/inventory-control-unit-of-measure-groupRequiredProperties'
- type: object
properties:
defaults:
readOnly: true
example: {}
examples:
Create a unit of measure group:
value:
id: Data storage
baseUnit: Gigabytes
abbreviation: GB
unitsOfMeasure:
- id: Terabytes
abbreviation: TB
conversionFactor: 1000
numberOfDecimalPlaces: 2
- id: Petabytes
abbreviation: PB
conversionFactor: 100000
numberOfDecimalPlaces: 2
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New Unit of measure group
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New unit of measure group:
value:
ia::result:
key: '17'
id: Data storage
href: /objects/inventory-control/unit-of-measure-group/17
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/unit-of-measure-group/{key}:
parameters:
- schema:
type: string
name: key
in: path
required: true
description: System-assigned unique key for the unit of measure group.
example: '11'
get:
summary: Get a unit of measure group
description: >+
Returns detailed information for a specified unit of measure group.
Permissions and other requirements
| Subscription | Inventory Control, Order Entry,
or Purchasing |
|---|
| User ype | Business, CRM, Employee,
Warehouse |
|---|
| Permissions | List, View Unit of Measure
groups |
|---|
tags:
- Unit of measure groups
operationId: get-inventory-control-unit-of-measure-group-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-unit-of-measure-group'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get a unit of measure group:
value:
key: '11'
id: Count
baseUnit: Each
abbreviation: null
defaults:
inventory:
key: '13'
id: Each
href: /objects/inventory-control/unit-of-measure/13
purchaseOrder:
key: '13'
id: Each
href: /objects/inventory-control/unit-of-measure/13
orderEntry:
key: '13'
id: Each
href: /objects/inventory-control/unit-of-measure/13
unitsOfMeasure:
- key: '13'
id: Each
abbreviation: null
numberOfDecimalPlaces: null
isBase: true
parent:
key: '11'
id: Count
href: /objects/inventory-control/unit-of-measure-group/11
conversionFactor: 1
href: /objects/inventory-control/unit-of-measure/13
- key: '14'
id: Pair
abbreviation: null
numberOfDecimalPlaces: null
isBase: false
parent:
key: '11'
id: Count
href: /objects/inventory-control/unit-of-measure-group/11
conversionFactor: 2
href: /objects/inventory-control/unit-of-measure/14
- key: '15'
id: Dozen
abbreviation: null
numberOfDecimalPlaces: null
isBase: false
parent:
key: '11'
id: Count
href: /objects/inventory-control/unit-of-measure-group/11
conversionFactor: 12
href: /objects/inventory-control/unit-of-measure/15
audit:
createdDateTime: '2014-01-08T11:28:12Z'
modifiedDateTime: '2014-01-08T11:28:12Z'
createdBy: '1'
modifiedBy: '95'
href: /objects/inventory-control/unit-of-measure-group/11
audit:
createdDateTime: '2014-01-08T11:28:12Z'
modifiedDateTime: '2014-01-08T11:28:12Z'
createdBy: '1'
modifiedBy: '95'
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update a unit of measure group
description: >+
Updates an existing unit of measure group by setting field values. Any
fields not provided remain unchanged.
Permissions and other requirements
| Subscription | Inventory Control, Order Entry,
or Purchasing |
|---|
| Configuration | Inventory Control, Order Entry,
or Purchasing must be enabled for custom units of measure to add, edit,
or delete unit of measure groups. |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Edit Unit of Measure
groups |
|---|
tags:
- Unit of measure groups
operationId: update-inventory-control-unit-of-measure-group-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-unit-of-measure-group'
- type: object
properties:
id:
example: Each
readOnly: true
examples:
Update a single value:
value:
defaults:
inventory:
key: '3'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated unit of measure group:
value:
ia::result:
key: '17'
id: Data Storage
href: /objects/inventory-control/unit-of-measure-group/17
ia::meta:
totalCount: 1
security:
- OAuth2: []
delete:
summary: Delete a unit of measure group
description: >+
Deletes a unit of measure group. Unit of measure groups that come with
Sage Intacct such as Length,Time, Area, and Count cannot be deleted.
Only custom unit of measure groups that are not in use can be deleted.
Permissions and other requirements
| Subscription | Inventory Control, Order Entry,
or Purchasing |
|---|
| Configuration | Inventory Control, Order Entry,
or Purchasing must be enabled for custom units of measure to add, edit,
or delete unit of measure groups. |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Delete Unit of Measure
groups |
|---|
tags:
- Unit of measure groups
operationId: delete-inventory-control-unit-of-measure-group-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/unit-of-measure:
get:
summary: List unit of measure objects
description: >+
Returns a collection with a key, ID, and link for each unit of measure.
This operation is mostly for use in testing; use the [query
service](/openapi/inv/inventory-control-unit-of-measure/tag/Units-of-measure/#tag/Unit-of-measure/operation/post-services-core-query-inventory-control-unit-of-measure)
to find units of measure that meet certain criteria and to specify the
properties that you want in the response.
Permissions and other requirements
| Subscription | Inventory Control, Order Entry,
or Purchasing |
|---|
| User ype | Business, CRM, Employee,
Warehouse |
|---|
| Permissions | List, View Units of
Measure |
|---|
tags:
- Units of measure
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of unit of measure objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List units of measure:
value:
ia::result:
- key: '135'
id: GigaBytes
href: /objects/inventory-control/unit-of-measure/135
- key: '136'
id: KiloBytes
href: /objects/inventory-control/unit-of-measure/136
- key: '137'
id: MegaBytes
href: /objects/inventory-control/unit-of-measure/137
ia::meta:
totalCount: 3
start: 1
pageSize: 100
next: null
previous: null
'400':
$ref: '#/components/responses/400error'
operationId: list-inventory-control-unit-of-measure
security:
- OAuth2: []
post:
summary: Create a unit of measure
description: >+
Create one or more custom units of measure within an existing unit of
measure group.
Permissions and other requirements
| Subscription | Inventory Control, Order Entry,
or Purchasing |
|---|
| Configuration | Inventory Control, Order Entry,
Purchasing must be enabled for custom units of measure to add, edit, or
delete units of measure. |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Add Units of
Measure |
|---|
tags:
- Units of measure
operationId: create-inventory-control-unit-of-measure
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-unit-of-measure'
- $ref: '#/components/schemas/inventory-control-unit-of-measureRequiredProperties'
- type: object
properties:
defaults:
readOnly: true
example: {}
examples:
Create a unit of measure:
value:
id: GigaBytes
abbreviation: GB
numberOfDecimalPlaces: 0
parent:
key: '17'
conversionFactor: 1024
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New Unit of measure
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New unit of measure:
value:
ia::result:
key: '135'
href: /objects/unit-of-measure/135
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/unit-of-measure/{key}:
parameters:
- schema:
type: string
name: key
in: path
required: true
example: '135'
description: System-assigned unique key for the unit of measure.
get:
summary: Get a unit of measure
description: >+
Returns detailed information for a specified unit of measure.
Permissions and other requirements
| Subscription | Inventory Control, Order Entry,
or Purchasing |
|---|
| User ype | Business, CRM, Employee,
Warehouse |
|---|
| Permissions | List, View Units of
Measure |
|---|
tags:
- Units of measure
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-unit-of-measure'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get a unit of measure:
value:
ia::result:
key: '135'
id: GigaBytes
abbreviation: GB
parent:
key: '17'
id: ComputerStorage
href: /objects/inventory-control-unit-of-measure/17
conversionFactor: 1024
numberOfDecimalPlaces: 0
isBase: false
audit:
createdDateTime: '2021-09-15T16:46:11Z'
modifiedDateTime: '2021-09-15T16:46:11Z'
createdBy: '1'
modifiedBy: '1'
href: /objects/inventory-control/unit-of-measure/135
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
description: Bad Request
operationId: get-inventory-control-unit-of-measure-key
security:
- OAuth2: []
patch:
summary: Update a unit of measure
description: >+
Updates an existing custom unit of measure by setting field values. Any
fields not provided remain unchanged. Units of measure already in use
cannot be modified.
Permissions and other requirements
| Subscription | Inventory Control, Order Entry,
or Purchasing |
|---|
| Configuration | Inventory Control, Order Entry,
or Purchasing must be enabled for custom units of measure to add, edit,
or delete units of measure. |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Edit Units of
Measure |
|---|
tags:
- Units of measure
operationId: update-inventory-control-unit-of-measure-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-unit-of-measure'
- type: object
properties:
id:
readOnly: true
examples:
Update a unit of measure:
value:
abbreviation: GB
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated unit of measure:
value:
ia::result:
key: '135'
href: /objects/inventory-control/unit-of-measure/135
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
security:
- OAuth2: []
delete:
summary: Delete a unit of measure
description: >+
Deletes a unit of measure. Units of measure that are provided with Sage
Intacct and included in default unit of measure groups such as Time,
Area, and Count cannot be deleted. Only custom units of measure that are
not in use can be deleted.
Permissions and other requirements
| Subscription | Inventory Control, Order Entry,
or Purchasing |
|---|
| Configuration | Inventory Control, Order Entry,
or Purchasing must be enabled for custom units of measure to add, edit,
or delete unit of measure groups. |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Delete Units of
Measure |
|---|
tags:
- Units of measure
operationId: delete-inventory-control-unit-of-measure-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/warehouse:
get:
summary: List warehouses
description: >+
Returns up to 100 object references from the collection with a key, ID,
and link for each warehouse. 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
| Subscription | Inventory Control |
|---|
| User ype | Business, CRM, Employee,
Warehouse |
|---|
| Permissions | List, View Warehouses |
|---|
tags:
- Warehouses
operationId: list-inventory-control-warehouse
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of warehouse objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List warehouses:
value:
ia::result:
- key: '5'
id: '103'
href: /objects/inventory-control/warehouse/5
- key: '8'
id: '101'
href: /objects/inventory-control/warehouse/8
- key: '9'
id: '100'
href: /objects/inventory-control/warehouse/9
ia::meta:
totalCount: 3
start: 1
pageSize: 100
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create a warehouse
description: >+
Creates a new warehouse. For a warehouse hierarchy, create the parent
warehouses before adding child warehouses.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Add
Warehouses |
|---|
tags:
- Warehouses
operationId: create-inventory-control-warehouse
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-warehouse'
- $ref: '#/components/schemas/inventory-control-warehouseRequiredProperties'
examples:
Create a warehouse:
value:
id: childId2
name: child2
location:
id: 1--Chicago
parent:
id: 101--Distribution Center
manager:
id: 1--Courtney, Bill
contacts:
primary:
id: Sam Smith
shipTo:
id: Bill North
status: active
isReplenishmentEnabled: true
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New warehouse
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New warehouse:
value:
ia::result:
key: '12'
id: '103'
href: /objects/inventory-control/warehouse/12
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/warehouse/{key}:
parameters:
- schema:
type: string
name: key
in: path
required: true
description: System-assigned unique key for the warehouse.
get:
summary: Get a warehouse
description: >+
Returns detailed information for a specified warehouse.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| User ype | Business, CRM, Employee,
Warehouse |
|---|
| Permissions | List, View Warehouses |
|---|
tags:
- Warehouses
operationId: get-inventory-control-warehouse-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the warehouse
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-warehouse'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get a warehouse:
value:
ia::result:
key: '3'
name: US NA Warehouse-1
id: USNAWA1
parent:
id: US NA--1
key: '22'
href: /objects/inventory-control/warehouse/22
location:
id: North America--North America
key: '10'
href: /objects/company-config/location/10
manager:
id: EM 1--Aman
key: '14'
href: /objects/company-config/employee/14
contacts:
primary:
id: Sam Smith
key: '210'
href: /objects/company-config/contact/210
shipTo:
id: Bill North
key: '229'
href: /objects/company-config/contact/229
status: active
isReplenishmentEnabled: true
enableNegativeInv: false
href: /objects/inventory-control/warehouse/15
audit:
createdDateTime: '2021-04-21T23:57:50Z'
modifiedDateTime: '2021-04-21T23:59:40Z'
createdBy: '1'
modifiedBy: '1'
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update a warehouse
description: >+
Updates an existing warehouse by setting field values. Any fields not
provided remain unchanged.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Edit
Warehouses |
|---|
tags:
- Warehouses
operationId: update-inventory-control-warehouse-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-warehouse'
- type: object
properties:
id:
readOnly: true
examples:
Update a single value:
value:
manager:
id: 2--Lapus, Alan
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated warehouse
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated warehouse:
value:
ia::result:
key: '9'
id: US NA Warehouse-2
href: /objects/inventory-control/warehouse/9
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete a warehouse
description: >+
Deletes a warehouse.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Delete
Warehouses |
|---|
tags:
- Warehouses
operationId: delete-inventory-control-warehouse-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/zone:
get:
summary: List zones
description: >+
Returns up to 100 object references from the collection with a key, ID,
and link for each zone. 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
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business, CRM, Employee,
Warehouse |
|---|
| Permissions | List, View Zones |
|---|
tags:
- Zones
operationId: list-inventory-control-zone
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of zone objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List zones:
value:
ia::result:
- key: '546'
id: RZ1A
href: /objects/inventory-control/zone/546
- key: '547'
id: RZ2A
href: /objects/inventory-control/zone/547
- key: '548'
id: RZ3A
href: /objects/inventory-control/zone/548
ia::meta:
totalCount: 3
start: 1
pageSize: 100
next: 2
previous: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create a zone
description: >+
Creates a new zone.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Add Zones |
|---|
tags:
- Zones
operationId: create-inventory-control-zone
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-zone'
- $ref: '#/components/schemas/inventory-control-zoneRequiredProperties'
examples:
Create a zone:
value:
id: Z2
description: Refrigeration zone 2
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New zone
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New zone:
value:
ia::result:
key: '546'
id: RZ2
href: /objects/inventory-control/zone/546
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/zone/{key}:
parameters:
- schema:
type: string
example: '564'
name: key
in: path
required: true
description: System-assigned unique key for the zone.
get:
summary: Get a zone
description: >+
Returns detailed information for a specified zone.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business, CRM, Employee,
Warehouse |
|---|
| Permissions | List, View Zones |
|---|
tags:
- Zones
operationId: get-inventory-control-zone-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the zone
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-zone'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get a zone:
value:
ia::result:
key: '564'
id: RZ2
description: Refrigeration zone 2
audit:
createdDateTime: '2021-05-07T01:15:23Z'
modifiedDateTime: '2021-05-07T01:15:23Z'
createdBy: '13'
modifiedBy: '13'
href: /objects/inventory-control/zone/564
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update a zone
description: >+
Updates an existing zone by setting field values. Any fields not
provided remain unchanged.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Edit Zones |
|---|
tags:
- Zones
operationId: update-inventory-control-zone-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-zone'
- type: object
properties:
id:
readOnly: true
examples:
Update a single value:
value:
description: Refrigeration zone 2A
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated zone
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated zone:
value:
ia::result:
key: '564'
id: RZ2
href: /objects/inventory-control/zone/564
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete a zone
description: >+
Deletes a zone. You can delete a zone if it is not being used and you no
longer need it. Deleted zones cannot be recovered.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows is
enabled. |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Delete Zones |
|---|
tags:
- Zones
operationId: delete-inventory-control-zone-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/product-line:
get:
summary: List product lines
description: >+
Returns up to 100 object references from the collection with a key, ID,
and link for each product line. 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
| Subscription | Inventory Control, Order Entry,
or Purchasing |
|---|
| User ype | Business, CRM, Employee,
Warehouse |
|---|
| Permissions | List, View Product Lines |
|---|
tags:
- Product lines
operationId: list-inventory-control-product-line
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List product line objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List product lines:
value:
ia::result:
- key: '23'
id: Adapters
href: /objects/inventory-control/product-line/23
- key: '25'
id: Telephones
href: /objects/inventory-control/product-line/25
- key: '29'
id: Auto Product Line
href: /objects/inventory-control/product-line/29
ia::meta:
totalCount: 3
start: 1
pageSize: 100
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create a product line
description: >+
Creates a new product line.
Permissions and other requirements
| Subscription | Inventory Control, Order Entry,
or Purchasing |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Add Product
Lines |
|---|
tags:
- Product lines
operationId: create-inventory-control-product-line
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-product-line'
- $ref: '#/components/schemas/inventory-control-product-lineRequiredProperties'
examples:
Create a product line:
value:
id: OCA
description: Other Computer Accessories
parent:
id: PCCS
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New product-line
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New product line:
value:
ia::result:
key: '26'
id: OCA
href: /objects/inventory-control/product-line/26
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/product-line/{key}:
parameters:
- name: key
description: System-assigned key for the product line.
in: path
required: true
schema:
type: string
get:
summary: Get a product line
description: >+
Returns detailed information for a specified product line.
Permissions and other requirements
| Subscription | Inventory Control, Order Entry,
or Purchasing |
|---|
| User ype | Business, CRM, Employee,
Warehouse |
|---|
| Permissions | List, View Product Lines |
|---|
tags:
- Product lines
operationId: get-inventory-control-product-line-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the product line
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-product-line'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get a product line:
value:
ia::result:
key: '25'
id: Telephones
description: Telephones
parent:
id: Adapters
key: '28'
href: /objects/inventory-control/product-line/28
status: active
audit:
createdDateTime: '2017-04-27T17:29:36Z'
modifiedDateTime: '2022-03-15T14:40:30Z'
createdBy: '1'
modifiedBy: '1'
href: /objects/inventory-control/product-line/25
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update a product line
description: >+
Updates an existing product line by setting field values. Any fields not
provided remain unchanged.
Permissions and other requirements
| Subscription | Inventory Control, Order Entry,
or Purchasing |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Edit Product
Lines |
|---|
tags:
- Product lines
operationId: update-inventory-control-product-line-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-product-line'
- type: object
properties:
id:
readOnly: true
examples:
Update a single value:
value:
description: Telephones for US markets
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated product-line
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated product line:
value:
ia::result:
key: '25'
id: Telephones
href: /objects/inventory-control/product-line/25
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete a Product line
description: >+
Deletes a product line.
Permissions and other requirements
| Subscription | Inventory Control, Order Entry,
or Purchasing |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Delete Product
Lines |
|---|
tags:
- Product lines
operationId: delete-inventory-control-product-line-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/item-cross-reference:
get:
summary: List item cross references
description: >+
Returns a collection with a key, ID, and link for each item cross
reference.
Permissions and other requirements
| Subscription | Inventory Control, Order Entry,
Purchasing |
|---|
| User ype | Employee, Business, Project Manager,
Warehouse |
|---|
| Permissions | List, View Item cross
references |
|---|
tags:
- Item cross references
operationId: list-inventory-control-item-cross-reference
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List item cross reference objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List item cross references:
value:
ia::result:
- key: '1'
id: '1'
href: /objects/inventory-control/item-cross-reference/1
- key: '2'
id: '2'
href: /objects/inventory-control/item-cross-reference/2
- key: '3'
id: '3'
href: /objects/inventory-control/item-cross-reference/3
ia::meta:
totalCount: 3
start: 1
pageSize: 100
next: 101
previous: null
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create an item cross reference
description: >+
Creates a new item cross reference.
Permissions and other requirements
| Subscription | Inventory Control, Order
Entry |
|---|
| User ype | Business |
|---|
| Permissions | Add, List, View Item cross
references |
|---|
tags:
- Item cross references
operationId: create-inventory-control-item-cross-reference
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-item-cross-reference'
- $ref: '#/components/schemas/inventory-control-item-cross-referenceRequiredProperties'
examples:
Create an item cross reference:
value:
item:
key: '649'
alternateItem:
key: '64'
unitOfMeasure:
key: '3'
referenceType: substitute
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New item-cross-reference
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New item cross reference:
value:
ia::result:
key: '6'
id: '6'
href: /objects/inventory-control/item-cross-reference/6
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/item-cross-reference/{key}:
parameters:
- name: key
description: System-assigned unique key for the item cross reference.
in: path
required: true
schema:
type: string
get:
summary: Get an item cross reference
description: >+
Returns detailed information for a specified item cross reference.
Permissions and other requirements
| Subscription | Inventory Control, Order Entry,
Purchasing |
|---|
| User ype | Employee, Business, Project Manager,
Warehouse |
|---|
| Permissions | List, View Item cross
references |
|---|
tags:
- Item cross references
operationId: get-inventory-control-item-cross-reference-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the item cross reference
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-item-cross-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get an internal item cross reference:
value:
ia::result:
key: '6'
id: '6'
referenceType: substitute
referenceTypeContext: internal
item:
key: '649'
id: Logitech-MK830
name: MK830 Keyboard and Mouse Combo
href: /objects/inventory-control/item/649
alternateItem:
key: '64'
id: Logitech-MK825
name: MK825 Keyboard and Mouse Combo
href: /objects/inventory-control/item/64
vendor:
key: null
id: null
name: null
customer:
key: null
id: null
name: null
itemAliasId: null
itemAliasDescription: null
unitOfMeasure:
key: '3'
id: Each
href: /objects/inventory-control/unit-of-measure/3
href: /objects/inventory-control/item-cross-reference/6
audit:
createdDateTime: '2023-11-09T06:20:34Z'
modifiedDateTime: '2023-11-09T07:02:22Z'
createdBy: '1'
modifiedBy: '22'
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
Get an external item cross reference:
value:
ia::result:
key: '7'
id: '7'
referenceType: customer
referenceTypeContext: external
item:
key: '649'
id: Logitech-MK830
name: MK830 Keyboard and Mouse Combo
href: /objects/inventory-control/item/649
alternateItem:
key: null
id: null
name: null
vendor:
key: null
id: null
name: null
customer:
key: '20'
id: C00012
name: Future Products Inc
href: /objects/accounts-receivable/customer/20
itemAliasId: Logitech-MK830
itemAliasDescription: Logitech-MK800 series keyboard and mouse combo
unitOfMeasure:
key: '3'
id: Each
href: /objects/inventory-control/unit-of-measure/3
href: /objects/inventory-control/item-cross-reference/7
audit:
createdDateTime: '2023-11-09T06:20:34Z'
modifiedDateTime: '2023-11-09T07:02:22Z'
createdBy: '1'
modifiedBy: '22'
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update an item cross reference
description: >+
Updates an existing item cross reference by setting field values. Any
fields not provided remain unchanged.
Permissions and other requirements
| Subscription | Inventory Control, Order
Entry |
|---|
| User ype | Business |
|---|
| Permissions | Edit, List, View Item cross
references |
|---|
tags:
- Item cross references
operationId: update-inventory-control-item-cross-reference-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-item-cross-reference'
- type: object
properties:
referenceType:
readOnly: true
examples:
Update an item cross reference:
value:
alternateItem:
key: '10'
unitOfMeasure:
key: '3'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated item cross reference
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated item cross reference:
value:
ia::result:
key: '6'
id: '6'
href: /objects/inventory-control/item-cross-reference/6
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete an item cross reference
description: >+
Deletes an item cross reference. An item cross reference can be deleted
if it hasn't been used in a transaction. Deleting an item cross
reference removes it from the system so that it cannot be recovered.
Permissions and other requirements
| Subscription | Inventory Control, Order
Entry |
|---|
| User ype | Business |
|---|
| Permissions | Edit, List, View Item cross
references |
|---|
tags:
- Item cross references
operationId: delete-inventory-control-item-cross-reference-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/item-landed-cost:
get:
summary: List item landed costs
description: >+
Returns a collection with a key, ID, and link for each item landed cost.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| User ype | Business |
|---|
| Permissions | List, View Item landed
cost |
|---|
tags:
- Item landed costs
operationId: list-inventory-control-item-landed-cost
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List item landed cost objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List item landed costs:
value:
ia::result:
- key: '25'
id: '25'
href: /objects/inventory-control/item-landed-cost/25
- key: '26'
id: '26'
href: /objects/inventory-control/item-landed-cost/26
- key: '27'
id: '27'
href: /objects/inventory-control/item-landed-cost/27
ia::meta:
totalCount: 3
start: 1
pageSize: 100
next: null
previous: null
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/item-landed-cost/{key}:
parameters:
- name: key
description: System-assigned unique key for the item landed cost.
in: path
required: true
schema:
type: string
get:
summary: Get an item landed cost
description: >+
Returns detailed information for a specified item landed cost.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| User ype | Business |
|---|
| Permissions | List, View Item landed
cost |
|---|
tags:
- Item landed costs
operationId: get-inventory-control-item-landed-cost-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the item-landed-cost
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-item-landed-cost'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get an item landed cost:
value:
ia::result:
key: '87'
id: '87'
item:
id: Dell Touch Screen
key: '234'
href: /objects/inventory-control/item/234
distributionMethod: weight
distributionMethodBaseUnit: Ounce
landedCostValue: '24.000000000'
active: true
href: /objects/inventory-control/item-landed-cost/87
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/item-vendor:
get:
summary: List item vendors
description: >+
Returns a collection with a key, ID, and link for each item vendor.
Permissions and other requirements
| Subscription | Inventory Control, Order Entry,
Purchasing |
|---|
| User ype | Employee, Business, Project Manager,
Warehouse |
|---|
| Permissions | List, View Items |
|---|
tags:
- Item vendors
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of item vendor objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List item vendors:
value:
ia::result:
- key: '5'
id: '5'
href: /objects/inventory-control/item-vendor/5
- key: '6'
id: '6'
href: /objects/inventory-control/item-vendor/6
- key: '7'
id: '7'
href: /objects/inventory-control/item-vendor/7
ia::meta:
totalCount: 3
start: 1
pageSize: 100
next: 101
previous: null
'400':
$ref: '#/components/responses/400error'
operationId: list-inventory-control-item-vendor
security:
- OAuth2: []
/objects/inventory-control/item-vendor/{key}:
parameters:
- schema:
type: string
name: key
in: path
required: true
description: System-assigned unique key for the item vendor.
example: '5'
get:
summary: Get an item vendor
description: >+
Returns detailed information for a specified item vendor.
Permissions and other requirements
| Subscription | Inventory Control, Order Entry,
Purchasing |
|---|
| User ype | Employee, Business, Project Manager,
Warehouse |
|---|
| Permissions | List, View Items |
|---|
tags:
- Item vendors
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the item vendor
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-item-vendor'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get an item vendor:
value:
ia::result:
key: '5'
id: '5'
item:
key: '13'
id: Phones
href: /objects/inventory-control/item/13
vendor:
key: '38'
id: Office_Supplies
href: /objects/accounts-payable/vendor/38
stockNumber: '#5678901234'
leadTime: 15
demandForecastDuringLeadTime: 5
economicalOrderQuantity: 10
vendorMinimumOrderQuantity: 10
bestPrice: '100'
latestPrice: '110'
unitOfMeasure:
key: '38'
id: Each
href: /objects/inventory-control/unit-of-measure/38
conversionFactor: '1'
isPreferredVendor: false
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
operationId: get-inventory-control-item-vendor-key
security:
- OAuth2: []
/objects/inventory-control/item-warehouse-standard-cost:
get:
summary: List item warehouse standard costs
description: >-
Returns a collection with a key, ID, and link for each item warehouse
standard cost.
tags:
- Item warehouse standard costs
operationId: list-inventory-control-item-warehouse-standard-cost
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of item-warehouse-standard-cost objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List of item warehouse standard costs:
value:
ia::result:
- key: '21'
id: '21'
href: '/objects/inventory-control/item-warehouse-standard-cost/21'
- key: '24'
id: '24'
href: '/objects/inventory-control/item-warehouse-standard-cost/24'
ia::meta:
totalCount: 2
start: 1
pageSize: 100
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create an item warehouse standard cost
description: Creates a new item warehouse standard cost.
tags:
- Item warehouse standard costs
operationId: create-inventory-control-item-warehouse-standard-cost
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-item-warehouse-standard-cost'
- $ref: '#/components/schemas/inventory-control-item-warehouse-standard-costRequiredProperties'
examples:
Creates an item warehouse standard cost:
value:
effectiveStartDate: '2021-01-23'
standardCost: '21'
itemWarehouse:
key: '13'
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New item-warehouse-standard-cost
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Creates an item warehouse standard cost:
value:
ia::result:
key: '23'
id: '23'
href: '/objects/inventory-control/item-warehouse-standard-cost/23'
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/item-warehouse-standard-cost/{key}:
parameters:
- name: key
description: system-assigned unique key for the item warehouse standard cost.
in: path
required: true
schema:
type: string
get:
summary: Get an item warehouse standard cost
description: >-
Returns detailed information for a particular item warehouse standard
cost.
tags:
- Item warehouse standard costs
operationId: get-inventory-control-item-warehouse-standard-cost-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the item-warehouse-standard-cost
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-item-warehouse-standard-cost'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Details of the item warehouse standard cost:
value:
ia::result:
key: '23'
id: '23'
effectiveStartDate: '2021-01-23'
standardCost: '122'
itemWarehouse:
key: '13'
id: '13'
itemId: LapTop Kit 1
warehouseId: WS001
href: /objects/inventory-control/item-warehouse-inventory/13
href: '/objects/inventory-control/item-warehouse-standard-cost/23'
audit:
createdDateTime: '2021-05-07T21:30:03Z'
modifiedDateTime: '2021-05-07T21:30:03Z'
createdBy: '13'
modifiedBy: '13'
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update an item warehouse standard cost
description: >-
Updates an existing item warehouse standard cost by setting field
values. Any fields not provided remain unchanged.
tags:
- Item warehouse standard costs
operationId: update-inventory-control-item-warehouse-standard-cost-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-item-warehouse-standard-cost'
- type: object
examples:
Updates an item warehouse standard cost:
value:
standardCost: '125'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated item-warehouse-standard-cost
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated item warehouse standard cost:
value:
ia::result:
key: '23'
id: '23'
href: '/objects/inventory-control/item-warehouse-standard-cost/23'
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete an item warehouse standard cost
description: Deletes an item warehouse standard cost.
tags:
- Item warehouse standard costs
operationId: delete-inventory-control-item-warehouse-standard-cost-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/item-warehouse-vendor:
get:
summary: List item warehouse vendors
description: >-
Returns a collection with a key, ID, and link for each item warehouse
vendor.
tags:
- Item warehouse vendors
operationId: list-inventory-control-item-warehouse-vendor
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of item-warehouse-vendor objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List of item warehouse vendors:
value:
ia::result:
- key: '21'
id: '21'
href: /objects/inventory-control/item-warehouse-vendor/21
- key: '22'
id: '22'
href: /objects/inventory-control/item-warehouse-vendor/22
ia::meta:
totalCount: 2
start: 1
pageSize: 100
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create an item warehouse vendor
description: Creates a new item warehouse vendor.
tags:
- Item warehouse vendors
operationId: create-inventory-control-item-warehouse-vendor
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-item-warehouse-vendor'
- $ref: '#/components/schemas/inventory-control-item-warehouse-vendorRequiredProperties'
examples:
Creates an item warehouse vendor:
value:
itemWarehouse:
key: '12'
vendor:
key: '122'
stockNumber: '#5678901234'
unitOfMeasure:
key: '38'
leadTime: 15
demandForecastDuringLeadTime: 5
economicalOrderQuantity: 10
vendorMinimumOrderQuantity: 10
isPreferredVendor: true
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New item-warehouse-vendor
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New item warehouse vendor:
value:
ia::result:
key: '66'
id: '66'
href: /objects/inventory-control/item-warehouse-vendor/66
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/item-warehouse-vendor/{key}:
parameters:
- name: key
description: system-assigned unique key for the item warehouse vendor.
in: path
required: true
schema:
type: string
get:
summary: Get an item warehouse vendor
description: Returns detailed information for a particular item warehouse vendor.
tags:
- Item warehouse vendors
operationId: get-inventory-control-item-warehouse-vendor-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the item-warehouse-vendor
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-item-warehouse-vendor'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Details of the item warehouse vendor:
value:
ia::result:
id: '66'
key: '66'
itemWarehouse:
id: '76'
key: '76'
href: /objects/item-warehouse-inventory/76
vendor:
id: vendorId-1702552731
key: '2387'
href: /objects/vendor/2387
stockNumber: '#5678901234'
leadTime: 15
demandForecastDuringLeadTime: 5
economicalOrderQuantity: 10
vendorMinimumOrderQuantity: 10
bestPrice: '112.23'
latestPrice: '112.23'
unitOfMeasure:
key: '38'
id: Each
href: /objects/inventory-control/unit-of-measure/38
conversionFactor: '1'
isPreferredVendor: true
href: /objects/inventory-control/item-warehouse-vendor/66
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update an item warehouse vendor
description: >-
Updates an existing item warehouse vendor by setting field values. Any
fields not provided remain unchanged.
tags:
- Item warehouse vendors
operationId: update-inventory-control-item-warehouse-vendor-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-item-warehouse-vendor'
- type: object
examples:
Updates an item warehouse vendor:
value:
stockNumber: '#5678901234222'
leadTime: 15
demandForecastDuringLeadTime: 5
economicalOrderQuantity: 10
vendorMinimumOrderQuantity: 10
isPreferredVendor: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated item-warehouse-vendor
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated item warehouse vendor:
value:
ia::result:
key: '66'
id: '66'
href: /objects/inventory-control/item-warehouse-vendor/66
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete an item warehouse vendor
description: Deletes an item warehouse vendor.
tags:
- Item warehouse vendors
operationId: delete-inventory-control-item-warehouse-vendor-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/kit-component:
get:
summary: List kit components
description: Returns a collection with a key, ID, and link for each kit component.
tags:
- Kit components
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of Kit Components objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
example-1:
value:
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
'400':
$ref: '#/components/responses/400error'
operationId: list-inventory-control-kit-component
security:
- OAuth2: []
post:
summary: Create a kit component
description: Creates a new kit component.
tags:
- Kit components
operationId: create-inventory-control-kit-component
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New Item with kit Components
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New kit component:
value:
ia::result:
key: '1'
id: '1'
href: /objects/inventory-control/kit-component/1
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-kit-component'
- $ref: '#/components/schemas/inventory-control-kit-componentRequiredProperties'
examples:
Create a kit component:
value:
kit:
key: '1'
component:
key: '2'
revenuePercentage: 90
defaultDeliveryStatus: undelivered
defaultDeferralStatus: deferUntilItemIsDelivered
numberOfUnits: 1
security:
- OAuth2: []
/objects/inventory-control/kit-component/{key}:
parameters:
- schema:
type: string
example: '1'
name: key
in: path
required: true
description: System-assigned key for the kit-component.
get:
summary: Get a kit component
description: Returns detailed information for a particular kit component.
tags:
- Kit components
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the kit-component
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-kit-component'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
example-1:
value:
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
'400':
$ref: '#/components/responses/400error'
operationId: get-inventory-control-kit-component-key
security:
- OAuth2: []
patch:
summary: Update a kit component
description: >-
Updates an existing kit component by setting field values. Any fields
not provided remain unchanged.
tags:
- Kit components
operationId: update-inventory-control-kit-component-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated Kit Component
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
example-1:
value:
ia::result:
key: '1'
id: '1'
href: /objects/inventory-control/kit-component/1
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-kit-component'
- type: object
properties:
id:
readOnly: true
examples:
example-1:
value:
component:
key: '10'
numberOfUnits: 1
security:
- OAuth2: []
delete:
summary: Delete a kit component
description: Deletes a kit component.
tags:
- Kit components
operationId: delete-inventory-control-kit-component-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/lot-category:
get:
summary: List lot categories
description: Returns a collection with a key, ID, and link for each lot category.
tags:
- Lot categories
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of lot category objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List lot category objects:
value:
ia::result:
- key: '2'
id: Medi-Lot
href: /objects/inventory-control/lot-category/2
- key: '3'
id: Chemical-Lot
href: /objects/inventory-control/lot-category/3
ia::meta:
totalCount: 2
start: 1
pageSize: 100
next: 101
previous: null
'400':
$ref: '#/components/responses/400error'
operationId: list-inventory-control-lot-category
security:
- OAuth2: []
post:
summary: Create a lot category
description: Creates a new lot category.
tags:
- Lot categories
operationId: create-inventory-control-lot-category
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New lot category
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New lot category:
value:
ia::result:
key: '2'
id: Medi-Lot
href: /objects/inventory-control/lot-category/2
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-lot-category'
- $ref: '#/components/schemas/inventory-control-lot-categoryRequiredProperties'
examples:
Create a lot category:
value:
id: Medi-Lot
name: Medical Item Lot
security:
- OAuth2: []
/objects/inventory-control/lot-category/{key}:
parameters:
- schema:
type: string
example: '2'
name: key
in: path
required: true
description: System-assigned unique key for the lot category.
get:
summary: Get a lot category
description: Returns detailed information for a specified lot category.
tags:
- Lot categories
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the lot category
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-lot-category'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get a lot category:
value:
ia::result:
key: '2'
id: Medi-Lot
name: Medical Item Lot
href: /objects/inventory-control/lot-category/2
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
operationId: get-inventory-control-lot-category-key
security:
- OAuth2: []
patch:
summary: Update a lot category
description: >-
Updates an existing lot category by setting field values. Any fields not
provided remain unchanged.
tags:
- Lot categories
operationId: update-inventory-control-lot-category-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated lot-category
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated lot category:
value:
ia::result:
key: '2'
id: Medi-Lot
href: /objects/inventory-control/lot-category/2
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-lot-category'
- type: object
properties:
id:
readOnly: true
examples:
Update a lot category:
value:
name: Medical Item Lot
security:
- OAuth2: []
delete:
summary: Delete a lot-category
description: Deletes a lot category.
tags:
- Lot categories
operationId: delete-inventory-control-lot-category-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/price-list:
get:
summary: List inventory price lists
description: >-
Returns a collection with a key, ID, and link for each inventory price
list. This operation is mostly for use in testing; use query to find
objects that meet certain criteria and to specify properties that are
returned.
tags:
- Inventory price lists
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List inventory price list objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List price lists:
value:
ia::result:
- key: '1'
id: Base Price List
href: /objects/inventory-control/price-list/1
- key: '2'
id: Initial Purchase Cost
href: /objects/inventory-control/price-list/2
- key: '3'
id: Initial Sales Price
href: /objects/inventory-control/price-list/3
ia::meta:
totalCount: 3
start: 1
pageSize: 100
next: null
previous: null
'400':
$ref: '#/components/responses/400error'
operationId: list-inventory-control-price-list
security:
- OAuth2: []
post:
summary: Create an inventory price list
description: Creates a new inventory price list.
tags:
- Inventory price lists
operationId: create-inventory-control-price-list
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New inventory-price-list
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New price list:
value:
ia::result:
key: '1'
id: Base Price List
href: /objects/inventory-control/price-list/1
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-price-list'
- $ref: '#/components/schemas/inventory-control-price-listRequiredProperties'
examples:
Create a price list:
value:
id: Base Price List
startDate: '2015-01-01'
endDate: '2022-01-01'
appliesTo: orderEntry
status: active
security:
- OAuth2: []
/objects/inventory-control/price-list/{key}:
parameters:
- schema:
type: string
name: key
in: path
required: true
description: System-assigned key for the inventory price list.
example: '1'
get:
summary: Get an inventory price list
description: Returns detailed information for a specified inventory price list.
tags:
- Inventory price lists
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the inventory-price-list
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-price-list'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get an inventory price list:
value:
ia::result:
key: '1'
id: Base Price List
href: /objects/inventory-control/price-list/1
startDate: '2000-01-01'
endDate: '2100-12-31'
appliesTo: orderEntry
status: active
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
operationId: get-inventory-control-price-list-key
security:
- OAuth2: []
patch:
summary: Update an inventory price list
description: >-
Updates an existing inventory price list by setting field values. Any
fields not provided remain unchanged.
tags:
- Inventory price lists
operationId: update-inventory-control-price-list-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated inventory-price-list
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated price list:
value:
ia::result:
key: '1'
id: Base Price List
href: /objects/inventory-control/price-list/1
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-price-list'
- type: object
properties:
id:
readOnly: true
example: '1'
examples:
Update a price list:
value:
startDate: '2018-02-01'
security:
- OAuth2: []
delete:
summary: Delete an inventory price list
description: Deletes an inventory price list.
tags:
- Inventory price lists
operationId: delete-inventory-control-price-list-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/price-schedule:
get:
summary: List inventory price schedules
description: >-
Returns a collection with a key, ID, and link for each inventory price
schedule. This operation is mostly for use in testing; use query to find
objects that meet certain criteria and to specify properties that are
returned.
tags:
- Inventory price schedules
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of inventory-price-schedule objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
'400':
$ref: '#/components/responses/400error'
operationId: list-inventory-control-price-schedule
security:
- OAuth2: []
post:
summary: Create an inventory price schedule
description: Creates a new inventory price schedule.
tags:
- Inventory price schedules
operationId: create-inventory-control-price-schedule
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New inventory-price-schedule
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New inventory price schedule:
value:
ia::result:
key: '1'
id: S1
href: /objects/inventory-control/price-schedule/1
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-price-schedule'
- $ref: '#/components/schemas/inventory-control-price-scheduleRequiredProperties'
examples:
Create an inventory price schedule:
value:
id: S1
description: Inventory Price Schedule 1
priceList:
id: '1'
discountPercent: ''
status: active
security:
- OAuth2: []
/objects/inventory-control/price-schedule/{key}:
parameters:
- schema:
type: string
name: key
in: path
required: true
description: System-assigned unique key for the inventory price schedule.
get:
summary: Get an inventory price schedule
description: Returns detailed information for a specified inventory price schedule.
tags:
- Inventory price schedules
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the inventory-price-schedule
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-price-schedule'
ia::meta:
$ref: '#/components/schemas/metadata'
'400':
$ref: '#/components/responses/400error'
operationId: get-inventory-control-price-schedule-key
security:
- OAuth2: []
patch:
summary: Update an inventory price schedule
description: >-
Updates an existing inventory price schedule by setting field values.
Any fields not provided remain unchanged.
tags:
- Inventory price schedules
operationId: update-inventory-control-price-schedule-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated inventory-price-schedule
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
'400':
$ref: '#/components/responses/400error'
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-price-schedule'
- type: object
properties:
id:
readOnly: true
security:
- OAuth2: []
delete:
summary: Delete an inventory price schedule
description: Deletes an inventory price schedule.
tags:
- Inventory price schedules
operationId: delete-inventory-control-price-schedule-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/total:
get:
summary: List inventory totals
description: >+
Returns a collection with a key, ID, and link for each inventory total.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| User ype | Business, Employee,
Warehouse |
|---|
| Permissions | List, View Inventory
totals |
|---|
tags:
- Inventory totals
operationId: list-inventory-control-total
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List inventory total objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List inventory total objects:
value:
ia::result:
- key: '51'
id: ONORDER
href: /objects/inventory-control/total/51
- key: '52'
id: ONHAND
href: /objects/inventory-control/total/52
- key: '53'
id: ONHOLD
href: /objects/inventory-control/total/53
- key: '54'
id: REQUESITIONED
href: /objects/inventory-control/total/54
- key: '55'
id: DAMAGED
href: /objects/inventory-control/total/55
- key: '56'
id: SCRAP OR SPOILAGE
href: /objects/inventory-control/total/56
- key: '57'
id: ALLOCATED
href: /objects/inventory-control/total/57
- key: '58'
id: RESERVED
href: /objects/inventory-control/total/58
- key: '59'
id: INTRANSIT
href: /objects/inventory-control/total/59
ia::meta:
totalCount: 9
start: 1
pageSize: 100
next: 101
previous: null
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create an inventory total
description: >+
Creates a new inventory total.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows must be
enabled to add inventory totals |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Add Inventory
totals |
|---|
tags:
- Inventory totals
operationId: create-inventory-control-total
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-total'
- $ref: '#/components/schemas/inventory-control-totalRequiredProperties'
examples:
Create an inventory total:
value:
id: SHIPPED
status: active
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New inventory total
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New inventory total:
value:
ia::result:
key: '60'
id: SHIPPED
href: /objects/inventory-control/total/60
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/total/{key}:
parameters:
- name: key
description: System-assigned unique key for the inventory total.
in: path
required: true
schema:
type: string
get:
summary: Get an inventory total
description: >+
Returns detailed information for a specified inventory total.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| User ype | Business, Employee,
Warehouse |
|---|
| Permissions | List, View Inventory
totals |
|---|
tags:
- Inventory totals
operationId: get-inventory-control-total-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the inventory total
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-total'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get an inventory total:
value:
ia::result:
key: '60'
id: SHIPPED
status: active
updateType: accumulative
href: /objects/inventory-control/total/60
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update an inventory total
description: >+
Updates an existing inventory total by setting field values. Any fields
not provided remain unchanged.
User-defined totals can be edited, but only the status of preset
inventory totals can be edited. To prevent a preset inventory total from
being selected in a transaction definition, change its status to
`inactive`.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows must be
enabled to edit inventory totals |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Edit Inventory
totals |
|---|
tags:
- Inventory totals
operationId: update-inventory-control-total-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-total'
- type: object
properties:
id:
readOnly: true
examples:
Update an inventory total:
value:
status: inactive
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated inventory total
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated inventory total:
value:
ia::result:
key: '60'
id: SHIPPED
href: /objects/inventory-control/total/1
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete an inventory total
description: >+
Deletes an inventory total. Only user-defined inventory totals can be
deleted.
Permissions and other requirements
| Subscription | Inventory Control |
|---|
| Configuration | Advanced workflows must be
enabled to delete inventory totals |
|---|
| User ype | Business |
|---|
| Permissions | List, View, Delete Inventory
totals |
|---|
tags:
- Inventory totals
operationId: delete-inventory-control-total-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/txn-definition:
get:
summary: List inventory transaction definitions
description: >-
Returns a collection with a key, ID, and link for each inventory
transaction definition.
tags:
- Inventory transaction definitions
operationId: list-inventory-control-txn-definition
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of inventory-txn-definition objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List inventory transaction definitions:
value:
ia::result:
- key: '715'
id: SYS-CC Adjustment Decrease
href: /objects/inventory-control/txn-definition/715
- key: '716'
id: SYS-CC Adjustment Increase
href: /objects/inventory-control/txn-definition/716
- key: '424'
id: SYS-LC Estimates Adj Incr
href: /objects/inventory-control/txn-definition/424
- key: '425'
id: SYS-LC Estimates Rev Adj Decr
href: /objects/inventory-control/txn-definition/425
- key: '521'
id: SYS-Warehouse In Transit
href: /objects/inventory-control/txn-definition/521
- key: '198'
id: SYS-Warehouse Transfer Out
href: /objects/inventory-control/txn-definition/198
- key: '309'
id: SYS-Warehouse Transfer In
href: /objects/inventory-control/txn-definition/309
- key: '763'
id: SYS-CC Adjustment Damaged
href: /objects/inventory-control/txn-definition/763
ia::meta:
totalCount: 8
start: 1
pageSize: 100
next: 101
previous: null
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create an inventory transaction definition
description: Creates a new inventory transaction definition.
tags:
- Inventory transaction definitions
operationId: create-inventory-control-txn-definition
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-txn-definition'
- $ref: '#/components/schemas/inventory-control-txn-definitionRequiredProperties'
examples:
Create an inventory transaction definition:
value:
id: Adjustment Decrease
description: Adjustment Decrease (Quantity - Value)
templateType: adjustment
workflowCategory: adjustment
enableUserOrGroupPermmission: false
documentPermissions:
editPolicy: all
deletePolicy: all
createPolicy: newDocumentOrConvert
multiEntityRuleForTxn: topLevelOrEntity
txnNumbering:
numberingSequence:
key: '12'
preserveSequenceNumbers: false
inheritSourceDocumentNumber: false
inventoryControl:
enableWarnOnLowQty: true
warehouseSelectionMethod: sortByID
defaultWarehouse:
key: '32'
accounting:
txnPosting: postToGeneralLedger
isSubTotalsEnabled: false
conversionType: closeTxn
pricingAndTerms:
initialPriceList:
key: '33'
specialPriceList:
key: '34'
userOverrides:
allowLocationOverride: true
allowDepartmentOverride: true
print:
documentTemplate: Adjustment_US_Template
defaultText: Document template is not selected.
status: active
inventoryTotalDetail:
- operation: subtract
inventoryTotal:
id: ONHAND
maintainType: quantityAndValue
inventoryAccountMapping:
- txnType: debit
glAccount:
key: '415'
lineNumber: 0
- txnType: credit
glAccount:
key: '85'
lineNumber: 1
reportingCategory: inventoryAdjustment
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New inventory-txn-definition
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New inventory transaction definition:
value:
ia::result:
key: '833'
href: /objects/inventory-control/txn-definition/833
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/txn-definition/{key}:
parameters:
- name: key
description: System-assigned unique key for the inventory transaction definition.
in: path
required: true
schema:
type: string
get:
summary: Get an inventory transaction definition
description: >-
Returns detailed information for a specified inventory transaction
definition.
tags:
- Inventory transaction definitions
operationId: get-inventory-control-txn-definition-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the inventory-txn-definition
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-txn-definition'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get an inventory transaction definition:
value:
ia::result:
key: '834'
id: Adjustment Decrease-dd
description: Adjustment Decrease (Quantity - Value)
templateType: adjustment
workflowCategory: adjustment
enableUserOrGroupPermmission: false
documentPermissions:
editPolicy: all
deletePolicy: beforePrinting
createPolicy: newDocumentOrConvert
multiEntityRuleForTxn: topLevelOnly
txnNumbering:
numberingSequence:
key: '12'
id: Adjustment Decrease
href: /objects/company-config/document-sequence/23
preserveSequenceNumbers: false
inheritSourceDocumentNumber: false
inventoryControl:
updatesInventory: quantityAndValue
increaseOrDecreaseInventory: decrease
updatesCost: false
enableWarnOnLowQty: true
warehouseSelectionMethod: sortByID
defaultWarehouse:
key: '21'
id: ARZ
href: /objects/inventory-control/warehouse/21
accounting:
txnPosting: postToGeneralLedger
isSubTotalsEnabled: false
conversionType: closeTxn
pricingAndTerms:
initialPriceList:
id: Base Price List
key: '33'
href: /objects/inventory-control/price-list/21
specialPriceList:
id: Discounted Price
key: '34'
href: /objects/inventory-control/price-list/21
userOverrides:
allowLocationOverride: true
allowDepartmentOverride: true
print:
documentTemplate: Adjustment_US_Template
defaultText: Document template is not selected.
status: active
audit:
createdDateTime: '2023-12-09T01:23:56Z'
modifiedDateTime: '2023-12-09T02:09:37Z'
createdBy: '1'
modifiedBy: '1'
reportingCategory: inventoryAdjustment
inventoryAccountMapping:
- id: '1242'
key: '1242'
inventoryTxnDefinition:
key: '834'
id: Adjustment Decrease
href: /objects/inventory-control/txn-definition/834
itemGLGroup:
key: '13'
id: Inventory- Computers and parts
href: /objects/inventory-control/item-gl-group/13
dimensions:
warehouse:
key: '21'
id: ARZ
href: /objects/inventory-control/warehouse/21
department:
key: '28'
id: Finance
name: Finance
href: /objects/company-config/department/28
location:
key: '22'
id: CA
name: California
href: /objects/company-config/location/22
isOffset: false
txnType: debit
moduleType: inventory
glAccount:
id: '5000.03'
key: '415'
href: /objects/general-ledger/account/415
lineNumber: 0
href: '/objects/inventory-control/txn-definition-cogs-gl-detail/1242'
- id: '1243'
key: '1243'
inventoryTxnDefinition:
key: '834'
id: Adjustment Decrease
href: /objects/inventory-control/txn-definition/834
itemGLGroup:
key: '13'
id: Inventory- Computers and parts
href: /objects/inventory-control/item-gl-group/13
dimensions:
warehouse:
key: '21'
id: ARZ
href: /objects/inventory-control/warehouse/21
department:
key: '28'
id: Finance
name: Finance
href: /objects/company-config/department/28
location:
key: '22'
id: CA
name: California
href: /objects/company-config/location/22
isOffset: false
txnType: credit
moduleType: inventory
glAccount:
id: '1400'
key: '85'
href: /objects/general-ledger/account/85
lineNumber: 1
href: '/objects/inventory-control/txn-definition-cogs-gl-detail/1243'
inventoryTotalDetail:
- id: '1094'
key: '1094'
inventoryTxnDefinition:
key: '834'
id: Adjustment Decrease
href: /objects/inventory-control/txn-definition/834
maintainType: quantityAndValue
inventoryTotal:
id: ONHAND
key: '52'
href: /objects/inventory-control/total/52
operation: subtract
href: '/objects/inventory-control/txn-definition-total-detail/1094'
subtotalDetail: []
sourceDocumentDetail: []
entitySettingDetail: []
href: /objects/inventory-control/txn-definition/834
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update an inventory transaction definition
description: >-
Updates an existing inventory transaction definition by setting field
values. Any fields not provided remain unchanged.
tags:
- Inventory transaction definitions
operationId: update-inventory-control-txn-definition-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-txn-definition'
- type: object
properties:
id:
readOnly: true
examples:
Update an inventory transaction definition:
value:
workflowCategory: adjustment
documentPermissions:
editPolicy: all
deletePolicy: beforePrinting
createPolicy: newDocumentOrConvert
multiEntityRuleForTxn: topLevelOnly
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated inventory-txn-definition
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Update inventory transaction definition:
value:
ia::result:
key: '833'
href: /objects/inventory-control/txn-definition/833
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete an inventory transaction definition
description: Deletes an inventory transaction definition.
tags:
- Inventory transaction definitions
operationId: delete-inventory-control-txn-definition-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/txn-definition-source:
get:
summary: List inventory transaction definition sources
description: >-
Returns a collection with a key, ID, and link for each inventory
transaction definition source.
tags:
- Inventory transaction definition sources
operationId: list-inventory-control-txn-definition-source
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of inventory-txn-definition-source objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List inventory transaction definition sources:
value:
ia::result:
- key: '208'
id: '208'
href: /object/inventory-txn-definition-source/208
- key: '209'
id: '209'
href: /object/inventory-txn-definition-source/209
ia::meta:
totalCount: 2
start: 1
pageSize: 100
next: 101
previous: null
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create an inventory transaction definition source
description: Creates a new inventory transaction definition source.
tags:
- Inventory transaction definition sources
operationId: create-inventory-control-txn-definition-source
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-txn-definition-source'
- $ref: '#/components/schemas/inventory-control-txn-definition-sourceRequiredProperties'
examples:
Create an inventory transaction definition source:
value:
inventoryTxnDefinition:
key: '171'
convertedFrom:
key: '172'
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New inventory-txn-definition-source
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New inventory transaction definition source:
value:
ia::result:
key: '208'
id: '208'
href: /objects/inventory-control/txn-definition-source/208
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/txn-definition-source/{key}:
parameters:
- name: key
description: >-
System-assigned unique key for the inventory transaction definition
source.
in: path
required: true
schema:
type: string
get:
summary: Get an inventory transaction definition source
description: >-
Returns detailed information for a specified inventory transaction
definition source.
tags:
- Inventory transaction definition sources
operationId: get-inventory-control-txn-definition-source-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the inventory-txn-definition-source
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-txn-definition-source'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get an inventory transaction definition source:
value:
ia::result:
key: '208'
id: '208'
inventoryTxnDefinition:
key: '173'
id: Adjustment Decrease
href: /objects/inventory-control/txn-definition/172
convertedFrom:
key: '172'
id: Adjustment Increase
href: /objects/inventory-control/txn-definition/173
href: /objects/inventory-control/txn-definition-source/208
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update an inventory transaction definition source
description: >-
Updates an existing inventory transaction definition source by setting
field values. Any fields not provided remain unchanged.
tags:
- Inventory transaction definition sources
operationId: update-inventory-control-txn-definition-source-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-txn-definition-source'
- type: object
examples:
Update an inventory transaction definition source:
value:
inventoryTxnDefinition:
key: '173'
convertedFrom:
key: '172'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated inventory-txn-definition-source
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated inventory transaction definition source:
value:
ia::result:
key: '208'
id: '208'
href: /objects/inventory-control/txn-definition-source/208
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete an inventory transaction definition source
description: Deletes an inventory transaction definition source.
tags:
- Inventory transaction definition sources
operationId: delete-inventory-control-txn-definition-source-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/txn-definition-cogs-gl-detail:
get:
summary: List inventory transaction definition COGS GL details
description: >-
Returns a collection with a key, ID, and link for each inventory
transaction definition COGS GL detail.
tags:
- Inventory transaction definition COGS GL details
operationId: list-inventory-control-txn-definition-cogs-gl-detail
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of inventory-txn-definition-cogs-gl-detail objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List inventory transaction definition COGS GL details:
value:
ia::result:
- key: '15'
id: '15'
href: '/objects/inventory-control/txn-definition-cogs-gl-detail/15'
- key: '19'
id: '19'
href: '/objects/inventory-control/txn-definition-cogs-gl-detail/19'
- key: '3'
id: '3'
href: '/objects/inventory-control/txn-definition-cogs-gl-detail/3'
ia::meta:
totalCount: 3
start: 1
pageSize: 100
next: null
previous: null
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create an inventory transaction definition COGS GL detail
description: Creates a new inventory transaction definition COGS GL detail.
tags:
- Inventory transaction definition COGS GL details
operationId: create-inventory-control-txn-definition-cogs-gl-detail
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-txn-definition-cogs-gl-detail'
- $ref: '#/components/schemas/inventory-control-txn-definition-cogs-gl-detailRequiredProperties'
examples:
Create an inventory transaction definition COGS GL detail:
value:
inventoryTxnDefinition:
key: '12'
itemGLGroup:
key: '13'
dimensions:
warehouse:
key: '21'
department:
key: '28'
location:
key: '22'
txnType: debit
glAccount:
key: '384'
lineNumber: 0
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New inventory-txn-definition-cogs-gl-detail
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New inventory transaction definition COGS GL detail:
value:
ia::result:
key: '208'
id: '208'
href: '/objects/inventory-control/txn-definition-cogs-gl-detail/208'
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/txn-definition-cogs-gl-detail/{key}:
parameters:
- name: key
description: >-
System-assigned unique key for the inventory transaction definition
COGS GL detail.
in: path
required: true
schema:
type: string
get:
summary: Get an inventory transaction definition COGS GL detail
description: >-
Returns detailed information for a particular inventory transaction
definition COGS GL detail.
tags:
- Inventory transaction definition COGS GL details
operationId: get-inventory-control-txn-definition-cogs-gl-detail-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the inventory-txn-definition-cogs-gl-detail
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-txn-definition-cogs-gl-detail'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get an inventory transaction definition COGS GL detail:
value:
ia::result:
key: '208'
id: '208'
inventoryTxnDefinition:
key: '12'
id: Inventory Adjustment
href: /objects/inventory-control/txn-definition/12
txnType: debit
moduleType: inventory
lineNumber: 0
glAccount:
key: '384'
id: '1501.04'
href: /objects/general-ledger/account/384
itemGLGroup:
key: '13'
id: Inventory- Computers and parts
href: /objects/inventory-control/item-gl-group/13
dimensions:
warehouse:
key: '21'
id: ARZ
href: /objects/inventory-control/warehouse/21
department:
key: '28'
id: Finance
name: Finance
href: /objects/company-config/department/28
location:
key: '22'
id: CA
name: California
href: /objects/company-config/location/22
href: '/objects/inventory-control/txn-definition-cogs-gl-detail/208'
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update an inventory transaction definition COGS GL detail
description: >-
Updates an existing inventory transaction definition COGS GL detail by
setting field values. Any fields not provided remain unchanged.
tags:
- Inventory transaction definition COGS GL details
operationId: update-inventory-control-txn-definition-cogs-gl-detail-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-txn-definition-cogs-gl-detail'
- type: object
examples:
Update an inventory txn definition subtotal COGS GL detail:
value:
glAccount:
key: '232'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated inventory-txn-definition-cogs-gl-detail
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated inventory transaction definition COGS GL detail:
value:
ia::result:
key: '208'
id: '208'
href: '/objects/inventory-control/txn-definition-cogs-gl-detail/208'
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete an inventory transaction definition COGS GL detail
description: Deletes an inventory transaction definition COGS GL detail.
tags:
- Inventory transaction definition COGS GL details
operationId: delete-inventory-control-txn-definition-cogs-gl-detail-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/txn-definition-entity-detail:
get:
summary: List inventory transaction definition entity details
description: >-
Returns a collection with a key, ID, and link for each inventory
transaction definition entity detail.
tags:
- Inventory transaction definition entity details
operationId: list-inventory-control-txn-definition-entity-detail
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of inventory-txn-definition-entity-detail objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
example-1:
value:
ia::result:
- key: '223'
id: '223'
href: /object/inventory-txn-definition-entity-detail/223
- key: '224'
id: '224'
href: /object/inventory-txn-definition-entity-detail/224
ia::meta:
totalCount: 2
start: 1
pageSize: 100
next: 101
previous: null
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create an inventory transaction definition entity detail
description: Creates a new inventory transaction definition entity detail.
tags:
- Inventory transaction definition entity details
operationId: create-inventory-control-txn-definition-entity-detail
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-txn-definition-entity-detail'
- $ref: '#/components/schemas/inventory-control-txn-definition-entity-detailRequiredProperties'
examples:
Create an inventory transaction definition entity detail:
value:
inventoryTxnDefinition:
key: '172'
entity:
key: '1'
txnNumbering:
preserveSequenceNumbering: true
inheritSourceDocumentNumber: false
sequenceNumber:
key: '30'
documentTemplate:
id: Intacct Inventory Adjustment
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New inventory-txn-definition-entity-detail
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New inventory transaction definition entity detail:
value:
ia::result:
key: '225'
id: '225'
href: '/objects/inventory-control/txn-definition-entity-detail/225'
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/txn-definition-entity-detail/{key}:
parameters:
- name: key
description: >-
System-assigned unique key for the inventory transaction definition
entity detail.
in: path
required: true
schema:
type: string
get:
summary: Get an inventory transaction definition entity detail
description: >-
Returns detailed information for a specified inventory transaction
definition entity detail.
tags:
- Inventory transaction definition entity details
operationId: get-inventory-control-txn-definition-entity-detail-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the inventory-txn-definition-entity-detail
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-txn-definition-entity-detail'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get an inventory transaction definition entity detail:
value:
ia::result:
key: '225'
id: '225'
inventoryTxnDefinition:
key: '172'
id: Adjustment Decrease
href: /objects/inventory-control/txn-definition/172
entity:
key: '1'
id: 1-us
href: /objects/company-config/entity/1
txnNumbering:
preserveSequenceNumbering: true
inheritSourceDocumentNumber: false
sequenceNumber:
key: '30'
id: Inventory_Adjustment
href: /objects/company-config/document-sequence/30
documentTemplate:
key: '65'
id: Intacct Inventory Adjustment
href: '/objects/inventory-control/txn-definition-entity-detail/225'
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update an inventory transaction definition entity detail
description: >-
Updates an existing inventory transaction definition entity detail by
setting field values. Any fields not provided remain unchanged.
tags:
- Inventory transaction definition entity details
operationId: update-inventory-control-txn-definition-entity-detail-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-txn-definition-entity-detail'
- type: object
examples:
Update an inventory transaction definition entity detail:
value:
inventoryTxnDefinition:
key: '172'
txnNumbering:
preserveSequenceNumbering: false
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated inventory-txn-definition-entity-detail
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated inventory transaction definition entity detail:
value:
ia::result:
key: '225'
id: '225'
href: '/objects/inventory-control/txn-definition-entity-detail/225'
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete an inventory transaction definition entity detail
description: Deletes an inventory transaction definition entity detail.
tags:
- Inventory transaction definition entity details
operationId: delete-inventory-control-txn-definition-entity-detail-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/txn-definition-subtotal-detail:
get:
summary: List inventory transaction definition subtotal details
description: >-
Returns a collection with a key, ID, and link for each inventory txn
definition subtotal detail.
tags:
- Inventory transaction definition subtotal details
operationId: list-inventory-control-txn-definition-subtotal-detail
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of inventory-txn-definition-subtotal-detail objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List of inventory txn definition subtotal details:
value:
ia::result:
- key: '15'
id: '15'
href: '/objects/inventory-control/txn-definition-subtotal-detail/15'
- key: '19'
id: '19'
href: '/objects/inventory-control/txn-definition-subtotal-detail/19'
- key: '3'
id: '3'
href: '/objects/inventory-control/txn-definition-subtotal-detail/3'
ia::meta:
totalCount: 3
start: 1
pageSize: 100
next: null
previous: null
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create a/an inventory transaction definition subtotal detail
description: Creates a new inventory transaction definition subtotal detail.
tags:
- Inventory transaction definition subtotal details
operationId: create-inventory-control-txn-definition-subtotal-detail
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-txn-definition-subtotal-detail'
- $ref: '#/components/schemas/inventory-control-txn-definition-subtotal-detailRequiredProperties'
examples:
Creates a/an inventory transaction definition subtotal detail:
value:
inventoryTxnDefinition:
key: '64'
subtotalType: discount
lineNumber: 0
description: Discount
valueType: percent
txnType: debit
subtotalValue: '10.10'
appliedToLineNumber: 1
isTax: false
glAccount:
key: '10'
offsetGLAccount:
key: '22'
dimensions:
department:
key: '13'
location:
key: '11'
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New inventory-txn-definition-subtotal-detail
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
example-1:
value:
ia::result:
key: '98'
id: '98'
href: '/objects/inventory-control/txn-definition-subtotal-detail/98'
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/txn-definition-subtotal-detail/{key}:
parameters:
- name: key
description: >-
system-assigned unique key for the inventory txn definition subtotal
detail.
in: path
required: true
schema:
type: string
get:
summary: Get a/an inventory transaction definition subtotal detail
description: >-
Returns detailed information for a particular inventory txn definition
subtotal detail.
tags:
- Inventory transaction definition subtotal details
operationId: get-inventory-control-txn-definition-subtotal-detail-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the inventory-txn-definition-subtotal-detail
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-txn-definition-subtotal-detail'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Details of the inventory transaction definition total:
value:
ia::result:
key: '98'
id: '98'
inventoryTxnDefinition:
key: '64'
id: Inventory Adjustment
href: /objects/inventory-control/txn-definition/64
subtotalType: discount
lineNumber: 0
description: Discount
valueType: percent
subtotalValue: '10.10'
txnType: debit
appliedLineNumber: '1'
isTax: false
glAccount:
key: '10'
id: '1000'
href: /objects/general-ledger/account/3
offsetGLAccount:
key: '20'
id: '1000.01'
href: /objects/general-ledger/account/160
dimensions:
department:
key: '13'
id: '8'
name: Finance
href: /objects/company-config/department/13
location:
key: '12'
id: CA
name: California
href: /objects/company-config/location/12
enableAvaTax: false
href: '/objects/inventory-control/txn-definition-subtotal-detail/98'
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update a/an inventory transaction definition subtotal detail
description: >-
Updates an existing inventory transaction definition subtotal detail by
setting field values. Any fields not provided remain unchanged.
tags:
- Inventory transaction definition subtotal details
operationId: update-inventory-control-txn-definition-subtotal-detail-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-txn-definition-subtotal-detail'
- type: object
examples:
Updates a/an inventory txn definition subtotal detail:
value:
inventoryTxnDefinition:
key: '64'
subtotalType: discount
value: '11.00'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated inventory-txn-definition-subtotal-detail
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
example-1:
value:
ia::result:
key: '98'
id: '98'
href: '/objects/inventory-control/txn-definition-subtotal-detail/98'
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete a/an inventory transaction definition subtotal detail
description: Deletes a/an inventory transaction definition subtotal detail.
tags:
- Inventory transaction definition subtotal details
operationId: delete-inventory-control-txn-definition-subtotal-detail-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/txn-definition-total-detail:
get:
summary: List inventory transaction definition total details.
description: >-
Returns a collection with a key, ID, and link for each inventory
transaction definition total detail.
tags:
- Inventory transaction definition total details
operationId: list-inventory-control-txn-definition-total-detail
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of inventory-txn-definition-total-detail objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
example-1:
value:
ia::result:
- key: '208'
id: '208'
href: '/object/inventory-control/txn-definition-total-detail/208'
- key: '209'
id: '209'
href: '/object/inventory-control/txn-definition-total-detail/209'
ia::meta:
totalCount: 2
start: 1
pageSize: 100
next: 101
previous: null
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create a/an inventory transaction definition total detail.
description: Creates a new inventory transaction definition total detail.
tags:
- Inventory transaction definition total details
operationId: create-inventory-control-txn-definition-total-detail
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-txn-definition-total-detail'
- $ref: '#/components/schemas/inventory-control-txn-definition-total-detailRequiredProperties'
examples:
example-1:
value:
inventoryTotal:
key: '51'
inventoryTxnDefinition:
key: '172'
operation: subtract
maintainType: quantityAndValue
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New inventory-txn-definition-total-detail
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
example-1:
value:
ia::result:
key: '208'
id: '208'
href: '/objects/inventory-control/txn-definition-total-detail/208'
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/txn-definition-total-detail/{key}:
parameters:
- name: key
description: >-
system-assigned unique key for the inventory transaction definition
total.
in: path
required: true
schema:
type: string
get:
summary: Get a/an inventory transaction definition total detail
description: >-
Returns detailed information for a particular inventory transaction
definition total detail.
tags:
- Inventory transaction definition total details
operationId: get-inventory-control-txn-definition-total-detail-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the inventory-txn-definition-total-detail
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-txn-definition-total-detail'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
example-1:
value:
ia::result:
key: '208'
id: '208'
inventoryTxnDefinition:
key: '172'
id: Adjustment Decrease
href: /objects/inventory-control/txn-definition/172
inventoryTotal:
key: '51'
id: ONHAND
href: /objects/inventory-control/total/51
maintainType: quantityAndValue
operation: subtract
href: '/objects/inventory-control/txn-definition-total-detail/208'
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update a/an inventory transaction definition total detail.
description: >-
Updates an existing inventory transaction definition total detail by
setting field values. Any fields not provided remain unchanged.
tags:
- Inventory transaction definition total details
operationId: update-inventory-control-txn-definition-total-detail-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-txn-definition-total-detail'
- type: object
examples:
example-1:
value:
inventoryTxnDefinition:
key: '172'
inventoryTotal:
key: '51'
maintainType: quantity
operation: subtract
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated inventory-txn-definition-total-detail
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
example-1:
value:
ia::result:
key: '208'
id: '208'
href: '/objects/inventory-control/txn-definition-total-detail/208'
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete a/an inventory transaction definition total detail.
description: Deletes a/an inventory transaction definition total detail.
tags:
- Inventory transaction definition total details
operationId: delete-inventory-control-txn-definition-total-detail-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/warehouse-group:
get:
summary: List warehouse groups
description: >-
Returns up to 100 object references from the collection with a key, ID,
and link for each warehouse group. This operation is mostly for use in
testing; use query to find objects that meet certain criteria and to
specify properties that are returned.
tags:
- Warehouse groups
operationId: list-inventory-control-warehouse-group
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of warehouse-group objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List of warehouse groups:
value:
ia::result:
- key: '1'
id: Top Level warehouses
href: /objects/inventory-control/warehouse-group/1
- key: '5'
id: warehouses without Activity
href: /objects/inventory-control/warehouse-group/5
ia::meta:
totalCount: 2
start: 1
pageSize: 100
next: null
previous: null
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create a warehouse group
description: Creates a new warehouse group.
tags:
- Warehouse groups
operationId: create-inventory-control-warehouse-group
requestBody:
description: Create a new warehouse group
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-warehouse-group'
- $ref: '#/components/schemas/inventory-control-warehouse-groupRequiredProperties'
examples:
Creates a warehouse group:
value:
id: EastCoastWarehouses
name: EastCoast Warehouses
description: Warehouses on eastcoast
groupType: specific
createDimensionComponents: true
memberFilter: []
maxMatches: 0
sortField: warehouseId
conditionType: and
expression: ''
sortOrder: ascending
groupMembers:
- warehouse:
id: W1
sortOrder: 0
- warehouse:
id: W2
sortOrder: 1
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New warehouse group
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New warehouse group created:
value:
ia::result:
key: '4'
id: EastCoastWarehouses
href: /objects/inventory-control/warehouse-group/4
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/warehouse-group/{key}:
parameters:
- name: key
description: System-assigned unique key for the warehouse group.
in: path
required: true
schema:
type: string
get:
summary: Get a warehouse group
description: Returns detailed information for a specified warehouse group.
tags:
- Warehouse groups
operationId: get-inventory-control-warehouse-group-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the warehouse-group
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-warehouse-group'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get a warehouse group:
value:
ia::result:
key: '12'
id: BooksWarehouses
name: Books Warehouses
description: Warehouses store Books
groupType: all
memberFilter:
- field: status
operator: equals
value: active
audit:
createdDateTime: '2023-12-12T23:33:05Z'
modifiedDateTime: '2023-12-12T23:33:05Z'
createdBy: '1'
modifiedBy: '1'
glAccountGroup:
id: BooksWarehouses
groupMembers: []
maxMatches: 10
sortField: warehouseId
conditionType: and
expression: ''
sortOrder: ascending
href: /objects/inventory-control/warehouse-group/12
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update a warehouse group
description: >-
Updates an existing warehouse group by setting field values. Any fields
not provided remain unchanged.
tags:
- Warehouse groups
operationId: update-inventory-control-warehouse-group-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-warehouse-group'
- type: object
properties:
id:
example: 4
readOnly: true
examples:
Update a single value:
value:
description: Warehouses store Books and notebooks
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated warehouse-group
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Update a single value:
value:
ia::result:
key: '12'
id: BooksWarehouses
href: /objects/inventory-control/warehouse-group/12
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete a warehouse group
description: >-
Deletes a warehouse group. A warehouse group can be deleted if it is not
being used for reporting.
tags:
- Warehouse groups
operationId: delete-inventory-control-warehouse-group-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/cycle/{key}:
parameters:
- name: key
description: System-assigned unique key for the inventory cycle.
in: path
required: true
schema:
type: string
get:
summary: Get an inventory cycle
description: Returns detailed information for a particular inventory cycle.
tags:
- Inventory cycles
operationId: get-inventory-control-cycle-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the inventory-cycle
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-cycle'
ia::meta:
$ref: '#/components/schemas/metadata'
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/cycle:
get:
summary: List inventory cycles
description: Returns a collection with a key, ID, and link for each inventory cycle.
tags:
- Inventory cycles
operationId: list-inventory-control-cycle
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of inventory-cycle objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/document:
get:
summary: List inventory documents
description: >-
Returns a collection with a key, ID, and link for each inventory
document.
tags:
- Inventory Control documents
operationId: list-inventory-control-document
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of inventory-control-document objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List of inventory documents:
value:
ia::result:
- key: '1477'
id: SYS-Warehouse Transfer Out-WHXFER-000009-doc-Out
href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/1477'
- key: '1478'
id: SYS-Warehouse Transfer In-WHXFER-000009-doc-In
href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20In/1478'
- key: '298'
id: Adjustment Decrease-007
href: '/objects/inventory-control/document::Adjustment%20Decrease/298'
- key: '607'
id: Beginning Balance-ADJINC0001
href: '/objects/inventory-control/document::Beginning%20Balance/607'
ia::meta:
totalCount: 4
start: 1
pageSize: 100
next: null
previous: null
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/document/{key}:
parameters:
- name: key
description: system-assigned unique key for the Inventory Control document.
in: path
required: true
schema:
type: string
get:
summary: Get an Inventory Control document
description: >-
Returns detailed information for a particular Inventory Control
document.
tags:
- Inventory Control documents
operationId: get-inventory-control-document-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the Inventory Control document
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-document'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Details of the inventory document:
value:
ia::result:
key: '3903'
documentNumber: WHXFER-000033-doc-In
id: SYS-Warehouse Transfer In-WHXFER-000033-doc-In
sourceDocument:
id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out
state: closed
transactionDate: '2024-02-14'
audit:
createdDateTime: '2024-02-14T21:43:07Z'
createdBy: '1'
modifiedBy: '1'
modifiedDateTime: '2024-02-14T21:43:08Z'
referenceNumber: HAMMER16 weekly transfer
documentType: SYS-Warehouse Transfer In
txnDefinition:
documentType: SYS-Warehouse Transfer In
id: SYS-Warehouse Transfer In
key: '78'
txnDefinitionTemplateClass: INVOICE
updatesInventory: quantityAndValue
increaseOrDecreaseInventory: increase
href: '/objects/inventory-control/txn-definition::SYS-Warehouse%20Transfer%20In/78'
warehouse:
defaultWarehouse: null
memo: CA to AZ transfer
inventoryBatch:
id: '791'
key: '791'
journalEntryKey: '1276'
href: /objects/inventory-control/batch/791
isPrinted: false
subTotal: '0.00'
total: '0.00'
txnCurrency: USD
exchangeRate:
date: '2024-02-14'
rate: '1.0000'
typeId: null
typeName: null
subtotalInTxnCurrency: '0.00'
totalInTxnCurrency: '0.00'
baseCurrency: USD
lastPrintedDate: null
printedBy:
key: null
id: null
isAdjustmentDocument: false
lines:
- id: '3706'
key: '3706'
documentHeader:
documentNumber: '3903'
key: '3903'
id: SYS-Warehouse Transfer In-WHXFER-000033-doc-In
documentType: SYS-Warehouse Transfer In
href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20In/3903'
documentType: SYS-Warehouse Transfer In
lineNumber: 0
dimensions:
item:
key: '907'
id: HAMMER16--16oz framing claw hammer
name: 16oz framing claw hammer
href: /objects/inventory-control/item/907
warehouse:
id: WareHouse10005
key: '8'
href: /objects/inventory-control/warehouse/8
location:
id: '1'
key: '6'
href: /objects/company-config/location/6
department:
id: null
key: null
project:
key: null
id: null
task:
key: null
id: null
item:
key: '907'
id: HAMMER16--16oz framing claw hammer
href: /objects/inventory-control/item/907
unit: Each
memo: null
quantity: '25.0000000000'
quantityConverted: '0.0000000000'
cost: '0.0000000000'
totalCost: '0'
audit:
modifiedDateTime: '2024-02-14T21:43:07Z'
createdDateTime: '2024-02-14T21:43:07Z'
createdBy: '1'
modifiedBy: '1'
status: active
costMethod: standard
unitQuantity: '25.0000000000'
multiplier: '1'
unitCost: '0.0000000000'
extendedCost: '0'
sourceDocument:
key: '3902'
id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out
documentType: SYS-Warehouse Transfer Out
href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3902'
sourceDocumentLine:
id: '3705'
key: '3705'
documentType: SYS-Warehouse Transfer In
href: '/objects/inventory-control/document-line::SYS-Warehouse%20Transfer%20In/3705'
txnCurrency: USD
baseCurrency: USD
conversionType: quantity
quantityRemaining: '25.0000000000'
trackingDetail:
- id: '3772'
key: '3772'
inventoryDocumentLine:
id: '3706'
key: '3706'
documentType: SYS-Warehouse Transfer In
href: '/objects/inventory-control/document-line::SYS-Warehouse%20Transfer%20In/3706'
item:
id: HAMMER16
key: '907'
href: /objects/inventory-control/item/907
quantity: '25.0000000000'
serialNumber: null
lotNumber: null
aisle:
key: null
id: null
row:
key: null
id: null
bin:
key: '8'
id: B#001
href: /objects/inventory-control/bin/8
expirationDate: null
audit:
createdDateTime: '2024-02-14T21:43:07Z'
modifiedDateTime: '2024-02-14T21:43:07Z'
createdBy: '1'
modifiedBy: '1'
href: '/objects/inventory-control/document-line-detail/3772'
href: '/objects/inventory-control/document-line::SYS-Warehouse%20Transfer%20In/3706'
history:
- id: '3123'
key: '3123'
convertedTo:
key: '3902'
id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out
documentType: SYS-Warehouse Transfer Out
href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3902'
convertedFrom:
id: null
documentType: null
key: null
inventoryDocument:
key: '3902'
id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out
documentType: SYS-Warehouse Transfer Out
href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3902'
href: /objects/inventory-control/document-history/3123
- id: '3124'
key: '3124'
convertedTo:
key: '3903'
id: SYS-Warehouse Transfer In-WHXFER-000033-doc-In
documentType: SYS-Warehouse Transfer In
href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20In/3903'
convertedFrom:
id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out
documentType: SYS-Warehouse Transfer Out
key: '3902'
href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3902'
inventoryDocument:
key: '3902'
id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out
documentType: SYS-Warehouse Transfer Out
href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3902'
href: /objects/inventory-control/document-history/3124
attachment:
id: null
key: null
subtotals:
- description: SUBTOTAL
total: '0.00000000000000'
txnTotal: '0.00000000000000'
- description: TOTAL
total: '0.00000000000000'
txnTotal: '0.00000000000000'
href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20In/3903'
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/document::{documentName}:
get:
summary: List named inventory documents
description: >-
Returns a collection with a key, ID, and link for each inventory
document with the specified name. This operation is mostly for use in
testing; use query to find objects that meet certain criteria and to
specify properties that are returned.
tags:
- Inventory Control documents
operationId: list-inventory-control-named-document
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of Inventory Control documents
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List of Inventory Control documents:
value:
ia::result:
- key: '1477'
id: SYS-Warehouse Transfer Out-WHXFER-000009-doc-Out
href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/1477'
- key: '3051'
id: SYS-Warehouse Transfer Out-WHXFER-000023-doc-Out
href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3051'
- key: '2970'
id: SYS-Warehouse Transfer Out-WHXFER-000021-doc-Out
href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/2970'
- key: '3166'
id: SYS-Warehouse Transfer Out-WHXFER-000024-doc-Out
href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3166'
ia::meta:
totalCount: 4
start: 1
pageSize: 100
next: null
previous: null
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create an Inventory Control document
description: Creates a new Inventory Control document.
tags:
- Inventory Control documents
operationId: create-inventory-control-document
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-document'
- $ref: '#/components/schemas/inventory-control-documentRequiredProperties'
examples:
Create an Inventory Control document:
value:
state: pending
transactionDate: '2024-02-14'
referenceNumber: HAMMER16 starting quantity
memo: Hammers already on hand
lines:
- unit: Each
unitQuantity: '100'
unitCost: '10'
dimensions:
item:
id: HAMMER16
warehouse:
id: WareHouse10004
location:
id: '1'
trackingDetail:
- quantity: '100'
bin:
id: B1004-001
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New inventory-control-document
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New Inventory document:
value:
ia::result:
key: '13977'
id: Beginning Balance-ADJINC0009
href: '/objects/inventory-control/document::Beginning%20Balance/13977'
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
parameters:
- $ref: '#/components/parameters/documentName'
/objects/inventory-control/document::{documentName}/{key}:
parameters:
- name: key
description: System-assigned unique key for the inventory document.
in: path
required: true
schema:
type: string
- $ref: '#/components/parameters/documentName'
get:
summary: Get a named Inventory Control document
description: Returns detailed information for a specified Inventory Control document.
tags:
- Inventory Control documents
operationId: get-inventory-control-named-document-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the inventory-control-document
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-document'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Details of the Inventory Control document:
value:
ia::result:
key: '3903'
documentNumber: WHXFER-000033-doc-In
id: SYS-Warehouse Transfer In-WHXFER-000033-doc-In
sourceDocument:
id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out
state: closed
transactionDate: '2024-02-14'
audit:
createdDateTime: '2024-02-14T21:43:07Z'
createdBy: '1'
modifiedBy: '1'
modifiedDateTime: '2024-02-14T21:43:08Z'
referenceNumber: HAMMER16 weekly transfer
documentType: SYS-Warehouse Transfer In
txnDefinition:
documentType: SYS-Warehouse Transfer In
id: SYS-Warehouse Transfer In
key: '78'
txnDefinitionTemplateClass: INVOICE
updatesInventory: quantityAndValue
increaseOrDecreaseInventory: increase
href: '/objects/inventory-control/txn-definition::SYS-Warehouse%20Transfer%20In/78'
warehouse:
defaultWarehouse: null
memo: CA to AZ transfer
inventoryBatch:
id: '791'
key: '791'
journalEntryKey: '1276'
href: /objects/inventory-control/batch/791
isPrinted: false
subTotal: '0.00'
total: '0.00'
txnCurrency: USD
exchangeRate:
date: '2024-02-14'
rate: '1.0000'
typeId: null
typeName: null
subtotalInTxnCurrency: '0.00'
totalInTxnCurrency: '0.00'
baseCurrency: USD
lastPrintedDate: null
printedBy:
key: null
id: null
isAdjustmentDocument: false
lines:
- id: '3706'
key: '3706'
documentHeader:
documentNumber: '3903'
key: '3903'
id: SYS-Warehouse Transfer In-WHXFER-000033-doc-In
documentType: SYS-Warehouse Transfer In
href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20In/3903'
documentType: SYS-Warehouse Transfer In
lineNumber: 0
dimensions:
item:
key: '907'
id: HAMMER16--16oz framing claw hammer
name: 16oz framing claw hammer
href: /objects/inventory-control/item/907
warehouse:
id: WareHouse10005
key: '8'
href: /objects/inventory-control/warehouse/8
location:
id: '1'
key: '6'
href: /objects/company-config/location/6
department:
id: null
key: null
project:
key: null
id: null
task:
key: null
id: null
item:
key: '907'
id: HAMMER16--16oz framing claw hammer
href: /objects/inventory-control/item/907
unit: Each
memo: null
quantity: '25.0000000000'
quantityConverted: '0.0000000000'
cost: '0.0000000000'
totalCost: '0'
audit:
modifiedDateTime: '2024-02-14T21:43:07Z'
createdDateTime: '2024-02-14T21:43:07Z'
createdBy: '1'
modifiedBy: '1'
status: active
costMethod: standard
unitQuantity: '25.0000000000'
multiplier: '1'
unitCost: '0.0000000000'
extendedCost: '0'
sourceDocument:
key: '3902'
id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out
documentType: SYS-Warehouse Transfer Out
href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3902'
sourceDocumentLine:
id: '3705'
key: '3705'
documentType: SYS-Warehouse Transfer In
href: '/objects/inventory-control/document-line::SYS-Warehouse%20Transfer%20In/3705'
txnCurrency: USD
baseCurrency: USD
conversionType: quantity
quantityRemaining: '25.0000000000'
trackingDetail:
- id: '3772'
key: '3772'
inventoryDocumentLine:
id: '3706'
key: '3706'
documentType: SYS-Warehouse Transfer In
href: '/objects/inventory-control/document-line::SYS-Warehouse%20Transfer%20In/3706'
item:
id: HAMMER16
key: '907'
href: /objects/inventory-control/item/907
quantity: '25.0000000000'
serialNumber: null
lotNumber: null
aisle:
key: null
id: null
row:
key: null
id: null
bin:
key: '8'
id: B#001
href: /objects/inventory-control/bin/8
expirationDate: null
audit:
createdDateTime: '2024-02-14T21:43:07Z'
modifiedDateTime: '2024-02-14T21:43:07Z'
createdBy: '1'
modifiedBy: '1'
href: '/objects/inventory-control/document-line-detail/3772'
href: '/objects/inventory-control/document-line::SYS-Warehouse%20Transfer%20In/3706'
history:
- id: '3123'
key: '3123'
convertedTo:
key: '3902'
id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out
documentType: SYS-Warehouse Transfer Out
href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3902'
convertedFrom:
id: null
documentType: null
key: null
inventoryDocument:
key: '3902'
id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out
documentType: SYS-Warehouse Transfer Out
href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3902'
href: /objects/inventory-control/document-history/3123
- id: '3124'
key: '3124'
convertedTo:
key: '3903'
id: SYS-Warehouse Transfer In-WHXFER-000033-doc-In
documentType: SYS-Warehouse Transfer In
href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20In/3903'
convertedFrom:
id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out
documentType: SYS-Warehouse Transfer Out
key: '3902'
href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3902'
inventoryDocument:
key: '3902'
id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out
documentType: SYS-Warehouse Transfer Out
href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3902'
href: /objects/inventory-control/document-history/3124
attachment:
id: null
key: null
subtotals:
- description: SUBTOTAL
total: '0.00'
txnTotal: '0.00'
- description: TOTAL
total: '0.00'
txnTotal: '0.00'
href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20In/3903'
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update an Inventory Control document
description: >-
Updates an existing Inventory Control document by setting field values.
Any fields not provided remain unchanged.
tags:
- Inventory Control documents
operationId: update-inventory-control-document-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-document'
- type: object
properties:
id:
readOnly: true
examples:
Update an Inventory Control document:
value:
referenceNumber: Updated quantity and tracking information
lines:
- key: '3698'
unitQuantity: '3'
trackingDetail:
- key: '3766'
quantity: '2'
- key: '3767'
ia::operation: delete
- quantity: '1'
lotNumber: Lot#666
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated inventory-control-document
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated Inventory Control document:
value:
ia::result:
key: '3905'
id: Beginning Balance-ADJINC0020
href: '/objects/inventory-control/document::Beginning%20Balance/3905'
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete an Inventory Control document
description: Deletes an Inventory Control document
tags:
- Inventory documents
operationId: delete-inventory-control-document-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/document-line:
get:
summary: List Inventory Control document lines
description: >-
Returns a collection with a key, ID, and link for each Inventory Control
document line.
tags:
- Inventory Control document lines
operationId: list-inventory-control-document-line
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of inventory-document-line objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List of Inventory Control document lines:
value:
ia::result:
- key: '2905'
id: '2905'
href: '/objects/inventory-control/document-line::Beginning%20Balance/2905'
- key: '3703'
id: '3703'
href: '/objects/inventory-control/document-line::Adjustment%20Increase%20Value/3703'
- key: '2751'
id: '2751'
href: '/objects/inventory-control/document-line::SYS-Warehouse%20Transfer%20Out/2751'
ia::meta:
totalCount: 3
start: 1
pageSize: 100
next: null
previous: null
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/document-line/{key}:
parameters:
- name: key
description: system-assigned unique key for the Inventory Control document line.
in: path
required: true
schema:
type: string
get:
summary: Get an Inventory Control document line
description: >-
Returns detailed information for a particular Inventory Control document
line.
tags:
- Inventory Control document lines
operationId: get-inventory-control-document-line-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the inventory document line
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-document-line'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Details of the Inventory Control document line:
value:
ia::result:
id: '3705'
key: '3705'
documentHeader:
documentNumber: '3902'
key: '3902'
id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out
documentType: SYS-Warehouse Transfer Out
href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3902'
documentType: SYS-Warehouse Transfer Out
lineNumber: 0
dimensions:
item:
key: '907'
id: HAMMER16
name: 16oz framing claw hammer
href: /objects/inventory-control/item/907
warehouse:
id: WareHouse10004
key: '4'
href: /objects/inventory-control/warehouse/4
location:
id: '1'
key: '6'
href: /objects/company-config/location/6
department:
id: null
key: null
project:
key: null
id: null
task:
key: null
id: null
item:
key: '907'
id: HAMMER16
href: /objects/inventory-control/item/907
unit: Each
memo: CA to AZ transfer
quantity: '25.0000000000'
quantityConverted: '25.0000000000'
cost: '0.0000000000'
totalCost: '0'
audit:
modifiedDateTime: '2024-02-14T21:43:07Z'
createdDateTime: '2024-02-14T21:43:06Z'
createdBy: '1'
modifiedBy: '1'
status: active
costMethod: standard
unitQuantity: '25.0000000000'
multiplier: '1'
unitCost: '0.0000000000'
extendedCost: '0'
sourceDocument:
key: null
id: null
documentType: null
sourceDocumentLine:
id: null
key: null
documentType: SYS-Warehouse Transfer Out
txnCurrency: USD
baseCurrency: USD
conversionType: quantity
quantityRemaining: '0.0000000000'
trackingDetail:
- id: '3771'
key: '3771'
inventoryDocumentLine:
id: '3705'
key: '3705'
documentType: SYS-Warehouse Transfer Out
href: '/objects/inventory-control/document-line::SYS-Warehouse%20Transfer%20Out/3705'
item:
id: HAMMER16
key: '907'
href: /objects/inventory-control/item/907
quantity: '25.0000000000'
serialNumber: ''
lotNumber: ''
aisle:
key: ''
id: ''
row:
key: ''
id: ''
bin:
key: '4'
id: B1004-001
href: /objects/inventory-control/bin/4
expirationDate: ''
audit:
createdDateTime: '2024-02-14T21:43:06Z'
modifiedDateTime: '2024-02-14T21:43:06Z'
createdBy: '1'
modifiedBy: '1'
href: /objects/inventory-control/document-line-detail/3771
href: '/objects/inventory-control/document-line::SYS-Warehouse%20Transfer%20Out/3705'
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/document-line::{documentName}:
get:
summary: List named Inventory Control document lines
description: >-
Returns a collection with a key, ID, and link for each named Inventory
Control document line. This operation is mostly for use in testing; use
query to find objects that meet certain criteria and to specify
properties that are returned.
tags:
- Inventory Control document lines
operationId: list-inventory-control-named-document-line
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of inventory-control-document-line objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List of Inventory Control document lines:
value:
ia::result:
- key: '624'
id: '624'
href: '/objects/inventory-control/document-line::Beginning%20Balance/624'
- key: '3605'
id: '3605'
href: '/objects/inventory-control/document-line::Beginning%20Balance/3605'
- key: '3628'
id: '3628'
href: '/objects/inventory-control/document-line::Beginning%20Balance/3628'
ia::meta:
totalCount: 3
start: 1
pageSize: 100
next: null
previous: null
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
parameters:
- $ref: '#/components/parameters/documentName'
/objects/inventory-control/document-line::{documentName}/{key}:
parameters:
- name: key
description: System-assigned key for the inventory document line.
in: path
required: true
schema:
type: string
- $ref: '#/components/parameters/documentName'
get:
summary: Get a named Inventory Control document line
description: >-
Returns detailed information for a specified Inventory Control document
line
tags:
- Inventory Control document lines
operationId: get-inventory-control-named-document-line-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the inventory-control-document-line
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-document-line'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Details of the Inventory Control document line:
value:
ia::result:
id: '3705'
key: '3705'
documentHeader:
documentNumber: '3902'
key: '3902'
id: SYS-Warehouse Transfer Out-WHXFER-000033-doc-Out
documentType: SYS-Warehouse Transfer Out
href: '/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/3902'
documentType: SYS-Warehouse Transfer Out
lineNumber: 0
dimensions:
item:
key: '907'
id: HAMMER16
name: 16oz framing claw hammer
href: /objects/inventory-control/item/907
warehouse:
id: WareHouse10004
key: '4'
href: /objects/inventory-control/warehouse/4
location:
id: '1'
key: '6'
href: /objects/company-config/location/6
department:
id: null
key: null
project:
key: null
id: null
task:
key: null
id: null
item:
key: '907'
id: HAMMER16
href: /objects/inventory-control/item/907
unit: Each
memo: CA to AZ transfer
quantity: '25.0000000000'
quantityConverted: '25.0000000000'
cost: '0.0000000000'
totalCost: '0'
audit:
modifiedDateTime: '2024-02-14T21:43:07Z'
createdDateTime: '2024-02-14T21:43:06Z'
createdBy: '1'
modifiedBy: '1'
status: active
costMethod: standard
unitQuantity: '25.0000000000'
multiplier: '1'
unitCost: '0.0000000000'
extendedCost: '0'
sourceDocument:
key: null
id: null
documentType: null
sourceDocumentLine:
id: null
key: null
documentType: SYS-Warehouse Transfer Out
txnCurrency: USD
baseCurrency: USD
conversionType: quantity
quantityRemaining: '0.0000000000'
trackingDetail:
- id: '3771'
key: '3771'
inventoryDocumentLine:
id: '3705'
key: '3705'
documentType: SYS-Warehouse Transfer Out
href: '/objects/inventory-control/document-line::SYS-Warehouse%20Transfer%20Out/3705'
item:
id: HAMMER16
key: '907'
href: /objects/inventory-control/item/907
quantity: '25.0000000000'
serialNumber: ''
lotNumber: ''
aisle:
key: ''
id: ''
row:
key: ''
id: ''
bin:
key: '4'
id: B1004-001
href: /objects/inventory-control/bin/4
expirationDate: ''
audit:
createdDateTime: '2024-02-14T21:43:06Z'
modifiedDateTime: '2024-02-14T21:43:06Z'
createdBy: '1'
modifiedBy: '1'
href: /objects/inventory-control/document-line-detail/3771
href: '/objects/inventory-control/document-line::SYS-Warehouse%20Transfer%20Out/3705'
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/document-subtotal:
get:
summary: List inventory document subtotals
description: >-
Returns a collection with a key, ID, and link for each inventory
document subtotal.
tags:
- Inventory document subtotals
operationId: list-inventory-control-document-subtotal
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of inventory-document-subtotal objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List of inventory document subtotals:
value:
ia::result:
- key: '13'
id: '13'
href: /objects/inventory-control/document-subtotal/13
- key: '14'
id: '14'
href: /objects/inventory-control/document-subtotal/14
- key: '15'
id: '15'
href: /objects/inventory-control/document-subtotal/15
ia::meta:
totalCount: 3
start: 1
pageSize: 100
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/document-subtotal/{key}:
parameters:
- name: key
description: System-assigned unique key for the inventory document subtotal.
in: path
required: true
schema:
type: string
get:
summary: Get an inventory document subtotal
description: >-
Returns detailed information for a particular inventory document
subtotal.
tags:
- Inventory document subtotals
operationId: get-inventory-control-document-subtotal-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the inventory-document-subtotal
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-document-subtotal'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Details of the inventory document subtotal:
value:
ia::result:
id: '7902'
key: '7902'
documentHeader:
key: '7808'
id: Inventory Receipt-IR-000253
documentType: Inventory Receipt
href: '/objects/inventory-control/document::Inventory%20Receipt/7808'
description: Freight
absoluteValue: '1.20'
percentValue: '5.0000000000'
total: '1.20000000000000'
isValueEditable: false
isPercentEditable: true
dimensions:
location:
key: '1'
id: '1'
href: /objects/company-config/location/1
department:
key: ''
id: ''
project:
key: ''
id: ''
name: ''
customer:
key: ''
id: ''
name: ''
vendor:
key: ''
id: ''
name: ''
employee:
key: ''
id: ''
name: ''
class:
key: ''
id: ''
name: ''
contract:
key: ''
id: ''
name: ''
warehouse:
key: '3'
id: WH10001
name: US AZ Warehouse 10001
href: /objects/inventory-control/warehouse/3
item:
key: '749'
id: FFSTD
name: FF Samples
href: /objects/inventory-control/item/749
nsp::product_line1:
key: null
id: null
txnAbsoluteValue: '1.20'
txnTotal: '1.20000000000000'
documentLine:
id: '62991'
key: '62991'
documentType: Inventory Receipt
href: '/objects/inventory-control/document-line::Inventory%20Receipt/62991'
audit:
createdDateTime: '2023-02-23T19:42:47Z'
modifiedDateTime: '2023-02-23T19:42:47Z'
createdBy: '1'
modifiedBy: '1'
nsp::GLDIMREGION: null
nsp::GLDIMVERTICAL: null
href: /objects/inventory-control/document-subtotal/7902
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/item-group:
get:
summary: List of item group objects
description: >-
Returns up to 100 item group references from the collection with a key,
ID, and link for each item group. This operation is mostly for use in
testing; use query to find objects that meet certain criteria and to
specify properties that are returned.
tags:
- Item groups
operationId: list-inventory-control-item-group
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of item-group objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List of item groups:
value:
ia::result:
- key: '1'
id: Top Level Items
href: /objects/inventory-control/item-group/1
- key: '5'
id: Items with Activity
href: /objects/inventory-control/item-group/5
- key: '6'
id: Costing Group
href: /objects/inventory-control/item-group/6
ia::meta:
totalCount: 3
start: 1
pageSize: 100
next: null
previous: null
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create an item group
description: Creates a new item group.
tags:
- Item groups
operationId: create-inventory-control-item-group
requestBody:
description: Create a new item group
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-item-group'
- $ref: '#/components/schemas/inventory-control-item-groupRequiredProperties'
examples:
Creates an item group:
value:
id: InsuranceItemsGroup
name: Insurance Items Group
description: Items that require insurance
groupType: specific
createDimensionComponents: true
memberFilter: []
maxMatches: 0
sortField: itemId
conditionType: and
expression: ''
sortOrder: ascending
groupMembers:
- item:
id: Monitor-HP
sortOrder: 0
- item:
id: Monitor-Dell
sortOrder: 1
- item:
id: Monitor-Asus
sortOrder: 2
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New item group
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New item group created:
value:
ia::result:
key: '14'
id: InsuranceItemsGroup
href: /objects/inventory-control/item-group/14
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/inventory-control/item-group/{key}:
parameters:
- name: key
description: System-assigned unique key for the item group.
in: path
required: true
schema:
type: string
get:
summary: Get an item group
description: Returns detailed information for a specified item group.
tags:
- Item groups
operationId: get-inventory-control-item-group-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the item-group
properties:
ia::result:
$ref: '#/components/schemas/inventory-control-item-group'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Get an item group:
value:
ia::result:
key: '12'
id: BooksGroup
name: BooksGroup
description: Group for Books
groupType: all
memberFilter:
- field: productLineId
operator: contains
value: BK
audit:
createdDateTime: '2023-12-12T23:33:05Z'
modifiedDateTime: '2023-12-12T23:33:05Z'
createdBy: '1'
modifiedBy: '1'
glAccountGroup:
id: BooksGroup
groupMembers: []
maxMatches: 10
sortField: itemId
conditionType: and
expression: ''
sortOrder: ascending
href: /objects/inventory-control/item-group/12
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update an item group
description: >-
Updates an existing item group by setting field values. Any fields not
provided remain unchanged.
tags:
- Item groups
operationId: update-inventory-control-item-group-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/inventory-control-item-group'
- type: object
properties:
id:
example: 12
readOnly: true
examples:
Update a single value:
value:
description: Group for Reference Books
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Update a single value:
value:
ia::result:
key: '12'
id: BooksGroup
href: /objects/inventory-control/item-group/12
ia::meta:
totalCount: 1
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete an item group
description: >-
Deletes an item group. An item group can be deleted if it is not being
used for reporting.
tags:
- Item groups
operationId: delete-inventory-control-item-group-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
components:
schemas:
inventory-control-aisleRequiredProperties:
type: object
required:
- id
object-reference:
type: object
description: Reference to created or updated object
properties:
key:
type: string
example: '12345'
id:
type: string
example: ID123
href:
type: string
readOnly: true
example: /objects///12345
metadata-pages:
description: Metadata for collection response
type: object
properties:
totalCount:
type: integer
description: Total count
readOnly: true
example: 3
start:
type: integer
description: Start element number
readOnly: true
example: 1
pageSize:
type: integer
description: Page size
readOnly: true
example: 100
next:
type: integer
description: Next element number
readOnly: true
nullable: true
example: 101
previous:
type: integer
description: Previous element number
readOnly: true
nullable: true
example: null
error-response:
type: object
description: Error response
properties:
ia::result:
type: object
properties:
ia::error:
type: object
properties:
code:
type: string
example: invalidRequest
message:
type: string
example: Payload contains errors
supportId:
type: string
example: sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ
errorId:
type: string
example: REST-1064
additionalInfo:
type: object
properties:
messageId:
type: string
example: IA.PAYLOAD_CONTAINS_ERRORS
placeholders:
type: string
propertySet:
type: string
details:
type: array
items:
type: object
properties:
code:
type: string
example: invalidRequest
message:
type: string
example: /testDate is not a valid field
errorId:
type: string
example: REST-1043
target:
type: string
example: /testDate
additionalInfo:
type: object
properties:
messageId:
type: string
example: IA.NOT_A_VALID_FIELD
placeholders:
type: string
example:
FIELD: /testDate
propertySet:
type: string
ia::meta:
$ref: '#/components/schemas/metadata'
audit:
type: object
properties:
createdDateTime:
description: Time of the submission
type: string
format: date-time
example: '2022-04-20T16:20:00Z'
readOnly: true
modifiedDateTime:
description: Time of the modification
type: string
format: date-time
example: '2022-04-20T16:20:00Z'
readOnly: true
createdBy:
description: User who created this
type: string
example: '1'
readOnly: true
nullable: true
modifiedBy:
description: User who modified this
type: string
example: '95'
readOnly: true
nullable: true
readOnly: true
inventory-control-aisle:
type: object
description: >-
An aisle is one of four optional attributes (zone, aisle, row, and bin
face) you can assign to a bin to make it easier to find in the
warehouse.
properties:
key:
type: string
description: System-assigned key for the aisle.
example: '13'
readOnly: true
id:
type: string
description: >-
Name or other unique identifier for the aisle. The aisle ID cannot
be modified.
example: A2
description:
type: string
description: Description for the aisle.
example: Aisle 2 Dishwashers
href:
type: string
description: URL for the aisle.
readOnly: true
example: /objects/inventory-control/aisle/13
audit:
$ref: '#/components/schemas/audit'
metadata:
description: Metadata for response
type: object
properties:
totalCount:
type: integer
description: Total count
readOnly: true
example: 3
totalSuccess:
type: integer
description: Total success
readOnly: true
example: 2
totalError:
type: integer
description: Total errors
readOnly: true
example: 1
inventory-control-bin-faceRequiredProperties:
type: object
required:
- id
inventory-control-bin-face:
type: object
description: >-
A bin face is one of four optional attributes (zone, aisle, row, and bin
face) you can assign to a bin to make it easier to find the bin within
the warehouse.
properties:
key:
type: string
description: System-assigned key for the bin face.
example: '3'
readOnly: true
id:
type: string
description: >-
Unique identifier or name for the bin face. The bin face ID cannot
be modified.
example: BF232
description:
type: string
description: Description for the bin face.
example: Bin Face 232
href:
type: string
description: URL for the bin face.
example: /objects/inventory-control/bin-face/3
readOnly: true
audit:
$ref: '#/components/schemas/audit'
inventory-control-bin-sizeRequiredProperties:
type: object
required:
- id
inventory-control-bin-size:
type: object
description: >-
A bin size in an attribute you can assign to a bin to help determine
whether the bin is suitable for storing certain items.
properties:
key:
type: string
description: System-assigned key for the bin size.
example: '5'
readOnly: true
id:
type: string
description: >-
Unique identifier or name for the bin size. This ID should make it
easy to understand the bin size. This ID cannot be modified.
example: 2x2
description:
type: string
description: Description for the bin size.
example: Bin Size 10 Wrenches
href:
type: string
description: URL for the bin size.
example: /objects/inventory-control/bin-size/5
readOnly: true
audit:
$ref: '#/components/schemas/audit'
inventory-control-binRequiredProperties:
type: object
required:
- id
status:
type: string
description: >-
Object status. Active objects are fully functional. Inactive objects are
essentially hidden and cannot be used or referenced.
enum:
- active
- inactive
default: active
example: active
inventory-control-bin:
type: object
description: >-
A bin identifies a specific location within a warehouse where items are
or can be stored. Bins make it easier to find items during transaction
processing.
properties:
key:
type: string
description: System-assigned key for the bin.
example: '10'
maxLength: 8
readOnly: true
id:
type: string
description: >-
Name or other unique identifier for the bin. The identifier should
make it easy to find the bin. For example, if bin 10 is in zone 4,
aisle 2, row 3a, and bin face 2, Z4-A2-R3a-BF2-B10 would be a good
ID.
example: Z4-A2-R3a-BF2-B10
maxLength: 30
description:
type: string
description: Description of the bin.
example: Bin of wrenches 02
maxLength: 100
href:
type: string
description: URL for this bin.
example: /objects/inventory-control/bin/10
readOnly: true
warehouse:
type: object
properties:
key:
type: string
description: System-assigned key for the warehouse.
example: '2'
id:
type: string
description: Name or other unique identifier for the warehouse.
example: WA2
href:
type: string
description: URL for the warehouse.
example: /objects/inventory-control/warehouse/2
readOnly: true
aisle:
type: object
properties:
key:
type: string
description: System-assigned key for the aisle.
example: '13'
id:
type: string
description: Name or other unique identifier for the aisle.
example: A2
href:
type: string
description: URL for the aisle.
example: /objects/inventory-control/aisle/13
readOnly: true
row:
type: object
properties:
key:
type: string
description: System-assigned key for the row.
example: '23'
id:
type: string
example: R3a
description: Name or other unique identifier for the row.
href:
type: string
description: URL for the row.
example: /objects/inventory-control/row/23
readOnly: true
zone:
type: object
properties:
key:
type: string
description: System-assigned key for the zone.
example: '12'
id:
type: string
example: Z4
description: Name or other unique identifier for the zone.
href:
type: string
description: URL for the zone.
example: /objects/inventory-control/zone/12
readOnly: true
binFace:
type: object
properties:
key:
type: string
description: System-assigned key for the bin face.
example: '3'
id:
type: string
example: BF2
description: Name or other unique identifier for the bin face.
href:
type: string
description: URL for the bin face.
example: /objects/inventory-control/bin-face/3
readOnly: true
binSize:
type: object
properties:
key:
type: string
description: System-assigned key for the Bin Size
example: '5'
id:
type: string
example: B10
description: Name or other unique identifier for the bin size.
href:
type: string
description: URL for the bin size.
example: /objects/inventory-control/bin-size/5
readOnly: true
sequenceNumber:
type: string
maxLength: 10
description: >-
Sequence number for the bin. Sequence numbering supports more
efficient picking, packing, and cycle counts.
example: '1233'
pattern: ^-{0,1}[0-9]*\.{0,1}[0-9]*$
isPortable:
type: boolean
description: >-
Set to true if the bin can be moved to another location, otherwise
set to false.
example: true
default: false
status:
$ref: '#/components/schemas/status'
audit:
$ref: '#/components/schemas/audit'
inventory-control-itemRequiredProperties:
type: object
required:
- id
- name
- itemType
- costMethod
inventory-control-item-landed-cost:
type: object
description: >
A landed cost item is a non-inventory item that represents a landed cost
expense, such as freight, insurance, customs duties, or handling fees.
This object is valid when Inventory Control is configured to enable
landed costs.
properties:
key:
type: string
description: System-assigned key for the item landed cost.
readOnly: true
example: '23'
maxLength: 8
id:
type: string
description: System-assigned ID for the item landed cost.
readOnly: true
example: '23'
maxLength: 8
href:
type: string
description: Endpoint URL for the item landed cost.
readOnly: true
example: /objects/inventory-control/item-landed-cost/23
distributionMethod:
type: string
description: >-
The distribution method for the item landed cost. The distribution
method provides a fair distribution of landed costs across multiple
items.
example: count
enum:
- volume
- weight
- count
distributionMethodBaseUnit:
type: string
description: >-
A read-only field that provides the base unit for the distribution
method.
readOnly: true
example: Each
landedCostValue:
type: string
description: >
This field establishes how the landed cost is distributed for the
associated item.
This value should be appropriate for the unit of measure (UOM) for
the item.
For example, if the distribution method is weight and the base unit
for the item is
ounce, and the item weighs 1 pound, a value of 16 to represent 1
pound in ounces is appropriate.
example: '16'
format: decimal-precision-9
minimum: 0
active:
type: boolean
description: >-
If set to `true`, the landed cost value provided will be distributed
for the item.
example: true
default: false
item:
type: object
description: Item associated with the landed cost.
properties:
key:
type: string
description: System-assigned key for the item.
example: '1000'
maxLength: 8
id:
type: string
description: Unique identifier for the item.
example: Dell Laptop
maxLength: 30
href:
type: string
description: Endpoint URL for the item.
readOnly: true
example: /objects/inventory-control/item/1000
tax.item-tax-group-item-map:
type: object
description: >-
This object maps items to a corresponding item tax group which includes
a standard tax solution.
properties:
key:
type: string
description: System-assigned key for the item-tax-group-item-map.
readOnly: true
example: 2
id:
type: string
description: Item tax group item map ID.
readOnly: true
example: 2
href:
type: string
description: Endpoint for the item-tax-group-item-map.
readOnly: true
example: /objects/tax/item-tax-group-item-map/2
item:
type: object
description: Inventory item.
properties:
key:
type: string
description: System-assigned key for the item.
example: 1
id:
type: string
description: Unique identifier for the item.
example: 1
href:
type: string
description: Item details URL.
readOnly: true
example: /objects/inventory-control/item/1
taxSolution:
type: object
description: Tax solution associated with the tax group.
properties:
key:
type: string
description: System-assigned key for the tax solution.
example: 4
id:
type: string
description: Unique identifier for the tax solution.
example: Canadian Sales Tax - SYS
href:
type: string
description: URL for the tax solution.
readOnly: true
example: /objects/tax/tax-solution/4
taxGroup:
type: object
description: The tax group to which the item is assigned.
properties:
key:
type: string
description: System-assigned key for the tax group.
example: 4
id:
type: string
description: Unique identifier for the tax group.
example: Goods Exempt Rate - CA
href:
type: string
description: URL for the tax group.
readOnly: true
example: /objects/tax/item-tax-group/4
inventory-control-item-warehouse-vendor:
type: object
description: >-
Use this object to specify the vendor information you want to use in the
replenishment calculations for the item in this warehouse.
properties:
key:
type: string
description: System generated Item Warehouse Vendor Key
readOnly: true
example: '5'
id:
type: string
description: System generated Item Warehouse Vendor ID
readOnly: true
example: '5'
itemWarehouse:
type: object
description: The item warehouse combination that can be ordered from the vendor.
properties:
key:
type: string
description: System generated Item Warehouse Inventory Key
example: '13'
maxLength: 8
id:
type: string
description: System generated Item Warehouse Inventory ID
example: '13'
maxLength: 8
href:
type: string
description: Item Warehouse Inventory URL.
readOnly: true
example: /objects/inventory-control/item-warehouse-inventory/13
vendor:
type: object
description: >-
The vendor to use in the replenishment calculations for the item in
this warehouse.
properties:
key:
type: string
description: System generated Vendor Key
example: '38'
maxLength: 8
id:
type: string
description: User sepcified Vendor ID
example: Office_Supplies
maxLength: 20
href:
type: string
description: Vendor details URL.
readOnly: true
example: /objects/accounts-payable/vendor/38
stockNumber:
type: string
description: The stock number that vendor uses for this item.
example: '#5678901234'
maxLength: 50
leadTime:
type: integer
description: >-
The number of days it takes the vendor to deliver this item to you
after receiving the order.
example: 15
maxLength: 3
demandForecastDuringLeadTime:
type: integer
description: >-
The quantity of this item that's expected to be sold during the lead
time.
example: 5
economicalOrderQuantity:
type: integer
description: >-
The quantity that makes the cost of reordering this item the most
economical.
example: 10
maxLength: 8
vendorMinimumOrderQuantity:
type: integer
description: The minimum quantity of this item the vendor is willing to sell.
example: 10
maxLength: 8
bestPrice:
type: string
description: The lowest price you paid for the item.
readOnly: true
format: decimal-precision-2
example: '100'
maxLength: 8
latestPrice:
type: string
description: This latest price you paid for the item.
readOnly: true
format: decimal-precision-2
example: '110'
maxLength: 8
unitOfMeasure:
type: object
description: The units of measure detail is the vendor sells this item in.
properties:
key:
type: string
description: The units of measure Key
example: '38'
maxLength: 8
id:
type: string
description: The units of measure Id.
example: Each
maxLength: 20
href:
type: string
description: Units of measure URL.
readOnly: true
example: /objects/inventory-control/unit-of-measure/38
conversionFactor:
type: string
description: >-
The number of base units required to equal the measure of the
corresponding related unit.
readOnly: true
example: '1'
maxLength: 30
isPreferredVendor:
type: boolean
description: >-
This identify a vendor as the preferred vendor for replenishing this
item for warehouse.
example: false
default: false
href:
type: string
description: Endpoint for the item warehouse vendor.
readOnly: true
example: /objects/inventory-control/item-vendor/5
inventory-control-item-warehouse-standard-cost:
type: object
description: >-
Standard cost for Item for warehouse. You can record different standard
costs for different date ranges for item and warehouse combinations.
properties:
key:
type: string
description: System-assigned key for item warehouse standard cost.
readOnly: true
example: '23'
maxLength: 8
id:
type: string
description: System assigned ID for item warehouse standard cost.
readOnly: true
example: '23'
maxLength: 8
href:
type: string
description: Endpoint for the item warehouse standard cost.
readOnly: true
example: /objects/inventory-control/item-warehouse-standard-cost/23
effectiveStartDate:
type: string
description: >
Set the date at which the cost will be effective. The cost is used
in the journal entries to debit Costs of Goods Sold and credit
Inventory.
Any postings before the first effective start date will use a cost
of zero. The cost for the last effective start date is used for any
postings after that date until a subsequent effective start date is
entered.
format: date
example: '2021-01-23'
maxLength: 10
standardCost:
type: string
description: >-
Provide the standard cost that will be effective from effective
date.
example: '122'
format: decimal-precision-10
maxLength: 15
minimum: 0
itemWarehouse:
type: object
description: Provide the Item warehouse information
properties:
key:
type: string
description: System generated Item Warehouse Inventory Key
example: '13'
maxLength: 8
id:
type: string
description: System generated Item Warehouse Inventory ID
example: '13'
maxLength: 8
href:
type: string
description: Item Warehouse Inventory URL.
readOnly: true
example: /objects/inventory-control/item-warehouse-inventory/13
itemId:
type: string
description: Related Item Id for item warehouse inventory.
readOnly: true
example: LapTop Kit 1
maxLength: 30
warehouseId:
type: string
description: Related Warehouse Id for item warehouse inventory.
readOnly: true
example: WS001
maxLength: 40
audit:
$ref: '#/components/schemas/audit'
inventory-control-item-warehouse-inventory:
type: object
description: >-
Warehouse inventory information is used with Inventory and Stockable Kit
items.
properties:
key:
type: string
description: System-assigned key for the item warehouse inventory information.
readOnly: true
example: '1'
id:
type: string
description: Unique identifier for the item warehouse inventory information.
readOnly: true
example: '1'
item:
type: object
description: Details for the good, service, or kit that is purchased or sold.
properties:
key:
type: string
description: System-assigned key for the item.
example: '9'
id:
type: string
description: Unique identifier for the item.
example: Prnt_Paper
href:
type: string
description: URL for the item.
readOnly: true
example: /objects/inventory-control/item/9
warehouse:
type: object
description: Details for the warehouse or stocking location for the item.
properties:
key:
type: string
description: System-assigned key for the warehouse.
example: '1'
id:
type: string
description: Unique identifier for the warehouse.
example: WH10001
href:
type: string
description: URL for the warehouse.
readOnly: true
example: /objects/inventory-control/warehouse/1
storageArea:
type: string
description: >-
Location within the warehouse where the item is normally stored,
such as Aisle 23, Row 12, Shelf 3, Bin 5.
example: Bin 5
inventoryCycle:
type: object
description: >-
Inventory cycles are used to keep track of when to take physical
inventory.
properties:
key:
type: string
description: System-assigned key for the inventory cycle.
example: '2'
id:
type: string
description: Unique identifier for the inventory cycle.
example: Daily Cycle
href:
type: string
description: URL for the inventory cycle.
readOnly: true
example: /objects/inventory-control/cycle/2
economicOrderQuantity:
type: integer
description: >-
The quantity that makes the cost of reordering this item the most
economical by minimizing total holding costs and total ordering
costs.
example: 10
standardCost:
type: string
description: >-
The planned or expected costs. Used in situations where purchase
costs remain relatively stable over time.
example: '110'
lastCost:
type: string
description: The most recent cost information for the item.
readOnly: true
example: '100'
averageCost:
type: string
description: The weighted average of all units.
readOnly: true
example: '100'
reorderMethod:
type: string
description: Available methods to reorder items when the inventory stock is low.
enum:
- null
- economicQuantity
- maxStockLevel
- reorderPoint
example: economicQuantity
nullable: true
default: null
readOnly: true
reorderPoint:
type: integer
description: >-
Value used as the starting point to determine when the item needs to
be replenished.
example: 121
reorderQuantity:
type: integer
description: >-
When current net inventory falls to the reorder point plus the
safety stock, the item is triggered for reorder with reorder
quantity.
example: 10
minOrderQuantity:
type: integer
description: The minimum quantity to be reordered at one time.
example: 10
maxOrderQuantity:
type: integer
description: The maximum quantity to be reordered at one time.
example: 100
maximumStock:
type: integer
description: The quantity of the item you do not want to exceed in the inventory.
example: 300
minimumStock:
type: integer
description: >-
The quantity of the item you do not want to fall below in the
inventory.
example: 50
lastSoldDate:
type: string
format: date
example: '2022-04-08'
description: Last date the item was sold.
readOnly: true
lastReceivedDate:
type: string
format: date
example: '2022-04-10'
description: Last date the item was received.
readOnly: true
defaultBin:
type: object
description: Default bin details for the item.
properties:
key:
type: string
description: System-assigned key for the default bin.
example: '45'
id:
type: string
description: Unique identifier for the default bin.
example: '45'
href:
type: string
description: URL for the default bin.
readOnly: true
example: /objects/inventory-control/bin/45
warehouseLocation:
type: object
description: Warehouse location and currency details for the item.
readOnly: true
properties:
key:
type: string
description: System-assigned key for the warehouse location.
readOnly: true
example: '3'
id:
type: string
description: Unique identifier for the warehouse location.
readOnly: true
example: LOC-USA-0778
currency:
type: string
description: Currency for the warehouse location.
readOnly: true
example: USD
href:
type: string
description: URL for the warehouse location.
readOnly: true
example: /objects/company-config/entity/3
safetyStock:
type: integer
description: >-
The extra quantity to have in inventory to avoid running out of
stock.
example: 20
replenishmentMethod:
type: string
description: >-
Replenishment method to use to automatically identify and reorder
items when inventory is low.
enum:
- null
- demandForecastBySingleValue
- reorderPoint
- demandForecastByFluctuatingValues
example: reorderPoint
nullable: true
default: null
enableReplenishment:
type: boolean
description: Set replenishment to `true` to replenish the items.
example: true
default: true
onOrder:
type: integer
description: >-
Quantities that are expected to arrive in the warehouse from
purchase orders.
example: 100
readOnly: true
inTransit:
type: integer
description: Total number of warehouse transfer items that are in transit.
example: 50
readOnly: true
onHand:
type: integer
description: >-
The item total received into the warehouse less the total that have
been shipped from the warehouse.
example: 200
readOnly: true
onHold:
type: integer
description: The quantity of the item that is on hold for the transaction.
example: 10
readOnly: true
reserved:
type: integer
description: >-
The reserved quantity for a warehouse is subtracted from available
items to keep that amount from being sold.
example: 50
readOnly: true
allocated:
type: integer
description: >-
The allocated inventory quantity is the count of items present in
the warehouse, which are reserved to open sale orders.
example: 20
readOnly: true
unCommitted:
type: integer
description: >-
Uncommitted inventory is excess inventory, the difference between
the forecast and the inventory.
example: 500
readOnly: true
href:
type: string
description: URL for the item warehouse inventory.
example: /objects/inventory-control/item-warehouse-inventory/1
readOnly: true
itemWarehouseVendor:
type: array
description: >-
Only required when override replenishment values on the
enableReplenishment is set to true. Provide vendor information you
want to use in the replenishment calculations for the item in this
warehouse.
items:
$ref: '#/components/schemas/inventory-control-item-warehouse-vendor'
standardCostEntries:
type: array
description: >-
You can provide the standard cost of the item for the warehouse. You
can use different standard costs for different date ranges.
items:
$ref: '#/components/schemas/inventory-control-item-warehouse-standard-cost'
audit:
$ref: '#/components/schemas/audit'
inventory-control-item-vendor:
type: object
description: >-
This object provides details about an item that can be purchased from a
particular vendor.
properties:
key:
type: string
description: System-assigned key for the item vendor.
readOnly: true
example: '5'
id:
type: string
description: Unique ID for the item vendor.
readOnly: true
example: '5'
item:
type: object
description: The item that can be ordered from the vendor.
properties:
key:
type: string
description: System-assigned key for the item.
example: '13'
id:
type: string
description: Unique ID for the item.
example: Phones
href:
type: string
description: Endpoint URL for the item.
readOnly: true
example: /objects/inventory-control/item/9
vendor:
type: object
description: The vendor the item can be ordered from.
properties:
key:
type: string
description: System-assigned key for the vendor.
example: '38'
id:
type: string
description: Unique ID for the vendor.
example: Office_Supplies
href:
type: string
description: Endpoint URL for the vendor.
readOnly: true
example: /objects/accounts-payable/vendor/38
stockNumber:
type: string
description: The stock number that vendor uses for this item.
example: '#5678901234'
leadTime:
type: integer
description: >-
The number of days it takes the vendor to deliver this item to you
after receiving the order.
example: 15
demandForecastDuringLeadTime:
type: integer
description: >-
The quantity of this item that's expected to be sold during the lead
time.
example: 5
economicalOrderQuantity:
type: integer
description: >-
The quantity that makes the cost of reordering this item the most
economical.
example: 10
vendorMinimumOrderQuantity:
type: integer
description: The minimum quantity of this item the vendor is willing to sell.
example: 10
bestPrice:
type: string
description: The lowest price paid for the item.
readOnly: true
format: decimal-precision-2
example: '100'
latestPrice:
type: string
description: The latest price paid for the item.
readOnly: true
format: decimal-precision-2
example: '110'
unitOfMeasure:
type: object
description: The unit of measure the vendor sells this item in.
properties:
key:
type: string
description: System-assigned key for the unit of measure.
example: '38'
id:
type: string
description: Unique ID for the unit of measure.
example: Each
href:
type: string
description: Endpoint URL for the unit of measure.
readOnly: true
example: /objects/inventory-control/unit-of-measure/38
conversionFactor:
type: string
description: >-
The number of base units required to equal the measure of the
corresponding related unit.
readOnly: true
example: '1'
isPreferredVendor:
type: boolean
description: >-
Identifies a preferred vendor for replenishing this item for
warehouses that do not have a vendor specified.
example: false
default: false
href:
type: string
description: Endpoint URL for the item vendor.
readOnly: true
example: /objects/inventory-control/item-vendor/5
inventory-control-kit-component:
type: object
description: >-
Kit-Components are common combinations of items to be ordered and
invoiced as a single item for simplifying data entry.
properties:
key:
type: string
description: System generated kit-component key
example: '1'
readOnly: true
id:
type: string
description: System generated kit-component identifier.
example: '1'
readOnly: true
kit:
type: object
description: Kit is item of type kit or stockable kit.
properties:
key:
type: string
description: System generated Item key
example: '27'
id:
type: string
description: Item unique identifier.
example: Kit_1
href:
type: string
description: Item URL details.
example: /objects/inventory-control/item/27
readOnly: true
component:
type: object
description: >-
Components are items to be ordered and invoiced as a single item
(i.e. kit or stockable kit).
properties:
key:
type: string
description: System generated Item key
example: '10'
id:
type: string
description: Item unique identifier.
example: Prnt_Paper
href:
type: string
description: Item/Component URL details.
example: /objects/inventory-control/item/10
readOnly: true
name:
type: string
description: The unique name of the item.
example: Paper for Printer
readOnly: true
costMethod:
type: string
description: >-
The cost method affects how the inventory cost layers are used,
the total valuation is determined, and the unit cost is derived
for an inventory item.
example: standard
enum:
- standard
- average
- FIFO
- LIFO
readOnly: true
itemType:
type: string
description: Type of the item.
example: inventory
enum:
- inventory
- nonInventory
- purchaseOnlyNonInventory
- salesOnlyNonInventory
- kit
- stockableKit
readOnly: true
standardCost:
type: string
description: >-
The planned or expected costs. This method is used in situations
where purchase costs remain relatively stable over time.
format: decimal-precision-9
example: '100.00'
maxLength: 15
readOnly: true
unitOfMeasure:
type: string
description: The standard unit of measure of the above item (i.e. component).
example: 10 Pack
readOnly: true
numberOfUnits:
type: number
description: Number of component units required in this kit.
example: 1
revenuePercentage:
type: number
description: >-
When item sold as part of Kit, the revenue part of the each item
will calculated based on the given percentage.
example: 10
maximum: 100
minimum: 0
defaultDeliveryStatus:
type: string
description: >-
Default that will indicate the most common delivery status of this
item when it's sold.
enum:
- delivered
- undelivered
example: delivered
default: delivered
defaultDeferralStatus:
type: string
description: >-
Choose whether to defer until this item is delivered or until the
entire bundle is delivered.
enum:
- deferUntilItemIsDelivered
- deferBundleUntilItemIsDelivered
example: deferUntilItemIsDelivered
default: deferUntilItemIsDelivered
lineNumber:
type: integer
description: >-
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
href:
type: string
description: kit-component URL
example: /objects/inventory-control/kit-component/1
readOnly: true
audit:
$ref: '#/components/schemas/audit'
inventory-control-item-cross-reference:
type: object
description: >-
An item cross reference associates an inventory item with a specific
customer or vendor, or with another inventory item.
properties:
key:
type: string
description: System-assigned key for the item cross reference.
readOnly: true
example: '23'
id:
type: string
description: >-
ID for the item cross reference. This value is the same as the `key`
for this object.
readOnly: true
example: '23'
href:
type: string
description: Endpoint URL for the item cross reference.
readOnly: true
example: /objects/inventory-control/item-cross-reference/23
referenceType:
type: string
description: >-
Reference type. Use `vendor` or `customer` for an external cross
reference. Use `substitute`, `upgrade`, `downgrade`, or `complement`
for an internal cross reference.
example: substitute
enum:
- customer
- vendor
- substitute
- upgrade
- downgrade
- complement
itemAliasId:
type: string
description: >-
Required for an external cross reference. Identifier for the item as
understood by the given vendor or customer. Must be unique for the
combination of vendor/item or customer/item.
example: Logitech - MK825
maxLength: 100
default: null
nullable: true
itemAliasDescription:
type: string
description: Description of the item alias for the cross reference.
example: Logitech - MK825 Wireless Keyboard and Mouse
maxLength: 50
nullable: true
default: null
unitOfMeasure:
type: object
description: Valid unit of measure for the item.
properties:
key:
type: string
description: System-assigned key for the unit of measure.
example: '21'
nullable: true
id:
type: string
description: Valid unit of measure ID for the item.
example: EACH
nullable: true
href:
type: string
description: Endpoint URL for the unit of measure.
readOnly: true
example: /objects/inventory-control/unit-of-measure/21
referenceTypeContext:
type: string
description: >-
The system assigns `external` when the `referenceType` is `customer`
or `vendor`. For all other `referenceType` values, the system
assigns `internal`.
example: internal
readOnly: true
enum:
- internal
- external
alternateItem:
type: object
description: >-
An alternate item. This field is required when using an internal
`referenceType`, such as `substitute` or `upgrade`.
properties:
key:
type: string
description: System-assigned key for the alternate item.
example: '22'
nullable: true
id:
type: string
description: ID for the alternate item.
example: Logitech-MK850
nullable: true
name:
type: string
description: Name of alternate item.
example: MK850 Wireless Keyboard and Mouse
nullable: true
readOnly: true
href:
type: string
description: Endpoint URL for the alternate item.
readOnly: true
example: /objects/inventory-control/item/22
customer:
type: object
description: The customer ID is required if `referenceType` is `customer`.
properties:
key:
type: string
description: System-assigned key for the customer.
example: '11'
nullable: true
id:
type: string
description: Customer ID, which is required if `referenceType` is `customer`.
example: C00023
nullable: true
name:
type: string
description: Name of the customer.
example: EDCO Financial
nullable: true
readOnly: true
href:
type: string
description: Endpoint URL for the customer.
readOnly: true
example: /objects/accounts-receivable/customer/11
item:
type: object
description: Inventory item to create the cross reference for.
properties:
key:
type: string
description: System-assigned key for the item.
example: '13'
id:
type: string
description: ID for the item.
example: Logitech-MK825
name:
type: string
description: Name of the item.
example: MK825 Wireless Keyboard and Mouse
readOnly: true
href:
type: string
description: Endpoint URL for the item.
readOnly: true
example: /objects/inventory-control/item/13
vendor:
type: object
description: The vendor ID is required if `referenceType` is `vendor`.
properties:
key:
type: string
description: System-assigned key for the vendor.
example: '22'
nullable: true
id:
type: string
description: Vendor ID, which is required if `referenceType` is `vendor`.
example: V0001
nullable: true
name:
type: string
description: Name of the vendor.
example: Ez Tech Solutions
nullable: true
readOnly: true
href:
type: string
description: Endpoint URL for the vendor.
readOnly: true
example: /objects/accounts-payable/vendor/22
audit:
$ref: '#/components/schemas/audit'
inventory-control-item:
type: object
description: >-
Items are goods, services, or kits that you purchase from vendors or
sell to customers.
properties:
key:
type: string
description: System-assigned key for the item.
readOnly: true
example: '23'
maxLength: 8
id:
type: string
description: Unique identifier for the item.
example: '23'
maxLength: 30
name:
type: string
description: Unique name for the item.
example: Dell Laptop 13inch
maxLength: 100
status:
$ref: '#/components/schemas/status'
itemType:
type: string
description: >-
The type for the item. Item type determines where the item will be
available.
enum:
- inventory
- nonInventory
- purchaseOnlyNonInventory
- salesOnlyNonInventory
- kit
- stockableKit
default: inventory
example: inventory
enableFulfillment:
type: boolean
description: >-
Set this field to true if you want to enable fulfillment for non
inventory item.
example: true
default: false
isItemEnabledForMRR:
type: boolean
description: >
Whether to include the item in the Software Digital Board Book
calculations of monthly recurring revenue.
Changing an item's MRR field only affects new transactions or
contract lines going forward. It will not affect existing
transactions or contract lines.
The best practice is to not change an item's MRR setting once the
item has been used in a transaction.
If you need to change your item's MRR configuration after
implementing Digital Board Book (DBB), contact your Sage Intacct
account manager for more information.
This field is only applicable if your company subscribes to the
Software Digital Board Book.
example: true
default: false
productLine:
type: object
description: Provide product line to which this item belongs.
properties:
key:
type: string
description: Record number of product line
example: '59'
maxLength: 8
id:
type: string
description: ID of the product line to which the item belongs.
example: '1233'
maxLength: 30
href:
type: string
description: URL for this product line.
readOnly: true
example: /objects/product-linel/59
costMethod:
type: string
enum:
- null
- standard
- average
- FIFO
- LIFO
description: >
Set the accounting method to use to determine the cost of
inventory.
This field applies only if Inventory Control is configured to enable
multiple cost methods and the item type is Inventory.
After you create an item, you cannot change its cost method.
example: standard
default: standard
nullable: true
extendedDescription:
type: string
description: >
Provide a detailed description of the item. This is most useful if
you have many items that have only slight variations.
The description is used as the default Item description when the
item is entered in Order Entry, Purchasing, and Inventory Control
transactions.
example: 13 inch dell laptop
maxLength: 400
poDescription:
type: string
description: >
Use this field to provide a purchase transaction description that
was used in a legacy accounting system during implementation or to
provide additional item details for internal reporting.
This description does not appear in any transactions and does not
print on any documents.
example: 13 inch dell laptop
maxLength: 400
soDescription:
type: string
description: >
Use this field to provide a sales transaction description that was
used in a legacy accounting system during implementation or to
provide additional item details for internal reporting.
This description does not appear in any transactions and does not
print on any documents.
example: 13 inch dell laptop
maxLength: 400
unitOfMeasureGroup:
type: object
description: Unit of measure group for the item.
properties:
key:
type: string
description: System-assigned key for the unit of measure group.
example: '10'
maxLength: 8
id:
type: string
description: Unique identifier for the unit of measure group.
example: '10'
href:
type: string
description: URL for the unit of measure group.
readOnly: true
example: /objects/inventory-control/unit-of-measure-group/10
notes:
type: string
description: Notes or detailed information not captured elsewhere.
example: Dell 13 inch laptop
maxLength: 1000
dateLastSold:
description: Date last sold
type: string
format: date
example: '2014-01-08'
readOnly: true
dateLastReceived:
description: Date last received
type: string
format: date
example: '2014-01-08'
readOnly: true
quantityOnOrder:
description: >-
The item total for the quantity on order. Item totals are combined
for all warehouses and automatically displayed based on transaction
entries.
type: string
example: '10'
readOnly: true
maxLength: 10
quantityInTransit:
description: >-
The item total in warehouse transfers that are in transit. Item
totals are combined for all warehouses and automatically displayed
based on transaction entries. In addition, you can view totals per
warehouse. This field applies only if in-transit warehouse transfers
is enabled.
type: string
example: '2'
readOnly: true
maxLength: 10
quantityOnHand:
description: >-
The item total for quantity on hand. Item totals are combined for
all warehouses and automatically displayed based on transaction
entries. In addition, you can view totals per warehouse.
type: string
example: '3'
readOnly: true
maxLength: 10
quantityOnHold:
description: >-
The item total for the quantity on hold. Item totals are combined
for all warehouses and automatically displayed based on transaction
entries. In addition, you can view totals per warehouse.
type: string
example: '3'
readOnly: true
maxLength: 10
quantityReserved:
description: >-
The item total for the quantity reserved. Item totals are combined
for all warehouses and automatically displayed based on transaction
entries. In addition, you can view totals per warehouse.
type: string
example: '3'
readOnly: true
maxLength: 10
quantityAllocated:
description: >-
The item total for the quantity allocated. Item totals are combined
for all warehouses and automatically displayed based on transaction
entries. In addition, you can view totals per warehouse.
type: string
example: '3'
readOnly: true
maxLength: 10
quantityUncommitted:
description: >-
The item total for the quantity uncommitted. Item totals are
combined for all warehouses and automatically displayed based on
transaction entries. In addition, you can view totals per warehouse.
type: string
example: '3'
readOnly: true
maxLength: 10
inventory:
type: object
properties:
shippingWeight:
type: number
description: Total shipping weight for the item.
example: 1233
maxLength: 10
autoPrintLabel:
type: boolean
default: false
description: >
Set to true if using a third-party label scanner to print
barcode labels when processing the item in purchasing
transactions.
When set to true, this field triggers label printing for the
received quantity. This field is used with scanner integrations
and has no functionality within Sage Intacct.
This field applies to inventory items and stockable kits only if
the Integrated scanner product in use option is enabled during
inventory control configuration.
example: false
glGroup:
type: object
description: The GL group to which the item belongs.
title: glGroup
properties:
id:
type: string
description: Unique identifier for the GL group.
example: '1501.0'
defaultRevenueRecognitionTemplate:
type: string
description: Default revenue recognition template ID.
example: '1232'
incomeGLAccount:
type: string
description: Revenue GL account number.
example: '12322'
inventoryGLAccount:
type: string
description: Inventory GL account number
example: '12322'
expenseGLAccount:
type: string
description: Expense GL account number
example: '12322'
cogsGLAccount:
type: string
description: COGS GL account number
example: '12322'
arGLAccountNumber:
type: string
description: AR GL account number
example: '12322'
apGLAccountNumber:
type: string
description: AP GL account number
example: '12322'
deferredRevenueGLAccountNumber:
type: string
description: Deferred revenue GL account number
example: '12322'
vsoeCategory:
type: string
description: Fair value category.
example: software
default: null
enum:
- null
- productSpecified
- software
- productUnspecified
- upgradeUnspecified
- upgradeSpecified
- services
- postContractSupport
nullable: true
vsoeDefaultDeliveryStatus:
type: string
description: VSOE default delivery status.
example: delivered
default: delivered
enum:
- null
- delivered
- undelivered
nullable: true
vsoeDefaultDeferralStatus:
type: string
description: VSOE default deferral status.
example: deferUntilItemIsDelivered
default: deferUntilItemIsDelivered
enum:
- null
- deferUntilItemIsDelivered
- deferBundleUntilItemIsDelivered
nullable: true
substituteItemId:
type: string
description: Substitute item ID
example: Dell Laptop 14inch
tracking:
type: object
description: >-
Provide information about if item is tracked by serial, lot, bin,
expiration date, or any combination of those.
properties:
enableSerialNo:
type: boolean
description: >-
Serial tracking enabled. Applicable to inventory or stockable
kit item types.
example: false
default: false
serialMask:
type: string
description: >-
Serial number mask to enforce a specific format. Applicable to
inventory or stockable kit item types.
example: XXAS
maxLength: 30
enableLotCategory:
type: boolean
description: >-
Lot tracking enabled. Applicable to inventory or stockable kit
item types.
example: false
default: false
lotCategory:
type: string
description: >-
Lot category. Applicable to inventory or stockable kit item
types.
example: Kitchen
maxLength: 30
enableBins:
type: boolean
description: >-
Bin tracking enabled. Applicable to inventory or stockable kit
item types.
example: false
default: false
enableExpiration:
type: boolean
description: >-
Expiration tracking enabled. Applicable to inventory or
stockable kit item types.
example: false
default: false
precision:
type: object
description: >
These numbers override the default precision, or number of decimal
places, for this item in the Inventory Control, Order Entry, and
Purchasing applications.
For example, an item with a cost of $0.00456 requires five decimal
places. Depending on your needs, you can assign the item a different
precision in each application.
For example, you can enter 4 in Purchasing and Inventory and 2 in
Sales. The default precision as shipped from Intacct is two decimal
places for each application. However, for Order Entry and
Purchasing, you can change this default to a precision of up to 10
decimal places in the application's configuration.
While Sage Intacct uses the number of decimal places specified here
for the item in transactions, it rounds values to 10 decimal places
for costing calculations, to 2 decimal places for the General
Ledger, and to 2 decimal places for reports.
If your company is subscribed to Contracts, the value of Unit cost
precision. Sales must either be blank or 10. In this scenario, the
best practice is to leave this field blank.
properties:
upc:
type: string
description: Universal Product Code (UPC) for the item.
example: '23342'
maxLength: 40
inventoryPrecision:
type: integer
description: Inventory unit cost precision
example: 2
maxLength: 2
salesPrecision:
type: integer
description: Sales unit cost precision
example: 2
maxLength: 2
purchasingPrecision:
type: integer
description: Sales unit cost precision
example: 2
maxLength: 2
landedCost:
type: object
properties:
enableLandedCost:
type: boolean
description: >
For inventory items set true to have Sage Intacct distribute
landed costs to this item.
For Non-inventory and Non-inventory (purchase only) set this
field to to identify the item as a landed cost. These items are
used to enter the actual landed cost amounts (such as for
shipping, insurance, and customs) for which you’re invoiced
after purchasing inventory items.
example: false
default: false
itemLandedCost:
type: array
description: >-
Only for Inventory items. Provide the count, volume, and weight of
the item expressed in the base unit of the unit of measure (UOM) so
a landed cost is distributed proportionately to the item when a
landed cost is distributed across multiple items.
items:
$ref: '#/components/schemas/inventory-control-item-landed-cost'
replenishment:
type: object
description: >
When replenishment is enabled on the Configure Inventory Control,
use this section of fields to include the item in replenishment,
which automates the process of identifying when to reorder items and
generating purchase orders.
The values you enter are used in the replenishment calculations and
drive the reorder information displayed for the item on the
Replenish Inventory.
properties:
enableReplenishment:
type: boolean
description: Enable replenishment for this item in the Vendor history.
example: false
default: false
unitOfMeasureDefault:
type: string
description: >-
Units of measure default for base units for inventory
replenishment for this item in the Vendor history. For example,
with the Count unit of measure group, you can specify each,
dozen, or pair. See the information about unit of measure groups
in the Sage Intacct product help.
example: Each
safetyStock:
type: integer
description: >-
Safety stock for this item in the Vendor history. Extra quantity
held in inventory to reduce the risk of stock outs due to
uncertainty in supply and demand.
example: 2
default: 0
maxLength: 10
maximumOrderQuantity:
type: integer
description: >-
Maximum order quantity for this item in the Vendor history.
Largest amount you can order in any one order. The provided may
be affected by the economic order quantity and/or unit of
measure set on the vendor.
example: 10
default: 0
maxLength: 10
replenishmentMethod:
type: string
description: >
Replenishment method for this item in the Vendor history.
Provide how the amount to reorder is calculated.
Reorder point - base calculation on a specific reorder quantity
and optional safety stock quantity Demand forecast by single
value - base calculation on lead time for the vendor Demand
forecast by statistical
account - base calculation on statistical journal entries for a
statistical account (statistical account must be configured for
inventory) See the information about replenishment methods and
calculations in the Sage Intacct product help.
example: reorderPoint
enum:
- ''
- demandForecastBySingleValue
- reorderPoint
- demandForecastByFluctuatingValues
default: ''
reorderPoint:
type: integer
description: >-
Reorder point specifying the quantity of inventory that you
don’t want to fall below. When the current net inventory falls
to the reorder point plus the safety stock, the item is
triggered for reorder. Use blank or positive integers. Applies
when the replenishmentMethod is Reorder point
example: 1
minimum: 0
maxLength: 10
reorderQuantity:
type: integer
description: >-
Reorder quantity for this item in the Vendor history. As an
example, if 12 units are needed according to other replenishment
calculations, a reorder quantity of 50 would cause the generated
purchase order to be for 50. Applies when the
replenishmentMethod is Reorder point
example: 1
default: 0
maxLength: 10
forecastDemandInLeadTime:
type: integer
description: >-
Forecast demand in lead time. Provide the quantity of this item
expected to be sold during the lead time. Valid values are
blank, 0, and positive integers. Only applicable when the
REPLENISHMENT_METHOD is Demand forecast by a single value. Only
applicable when the replenishmentMethod is Demand forecast by a
single value.
example: 1
default: 1
minimum: 0
maxLength: 10
itemDetails:
type: object
description: >-
The Item details gives wholesale distribution companies the ability
to define an item with many more attributes that are unique for
their operations.
properties:
primaryCountryOfOrigin:
type: string
description: Primary country of origin.
example: China 75%
maxLength: 30
condition:
type: string
description: Condition name or descriptor.
example: good
maxLength: 30
engineeringAlert:
type: string
description: Engineering Alert name or descriptor.
example: Software Setup
maxLength: 30
specification1:
type: string
description: Specification name/descriptor 1.
example: length 12 cm
maxLength: 30
specification2:
type: string
description: Specification name/descriptor 2.
example: width 12 cm
maxLength: 30
specification3:
type: string
description: Specification name/descriptor 3.
example: height 13 cm
maxLength: 30
universalProductCode:
type: integer
description: UPC-12, the 12-digit Universal Product Code of the item.
example: 123456789123
maxLength: 12
internationalArticleNumber:
type: integer
description: EAN-13, the 13-digit International Article Number of the item.
example: 1234567891234
maxLength: 13
isSafetyItem:
type: boolean
description: Use true if item is classified as a Safety Item.
example: true
default: false
isRestrictedItem:
type: boolean
description: Use true if item is classified as a Restricted Item.
example: true
default: false
isCompliantItem:
type: boolean
description: Use true if item is classified as a Compliant Item.
example: true
default: false
isApprovedByEngineering:
type: boolean
description: Use true if item is approved by engineering.
example: true
default: false
isApprovedByQualityControl:
type: boolean
description: Use true if item is approved by quality control.
example: true
default: false
isApprovedBySales:
type: boolean
description: Use true if item is approved by sales.
example: true
default: false
measurements:
type: object
properties:
weightUnitOfMeasure:
type: object
description: >-
Provide shipWeight without weightUnitOfMeasure or netWeight, but
if you provide netWeight you must also specify the other two.
weightUnitOfMeasure must be set to one of the values defined for
the Weight unit of measure.
properties:
id:
type: string
description: Id of unit of measure
example: Grams
maxLength: 50
key:
type: string
description: system generated key of unit of measure
example: '25'
maxLength: 8
href:
type: string
description: URL for the unit of measure.
readOnly: true
example: /objects/inventory-control/unit-of-measure/25
netWeight:
type: number
description: Net weight of item.
example: 1.67
maxLength: 13
lengthWidthHeightUnitOfMeasure:
type: object
description: >-
The size of the item, useful for calculating storage bin and
shipping box size requirements. Specify the unit of measure and
the length, width, and height. You must specify all four values
or none. lengthWidthHeightUnitOfMeasure must be set to one of
the values defined for the length unit of measure.
properties:
id:
type: string
description: Id of unit of measure
example: inches
maxLength: 50
key:
type: string
description: system generated key of unit of measure
example: '21'
maxLength: 8
href:
type: string
description: URL for the unit of measure.
readOnly: true
example: /objects/inventory-control/unit-of-measure/21
length:
type: number
description: Length of item.
example: 10
maxLength: 13
width:
type: number
description: Width of item.
example: 23
maxLength: 13
height:
type: number
description: Height of item.
example: 11.23
maxLength: 13
thicknessUnitOfMeasure:
type: object
description: >-
The thickness of the item, useful for calculating storage bin or
shipping box size requirements. Specify the unit of measure,
actual thickness, and minimum and maximum thickness. You must
specify all four values or none. If the item thickness does not
vary, set all three thickness fields to the same value.
thicknessUnitOfMeasure must be set to one of the values defined
for the length unit of measure.
properties:
id:
type: string
description: Id of unit of measure
example: inches
maxLength: 50
key:
type: string
description: system generated key of unit of measure
example: '21'
maxLength: 8
href:
type: string
description: URL for the unit of measure.
readOnly: true
example: /objects/inventory-control/unit-of-measure/21
thickness:
type: number
description: Thickness of Item
example: 10
maxLength: 13
maximum: 99999999.99
minimumThickness:
type: number
description: Minimum thickness of Item
example: 23
maxLength: 13
maximum: 99999999.99
maximumThickness:
type: number
description: Maximum thickness of Item
example: 11.23
maxLength: 13
maximum: 99999999.99
areaUnitOfMeasure:
type: object
description: >-
The area of the item. You must specify both or neither.
areaUnitOfMeasure must be set to one of the values defined for
the Area unit of measure.
properties:
id:
type: string
description: Id of unit of measure
example: Square Feet
maxLength: 50
key:
type: string
description: system generated key of unit of measure
example: '22'
maxLength: 8
href:
type: string
description: URL for the unit of measure.
readOnly: true
example: /objects/inventory-control/unit-of-measure/22
area:
type: number
description: Area of Item
example: 0.567
maxLength: 13
volumeUnitOfMeasure:
type: object
description: >-
The item unit of measure and total volume. You must specify both
or neither. volumeUnitOfMeasure must be set to one of the values
defined for the Volume unit of measure.
properties:
id:
type: string
description: Id of unit of measure
example: Cubic Meter
maxLength: 50
key:
type: string
description: system generated key of unit of measure
example: '24'
maxLength: 8
href:
type: string
description: URL for the unit of measure.
readOnly: true
example: /objects/inventory-control/unit-of-measure/24
volume:
type: number
description: Volume of Item
example: 0.789
maxLength: 13
densityUnitOfMeasure:
type: string
description: The density of the item unit of measure and density value.
example: Cubic Meter
density:
type: number
description: Density of Item
example: 0.789
maxLength: 13
durometerUnitOfMeasure:
type: string
description: Durometer (hardness) measurement of the item.
example: '10'
maxLength: 10
diameterUnitOfMeasure:
type: object
description: >-
The diameter of the item Unit of measure, and inner and outer
diameter. You must specify all three or none. DIAMETERUOM must
be set to one of the values defined for the length unit of
measure.
properties:
id:
type: string
description: Id of unit of measure
example: inches
maxLength: 50
key:
type: string
description: system generated key of unit of measure
example: '21'
maxLength: 8
href:
type: string
description: URL for the unit of measure.
readOnly: true
example: /objects/inventory-control/unit-of-measure/21
innerDiameter:
type: number
description: Inner Diameter of Item
example: 12
maxLength: 13
outerDiameter:
type: number
description: Outer Diameter of Item
example: 13.5
maxLength: 13
commercial:
type: object
properties:
brand:
type: string
description: Brand of the item.
example: Touch Screen
maxLength: 30
subBrand:
type: string
description: Sub brand of the item.
example: Touch Screen with LED
maxLength: 30
category:
type: string
description: Category of the item.
example: Touch Screen with LED
maxLength: 30
subCategory:
type: string
description: Sub category of the item.
example: Touch Screen with LED
maxLength: 30
catalogReference:
type: string
description: Catalog reference for the item.
example: Touch Screen with LED laptops
maxLength: 30
color:
type: string
description: Catalog reference for the item.
example: black
maxLength: 30
size1:
type: string
description: Size 1 of the item.
example: '13'
maxLength: 30
size2:
type: string
description: Size 2 of the item.
example: '12'
maxLength: 30
style:
type: string
description: Style of the item.
example: '12'
maxLength: 30
webName:
type: string
description: Name of the item to appear on the web.
example: Dell Inspiration
maxLength: 100
webShortDiscription:
type: string
description: Short description for the web.
example: Dell Inspiration 13 inch LED
maxLength: 1000
webLongDescription:
type: string
description: Long description for the web.
example: Dell Inspiration 13 inch LED touchscreen
maxLength: 2000
isGiftCard:
type: boolean
description: Use true if item is gift card.
example: true
default: false
isWebEnabled:
type: boolean
description: Use true if item is web enabled.
example: true
default: false
defaultConversionType:
type: string
description: Option to select default conversion type either Quantity or Price
default: quantity
example: quantity
enum:
- quantity
- price
purchasing:
type: object
properties:
standardCost:
type: string
description: Standard cost value for the item.
example: '1501.04'
maxLength: 15
format: decimal-precision-10
sales:
type: object
properties:
isTaxable:
type: boolean
description: Set to `true` if the sale of the item is taxable.
default: false
example: true
basePrice:
type: string
description: Base price for the item.
example: '1000'
maxLength: 15
format: decimal-precision-10
isAvailableForDropShip:
type: boolean
description: Available for drop ship
example: false
default: false
isAvailableForBuyToOrder:
type: boolean
description: Available for buy to order
example: false
default: false
taxGroup:
type: object
description: The tax group to assign the item to.
title: taxGroup
properties:
key:
type: string
description: System-assigned key for the tax group.
example: '1000'
id:
type: string
description: Unique identifier for the tax group.
example: Acme Company Customers
href:
type: string
description: URL for the tax group.
readOnly: true
example: /objects/tax/item-tax-group/23
taxSolution:
type: object
description: The tax solution to assign the item to.
title: taxSolution
properties:
key:
type: string
description: System-assigned key for the tax solution.
example: '1000'
id:
type: string
description: Unique identifier for the tax solution.
example: Acme Company Customers
href:
type: string
description: URL for the tax solution.
readOnly: true
example: /objects/tax/tax-solution/23
allowMultipleTaxGroups:
type: boolean
description: >
Allow multiple item tax groups per item, which is needed when an
item is taxed at different rates in different tax
jurisdictions.
Allow multiple item tax groups. When you set this to true and
provide an itemTaxMap, the tax group at the header level is
ignored and the mapping is used instead.
example: false
default: false
itemTaxMap:
type: array
items:
$ref: '#/components/schemas/tax.item-tax-group-item-map'
warehouseInfo:
type: array
items:
$ref: '#/components/schemas/inventory-control-item-warehouse-inventory'
itemVendor:
type: array
items:
$ref: '#/components/schemas/inventory-control-item-vendor'
isEnabledForContracts:
type: boolean
description: Set this to true if you want to enable the item for contracts.
example: false
default: false
kitRevenuePosting:
type: string
enum:
- null
- componentLevel
- kitLevel
description: Kit revenue posting.
example: componentLevel
default: componentLevel
nullable: true
kitRevenuePrinting:
type: string
enum:
- null
- individualComponents
- kit
description: Kit revenue posting.
example: individualComponents
default: individualComponents
nullable: true
kitComponents:
type: array
items:
$ref: '#/components/schemas/inventory-control-kit-component'
contractTerm:
type: object
description: >-
Contract Term section is enabled only if contracts is subscribed for
item.
properties:
isStartDateAndEndDateEnabled:
type: boolean
example: false
description: >
Set this field to identify this item as having a default term.
In Order Entry transactions, this also makes this item eligible
for renewals and price proration.
For Contracts, Set this to true if you want to set up automatic
price proration for this item.
default: false
periodsMeasuredIn:
type: string
description: >-
Provide the period of duration to use to measure the item's
term.
enum:
- null
- days
- weeks
- months
- years
example: days
default: days
nullable: true
numberOfPeriods:
type: integer
description: >-
Enter the default number of periods to include in the item's
term. For example, if Periods measured in is Months and Number
of periods is 6, then the item's default term is 6 months.
Required if you set isStartDateAndEndDateEnabled to true.
example: 2
maxLength: 4
isProratedPricingAllowed:
type: boolean
example: false
description: >
Set this field to true if you want the system to automatically
prorate the price when the sales transaction line or contract
line term is less than the item's default term.
For Order Entry, this field prorates the fair value in a
multiple-element arrangement (when also subscribed to Advanced
Revenue Management). For Order Entry only, leave this checkbox
cleared if you want the option to manually prorate the price
using the prorate button in a sales transaction.
default: false
defaultRenewalTemplate:
type: object
description: >-
Provide the default renewal instruction set for this item in
sales transactions. Only displays if your company is subscribed
to Revenue Recognition for Order Entry. This field is not
applicable to the Contracts application.
title: Default Renewal Template
properties:
key:
type: string
description: System-assigned key for the renewal template.
example: '22'
id:
type: string
description: Unique identifier for the renewal template.
example: Sales Renewal Template US
contractDefault:
type: object
description: >
The fields in this section allow you to set default templates to use
for this item when the item is selected in a contract line or as an
expense. The user can override these defaults on the contract line
or expense.
For Non-Inventory (Purchase only) items, only the Expense template
fields are applicable.
This section is not applicable to Kit and Stockable kit items;
properties:
billingTemplate:
type: object
description: >-
Provide billing template that would most often be associated
with this item.
title: Billing Template
properties:
key:
type: string
description: System-assigned key for the billing template
example: '31'
id:
type: string
description: Unique identifier for the billing template
example: Monthly Billing
revRecTemplate1:
type: object
description: >-
Provide the default revenue template for the applicable
journals. Your Contracts configuration may use one or two sets
of revenue journals.
title: Rev Rec Template 1
properties:
key:
type: string
description: System-assigned key for the Rev Rec template
example: '32'
id:
type: string
description: Unique identifier for the Rev Rec template
example: Monthly Billing
href:
type: string
description: URL for the Rev Rec template
readOnly: true
example: /objects/contracts/revenue-template/32
revRecTemplate2:
type: object
description: >-
Provide the default revenue template for the applicable
journals. Your Contracts configuration may use one or two sets
of revenue journals. Different from RevRecTemplate1 and
RevRecTemplate2 is used for ASC606 standards.
title: Rev Rec Template 2
properties:
key:
type: string
description: System-assigned key for the Rev Rec template
example: '33'
id:
type: string
description: Unique identifier for the Rev Rec template
example: Half Cycle
href:
type: string
description: URL for the Rev Rec template
readOnly: true
example: /objects/contracts/revenue-template/33
expenseTemplate1:
type: object
description: >-
Provide the default expense template for the applicable
journals. Your Contracts configuration may use one or two
expense journals.
title: Rev Rec Template 2
properties:
key:
type: string
description: System-assigned key for the contract expense template
example: '33'
id:
type: string
description: Unique identifier for the contract expense template
example: Full Cycle Month Expense 2
href:
type: string
description: URL for the contract expense template
readOnly: true
example: /objects/contracts/expense-template/33
expenseTemplate2:
type: object
description: >-
Provide the default expense template for the applicable
journals. Your Contracts configuration may use one or two
expense journals. Different from expenseTemplate1 and
expenseTemplate2 is used for ASC606 standards.
title: Rev Rec Template 2
properties:
key:
type: string
description: System-assigned key for the contract expense template
example: '34'
id:
type: string
description: Unique identifier for the contract expense template
example: Half Cycle Month Expense 2
href:
type: string
description: URL for the contract expense template
readOnly: true
example: /objects/contracts/expense-template/34
contractFairValueCategory:
type: object
description: >
Sage Intacct uses fair value categories to distinguish products
or services included in an MEA that will be used in the
algorithm that determines another item's estimated standalone
selling price.
If the item can be sold as part of a multiple-element
arrangement, Provide the category that identifies the
performance obligation. Learn more about fair value categories
in contracts.
This field is only applicable if your company is subscribed to
Contract Advanced Revenue Recognition.
title: Contract Fair Value Category
properties:
key:
type: string
description: System-assigned key for Contract Fair Value Category
example: '37'
id:
type: string
description: Unique identifier for the Contract Fair Value Category
example: Half Cycle Month Expense 2
defaultContractDeliveryStatus:
type: string
description: >-
Options are Delivered the contract line's recognition event has
occurred Undelivered the contract line's recognition event has
not occurred
default: delivered
example: delivered
enum:
- null
- delivered
- undelivered
nullable: true
defaultContractDeferralStatus:
type: string
description: >
Defer revenue until item is delivered the revenue schedule for
this item will not start until this item has Delivery status =
'Delivered'.
Defer revenue until all items are delivered the revenue schedule
for this item will not start until all contract lines in the
contract have Delivery status = 'Delivered'.
default: deferRevenueUntilItemIsDelivered
example: deferRevenueUntilItemIsDelivered
enum:
- null
- deferRevenueUntilItemIsDelivered
- deferRevenueUntilAllItemsAreDelivered
nullable: true
isDefaultBundle:
type: boolean
description: >
Set this to true if item is to be included in the default bundle
when an MEA allocation that includes this item is created. Users
can choose to exclude the item when they create the MEA
allocation.
This field is only applicable if your company is subscribed to
Contract Advanced Revenue Recognition.
example: true
default: false
itemCrossReference:
type: array
items:
$ref: '#/components/schemas/inventory-control-item-cross-reference'
href:
type: string
description: Endpoint for the item.
readOnly: true
example: /objects/inventory-control/item/23
audit:
$ref: '#/components/schemas/audit'
inventory-control-item-gl-groupRequiredProperties:
type: object
required:
- id
example:
id: Stockable Kit
inventory-control-item-gl-group:
type: object
description: >-
Item GL groups are used to organize transaction definitions for posting
to the general ledger.
properties:
key:
type: string
description: System-assigned key for the item GL group.
readOnly: true
example: '13'
id:
type: string
description: Name or other unique identifier for the item GL group.
example: Stockable Kit
deferredRevenueGLAccount:
type: object
description: >-
GL account to which to defer revenue for items belonging to this GL
group.
properties:
key:
type: string
description: System-assigned key for the deferred revenue GL account.
example: '411'
id:
type: string
description: Account number for the deferred revenue GL account.
example: '1501.04'
name:
type: string
description: Name of the deferred revenue GL account.
example: Expense Account
readOnly: true
href:
type: string
description: URL for the deferred revenue GL account.
example: /objects/general-ledger/account/411
readOnly: true
defaultRevenueRecognitionTemplate:
type: object
description: >-
Default revenue recognition template to use for deferred revenue for
items belonging to this GL group.
properties:
key:
type: string
description: System-assigned key for the revenue recognition template.
example: '1'
id:
type: string
description: Unique identifier for the revenue recognition template.
example: '100'
href:
type: string
description: URL for the revenue recognition template.
example: /objects/accounts-receivable/revenue-recognition-template/1
readOnly: true
isSystemGenerated:
type: boolean
description: Indicates whether this is a system-generated GL group.
example: false
readOnly: true
default: false
href:
type: string
description: item gl group URL
example: /objects/inventory-control/item-gl-group/13
readOnly: true
audit:
$ref: '#/components/schemas/audit'
inventory-control-item-warehouse-inventoryRequiredProperties:
type: object
required:
- item
- warehouse
example:
item:
key: '9'
id: Prnt_Paper
warehouse:
key: '1'
id: WH10001
inventory-control-rowRequiredProperties:
type: object
required:
- id
inventory-control-row:
type: object
description: >-
A row is one of four optional attributes (zone, aisle, row, and bin
face) you can assign to a bin to make it easier to find in the
warehouse.
properties:
key:
type: string
description: System-assigned key for the row.
example: '2'
readOnly: true
id:
type: string
description: >-
Name or other unique identifier for the row. The row ID cannot be
modified.
example: R3ADW
description:
type: string
description: Description for the row.
example: Row 3A Dishwashers
href:
type: string
description: URL for the row.
readOnly: true
example: /objects/inventory-control/row/2
audit:
$ref: '#/components/schemas/audit'
inventory-control-unit-of-measure-groupRequiredProperties:
type: object
required:
- id
- baseUnit
inventory-control-unit-of-measure:
type: object
description: Unit of measure included in a unit of measure group.
properties:
key:
type: string
description: System-assigned key for this unit of measure.
example: '59'
readOnly: true
id:
type: string
description: Unique identifier for this unit of measure.
example: Hours
nullable: false
abbreviation:
type: string
description: Unique abbreviation for this unit of measure.
example: HR
numberOfDecimalPlaces:
type: integer
description: >-
Allowed number of decimal places for this unit of measure. should be
integer less than 4
maxLength: 1
example: 2
isBase:
type: boolean
description: >-
Indicates whether this unit of measure is the base unit of measure
for its group.
example: false
default: false
readOnly: true
parent:
type: object
description: Name of the unit of measure group that includes this unit.
properties:
key:
type: string
description: System-assigned key for the parent unit of measure group.
readOnly: true
example: '17'
id:
type: string
description: Name of the parent unit of measure group.
example: ComputerStorage
href:
type: string
description: >-
URL for the unit of measure group in which current unit of
measure will be part of.
readOnly: true
example: /objects/inventory-control/unit-of-measure-group/17
conversionFactor:
type: number
description: Number of base units for this unit of measure.
maxLength: 30
example: 2.5
href:
type: string
description: URL for this unit of measure.
readOnly: true
example: /objects/inventory-control/unit-of-measure/59
audit:
$ref: '#/components/schemas/audit'
inventory-control-unit-of-measure-group:
type: object
description: >-
Unit of measure group, like Count,Area or Length, provided for items
handled under Inventory Control, Order Entry, and Purchasing.
properties:
key:
type: string
description: >-
System-assigned key for the unit of measure group. Used to identify
the unit of measure group in URLs or JSON bodies for all operations
on the group.
example: '16'
readOnly: true
id:
type: string
description: Name of the unit of measure group.
example: Time
nullable: false
baseUnit:
type: string
description: >-
Base unit for the group. The base unit is the smallest reasonable
unit for pricing within the unit of measure group.
example: Seconds
nullable: false
abbreviation:
type: string
description: Abbreviation for the base unit.
example: SEC
defaults:
type: object
description: >
Default unit of measure for Inventory, Order Entry, and Purchasing
transactions. This is the default unit within a unit of measure
group for transactions that contain items associated with the group.
For example, Count is a standard unit of measure group with Each,
Pair, and Dozen defined as related units. The Each unit can be set
to be the default unit for inventory transactions.
For more information, see [Unit of measure
groups](https://www.intacct.com/ia/docs/en_US/help_action/Order_Entry/Setting_up_Order_Entry/UOM_groups/UOM-groups-OE.htm).
properties:
inventory:
type: object
description: Default unit of measure for Inventory transactions.
properties:
key:
type: string
description: >-
System-assigned key for the default unit of measure for
Inventory transactions.
example: '3'
id:
type: string
description: >-
Id for the default unit of measure for Inventory
transactions.
example: Each
href:
type: string
description: >-
URL for the default unit of measure for Inventory
transactions.
readOnly: true
example: /objects/inventory-control/unit-of-measure/3
purchaseOrder:
type: object
description: Default unit of measure for Purchasing transactions.
properties:
key:
type: string
description: >-
System-assigned key for the default unit of measure for
Purchasing transactions.
example: '3'
id:
type: string
description: >-
Id for the default unit of measure for Purchasing
transactions.
example: Each
href:
type: string
description: >-
URL for the default unit of measure for Purchasing
transactions.
readOnly: true
example: /objects/inventory-control/unit-of-measure/3
orderEntry:
type: object
description: Default unit of measure for Order Entry (Sales) transactions.
properties:
key:
type: string
description: >-
System-assigned key for the default unit of measure for
Order Entry (Sales) transactions.
example: '3'
id:
type: string
description: >-
Id for the default unit of measure for Order Entry (Sales)
transactions.
example: Each
href:
type: string
description: >-
URL for the default unit of measure for Order Entry (Sales)
transactions.
readOnly: true
example: /objects/inventory-control/unit-of-measure/3
unitsOfMeasure:
type: array
description: Related units of measure included in the group.
items:
$ref: '#/components/schemas/inventory-control-unit-of-measure'
href:
type: string
description: Unit of measure group URL.
readOnly: true
example: /objects/inventory-control/unit-of-measure-group/41
audit:
$ref: '#/components/schemas/audit'
inventory-control-unit-of-measureRequiredProperties:
type: object
required:
- id
- parent
- conversionFactor
inventory-control-warehouseRequiredProperties:
type: object
required:
- id
- name
- location
inventory-control-warehouse:
type: object
description: >
A warehouse can be an actual warehouse, a store, or any type of stocking
location or site that requires inventory tracking and management.
Warehouse also serves as a dimension that can be set on transactions to
expand report functionality and insight.
properties:
key:
type: string
description: System-assigned key for the warehouse.
example: '2'
readOnly: true
id:
type: string
description: Unique identifier for the warehouse.
example: USNA1
name:
type: string
description: Name of the warehouse.
example: US NA Warehouse-1
href:
type: string
description: URL for the warehouse.
example: /objects/inventory-control/warehouse/2
readOnly: true
status:
$ref: '#/components/schemas/status'
isReplenishmentEnabled:
type: boolean
description: >-
This property is set to `true` by default if Inventory Control is
configured for replenishment. If the warehouse should not be
replenished, set to `false`.
example: true
default: true
enableNegativeInv:
type: boolean
description: >-
Set to `true` to save transactions that cause the inventory for
items in this warehouse to be negative.
example: true
default: false
location:
type: object
description: The geographical location of the warehouse.
properties:
id:
type: string
example: PHO--Phoenix
key:
type: string
description: System-assigned key for the location.
example: '2'
href:
type: string
description: URL for the location.
readOnly: true
example: /objects/company-config/location/2
parent:
type: object
description: >-
If this warehouse is part of a hierarchy, the parent warehouse of
this warehouse.
properties:
id:
type: string
description: Unique identifier for the parent warehouse.
example: WH10001--US AZ Warehouse 10001
key:
type: string
description: System-assigned key for the parent warehouse.
example: '32'
href:
type: string
description: URL for the parent warehouse.
readOnly: true
example: /objects/inventory-control/warehouse/32
manager:
type: object
description: Employee who is responsible for the warehouse.
properties:
id:
type: string
description: Unique identifier of the employee who is the warehouse manager.
example: EM 1--Aman
key:
type: string
description: System-assigned key for the warehouse manager.
example: '23'
href:
type: string
description: URL for the warehouse manager.
readOnly: true
example: /objects/company-config/employee/23
contacts:
type: object
description: |
The contact for the warehouse.
properties:
primary:
type: object
title: primary
properties:
id:
type: string
description: Name for the warehouse contact.
example: Sam Smith
key:
type: string
description: System-assigned key for the warehouse contact.
example: '210'
href:
type: string
description: URL for the warehouse contact.
readOnly: true
example: /objects/company-config/contact/210
shipTo:
type: object
description: Ship to contact for the warehouse.
title: shipTo
properties:
id:
type: string
description: Name for the Ship to contact.
example: Bill North
key:
type: string
description: System-assigned key for the Ship to contact.
example: '223'
href:
type: string
description: URL for the Ship to contact.
readOnly: true
example: /objects/company-config/contact/223
audit:
$ref: '#/components/schemas/audit'
inventory-control-zoneRequiredProperties:
type: object
required:
- id
inventory-control-zone:
type: object
description: >-
A zone is one of four optional attributes (zone, aisle, row, and bin
face) you can assign to a bin to make it easier to find in the
warehouse.
properties:
key:
type: string
description: System-assigned key for the zone.
readOnly: true
example: '12'
id:
type: string
description: >-
Unique identifier or name for the zone. The zone ID cannot be
modified.
example: Z4REF
description:
type: string
description: Description for the zone.
example: Refrigeration Zone Four
href:
type: string
description: URL for the zone.
readOnly: true
example: /objects/inventory-control/zone/12
audit:
$ref: '#/components/schemas/audit'
inventory-control-product-lineRequiredProperties:
type: object
required:
- id
inventory-control-product-line:
type: object
description: >-
Product lines are groups of related products. Using product lines makes
it easier to update prices and track inventory movement.
properties:
key:
type: string
description: System-assigned key for the product line.
readOnly: true
example: '25'
id:
type: string
description: Name or other unique identifier for the product line.
example: Telephones
description:
type: string
description: Description of the product line.
example: Product line for all phones
parent:
type: object
description: >-
If this product line is part of a hierarchy, the parent product line
of this product line.
properties:
key:
type: string
description: System-assigned key for the parent product line.
example: '28'
id:
type: string
description: Unique identifier for the parent product line.
example: Electronics
href:
type: string
readOnly: true
example: /objects/inventory-control/product-line/28
href:
type: string
description: product line URL
example: /objects/inventory-control/product-line/25
readOnly: true
status:
$ref: '#/components/schemas/status'
audit:
$ref: '#/components/schemas/audit'
inventory-control-item-cross-referenceRequiredProperties:
type: object
required:
- referenceType
- item
example:
item:
key: '649'
referenceType: substitute
inventory-control-item-landed-costRequiredProperties:
type: object
required:
- distributionMethod
- item
- landedCostValue
inventory-control-item-warehouse-standard-costRequiredProperties:
type: object
required:
- effectiveStartDate
- standardCost
properties:
itemWarehouse:
required:
- key
example:
itemWarehouse:
key: '649'
inventory-control-item-warehouse-vendorRequiredProperties:
type: object
required:
- vendor
properties:
itemWarehouse:
required:
- key
example:
itemWarehouse:
key: '649'
inventory-control-kit-componentRequiredProperties:
type: object
required:
- kit
- component
- numberOfUnits
inventory-control-lot-categoryRequiredProperties:
type: object
required:
- id
- name
inventory-control-lot-category:
type: object
description: >-
Lot categories let you group a specific set of items that have something
in common.
properties:
key:
type: string
description: System generated lot-category key
example: '2'
readOnly: true
id:
type: string
description: The unique identifier assigned to this lot category
nullable: false
example: Medi-Lot
maxLength: 30
name:
type: string
description: A meaningful descriptive name of lot category.
nullable: false
example: Medical Item Lot
maxLength: 50
href:
type: string
description: Lot Category URL
readOnly: true
example: /objects/inventory-control/lot-category/2
inventory-control-price-listRequiredProperties:
type: object
required:
- id
- appliesTo
example:
id: Base Price List
appliesTo: orderEntry
inventory-control-price-list:
type: object
description: An inventory price list is a container for price list entries.
properties:
key:
type: string
description: System-assigned key for the inventory price list.
readOnly: true
example: '1'
id:
type: string
description: Name or other unique identifier for the inventory price list.
nullable: false
example: Base Price List
href:
type: string
description: URL for the inventory price list.
readOnly: true
example: /objects/inventory-control/price-list/1
startDate:
type: string
format: date
description: >-
Start date of the time period during which the price list will be
effective.
example: '2000-01-01'
endDate:
type: string
format: date
description: >-
End date of the time period during which the price list will be
effective.
example: '2100-12-31'
appliesTo:
type: string
description: >-
Indicates the application that this price list applies to, which can
be Purchasing or Order Entry.
nullable: false
enum:
- purchasing
- orderEntry
example: orderEntry
status:
$ref: '#/components/schemas/status'
inventory-control-price-scheduleRequiredProperties:
type: object
required:
- id
inventory-control-price-schedule:
type: object
description: >-
Inventory price schedules are pricing groups that can be associated with
price lists.
properties:
key:
type: string
description: System-assigned key for the inventory price schedule.
readOnly: true
id:
type: string
description: Name or other unique identifier for the inventory price schedule.
href:
type: string
description: URL for the inventory price schedule.
readOnly: true
description:
type: string
description: Meaningful description of the inventory price schedule.
priceList:
type: object
description: Price list associated with the inventory price schedule.
properties:
key:
type: string
description: System-assigned key for the inventory price list.
id:
type: string
description: Name or other unique identifier for the inventory price list.
href:
type: string
description: URL for the inventory price list.
readOnly: true
discountPercent:
type: string
description: Discount that will apply to assigned customers.
status:
$ref: '#/components/schemas/status'
inventory-control-totalRequiredProperties:
type: object
required:
- id
inventory-control-total:
type: object
description: >-
Use inventory totals to keep track of the items on hand that are
available for sale. Sage Intacct is preconfigured with nine inventory
totals for tracking inventory that's damaged, in transit, on hand, on
hold, on order, requisitioned, or scrap and spoilage. You can also
create your own inventory totals as needed.
properties:
key:
type: string
description: System-assigned key for the inventory total.
readOnly: true
example: '23'
maxLength: 8
id:
type: string
description: ID of inventory total. This should be a unique value.
example: SHIPPED
maxLength: 30
href:
type: string
description: Endpoint for the inventory total.
readOnly: true
example: /objects/inventory-control/total/23
updateType:
type: string
description: >-
Inventory total type, which is assigned when the total is created.
All custom totals that are created are accumulative type.
example: accumulative
readOnly: true
enum:
- accumulative
- perPeriod
- continuous
status:
$ref: '#/components/schemas/status'
inventory-control-txn-definitionRequiredProperties:
type: object
required:
- id
- templateType
- workflowCategory
- status
inventory-control-txn-definition-total-detail:
type: object
description: >-
Specify the inventory running total that will be affected by the
transaction, whether to track the quantity, value, or both, and whether
that amount will increase or decrease when the user saves the
transaction.
properties:
key:
type: string
description: System-assigned key for the inventory transaction definition total.
readOnly: true
example: '23'
maxLength: 8
id:
type: string
description: System-assigned id for the inventory transaction definition total.
readOnly: true
example: '23'
maxLength: 8
href:
type: string
description: Endpoint for the inventory transaction definition total.
readOnly: true
example: /objects/inventory-control/txn-definition-total-detail/23
maintainType:
type: string
description: >-
Specify the inventory running total that will be affected by the
transaction, whether to track the quantity, value, or both.
enum:
- quantity
- value
- quantityAndValue
example: value
operation:
type: string
description: >-
Specify if amount will increase or decrease when user saves the
transaction.
enum:
- add
- subtract
example: add
inventoryTotal:
type: object
description: Specify the inventory total
properties:
key:
type: string
description: System-assigned key for the inventory-total.
example: '23'
id:
type: string
description: Inventory total.
example: ONHAND
href:
type: string
description: Endpoint for the invtotal.
readOnly: true
example: /objects/inventory-control/total/23
inventoryTxnDefinition:
type: object
description: Inventory transaction definition
properties:
key:
type: string
description: System-assigned key for the inventory transaction definition.
example: '23'
id:
type: string
description: Document ID for the inventory transaction definition.
example: Adjustment Decrease
href:
type: string
description: URL for the inventory transaction definition.
readOnly: true
example: /objects/inventory-control/txn-definition/23
dimension-ref:
type: object
properties:
location:
type: object
properties:
key:
type: string
description: Location key
example: '22'
nullable: true
id:
type: string
description: Location
example: LOC-22
nullable: true
name:
type: string
description: Location name
readOnly: true
example: California
nullable: true
href:
type: string
readOnly: true
example: /objects/company-config/location/22
department:
type: object
properties:
key:
type: string
description: Department key
example: '11'
nullable: true
id:
type: string
description: Department
example: DEP-11
nullable: true
name:
type: string
description: Department name
readOnly: true
example: Sales and Marketing
nullable: true
href:
type: string
readOnly: true
example: /objects/company-config/department/11
employee:
type: object
properties:
key:
type: string
description: Employee key
example: '10'
nullable: true
id:
type: string
description: Employee ID
example: EMP-10
nullable: true
name:
type: string
description: Employee name
readOnly: true
example: Thomas, Glenn
nullable: true
href:
type: string
example: /objects/company-config/employee/10
readOnly: true
project:
type: object
properties:
key:
type: string
description: Project key
example: '2'
nullable: true
id:
type: string
description: Project ID
example: NET-XML30-2
nullable: true
name:
type: string
description: Project name
readOnly: true
example: Talcomp training
nullable: true
href:
type: string
readOnly: true
example: /objects/projects/project/2
customer:
type: object
properties:
key:
type: string
description: Customer key
example: '13'
nullable: true
id:
type: string
description: Customer ID
example: CUST-13
nullable: true
name:
type: string
description: Customer name
readOnly: true
example: Jack In the Box
nullable: true
href:
type: string
readOnly: true
example: /objects/accounts-receivable/customer/13
vendor:
type: object
properties:
key:
type: string
description: Vendor key
example: '357'
nullable: true
id:
type: string
description: Vendor ID
example: '1605212096809'
nullable: true
name:
type: string
description: Vendor name
readOnly: true
example: GenLab
nullable: true
href:
type: string
readOnly: true
example: /objects/accounts-payable/vendor/357
item:
type: object
properties:
key:
type: string
description: Item key
example: '13'
nullable: true
id:
type: string
description: Item ID
example: Case 13
nullable: true
name:
type: string
description: Item name
readOnly: true
example: Platform pack
nullable: true
href:
type: string
readOnly: true
example: /objects/inventory-control/item/13
warehouse:
type: object
properties:
key:
type: string
description: Warehouse key
example: '6'
nullable: true
id:
type: string
description: Warehouse ID
example: WH01
nullable: true
name:
type: string
description: Warehouse name
readOnly: true
example: WH01
nullable: true
href:
type: string
readOnly: true
example: /objects/inventory-control/warehouse/6
class:
type: object
properties:
key:
type: string
description: Class key
example: '731'
nullable: true
id:
type: string
description: Class ID
example: REST_CLS_001
nullable: true
name:
type: string
description: Class name
readOnly: true
example: Enterprises
nullable: true
href:
type: string
readOnly: true
example: /objects/company-config/class/731
task:
type: object
properties:
id:
type: string
description: Task ID
example: '1'
nullable: true
key:
type: string
description: Task key
example: '1'
nullable: true
name:
type: string
description: Task name
readOnly: true
example: Project Task
nullable: true
href:
type: string
readOnly: true
example: /objects/projects/task/1
costType:
type: object
properties:
id:
type: string
description: Cost Type ID
example: '2'
nullable: true
key:
type: string
description: Cost Type key
example: '2'
nullable: true
name:
type: string
description: Cost Type name
readOnly: true
example: Project Expense
nullable: true
href:
type: string
readOnly: true
example: /objects/construction/cost-type/2
asset:
type: object
properties:
id:
type: string
description: Asset ID
example: A001
nullable: true
key:
type: string
description: Asset key
example: '1'
nullable: true
name:
type: string
description: Asset name
readOnly: true
example: Laptop 1
nullable: true
href:
type: string
readOnly: true
example: /objects/fixed-assets/asset/1
contract:
type: object
properties:
id:
type: string
description: Contract ID
example: CON-0045-1
nullable: true
key:
type: string
description: Contract key
example: '12'
nullable: true
name:
type: string
description: Contract name
readOnly: true
example: ACME Widgets - Service
nullable: true
href:
type: string
readOnly: true
example: /objects/contracts/contract/12
inventory-control-txn-definition-subtotal-detail:
type: object
description: >-
Subtotal detail for Inventory transaction definition will hold the type
of subtotal that are supported by each Transaction definition.
properties:
key:
type: string
description: >-
System-assigned key for the inventory transaction definition
subtotal detail.
readOnly: true
example: '23'
maxLength: 8
id:
type: string
description: >-
System-assigned ID for the inventory transaction definition subtotal
detail.
readOnly: true
example: '23'
maxLength: 8
href:
type: string
description: Endpoint for the inventory transaction definition subtotal detail.
readOnly: true
example: /objects/inventory-control/txn-definition-subtotal-detail/23
inventoryTxnDefinition:
type: object
description: >-
Inventory transaction definition associated with Inventory
transaction definition subtotal detail. And its required information
to create inventory transaction definition Subtotal detail.
properties:
key:
type: string
description: System-assigned key for the inventory transaction definition.
example: '23'
maxLength: 8
id:
type: string
description: System-assigned ID for the inventory transaction definition.
example: Adjustment Decrease
maxLength: 30
href:
type: string
description: URL for the inventory transaction definition.
readOnly: true
example: /objects/inventory-control/txn-definition/23
lineNumber:
type: integer
description: >-
Line number of subtotal on Inventory transaction definition . 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. The transaction definition
will use the line numbers to display the order of subtotals.
example: 1
maxLength: 8
description:
type: string
description: >-
Provide a text description of the subtotal. A unique description is
required to create an inventory transaction definition subtotal
detail object.
example: Discount
maxLength: 100
subtotalType:
type: string
description: >-
Provide subtotalType Options are Discount or Charge. And its
required information to create inventory transaction definition
Subtotal detail.
enum:
- discount
- charge
example: discount
appliedToLineNumber:
type: integer
description: >-
Specify the subtotal line number to which the subtotal will apply.
Sage Intacct treats the initial subtotal line as line number 0. The
first defined subtotal from the transaction definition is line
number 1, the second defined subtotal is line number 2, and so on.
The value of Applied to line is implicitly assumed to be 0. Taxes,
all other charges, and discounts are computed at the line level.
This fields does not apply if is set to line-level Simple Tax.
example: 1
maxLength: 8
valueType:
type: string
description: >-
Value type options are Amount or Percent. And its required
information to create inventory transaction definition Subtotal
detail
enum:
- amount
- percent
example: amount
subtotalValue:
type: string
description: >-
Provide a default value for the subtotal. If Value type is Amount,
enter the amount of the subtotal. For example, enter 250. If Value
type is Percent, enter a percentage as a whole number. For example,
enter 10 for 10%. Users can override the default subtotal value in
the transaction.
example: '10.23'
maxLength: 12
txnType:
type: string
description: >-
Indicate whether the subtotal will debit or credit the corresponding
GL account and GL offset account.
enum:
- ''
- debit
- credit
example: credit
glAccount:
type: object
description: Set the GL account to which the subtotal will post.
properties:
href:
type: string
description: Endpoint for the glaccount.
readOnly: true
example: /objects/general-ledger/account/10
id:
type: string
example: '7501'
description: Id of GL Account
maxLength: 96
key:
type: string
example: '10'
description: System generated GL Account Key
maxLength: 8
offsetGlAccount:
type: object
description: >-
Offset GL account to which the subtotal will post. This field is
only applicable if you are using advanced workflows.
properties:
href:
type: string
description: Endpoint for the offsetglaccount.
readOnly: true
example: /objects/general-ledger/account/22
id:
type: string
description: Id of GL Account
example: '4001.04'
maxLength: 96
key:
type: string
description: System generated GL Account Key
example: '22'
maxLength: 8
isTax:
type: boolean
description: >-
Set isTax to true to create subtotal as a tax. When the transaction
posts, the tax will post separately based on the items in the
transaction. Set isTax to true for tax subtotal lines if your
organization uses Simple Tax, Advanced Tax, or Avalara AvaTax.
example: false
default: false
enableAvaTax:
type: boolean
description: >-
Set isAvaTax field to true if the subtotal line item applies to
AvaTax and company is subscribed to Avalara AvaTax integration.
example: false
default: false
dimensions:
type: object
allOf:
- $ref: '#/components/schemas/dimension-ref'
- type: object
properties:
department:
title: department
type: object
description: >-
Optional. Provide a default department for the subtotal.
This setting does not apply at the top level.
properties:
href:
type: string
description: Endpoint for the dept.
readOnly: true
example: /objects/company-config/department/13
id:
type: string
description: ID of department.
example: '13'
maxLength: 20
key:
type: string
description: System generated key of department.
example: '8'
maxLength: 8
name:
type: string
description: Name of department.
readOnly: true
example: Finance
maxLength: 40
location:
type: object
description: >-
Optional. Provide a default location for the subtotal. This
setting does not apply at the top level.
properties:
href:
type: string
description: Endpoint for the location.
readOnly: true
example: /objects/company-config/location/12
id:
type: string
description: Id for the location.
example: CA
maxLength: 20
key:
type: string
description: System generated location key.
example: '12'
maxLength: 8
name:
type: string
readOnly: true
description: Name of the location.
example: California
maxLength: 40
inventory-control-txn-definition-source:
type: object
description: Document conversion detail for an Inventory transaction
properties:
key:
type: string
description: >-
System-assigned key for the inventory transaction definition source
document.
readOnly: true
example: '23'
id:
type: string
description: >-
System-assigned id for the inventory transaction definition source
document.
readOnly: true
example: '23'
href:
type: string
description: Endpoint for the inventory transaction definition source document.
readOnly: true
example: /objects/inventory-control/txn-definition-source/23
inventoryTxnDefinition:
type: object
description: Inventory transaction definition
properties:
key:
type: string
description: System-assigned key for the inventory transaction definition.
example: '23'
id:
type: string
description: System-assigned ID for the inventory transaction definition.
example: Adjustment Decrease
href:
type: string
description: URL for the inventory transaction definition.
readOnly: true
example: /objects/inventory-control/txn-definition/23
convertedFrom:
type: object
description: Can be converted from inventory transaction definition
properties:
key:
type: string
description: System-assigned key for the inventory transaction definition.
example: '23'
id:
type: string
description: System-assigned ID for the inventory transaction definition.
example: Adjustment Increase
href:
type: string
description: URL for the inventory transaction definition.
readOnly: true
example: /objects/inventory-control/txn-definition/23
inventory-control-txn-definition-cogs-gl-detail:
type: object
description: >-
This object holds the inventory account mapping for inventory
transaction definitions that are configured to post cost of goods (COGS)
adjustments to the General Ledger. For example, if a transaction
definition is for a cost of goods (COG) adjustment that accounts for
spoilage, you might debit the spoilage account and credit the Inventory
account.
properties:
key:
type: string
description: System-assigned key for the inventory-txn-definition-cogs-gl-detail.
readOnly: true
example: '23'
maxLength: 8
id:
type: string
description: Inventory transaction definition GL mapping ID.
readOnly: true
example: '23'
maxLength: 8
href:
type: string
description: Endpoint for the inventory-txn-definition-cogs-gl-detail.
readOnly: true
example: /objects/inventory-control/txn-definition-cogs-gl-detail/23
txnType:
type: string
description: Indicate whether debit or credit the corresponding GL account.
enum:
- debit
- credit
example: debit
moduleType:
type: string
description: >-
Readonly Module type will be always inventory since COGS account
will be linked to Inventory Transaction Definition.
readOnly: true
example: inventory
enum:
- subledger
- inventory
lineNumber:
type: integer
description: >-
Line number of cogs-gl detail on Inventory transaction definition .
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. Once user
posts the information system will use the line numbers to post the
GL in the order provided.
example: 1
maxLength: 8
glAccount:
type: object
description: >-
Set the GL account to which this transaction posts for the specified
account mapping (itemGLGroup and warehouse).
properties:
key:
type: string
description: System-assigned key for the account.
example: '384'
maxLength: 8
id:
type: string
description: User-assigned number for the account.
example: '1501.04'
maxLength: 96
href:
type: string
readOnly: true
description: Endpoint for the gl-account.
example: /objects/general-ledger/account/384
dimensions:
type: object
allOf:
- $ref: '#/components/schemas/dimension-ref'
- type: object
properties:
location:
type: object
description: >-
Set the default location against which the line item will be
recorded. The location is only applicable if user override
for location has not been enabled. This setting is not
applicable at the top level.
properties:
key:
type: string
description: >-
System-assigned unique key for the location. Used to
identify the location in URLs or JSON bodies for all
operations on the location.
example: '22'
maxLength: 8
id:
type: string
description: ID of location.
example: CA
maxLength: 20
name:
type: string
description: Name of the location.
readOnly: true
example: California
maxLength: 40
href:
type: string
description: Endpoint for the location.
readOnly: true
example: /objects/company-config/location/22
department:
type: object
description: >-
Set the default department against which the line item will
be recorded. The deparment is only applicable if user
override for department has not been enabled. This setting
is not applicable at the top level.
properties:
key:
type: string
description: System generated key of department.
example: '28'
maxLength: 8
id:
type: string
description: ID of department.
example: Finance
maxLength: 20
name:
type: string
description: Name of department.
readOnly: true
example: Finance
maxLength: 40
href:
type: string
description: Endpoint for the department.
readOnly: true
example: /objects/company-config/department/28
warehouse:
type: object
description: >-
The Item GL group and Warehouse together form the criteria
set for the account mapping. For example, you could have the
Maintenance item GL group, Warehouse 13, and Hardware
Customer GL group mapped to a COGS account and Inventory
account, and the Maintenance item GL group, Warehouse 13,
and Software Customer GL group mapped to a different COGS
account and Inventory account.
properties:
key:
type: string
description: System genrated Key of selected warehouse.
example: '21'
maxLength: 8
id:
type: string
description: ID of selected warehouse.
example: ARZ
maxLength: 40
href:
type: string
description: Endpoint for the warehouse.
readOnly: true
example: /objects/inventory-control/warehouse/21
itemGLGroup:
type: object
description: >-
The Item GL group and Warehouse together form the criteria set for
the account mapping. For example, you could have the Maintenance
item GL group, Warehouse 13, and Hardware Customer GL group mapped
to a COGS account and Inventory account, and the Maintenance item GL
group, Warehouse 13, and Software Customer GL group mapped to a
different COGS account and Inventory account.
properties:
key:
type: string
description: System-assigned key for the item GL group.
example: '13'
maxLength: 8
id:
type: string
description: Name of the item GL group.
example: Inventory- Computers and parts
maxLength: 80
href:
type: string
description: Endpoint for the itemglgroup.
readOnly: true
example: /objects/inventory-control/item-gl-group/13
inventoryTxnDefinition:
type: object
description: Inventory Transaction Definition related to COGS Gl Account mapping.
properties:
key:
type: string
description: System-assigned key for the inventory transaction definition.
example: '12'
maxLength: 8
id:
type: string
description: ID for the inventory transaction definition.
example: Inventory Shipper
maxLength: 30
href:
type: string
description: URL for the inventory transaction definition.
readOnly: true
example: /objects/inventory-control/txn-definition/23
inventory-control-txn-definition-entity-detail:
type: object
description: >-
This object contains details about which entities can create
transactions and also includes settings for each entity, such as
numbering sequences and document templates. These details and settings
are applicable to transaction definitions that are configured to create
transactions at the "Top level or entity" or "Entity only" level.
properties:
key:
type: string
description: >-
System-assigned key for the inventory transaction definition entity
detail.
readOnly: true
example: '23'
maxLength: 8
id:
type: string
description: Document parameters entity property ID.
readOnly: true
example: '23'
maxLength: 8
href:
type: string
description: Endpoint for the inventory transaction definition entity detail.
readOnly: true
example: /objects/inventory-control/txn-definition-entity-detail/23
txnNumbering:
type: object
properties:
preserveSequenceNumbering:
type: boolean
description: >-
If true then preserve sequence numbering. Ensures that numbers
are never skipped. Enabling this option can affect performance
when a large volume of transactions is entered at the same time.
This field is not required if you do not specify a
sequenceNumber.
example: false
default: false
inheritSourceDocumentNumber:
type: boolean
description: >-
Inherit source document number. For example, if you convert
transfer out TO-001 into a transfer in, the number for the
transfer in will be TO-001 if the transfer in is set to inherit
the source transaction number.
example: false
default: false
sequenceNumber:
type: object
description: >-
Select the numbering sequence to use to automatically number
transactions for the corresponding entity.
properties:
key:
type: string
description: Document sequence Key
example: '13'
maxLength: 8
href:
type: string
description: Endpoint for the seqnum.
example: /objects/company-config/document-sequence/13
id:
type: string
description: The ID of the numbering sequence.
example: Adjustment Decrease
maxLength: 20
documentTemplate:
type: object
description: >-
Provide printed document template to use as the default for printed
output (PDFs) for the corresponding entity. Inventory transaction
definition document template is used if you not provide this field.
properties:
key:
type: string
description: The system generated key document template.
example: '65'
maxLength: 8
id:
type: string
description: The name of document template.
example: Intacct Inventory transfer sample
maxLength: 100
entity:
type: object
description: The entity to associate with the transaction definition.
properties:
href:
type: string
description: Endpoint for the entityloc.
readOnly: true
example: /objects/company-config/entity/1
key:
type: string
description: >-
System-assigned unique key for the entity. Used to identify the
entity in URLs or JSON bodies for all operations involving the
entity.
example: '1'
maxLength: 8
id:
type: string
description: >-
Unique identifier of the entity. 20 characters max. The ID
cannot be changed after the entity has been created.
example: 1-us
maxLength: 20
inventoryTxnDefinition:
type: object
description: >-
Header Inventory transaction definition level details and its
required to create new entity settings.
properties:
key:
type: string
description: >-
System-assigned key for the inventory transaction definition
entity detail.
example: '233'
maxLength: 8
id:
type: string
description: >-
System-assigned ID for the inventory transaction definition
entity detail.
example: Adjustment Decrease
maxLength: 20
href:
type: string
description: URL for the inventory transaction definition.
readOnly: true
example: /objects/inventory-control/txn-definition/233
inventory-control-txn-definition:
type: object
description: >-
An inventory transaction definition includes the accounting rules,
workflow settings, security settings, and other characteristics for a
transaction.
properties:
key:
type: string
description: System-assigned key for the inventory transaction definition.
readOnly: true
example: '23'
maxLength: 8
id:
type: string
description: >-
Unique name for Inventory transaction definition. Required on create
and cannot be modifed.
example: Adjustment Decrease
maxLength: 30
href:
type: string
description: URL for the inventory-txn-definition.
readOnly: true
example: /objects/inventory-control/txn-definition/23
templateType:
type: string
description: >-
Template type Determines whether certain fields appear on the
transaction (for example, Expiration date versus Ship Date). Other
areas in Intacct where you use the Template type include - 1) You
associate document templates (used for printed output) to
transactions by Template type. Learn more about document templates
in help section. 2) In Salesforce integrations, the integration
groups the related list of Intacct objects by transaction definition
Template type. 3) In Avalara AvaTax integrations, the integration
uses the transaction definition Template type to determine if a
transaction is positive or negative.
example: adjustment
enum:
- quote
- order
- list
- invoice
- adjustment
- other
default: quote
description:
type: string
description: >-
A meaningful description of the transaction definition. The
description appears in the transaction definition list.
example: Adjustment Decrease (Quantity Only)
maxLength: 100
workflowCategory:
type: string
description: >-
Workflow category associates the transaction with the appropriate
icon on the Overview page and with the applicable transaction menu
grouping in the Inventory Control menu.
example: receipt
enum:
- receipt
- transfer
- adjustment
- shipping
default: adjustment
reportingCategory:
type: string
description: >-
Establishes a reporting category that best reflects the purpose of
the transaction definition so that similar documents can be grouped
when building reports. This field is applicable for use with
Interactive Custom Report Writer or Interactive Visual Explorer
subscriptions only.
example: inventoryAdjustment
default: null
enum:
- null
- inventoryAdjustment
- buildKits
- disassembleKits
- inventoryDamagedGoods
- inventoryReceipt
- inventoryScrapOrSpoilage
- inventoryShipper
- warehouseTransfer
nullable: true
status:
$ref: '#/components/schemas/status'
txnNumbering:
type: object
properties:
numberingSequence:
type: object
description: >-
Use numbering sequence to automatically number transactions.
Leave this field blank to number transactions manually.
properties:
key:
type: string
description: Numbering sequence key.
example: '23'
maxLength: 8
id:
type: string
description: Numbering sequence ID.
example: Adjustment Decrease
maxLength: 20
href:
type: string
description: URL for the document sequence number.
readOnly: true
example: /objects/company-config/document-sequence/23
preserveSequenceNumbers:
type: boolean
description: >-
Ensures that numbers are never skipped. Enabling this option can
affect performance when a large volume of transactions is
entered at the same time.
example: false
default: false
inheritSourceDocumentNumber:
type: boolean
description: >-
For example, if you convert transfer out TO-001 into a transfer
in, the number for the transfer in will be TO-001 if the
transfer in is set to inherit the source transaction number.
example: false
default: false
inventoryControl:
type: object
description: Provide values to only if company subscribes to Inventory Control.
properties:
enableWarnOnLowQty:
type: boolean
description: >-
Warn user if item on hand quantity falls below 0. Alerts the
user if the quantity needed is greater than the ONHAND total in
the selected warehouse. The warning also shows the ONORDER and
ONHOLD totals. The warning appears when the user tabs out of the
Quantity field in the transaction.
example: true
default: true
updatesInventory:
type: string
description: >-
System will assing depending on Inventory Totals provided in
transaction definition. If Inventory Total is affecting both
qunatity and value then value will be quantityAndValue.
example: value
readOnly: true
enum:
- 'no'
- quantity
- value
- quantityAndValue
default: 'no'
updatesCost:
type: boolean
description: >-
System will assing depending on Inventory Totals provided in
transaction definition. System will set this to true if this
transaction will update costing.
example: false
readOnly: true
default: false
increaseOrDecreaseInventory:
type: string
description: >-
Increases or decreases inventory. System will auto assign
depending on Inventory totals selected and if its adding
quantity/value or decrease the quantity/value.
readOnly: true
example: increase
enum:
- increase
- decrease
default: increase
warehouseSelectionMethod:
type: string
description: >-
Determines how warehouses are presented to the user in the
warehouse dropdown list in the transaction.
example: sortByID
enum:
- sortByID
- sortByName
- warehouseWithAvailableInventory
- useTheDefaultWarehouse
default: sortByID
defaultWarehouse:
type: object
description: >-
Set this only when the Warehouse selection method is Use the
default warehouse. A user's Default warehouse setting in their
user preferences overrides this selection.
properties:
key:
type: string
description: Default warehouse key.
example: '20'
maxLength: 8
id:
type: string
description: Default warehouse id.
example: Warehouse-001
maxLength: 20
href:
type: string
description: URL for the warehouse.
readOnly: true
example: /objects/inventory-control/warehouse/20
accounting:
type: object
properties:
txnPosting:
type: string
description: >-
Specify whether the transaction post process creates a GL entry
if so the transaction posts directly to the General Ledger. If
you set to do not post the transaction post process will not
create a GL entry. If you set to post to General Ledger, at
least one debit and credit inventory account mapping should be
selected.
example: postToGeneralLedger
enum:
- postToGeneralLedger
- doNotPost
default: postToGeneralLedger
isSubTotalsEnabled:
type: boolean
description: >-
Enable subtotals allows users to specify standard subtotals,
such as tax or a discount, for this transaction. When you set
this field to true, you must add at least one subtotal detail.
example: false
default: false
conversionType:
type: string
description: >-
Indicates how the system processes transactions that are partially
completed. Leave transaction open will converts the transaction to
another transaction type, the system leaves the original transaction
open until the all items are completed. Close transaction will
converts this transaction to another transaction type, the system
closes this transaction regardless of whether the transaction is
complete.
example: closeTxn
enum:
- leaveTxnOpen
- closeTxn
default: closeTxn
pricingAndTerms:
type: object
description: Pricing and terms
properties:
initialPriceList:
type: object
description: >-
Set the initial price list if desired. If you are using layered
price lists, this indicates the first price list the system will
evaluate when determining a suggested transaction price.
properties:
key:
type: string
description: Initial price list key.
example: '12'
maxLength: 8
id:
type: string
description: Initial price list.
example: Base Price List
maxLength: 40
href:
type: string
description: URL for the initial price list.
readOnly: true
example: /objects/inventory-control/price-list/12
specialPriceList:
type: object
description: >-
If you are using layered price lists, this indicates a special
price list (for example, a discounted price list or seasonal
price list). The special price list takes precedence over the
Initial price list
properties:
key:
type: string
description: Special price list key.
example: '13'
maxLength: 8
id:
type: string
description: Special price list.
example: Discount Price List
maxLength: 40
href:
type: string
description: URL for the special price list.
readOnly: true
example: /objects/inventory-control/price-list/13
print:
type: object
description: Print
properties:
documentTemplate:
type: string
description: >-
Provide printed document template to use for printed output
(PDFs).
example: Adjustment_US_Template
maxLength: 50
defaultText:
type: string
description: >-
If you do not set print Document template, enter any text that
you want to appear on every document printed from this
transaction.
example: Document template is not selected.
maxLength: 4000
enableUserOrGroupPermmission:
type: boolean
description: >-
By default, all users with the appropriate application permissions
have access to transactions that use this transaction definition. To
restrict access to certain users or groups, set this field to
'true'.
example: false
default: false
userOverrides:
type: object
description: User Overrides
properties:
allowDepartmentOverride:
type: boolean
description: >-
Set to true to allow users to override the department set for
the transaction.
example: false
default: false
allowLocationOverride:
type: boolean
description: >-
Set to true to allow users to override the location set for the
transaction.
example: false
default: false
documentPermissions:
type: object
description: Document permissions
properties:
editPolicy:
type: string
description: >-
Sets the edit permission for this transaction type. If No edit
is selected user cannot edit this transaction after it is
created. If Before Printing is selected user can edit this
transaction until it has been printed to PDF. After it has been
printed, the transaction cannot be edited. If Edit in Draft Only
is selected user The user can edit this transaction until it has
been posted. After it has been posted, the transaction cannot be
edited. If All is selected user can edit this transaction as
allowed by the transaction's condition
example: all
enum:
- noEdit
- beforePrinting
- editInDraftOnly
- all
default: all
deletePolicy:
type: string
description: >-
Sets the delete permission for this transaction type. If No
delete is selected user cannot delete this transaction after it
is created. If Before Printing is selected the user can delete
this transaction until it has been printed to PDF. After it has
been printed, the transaction cannot be deleted. If All is
selected the user can delete this transaction as allowed by the
transaction’s condition.
example: all
enum:
- noDelete
- beforePrinting
- deleteInDraftOnly
- all
default: all
createPolicy:
type: string
description: >-
Sets the create permissions for this transaction type. If New
document or Convert is selected the user can create this
transaction as a standalone transaction or the user can create
this transaction by converting the previous transaction in the
workflow. If Convert only is selected the user can can only
create this document by converting the previous transaction in
the workflow.
example: newDocumentOrConvert
enum:
- newDocumentOrConvert
- convertOnly
default: newDocumentOrConvert
multiEntityRuleForTxn:
type: string
description: >-
Sets the context for where users can create transactions from
this transaction definition within a multi-entity, shared
environment.
example: topLevelOrEntity
enum:
- topLevelOrEntity
- topLevelOnly
- entityOnly
default: topLevelOrEntity
inventoryTotalDetail:
type: array
description: Related inventory transaction definition totals.
items:
$ref: '#/components/schemas/inventory-control-txn-definition-total-detail'
subtotalDetail:
type: array
description: Related inventory transaction subtotals
items:
$ref: '#/components/schemas/inventory-control-txn-definition-subtotal-detail'
sourceDocumentDetail:
type: array
description: Related inventory transaction definition converted.
items:
$ref: '#/components/schemas/inventory-control-txn-definition-source'
inventoryAccountMapping:
type: array
description: >-
Related inventory transaction definition GL account mappings by item
GL group. If transaction posting is General Ledger, enter applicable
inventory account mapping here. For example, if the transaction
definition is for an adjustment that accounts for spoilage, you
might debit the spoilage account and credit the Inventory account.
items:
$ref: '#/components/schemas/inventory-control-txn-definition-cogs-gl-detail'
entitySettingDetail:
type: array
description: Related inventory transaction definition Entity detail
items:
$ref: '#/components/schemas/inventory-control-txn-definition-entity-detail'
audit:
$ref: '#/components/schemas/audit'
inventory-control-txn-definition-sourceRequiredProperties:
type: object
required:
- inventoryTxnDefinition
- convertedFrom
example:
inventoryTxnDefinition:
key: '173'
convertedFrom:
key: '172'
inventory-control-txn-definition-cogs-gl-detailRequiredProperties:
type: object
required:
- inventoryTxnDefinition
- txnType
- glAccount
inventory-control-txn-definition-entity-detailRequiredProperties:
type: object
required:
- inventoryTxnDefinition
- entity
inventory-control-txn-definition-subtotal-detailRequiredProperties:
type: object
required:
- inventoryTxnDefinition
- subtotalType
- valueType
- description
inventory-control-txn-definition-total-detailRequiredProperties:
type: object
required:
- maintainType
- operation
- inventoryTxnDefinition
- inventoryTotal
example:
inventoryTxnDefinition:
key: '172'
inventoryTotal:
key: '51'
maintainType: quantity
operation: subtract
inventory-control-warehouse-groupRequiredProperties:
type: object
required:
- id
- name
- groupType
inventory-control-warehouse-group-member:
type: object
description: Member warehouses of the warehouse group
properties:
key:
type: string
description: System-assigned key for the warehouse-group member.
readOnly: true
example: '10'
id:
type: string
description: Unique identifier for the warehouse group member.
readOnly: true
example: '10'
href:
type: string
description: Warehouse group member URL.
readOnly: true
example: /objects/inventory-control/warehouse-group-member/10
warehouseGroup:
type: object
description: Warehouse group that this warehouse is a member of.
properties:
key:
type: string
description: System-assigned key for the warehouse group.
example: '4'
id:
type: string
description: Unique identifier for the warehouse group.
example: EastCoastWarehouses
href:
type: string
description: URL for the warehouse group.
readOnly: true
example: /objects/inventory-control/warehouse-group/4
warehouse:
type: object
description: Member warehouse of the warehousegroup.
properties:
key:
type: string
description: Key of the associated warehouse object.
example: '9'
id:
type: string
description: ID of the associated warehouse object.
example: MCOM
name:
type: string
description: Name of the associated warehouse object.
readOnly: true
example: Mobile Components
href:
type: string
description: URL of the associated warehouse object.
readOnly: true
example: /objects/inventory-control/warehouse/9
status:
title: status
type: string
description: Warehouse status
enum:
- active
- inactive
example: active
sortOrder:
type: integer
description: >-
Sort Order of the warehouse within the warehouse group startting
from 0.
example: 1
audit:
$ref: '#/components/schemas/audit'
inventory-control-warehouse-group:
type: object
description: >-
A warehouse group categorizes warehouse dimension records, mainly for
the purpose of structuring financial reporting.
properties:
key:
type: string
description: System-assigned key for the warehouse group.
readOnly: true
example: '4'
id:
type: string
description: Unique identifier for the warehouse group.
example: EastCoastWarehouses
href:
type: string
description: Warehouse group URL.
readOnly: true
example: /objects/inventory-control/warehouse-group/4
name:
type: string
description: Name of the warehouse group.
example: EastCoast Warehouses
description:
type: string
description: Description of the warehouse group.
example: Warehouses on the east coast
groupType:
type: string
description: >-
Group membership type. The group type and related fields that you
set determine which warehouses are added to the group. * `all` - All
items that match the `memberFilter` criteria. If ‘all’ is selected,
'memberFilter' is required. * `specific` - Specify the items to
include and their order in the `groupMembers` array. If ‘specific’
is selected, 'groupMembers' is required.
example: all
enum:
- all
- specific
sortField:
type: string
description: >-
Warehouse field to sort on. Only applicable when `groupType` =
`all`.
example: warehouseId
default: warehouseId
enum:
- createdAtEntityId
- location
- managerId
- parentWarehouse
- status
- warehouseId
sortOrder:
type: string
description: >-
Sort order for warehouse that match the `memberFilter`. Only
applicable when `groupType` = `all`.
example: ascending
enum:
- ascending
- descending
default: ascending
maxMatches:
type: integer
description: >-
The maximum number of warehouses that match the memberFilter to
include in the warehouse group. Only applicable when `groupType` =
`all`.
example: 100
createDimensionComponents:
type: boolean
description: >-
Set to 'true' to create a dimension structure that enables the group
to be used on the rows and columns of financial reports. If this
field is set to false, the group can only be used for filtering.
default: false
example: true
glAccountGroup:
type: object
description: >-
General ledger (GL) account group associated with the warehouse
group.
properties:
key:
type: string
readOnly: true
example: '23'
id:
type: string
description: ID for the gl-account-group.
readOnly: true
example: EastCoastWarehouses
href:
type: string
description: URL for the gl-account-group.
readOnly: true
example: /objects/general-ledger/gl-account-group/23
memberFilter:
type: array
description: >-
One or more filters to select the warehouses to include in the
warehouse group.
nullable: true
items:
title: memberFilter
properties:
field:
type: string
description: Warehouse field to filter on.
enum:
- createdAtEntityId
- location
- managerId
- parentWarehouse
- status
- warehouseId
example: status
operator:
type: string
description: Operator to filter the group.
enum:
- equals
- doesNotEqual
- isGreaterThan
- isLessThan
- isOneOf
- isNotOneOf
- isEmpty
- isNotEmpty
- contains
- isCurrentUser
example: equals
value:
type: string
description: Value to use to filter the group.
example: active
conditionType:
type: string
description: >-
Whether multiple memberFilter are treated as 'and', 'or', or as a
complex expression.
example: and
enum:
- and
- or
- expression
default: and
expression:
type: string
description: >-
Expression for combining multiple filters. Only applicable if the
'conditionType' is 'expression'.
example: (1 AND 2) OR 3
groupMembers:
type: array
description: The members of the warehouse group.
items:
$ref: '#/components/schemas/inventory-control-warehouse-group-member'
audit:
$ref: '#/components/schemas/audit'
inventory-control-cycleRequiredProperties:
type: object
required:
- id
inventory-control-cycle:
type: object
description: Inventory cycle information.
properties:
key:
type: string
description: System generated Key
example: 1
readOnly: true
id:
type: string
description: >-
Unique identifier for the inventory cycle. The face ID cannot be
modified.
example: Monthly Cycle
description:
type: string
description: Description for the inventory cycle
example: Monthwise inventory cycle
href:
type: string
description: inventory-cycle url
example: /objects/inventory-control/cycle/3
readOnly: true
status:
$ref: '#/components/schemas/status'
audit:
$ref: '#/components/schemas/audit'
inventory-control-documentRequiredProperties:
type: object
required:
- transactionDate
properties:
lines:
type: array
items:
required:
- unit
- unitQuantity
- unitCost
properties:
dimensions:
required:
- item
- warehouse
- location
example: >-
{ "item": { "id": "1" }, "warehouse": { "id": "1" },
"location" : { "id": "1" }}
entity-ref:
type: object
properties:
key:
type: string
description: System-assigned key for the objects Entity Location.
readOnly: true
nullable: true
example: '46'
id:
type: string
description: User-assigned ID for the objects Entity Location
readOnly: true
nullable: true
example: CORP
name:
type: string
description: User-assigned NAME for the objects Entity Location
readOnly: true
nullable: true
example: Corp
href:
type: string
readOnly: true
example: /objects/company-config/entity/46
readOnly: true
inventory-control-document-line-detail:
type: object
description: >-
List of warehouse inventory details including serial number, aisle, bin,
and row per item
properties:
key:
type: string
description: System-assigned key for the Inventory Control document line detail
readOnly: true
example: '55'
id:
type: string
description: Inventory Control document line details ID
readOnly: true
example: '55'
href:
type: string
description: Endpoint for the Inventory Control document line detail
readOnly: true
example: /objects/inventory-control/document-line-detail/55
quantity:
type: string
format: decimal-precision-10
description: >-
The quantity in base units for the combination of the tracking
attributes specified in this line detail
example: '10'
serialNumber:
type: string
description: Serial number of the item
example: S1001
lotNumber:
type: string
description: The lot number of the item(s)
example: L1001
expirationDate:
type: string
description: The expiration date of the item(s)
format: date
nullable: true
example: '2023-04-04'
aisle:
type: object
description: Aisle associated with the line details
properties:
href:
type: string
description: Endpoint for the aisle
readOnly: true
example: /objects/inventory-control/aisle/10
key:
type: string
description: System-assigned key for the aisle
example: '10'
id:
type: string
description: Aisle ID
example: AISLE1
bin:
type: object
description: The bin associated with the line details
properties:
href:
type: string
description: Endpoint for the bin.
readOnly: true
example: /objects/inventory-control/bin/20
key:
type: string
description: System-assigned key for the bin
example: '20'
id:
type: string
description: Bin ID
example: BIN1
row:
type: object
description: The row associated with the line details
properties:
href:
type: string
description: Endpoint for the row
readOnly: true
example: /objects/inventory-control/row/15
key:
type: string
description: System-assigned key for the row
example: '15'
id:
type: string
description: Row ID
example: ROW1
item:
type: object
description: Item associated with the line details
properties:
key:
type: string
description: System-assigned key for the item
example: '10'
id:
type: string
description: Item ID
example: Battery
href:
type: string
description: URL for the item
readOnly: true
example: /objects/inventory-control/item/10
componentItem:
type: object
description: Component item associated with the line details
properties:
key:
type: string
description: System-assigned key for the component item
example: '10'
id:
type: string
description: Component item Id
example: Battery
href:
type: string
description: URL for the component item
readOnly: true
example: /objects/inventory-control/item/10
audit:
$ref: '#/components/schemas/audit'
inventoryDocumentLine:
type: object
description: Inventory document line information
readOnly: true
properties:
key:
type: string
description: System-assigned key for the Inventory document line
readOnly: true
example: '23'
id:
type: string
description: ID for the document line item
readOnly: true
example: '23'
documentType:
type: string
description: Type of the Inventory document line
readOnly: true
example: Beginning Balance
href:
type: string
description: URL for the Inventory document
readOnly: true
example: /objects/inventory-control/document-line::Beginning%20Balance/23
inventory-control-document-line:
type: object
description: >-
Line information for Inventory transactions including opening balances
and adjustments.
properties:
key:
type: string
description: System-assigned key for the Inventory document line item
readOnly: true
example: '23'
id:
type: string
description: System-assigned ID for the Inventory document line item
readOnly: true
example: '23'
href:
type: string
description: URL for the Inventory document line item
readOnly: true
example: /objects/inventory-control/document-line::Beginning%20Balance/23
documentType:
type: string
description: The type of transaction
example: Beginning Balance
readOnly: true
memo:
type: string
description: Line item memo
example: Starting quantity of fuel pumps
lineDescription:
type: string
description: Line item description
example: High efficiency pump
unitOfMeasure:
type: object
description: The unit of measure for this line
properties:
key:
type: string
description: The unit of measure Key
example: '38'
maxLength: 8
id:
type: string
description: The unit of measure Id
example: Each
maxLength: 20
href:
type: string
description: Unit of measure URL.
readOnly: true
example: /objects/inventory-control/unit-of-measure/38
unitQuantity:
type: string
format: decimal-precision-10
description: Unit quantity associated with this line item
example: '100'
quantity:
type: string
format: decimal-precision-10
description: Base unit quantity associated with this line item
readOnly: true
example: '100'
quantityConverted:
type: string
format: decimal-precision-10
description: >-
Quantity of the item converted to a downstream document from the
original quantity entered
readOnly: true
example: '5'
quantityRemaining:
type: string
format: decimal-precision-10
description: Quantity remaining after a partial conversion of this transaction
readOnly: true
example: '5'
cost:
type: string
format: decimal-precision-10
description: The cost per base unit
example: '1.00'
readOnly: true
unitCost:
type: string
format: decimal-precision-10
description: Unit cost associated with this line item
example: '1.00'
extendedCost:
type: string
format: decimal-precision-10
description: Extended total cost
example: '1.00'
totalCost:
type: string
format: decimal-precision-10
description: Total cost
readOnly: true
example: '1.0000000000'
lineNumber:
type: integer
description: Line number of the document line
readOnly: true
example: 15
costMethod:
type: string
description: Item cost method
readOnly: true
default: null
nullable: true
example: standard
enum:
- null
- average
- standard
- FIFO
- LIFO
txnCurrency:
type: string
description: Transaction currency
example: USD
baseCurrency:
type: string
description: Transaction base currency
example: USD
conversionType:
type: string
description: Transaction conversion type
enum:
- quantity
- price
default: quantity
example: quantity
trackingDetail:
type: array
description: >-
List of warehouse inventory details including serial number, aisle,
bin, and row per item.
items:
$ref: '#/components/schemas/inventory-control-document-line-detail'
documentHeader:
type: object
properties:
href:
type: string
description: URL for the inventory-document.
readOnly: true
example: /objects/inventory-control/document::Beginning%20Balance/23
key:
type: string
description: System-assigned unique key of the Inventory document
example: '23'
id:
type: string
description: Inventory document ID
example: Beginning Balance-ADJINC0001
documentNumber:
type: string
description: Document header number
example: ADJINC0001
documentType:
type: string
description: Type of the Inventory document
readOnly: true
example: Beginning Balance
dimensions:
type: object
allOf:
- $ref: '#/components/schemas/dimension-ref'
- type: object
properties:
location:
title: location
type: object
description: Location associated with the document line
properties:
key:
type: string
description: System-assigned location key
example: '22'
id:
type: string
description: Location ID
example: LOC-22
href:
type: string
description: Location URL
readOnly: true
example: /objects/company-config/location/23
department:
type: object
description: Department associated with the document line
title: department
properties:
key:
type: string
description: System-assigned department key
readOnly: true
example: '9'
id:
type: string
description: Department ID
example: Sales
href:
type: string
description: Department URL
readOnly: true
example: /objects/company-config/department/9
warehouse:
title: warehouse
description: Warehouse associated with the document line
type: object
properties:
key:
type: string
description: System-assigned warehouse key
example: '6'
id:
type: string
description: Warehouse ID
example: WH01
href:
type: string
description: Warehouse URL
readOnly: true
example: /objects/inventory-control/warehouse/6
project:
title: project
description: Project associated with the document line
type: object
properties:
key:
type: string
description: System-assigned project key
example: '2'
id:
type: string
description: Project ID
example: NET-XML30-2
href:
type: string
readOnly: true
description: Project URL
example: /objects/projects/project/2
task:
title: task
description: Task associated with the document line
type: object
properties:
id:
type: string
description: Task ID
example: TSK01
key:
type: string
description: System-assigned task key
example: '1'
href:
type: string
description: Task
readOnly: true
example: /objects/projects/task/1
sourceDocument:
type: object
description: Parent or source document
properties:
href:
type: string
description: Inventory-document URL
readOnly: true
example: /objects/inventory-control/document::Beginning%20Balance/23
id:
type: string
description: Source inventory document ID
example: BB-193
documentType:
type: string
description: Source inventory document type
example: Beginning Balance
readOnly: true
key:
type: string
description: System assigned inventory document key
example: '23'
sourceDocumentLine:
type: object
description: Source document line
properties:
href:
type: string
description: URL for the Inventory document line
readOnly: true
example: /objects/inventory-control/document-line::Beginning%20Balance/23
id:
type: string
description: Source document line ID.
example: '23'
key:
type: string
description: Source document line key.
example: '23'
documentType:
type: string
description: Type of the Inventory document line
readOnly: true
example: Beginning Balance
audit:
type: object
allOf:
- $ref: '#/components/schemas/audit'
- type: object
properties:
createdDateTime:
type: string
description: Time of the submission.
format: date-time
example: '2014-01-08T11:28:12Z'
readOnly: true
status:
$ref: '#/components/schemas/status'
inventory-control-document-history:
type: object
description: >-
History of workflow conversions associated with the Inventory
transaction
properties:
key:
type: string
description: System-assigned key for the Inventory document history
readOnly: true
example: '11'
id:
type: string
description: System-assigned ID for the Inventory document history
readOnly: true
example: '11'
href:
type: string
description: Endpoint for the Inventory document history
readOnly: true
example: /objects/inventory-control/document-history/11
convertedFrom:
type: object
description: >-
When an inventory document is the result of a conversion, this field
shows the transaction from which the document was converted.
readOnly: true
properties:
key:
type: string
description: System-assigned key for the Inventory document
readOnly: true
example: '22'
id:
type: string
description: System-assigned ID for the Inventory document
readOnly: true
example: SYS-Warehouse Transfer Out-WHXFER-000028-doc-Out
documentType:
type: string
description: Type of the Inventory document
readOnly: true
example: SYS-Warehouse Transfer Out
href:
type: string
description: URL for the Inventory document
readOnly: true
example: >-
/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/22
convertedTo:
type: object
description: >-
When an inventory document is the result of a conversion, this field
shows the transaction to which the document was converted.
readOnly: true
properties:
key:
type: string
description: System-assigned key for the Inventory document
readOnly: true
example: '14'
id:
type: string
description: System-assigned ID for the Inventory document
readOnly: true
example: SYS-Warehouse Transfer In-WHXFER-000028-doc-In
documentType:
type: string
description: Type of the Inventory document
readOnly: true
example: SYS-Warehouse Transfer In
href:
type: string
description: URL for the Inventory document
readOnly: true
example: >-
/objects/inventory-control/document::SYS-Warehouse%20Transfer%20In/14
inventoryDocument:
type: object
description: >-
The Inventory document with which the history information is
associated
readOnly: true
properties:
key:
type: string
description: System-assigned key for the Inventory document.
readOnly: true
example: '23'
id:
type: string
description: Name or other unique identifier for the Inventory document.
readOnly: true
example: '23'
documentType:
type: string
description: Type of the Inventory document
readOnly: true
example: SYS-Warehouse Transfer Out
href:
type: string
description: Endpoint for the document.
readOnly: true
example: >-
/objects/inventory-control/document::SYS-Warehouse%20Transfer%20Out/23
inventory-control-document-subtotal:
type: object
description: Details of Subtotals, taxes, discounts, charges etc for the transaction.
properties:
key:
type: string
description: System-assigned key for the inventory document subtotal.
readOnly: true
example: '23'
id:
type: string
description: ID for the inventory document subtotal.
readOnly: true
example: '23'
href:
type: string
description: Endpoint for the inventory document subtotal.
readOnly: true
example: /objects/inventory-control/document-subtotal/23
description:
type: string
description: Description about subtotal.
example: Freight
percentValue:
type: string
format: decimal-precision-10
description: >-
Percentage value that is calculated on the total of all line items
of the document.
example: '5.0000000000'
absoluteValue:
type: string
format: decimal-precision-2
description: >-
Non negative base amount calculated across all other lines of the
document.
example: '1.20'
txnAbsoluteValue:
type: string
format: decimal-precision-2
description: >-
Non negative transaction amount calculated across all other lines of
the document.
readOnly: true
example: '1.20'
isValueEditable:
type: boolean
description: Indicates whether the absoluteValue is editable.
readOnly: true
example: false
enum:
- false
- true
default: false
isPercentEditable:
type: boolean
description: Indicates whether the percentValue is editable.
readOnly: true
example: false
enum:
- false
- true
default: false
total:
type: string
format: decimal-precision-14
readOnly: true
description: The computed base amount for the subtotal.
example: '1.20000000000000'
txnTotal:
type: string
format: decimal-precision-14
readOnly: true
description: The computed transaction amount for the subtotal.
example: '1.20000000000000'
documentLine:
type: object
description: The Inventory document line associated with the subtotal.
readOnly: true
properties:
href:
type: string
description: Endpoint for the Inventory document line.
readOnly: true
example: >-
/objects/inventory-control/document-line::Inventory%20Receipt/62991
key:
type: string
description: System-assigned key for the inventory document line.
readOnly: true
example: '62991'
id:
type: string
description: System-assigned ID for the inventory document line.
readOnly: true
example: '62991'
documentType:
type: string
description: Type of the Inventory Control document
example: Inventory Receipt
readOnly: true
dimensions:
type: object
allOf:
- $ref: '#/components/schemas/dimension-ref'
- type: object
properties:
location:
title: location
description: Location associated with the subtotal line.
type: object
properties:
key:
type: string
description: System-assigned key for the location.
example: '22'
id:
type: string
description: Identifier for the location.
example: LOC-22
href:
type: string
description: URL for the location.
readOnly: true
example: /objects/company-config/location/22
department:
title: department
type: object
description: >-
A dimension that allows you to create a hierarchy of
departments to reflect how your company is organized.
properties:
key:
type: string
description: System-assigned key for the department.
readOnly: true
example: '9'
id:
type: string
description: Unique identifier of the department.
example: Accounting
href:
type: string
readOnly: true
description: URL for the department.
example: /objects/company-config/department/9
documentHeader:
type: object
description: Inventory document header.
readOnly: true
properties:
href:
type: string
description: URL for the inventory-document.
readOnly: true
example: /objects/inventory-control/document::Inventory%20Receipt/7808
key:
type: string
description: Document header number.
readOnly: true
example: '7808'
documentType:
type: string
description: Type of the order entry document.
example: Inventory Receipt
readOnly: true
id:
type: string
readOnly: true
example: Inventory Receipt-IR-000253
audit:
$ref: '#/components/schemas/audit'
inventory-control-document:
type: object
description: >-
Header information for Inventory Control transactions including opening
balances and adjustments
properties:
key:
type: string
description: System-assigned key for the Inventory document
readOnly: true
example: '23'
id:
type: string
description: Inventory document ID
readOnly: true
example: Beginning Balance-ADJINC0001
documentNumber:
type: string
description: >-
Document number; if the transaction definition does not have a
numbering sequence configured, provide a number to identify the
transaction.
example: ADJINC0001
documentType:
type: string
description: The type of transaction
example: Beginning Balance
isPrinted:
type: boolean
description: Indicates whether the document has been printed
readOnly: true
enum:
- true
- false
default: false
example: false
subTotal:
type: string
format: decimal-precision-2
description: Subtotal of the document in base currency
example: '1.00'
readOnly: true
total:
type: string
format: decimal-precision-2
description: The sum of values across all lines in the document
example: '1.00'
readOnly: true
subtotalInTxnCurrency:
type: string
format: decimal-precision-2
description: Subtotal of the document in transaction currency
example: '1.00'
readOnly: true
totalInTxnCurrency:
type: string
format: decimal-precision-2
description: Total in the transaction currency
example: '1.00'
readOnly: true
state:
type: string
description: Document state
example: pending
default: draft
enum:
- draft
- pending
- closed
- inProgress
- converted
- partiallyConverted
- convertedByLine
- partiallyConvertedByLine
- exception
referenceNumber:
type: string
description: Reference number
example: INV-1002
memo:
type: string
description: Text printed on the Inventory document
example: Transfer CA to AZ
exchangeRate:
type: object
description: Exchange rate details used to calculate the base amount
properties:
date:
type: string
format: date
example: '2021-01-23'
description: >-
Exchange rate date for this transaction; either the current
date, the date the transaction was issued, or the date the
transaction will be paid
rate:
type: string
format: decimal-precision-4
description: >-
Exchange rate used to calculate the base amount from the
transaction amount
example: '1.0789'
typeId:
type: string
description: >-
Exchange rate type used to calculate the base amount from the
transaction amount
example: '1'
typeName:
type: string
description: The name of exchange rate type
example: Intacct Daily Rate
transactionDate:
type: string
format: date
description: Transaction date
example: '2023-01-01'
lastPrintedDate:
type: string
format: date
description: Last printed date.
example: '2023-01-01'
nullable: true
isAdjustmentDocument:
type: boolean
description: is this an Adjustment Document.
example: false
default: false
baseCurrency:
type: string
description: Base currency for the transaction.
example: USD
txnCurrency:
type: string
description: Currency used for the transaction.
example: USD
txnDefinition:
type: object
properties:
href:
type: string
description: URL for the inventory transaction definition.
readOnly: true
example: /objects/inventory-control/txn-definition/23
key:
type: string
description: Transaction definition key.
example: '23'
id:
type: string
description: Transaction definition id.
example: Beginning Balance
documentType:
type: string
description: Type of transaction.
example: Beginning Balance
txnDefinitionTemplateClass:
type: string
description: Transaction definition template class.
readOnly: true
example: INVOICE
updatesInventory:
type: string
description: Affects inventory.
example: quantityAndValue
enum:
- 'no'
- quantity
- value
- quantityAndValue
increaseOrDecreaseInventory:
type: string
description: Increases or decreases inventory.
example: increase
enum:
- increase
- decrease
sourceDocument:
type: object
properties:
key:
type: string
description: Source document key.
example: '23'
id:
type: string
description: The source from which the order entry document was created.
example: Beginning Balance-Doc0001
href:
type: string
description: URL for the inventory-document.
readOnly: true
example: /objects/inventory-control/document/23
attachment:
type: object
description: Supporting document for this Inventory transaction
properties:
key:
type: string
example: '23'
id:
type: string
example: Beginning Balance attachment
href:
type: string
description: URL for the inventory-document.
readOnly: true
example: /objects/company-config/attachment/23
printedBy:
type: object
description: The last user who printed this document
properties:
href:
type: string
description: URL for the user
readOnly: true
example: /objects/company-config/user/23
key:
type: string
description: Last printed by
example: '23'
id:
type: string
description: Last printed by
example: John Smith
warehouse:
type: object
properties:
key:
type: string
description: Warehouse Key
example: '23'
id:
type: string
description: Warehouse ID
example: WH-0001
defaultWarehouse:
type: string
description: Default warehouse.
example: DF-WH-0001
href:
type: string
description: Endpoint for the warehouse.
readOnly: true
example: /objects/inventory-control/warehouse/23
href:
type: string
description: URL for the inventory-document.
readOnly: true
example: /objects/inventory-control/document/23
entity:
$ref: '#/components/schemas/entity-ref'
audit:
type: object
allOf:
- $ref: '#/components/schemas/audit'
- type: object
properties:
createdDateTime:
type: string
description: Time of the submission.
format: date-time
example: '2014-01-08T11:28:12Z'
readOnly: true
lines:
type: array
description: Lines of the order entry document.
items:
$ref: '#/components/schemas/inventory-control-document-line'
history:
type: array
description: Lines of the Inventory document history
items:
$ref: '#/components/schemas/inventory-control-document-history'
subtotals:
type: array
description: Lines of the inventory document subtotal.
items:
$ref: '#/components/schemas/inventory-control-document-subtotal'
postingSummary:
type: object
description: Information about the journal entries associated with this document
readOnly: true
properties:
key:
type: string
description: Record number of Inventory Control posting summary
example: '23'
id:
type: string
description: Inventory Control posting summary ID
example: '23'
href:
type: string
description: URL for the Inventory Control posting summary
example: /objects/inventory-control/posting-summary/23
journalEntry:
type: object
description: The journal entries associated with this document
readOnly: true
properties:
key:
type: string
description: Record number of Journal Entry
example: '23'
id:
type: string
description: Journal Entry ID
example: '23'
href:
type: string
description: URL for the Journal Entry
example: /objects/journal-entry/23
inventory-control-item-groupRequiredProperties:
type: object
required:
- id
- name
- groupType
inventory-control-item-group-member:
type: object
description: Member items of an item group
properties:
key:
type: string
description: System-assigned key for the item-group member.
readOnly: true
example: '41'
id:
type: string
description: Unique identifier for the Item group member.
readOnly: true
example: '41'
href:
type: string
description: item group member URL.
readOnly: true
example: /objects/inventory-control/item-group-member/41
itemGroup:
type: object
description: Item group that this item is a member of.
properties:
key:
type: string
description: System-assigned key for the item group.
example: '16'
id:
type: string
description: Unique identifier for the Item group.
example: 1st Level Items
href:
type: string
description: URL for the item group.
readOnly: true
example: /objects/inventory-control/item-group/16
item:
type: object
description: reference of the member item.
properties:
key:
type: string
description: key of the associated Item object.
example: '16'
id:
type: string
description: ID of the associated Item object.
example: C001
name:
type: string
description: Name of the associated Item object.
readOnly: true
example: Printers-HP
status:
title: status
type: string
readOnly: true
description: Item status
enum:
- active
- inactive
example: active
href:
type: string
description: URL of the associated item object.
readOnly: true
example: /objects/inventory-control/item/16
sortOrder:
type: integer
description: Sort Order of the item within the item group.
example: 1
audit:
$ref: '#/components/schemas/audit'
inventory-control-item-group:
type: object
description: >-
An item group categorizes item dimension records, mainly for the purpose
of structuring financial reporting.
properties:
key:
type: string
description: System-assigned key for the item-group.
readOnly: true
example: '23'
id:
type: string
description: Unique identifier for the Item group.
example: 1st Level Items
href:
type: string
description: item group URL.
readOnly: true
example: /objects/inventory-control/item-group/23
name:
type: string
description: Name of the item group.
example: Level 1 Items
description:
type: string
description: Description about the item group.
example: Level 1 Items
groupType:
type: string
description: >-
Group membership type. Set the group type to filter from the whole
set of dimension groups. * `all` - All items that match the
`memberFilter` criteria. If ‘all’ is selected, 'memberFilter' is
required. * `specific` - Specify the items to include and their
order in the `groupMembers` array. If ‘specific’ is selected,
'groupMembers' is required.
example: all
enum:
- all
- specific
sortField:
type: string
description: Item field to sort on.Only applicable when `groupType` = `all`.
example: itemId
default: itemId
enum:
- area
- brand
- catalogReference
- category
- color
- condition
- costMethod
- createdAtEntityId
- dateLastReceived
- dateLastSold
- defaultWarehouse
- density
- durometer
- ean13
- enableStartAndEndDates
- engineeringAlert
- extendedDescription
- glGroup
- height
- innerDiameter
- inventoryCycle
- itemId
- itemTaxGroup
- itemType
- length
- maximumThickness
- minimumThickness
- name
- netWeight
- note
- numberOfPeriods
- outerDiameter
- periodsMeasuredIn
- primaryCountryOfOrigin
- productLineId
- productType
- replenishmentMethod
- shippingWeight
- size1
- size2
- specification1
- specification2
- specification3
- standardCost
- status
- style
- subBrand
- subCategory
- substituteItem
- taxable
- taxCode
- thickness
- uomForArea
- uomForDensity
- uomForDiameter
- uomForLengthWidthAndHeight
- uomForThickness
- uomForVolume
- uomForWeight
- upc
- upc12
- unitOfMeasureGroup
- volume
- webLongDescription
- webName
- webShortDescription
- width
sortOrder:
type: string
description: >-
Sort order for the items that match the `memberFilter`. Only
applicable when `groupType` = `all`.
example: ascending
enum:
- ascending
- descending
default: ascending
maxMatches:
type: integer
description: >-
The maximum number of items to fetch after sorting on the SortField
as per the sort order (ascending or decending). Only applicable when
`groupType` = `all`
example: 100
createDimensionComponents:
type: boolean
description: >-
Set to 'true' to create a dimension structure that enables the group
to be used on the rows and columns of financial reports. If this
field is set to false, the group can only be used for filtering.
default: false
example: true
glAccountGroup:
type: object
description: General ledger (GL) account group associated with the item group.
properties:
key:
type: string
example: '23'
id:
type: string
description: ID for the gl-account-group.
example: 1st Level Items
href:
type: string
description: URL for the gl-account-group.
readOnly: true
example: /objects/inventory-control/gl-account-group/23
memberFilter:
type: array
description: >-
One or more filters to select the items to include in the item
group.
nullable: true
items:
properties:
field:
type: string
description: Item field to filter on.
example: status
enum:
- area
- brand
- catalogReference
- category
- color
- condition
- costMethod
- createdAtEntityId
- dateLastReceived
- dateLastSold
- defaultWarehouse
- density
- durometer
- ean13
- enableStartAndEndDates
- engineeringAlert
- extendedDescription
- glGroup
- height
- innerDiameter
- inventoryCycle
- itemId
- itemTaxGroup
- itemType
- length
- maximumThickness
- minimumThickness
- name
- netWeight
- note
- numberOfPeriods
- outerDiameter
- periodsMeasuredIn
- primaryCountryOfOrigin
- productLineId
- productType
- replenishmentMethod
- shippingWeight
- size1
- size2
- specification1
- specification2
- specification3
- standardCost
- status
- style
- subBrand
- subCategory
- substituteItem
- taxable
- taxCode
- thickness
- uomForArea
- uomForDensity
- uomForDiameter
- uomForLengthWidthAndHeight
- uomForThickness
- uomForVolume
- uomForWeight
- upc
- upc12
- unitOfMeasureGroup
- volume
- webLongDescription
- webName
- webShortDescription
- width
operator:
type: string
description: Operator to filter the group.
enum:
- equals
- doesNotEqual
- isGreaterThan
- isLessThan
- isOneOf
- isNotOneOf
- isEmpty
- isNotEmpty
- contains
- isCurrentUser
example: equals
value:
type: string
description: Value to use to filter the group.
example: active
conditionType:
type: string
description: >-
Whether multiple memberFilter are treated as 'and', 'or', or as a
complex expression.
example: and
enum:
- and
- or
- expression
default: and
expression:
type: string
description: >-
Expression for combining multiple filters. Only applicable if the
'conditionType' is 'expression'.
example: (1 AND 2) OR 3
groupMembers:
type: array
description: The members of the item group.
items:
$ref: '#/components/schemas/inventory-control-item-group-member'
audit:
$ref: '#/components/schemas/audit'
responses:
400error:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/error-response'
securitySchemes:
OAuth2:
description: Sage Intacct OAuth 2.0 authorization code flow
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://api.intacct.com/ia/api/v1-beta2/oauth2/authorize
tokenUrl: https://api.intacct.com/ia/api/v1-beta2/oauth2/token
refreshUrl: https://api.intacct.com/ia/api/v1-beta2/oauth2/token
scopes: {}
parameters:
documentName:
name: documentName
in: path
required: true
schema:
type: string
description: Document Name