Unleashed MCP

The exact retained JSON includes schemas, nested fields, notes, source evidence and unresolved questions. It is a documented contract, not a live response.

{
  "id": "list_stock_on_hand",
  "name": "unleashed_list_stock_on_hand",
  "resourceId": "StockOnHand",
  "description": "List a page of Stock On Hand data",
  "method": "GET",
  "path": "/StockOnHand",
  "documentationUrl": "https://apidocs.unleashedsoftware.com/StockOnHand",
  "readOnly": true,
  "destructive": false,
  "idempotent": true,
  "pathParameters": [],
  "queryParameters": [
    {
      "name": "asAtDate",
      "required": false,
      "description": "Returns the Stock on Hand for a specific date.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Returns the Stock on Hand for a specific date."
      },
      "sourceSection": "Available Filters for GET StockOnHand endpoint"
    },
    {
      "name": "isAssembled",
      "required": false,
      "description": "If set to true , the AvailableQty will also include the quantity that can be assembled via any auto-assembly BOMs.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "If set to true , the AvailableQty will also include the quantity that can be assembled via any auto-assembly BOMs."
      },
      "sourceSection": "Available Filters for GET StockOnHand endpoint"
    },
    {
      "name": "modifiedSince",
      "required": false,
      "description": "Returns Stock on Hand created or modified since the specified date. Please note this filter is not available for single product queries.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Returns Stock on Hand created or modified since the specified date. Please note this filter is not available for single product queries."
      },
      "sourceSection": "Available Filters for GET StockOnHand endpoint"
    },
    {
      "name": "orderBy",
      "required": false,
      "description": "Orders the list by a specific column, by default the list is ordered by productCode .",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Orders the list by a specific column, by default the list is ordered by productCode ."
      },
      "sourceSection": "Available Filters for GET StockOnHand endpoint"
    },
    {
      "name": "productId",
      "required": false,
      "description": "Returns products with the specific Product Guid. You can enter multiple product guids separated by commas.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Returns products with the specific Product Guid. You can enter multiple product guids separated by commas."
      },
      "sourceSection": "Available Filters for GET StockOnHand endpoint"
    },
    {
      "name": "warehouseCode",
      "required": false,
      "description": "Returns Stock on Hand for a specific warehouse code.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Returns Stock on Hand for a specific warehouse code."
      },
      "sourceSection": "Available Filters for GET StockOnHand endpoint"
    },
    {
      "name": "warehouseName",
      "required": false,
      "description": "Returns Stock on Hand for a specific warehouse name.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Returns Stock on Hand for a specific warehouse name."
      },
      "sourceSection": "Available Filters for GET StockOnHand endpoint"
    },
    {
      "name": "pageSize",
      "required": false,
      "description": "Number of records per page.",
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 1000
      },
      "sourceSection": "Global Pagination reference"
    }
  ],
  "requestBodySchema": null,
  "responseSchema": null,
  "pagination": {
    "strategy": "path-page",
    "pathTemplate": "/StockOnHand/{page}",
    "pageParameter": "page",
    "pageSizeParameter": "pageSize",
    "firstPage": 1,
    "defaultPageSize": 200,
    "maximumPageSize": 1000,
    "minimumPageSize": 1,
    "responseItemsPath": "Items",
    "responsePaginationPath": "Pagination",
    "documentationUrl": "https://apidocs.unleashedsoftware.com/Pagination",
    "notes": [
      "Prefer Pagination.NumberOfPages when supplied. Older responses without metadata require stopping on a short page."
    ]
  },
  "notes": [],
  "provenance": [
    {
      "sourceUrl": "https://apidocs.unleashedsoftware.com/StockOnHand",
      "sourceSha256": "740c0f53604d882370f3b1c228bd80af81f3e331d4f39f789afbc80c7cd369ec",
      "section": "The full range of URIs and HTTP Verbs supported are",
      "evidence": "GET /StockOnHand",
      "operationDescriptions": [
        "List a page of Stock On Hand data"
      ]
    }
  ],
  "confidence": "documented-route",
  "unresolved": [
    "No authenticated sandbox or production request has verified this operation."
  ],
  "requestFieldTable": null,
  "responseFieldTable": "Available Fields for GET StockOnHand endpoint"
}

