InventoryTransfers
This entity describes a transaction where a specified quantity of one InventoryItem entity is transferred from the item’s currently assigned InventoryLocation to another InventoryLocation. It also describes a note added when a user manually updates an inventory item's On Hand quantity. These "audit" notes may or may not be required.
NOTE The InventoryTransfer entity does not describe transactions where an InventoryItem is associated with a Company as an Asset.
NOTE You can refer to the Online Help to find root and child access URLs of the entity you wish to query. Refer to Finding resource and child access URLs of REST API entities for more information.
Entity details
Entity Name: | InventoryTransfers |
Entity Path: |
/atservicesrest/v1.0/InventoryTransfers |
Can Create: | |
Can Update: | |
Can Query: | |
Can Delete: | |
Can Have UDFs: |
Conditions and requirements
In Autotask, Transfer Inventory Items permission is required to create or update an InventoryTransfer.
Special field attributes
Field | Conditions and Requirements |
---|---|
fromLocationID | fromLocationID must = inventoryLocationID of a valid InventoryItem. |
productID | productID must = productID of a valid InventoryItem. |
quantityTransferred |
quantityTransferred must be <= quantityOnHand. quantityTransferred must be > 0. |
serialNumber |
For products that track a serial number:
|
toLocationID |
toLocationID cannot be = to fromLocationID. toLocationID must reference an active Inventory location. |
notes, updateNote | During create, if no value is supplied for these fields, the API will store a value of "Updated using Web Services API." Otherwise, the API will concatenate the values of both fields. |
updateNote |
|
Field definitions
The following table describes the standard Autotask fields for this entity. Refer to the following articles for more information about working with these fields:
- The entityInformation REST API call
- Making basic query calls to the REST API
- Advanced query features of the REST API
To learn how to query picklist endpoints, refer to Understanding picklists.
Notes
- For string datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
- LT indicates Local Term.
- If this entity has child collections, they will appear in a Child collection access URLs or an Entity URLs and relationships drop-down in the Entity details section of this article.
- You can call the /query/count/ endpoint of a resource to determine how many records a collection holds.
Field Name | Datatype | Read-Only | Is Required | Reference Name | Picklist |
---|---|---|---|---|---|
fromLocationID | long | InventoryLocations | |||
id | long | ||||
notes | string (4000) | ||||
productID | long | Products | |||
quantityTransferred | integer | ||||
serialNumber | string (100) | ||||
toLocationID | long | InventoryLocations | |||
transferByResourceID | integer | Resources | |||
transferDate | datetime | ||||
updateNote | string (500) |