Items & Inventory Endpoints (cont.)

Items & Inventory (continued)

ItemStock (continued)

POST /ItemStock — Create/Update Item Stock

Request body: array of ItemStock objects.

GET /ItemStock/{id} — Get One Item Stock Record

Returns a single ItemStock record. Requires authentication.

Parameter	Type	Description
id	integer (path, required)	ItemStock ID
includedetails	boolean	Include extra objects in the response

DELETE /ItemStock/{id} — Delete Item Stock Record

Parameter	Type	Description
id	integer (path, required)	ItemStock ID

ItemStock schema:

Field	Type	Description
id	integer	Unique stock record ID
item_id	integer	Item ID
item_name	string	Item name
item_assettype_id	integer	Asset type of the item
stocklocation_id	integer	Stock location ID
stocklocation_name	string	Stock location name
stockbin_id	integer	Stock bin ID
stockbin_name	string	Stock bin name
date	date-time	Date of the stock transaction
quantity_in	double	Quantity received/added
quantity_issued	double	Quantity issued/consumed (read-only)
quantity_remaining	double	Current quantity remaining
cost	double	Unit cost of this stock
supplier_id	integer	Supplier ID
supplier_name	string	Supplier name
purchaseorder_id	integer	Linked purchase order ID
purchaseorder_line_id	integer	Linked purchase order line ID
purchaseorder_ref	string	Purchase order reference
salesorder_id	integer	Linked sales order ID
ticket_id	integer	Linked ticket ID
serialised_asset_count	integer	Number of serialised assets in this stock batch
serialised_assets_in_stock	integer	Number of serialised assets currently in stock
serialised_assets	array	Serialised asset device records
is_stock_take	boolean	Whether this is a stock take record
delivering_to_user	boolean	Whether stock is being delivered to a user
dont_track_stock	boolean	Whether to skip stock tracking
note	string	Stock record note

---

ItemStockHistory

Historical log of stock movements.

GET /ItemStockHistory — List Stock History

Returns multiple ItemStockHistory records. Requires authentication.

Parameter	Type	Description
count	integer	Number of records to return
idonly	boolean	Return IDs only
item_id	integer	Filter by item ID
itemstock_id	integer	Filter by item stock record ID
order–order5	string	Order fields
orderdesc–orderdesc5	boolean	Descending order flags
page_no	integer	Page number for pagination
page_size	integer	Page size for pagination
pageinate	boolean	Whether to use pagination
search	string	Filter by search string
stockbin_id	integer	Filter by stock bin ID
stocklocation_id	integer	Filter by stock location ID

GET /ItemStockHistory/{id} — Get One Stock History Record

Parameter	Type	Description
id	integer (path, required)	ItemStockHistory ID

---

ItemSupplier

Supplier-specific pricing records for items.

GET /itemsupplier — List Item Suppliers

Returns all ItemSupplier records.

POST /itemsupplier — Create/Update Item Suppliers

Request body: array of ItemSupplier objects.

GET /itemsupplier/{id} — Get One Item Supplier

Returns a single ItemSupplier record. Requires authentication.

Parameter	Type	Description
id	integer (path, required)	ItemSupplier ID
includedetails	boolean	Include extra objects in the response

DELETE /itemsupplier/{id} — Delete Item Supplier

Parameter	Type	Description
id	integer (path, required)	ItemSupplier ID

ItemSupplier schema:

Field	Type	Description
id	integer	Unique ID
guid	uuid	Unique GUID
item_id	integer	Item ID
supplier_id	integer	Supplier ID
supplier_name	string	Supplier name
price	double	Supplier-specific selling price
cost	double	Supplier-specific cost price
client_id	integer	Client-specific pricing client ID
client_name	string	Client name
supplier_sku	string	Supplier's SKU/part number
currency_id	integer	Currency ID for this supplier pricing
currency_name	string	Currency name
note	string	Notes

---

StockBin

Physical storage bin locations within a stock location.

GET /StockBin — List Stock Bins

Returns all StockBin records.

POST /StockBin — Create/Update Stock Bins

Request body: array of StockBin objects.

