Stock Items

Retrieve a single stock item

get/accounting/stockItems/{stockItemId}

Request

  • Base URL: https://api.clearbooks.co.uk/v1
  • URL: https://api.clearbooks.co.uk/v1/accounting/stockItems/{stockItemId}
  • Auth: OAuth 2 (authorization code, authorization URL https://secure.clearbooks.co.uk/account/action/oauth/, token URL https://api.clearbooks.co.uk/oauth/token, scopes: accounting.stock_items:read)

Path parameters

stockItemIdinteger required

ID of stock item

Headers

X-Business-IDinteger

ID of the business to use (required for multi-business authorisations only)

Response

A stock item object

idinteger
namestring
skustring
type'purchases' | 'sales' | 'both'
descriptionstring
salesUnitPricenumber double
salesAccountCodeinteger
salesVatRateKeystring
salesQuantitynumber double
purchaseUnitPricenumber double
purchaseAccountCodeinteger
purchaseVatRateKeystring
purchaseQuantitynumber double
trackStockboolean

Changes

No recorded changes to this operation across all 1 revision of this API.