{
  "id": "StockOnHand",
  "name": "Stock On Hand",
  "group": "Read only data",
  "documentationUrl": "https://apidocs.unleashedsoftware.com/StockOnHand",
  "snapshot": "snapshots/StockOnHand.html",
  "sourceSha256": "740c0f53604d882370f3b1c228bd80af81f3e331d4f39f789afbc80c7cd369ec",
  "fetchedAt": "2026-10-23T14:00:34.769528+00:00",
  "operationIds": [
    "list_stock_on_hand",
    "get_stock_on_hand",
    "list_stock_on_hand_all_warehouses"
  ],
  "fieldTables": [
    {
      "heading": "GET Stock On Hand",
      "anchor": "get-stock-on-hand",
      "summary": "Available Fields for GET StockOnHand endpoint",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "Notes"
        ],
        [
          "AllocatedQty",
          "Decimal",
          "",
          ""
        ],
        [
          "AvailableQty",
          "Decimal",
          "",
          "Quantity on hand - allocated quantity + quantity that can be assembled based on components"
        ],
        [
          "AvgCost",
          "Decimal",
          "",
          ""
        ],
        [
          "DaysSinceLastSale",
          "Nullable Integer",
          "",
          ""
        ],
        [
          "Guid",
          "Guid",
          "",
          "Unique identifier."
        ],
        [
          "LastModifiedOn",
          "Nullable DateTime",
          "",
          ""
        ],
        [
          "OnPurchase",
          "Decimal",
          "",
          ""
        ],
        [
          "ProductCode",
          "String",
          "100",
          ""
        ],
        [
          "ProductDescription",
          "String",
          "500",
          ""
        ],
        [
          "ProductGroupName",
          "String",
          "450",
          ""
        ],
        [
          "ProductGuid",
          "Guid",
          "",
          ""
        ],
        [
          "ProductSourceId",
          "String",
          "500",
          ""
        ],
        [
          "QtyOnHand",
          "Decimal",
          "",
          ""
        ],
        [
          "TotalCost",
          "Decimal",
          "",
          ""
        ],
        [
          "Warehouse",
          "String",
          "100",
          ""
        ],
        [
          "WarehouseCode",
          "String",
          "15",
          ""
        ],
        [
          "WarehouseId",
          "Guid",
          "",
          ""
        ]
      ]
    }
  ],
  "filterTables": [
    {
      "heading": "GET Stock On Hand",
      "anchor": "get-stock-on-hand",
      "summary": "Available Filters for GET StockOnHand endpoint",
      "rows": [
        [
          "Filter",
          "Description"
        ],
        [
          "asAtDate",
          "Returns the Stock on Hand for a specific date."
        ],
        [
          "isAssembled",
          "If set to true , the AvailableQty will also include the quantity that can be assembled via any auto-assembly BOMs."
        ],
        [
          "modifiedSince",
          "Returns Stock on Hand created or modified since the specified date. Please note this filter is not available for single product queries."
        ],
        [
          "orderBy",
          "Orders the list by a specific column, by default the list is ordered by productCode ."
        ],
        [
          "productId",
          "Returns products with the specific Product Guid. You can enter multiple product guids separated by commas."
        ],
        [
          "warehouseCode",
          "Returns Stock on Hand for a specific warehouse code."
        ],
        [
          "warehouseName",
          "Returns Stock on Hand for a specific warehouse name."
        ]
      ]
    }
  ],
  "documentationNotes": [
    "The StockOnHand resource allows stock on hand to be listed, or viewed. An individual product’s StockOnHand details can be viewed by appending its identifier (a GUID formatted as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX ) to the URI.",
    "Note: Products without any transactions will not be returned (i.e; zero quantity products with no previous transactions)."
  ]
}