GET /StockBin/{id} — Get One Stock Bin

Parameter	Type	Description
id	integer (path, required)	StockBin ID

DELETE /StockBin/{id} — Delete Stock Bin

Parameter	Type	Description
id	integer (path, required)	StockBin ID

StockBin schema:

Field	Type	Description
id	integer	Unique bin ID
name	string	Bin name
site_id	integer	Site/location ID this bin belongs to
parent_id	integer	Parent bin ID (for nested bins)
parent_name	string	Parent bin name
sequence	integer	Display order sequence
dont_add_to_order	boolean	Whether to exclude this bin from order suggestions

---

StockTrace

Traceability records for serialised stock movements.

GET /StockTrace — List Stock Traces

Returns all StockTrace records.

GET /StockTrace/{id} — Get One Stock Trace

Parameter	Type	Description
id	integer (path, required)	StockTrace ID

---

PartsLookup

Database lookup configurations for automatically populating item/parts data from external databases.

GET /DatabaseLookup — List Parts Lookups

Returns multiple PartsLookup records. Requires authentication.

Parameter	Type	Description
type	integer	Filter by lookup type

POST /DatabaseLookup — Create/Update Parts Lookups

Request body: array of PartsLookup objects.

GET /DatabaseLookup/{id} — Get One Parts Lookup

Returns a single PartsLookup record. Requires authentication.

Parameter	Type	Description
id	integer (path, required)	PartsLookup ID
includedetails	boolean	Include extra objects in the response
lookup_value	object	Value to use when running the lookup

DELETE /DatabaseLookup/{id} — Delete Parts Lookup

Parameter	Type	Description
id	integer (path, required)	PartsLookup ID

POST /DatabaseLookup/run — Run Parts Lookup

Executes a parts lookup against the configured external database. Request body: array of PartsLookup objects.

PartsLookup schema:

Field	Type	Description
id	integer	Unique lookup ID
guid	uuid	Unique GUID
name	string	Lookup name
use	integer	Lookup use type
active	boolean	Whether this lookup is active
field_id	integer	Field ID to populate from lookup result
field_name	string	Field name to populate
table_id	integer	Source table ID
table_name	string	Source table name
sql_server	string	SQL server hostname
sql_database	string	SQL database name
sql_user	string	SQL username
sql_script	string	SQL query script
key_field	string	Key field in the lookup result
lookup_field	string	Field to match on
lookup_value	string	Value to look up
allowmultipleresults	boolean	Whether to allow multiple results
lookuponrefresh	boolean	Whether to re-run on form refresh
matchedhint	string	Message shown when a match is found
notmatchedhint	string	Message shown when no match is found
showmessagetouseroragent	integer	Who to show the result message to
messagerequiresconfirmationuser	boolean	Whether user must confirm the message
messagerequiresconfirmationagent	boolean	Whether agent must confirm the message
fields	array	PartsLookupField definitions
field_mappings	array	PartsLookupMapping definitions
agent_mappings	array	TechPartsLookup agent-specific mappings
rules	array	Autoassign rules
lookup_type	integer	Lookup type
lookup_type_name	string	Lookup type name
client_id	integer	Associated client ID
ticket_id	integer	Associated ticket ID
asset_id	integer	Associated asset ID
trigger_type	integer	Trigger type for auto-running the lookup
integration_method_id	integer	Integration method ID
integration_method_name	string	Integration method name

---

PartsLookupConfirmation

Records user/agent confirmations on parts lookup results.

GET /DatabaseLookupConfirmation/{id} — Get One Lookup Confirmation

Parameter	Type	Description
id	integer (path, required)	PartsLookupConfirmation ID

POST /DatabaseLookupConfirmation — Create/Update Lookup Confirmations

Request body: array of PartsLookupConfirmation objects.

PartsLookupConfirmation schema:

Field	Type	Description
id	integer	Unique confirmation ID
database_lookup_id	integer	The PartsLookup this confirmation belongs to
ticket_id	integer	Associated ticket ID
form_id	string	Form ID where the confirmation was presented
value	integer	Confirmation value (accepted/rejected)
lookup_values	string	The lookup values that were confirmed

---