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": "get_batch_numbers",
  "name": "unleashed_get_batch_numbers",
  "resourceId": "BatchNumbers",
  "description": "View a Batch Number with the specified Guid",
  "method": "GET",
  "path": "/BatchNumbers/{batchNumberGuid}",
  "documentationUrl": "https://apidocs.unleashedsoftware.com/BatchNumbers",
  "readOnly": true,
  "destructive": false,
  "idempotent": true,
  "pathParameters": [
    {
      "name": "batchNumberGuid",
      "required": true,
      "schema": {
        "type": "string",
        "minLength": 1
      },
      "description": "Provider identifier from the corresponding resource; preserve the documented identifier type."
    }
  ],
  "queryParameters": [
    {
      "name": "available",
      "required": false,
      "description": "If set to false, returns all batch numbers. Default value is true and returns only the available batch numbers.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "If set to false, returns all batch numbers. Default value is true and returns only the available batch numbers."
      },
      "sourceSection": "Available Filters for GET BatchNumbers"
    },
    {
      "name": "batchNumber",
      "required": false,
      "description": "Returns a list of batch numbers containing this string.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Returns a list of batch numbers containing this string."
      },
      "sourceSection": "Available Filters for GET BatchNumbers"
    },
    {
      "name": "endDate",
      "required": false,
      "description": "Returns batch numbers created before a specified date.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Returns batch numbers created before a specified date."
      },
      "sourceSection": "Available Filters for GET BatchNumbers"
    },
    {
      "name": "expiryFrom",
      "required": false,
      "description": "Returns batch numbers expired after a specified date.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Returns batch numbers expired after a specified date."
      },
      "sourceSection": "Available Filters for GET BatchNumbers"
    },
    {
      "name": "expiryTo",
      "required": false,
      "description": "Returns batch numbers expired before a specified date.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Returns batch numbers expired before a specified date."
      },
      "sourceSection": "Available Filters for GET BatchNumbers"
    },
    {
      "name": "modifiedSince",
      "required": false,
      "description": "Returns batch numbers created or edited after a specified date. For example: modifiedSince=2016-07-01, modifiedSince=2016-07-01T19:54:18.060.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Returns batch numbers created or edited after a specified date. For example: modifiedSince=2016-07-01, modifiedSince=2016-07-01T19:54:18.060."
      },
      "sourceSection": "Available Filters for GET BatchNumbers"
    },
    {
      "name": "pageSize",
      "required": false,
      "description": "Specifies the page size for pagination. Default page size is 200 batch numbers. Note: Requesting large numbers of batch numbers can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests.",
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 1000,
        "description": "Specifies the page size for pagination. Default page size is 200 batch numbers. Note: Requesting large numbers of batch numbers can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests."
      },
      "sourceSection": "Available Filters for GET BatchNumbers"
    },
    {
      "name": "ProductCode",
      "required": false,
      "description": "Returns batch numbers attached to the product code.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Returns batch numbers attached to the product code."
      },
      "sourceSection": "Available Filters for GET BatchNumbers"
    },
    {
      "name": "startDate",
      "required": false,
      "description": "Returns batch numbers created after a specified date.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Returns batch numbers created after a specified date."
      },
      "sourceSection": "Available Filters for GET BatchNumbers"
    },
    {
      "name": "WarehouseCode",
      "required": false,
      "description": "Returns batch numbers attached to the warehouse.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Returns batch numbers attached to the warehouse."
      },
      "sourceSection": "Available Filters for GET BatchNumbers"
    }
  ],
  "requestBodySchema": null,
  "responseSchema": null,
  "pagination": null,
  "notes": [],
  "provenance": [
    {
      "sourceUrl": "https://apidocs.unleashedsoftware.com/BatchNumbers",
      "sourceSha256": "1eb681e7efd19d4945a252adaedc7b1fbfab3cbd6066ea79f0a7e48575a53fac",
      "section": "The full range of URIs and HTTP Verbs supported are",
      "evidence": "GET /BatchNumbers/{batchNumberGuid}",
      "operationDescriptions": [
        "View a Batch Number with the specified Guid"
      ]
    }
  ],
  "confidence": "documented-route",
  "unresolved": [
    "No authenticated sandbox or production request has verified this operation."
  ],
  "requestFieldTable": null,
  "responseFieldTable": "Available Fields for GET BatchNumbers"
}

{
  "id": "BatchNumbers",
  "name": "Batch Numbers",
  "group": "Read only data",
  "documentationUrl": "https://apidocs.unleashedsoftware.com/BatchNumbers",
  "snapshot": "snapshots/BatchNumbers.html",
  "sourceSha256": "1eb681e7efd19d4945a252adaedc7b1fbfab3cbd6066ea79f0a7e48575a53fac",
  "fetchedAt": "2026-10-23T14:00:30.406373+00:00",
  "operationIds": [
    "list_batch_numbers",
    "get_batch_numbers"
  ],
  "fieldTables": [
    {
      "heading": "GET BatchNumbers",
      "anchor": "get-batchnumbers",
      "summary": "Available Fields for GET BatchNumbers",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "BatchNumber",
          "String",
          "50"
        ],
        [
          "CreatedBy",
          "String",
          "50"
        ],
        [
          "CreatedOn",
          "Date",
          ""
        ],
        [
          "ExpiryDate",
          "Date",
          ""
        ],
        [
          "Guid",
          "Guid",
          ""
        ],
        [
          "LastModifiedBy",
          "String",
          "50"
        ],
        [
          "LastModifiedOn",
          "Date",
          ""
        ],
        [
          "OriginalQty",
          "Decimal",
          ""
        ],
        [
          "ProductCode",
          "String",
          "100"
        ],
        [
          "Quantity",
          "Decimal",
          ""
        ],
        [
          "Status",
          "String",
          "20"
        ],
        [
          "WarehouseCode",
          "String",
          "15"
        ]
      ]
    }
  ],
  "filterTables": [
    {
      "heading": "GET BatchNumbers",
      "anchor": "get-batchnumbers",
      "summary": "Available Filters for GET BatchNumbers",
      "rows": [
        [
          "Filter",
          "Description"
        ],
        [
          "available",
          "If set to false, returns all batch numbers. Default value is true and returns only the available batch numbers."
        ],
        [
          "batchNumber",
          "Returns a list of batch numbers containing this string."
        ],
        [
          "endDate",
          "Returns batch numbers created before a specified date."
        ],
        [
          "expiryFrom",
          "Returns batch numbers expired after a specified date."
        ],
        [
          "expiryTo",
          "Returns batch numbers expired before a specified date."
        ],
        [
          "modifiedSince",
          "Returns batch numbers created or edited after a specified date. For example: modifiedSince=2016-07-01, modifiedSince=2016-07-01T19:54:18.060."
        ],
        [
          "pageSize",
          "Specifies the page size for pagination. Default page size is 200 batch numbers. Note: Requesting large numbers of batch numbers can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests."
        ],
        [
          "ProductCode",
          "Returns batch numbers attached to the product code."
        ],
        [
          "startDate",
          "Returns batch numbers created after a specified date."
        ],
        [
          "WarehouseCode",
          "Returns batch numbers attached to the warehouse."
        ]
      ]
    }
  ],
  "documentationNotes": [
    "The BatchNumbers resource allows you to manage batch numbers on sales orders and sales shipments. An individual batch number details can be viewed by appending its identifier (a GUID formatted as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX ) to the URI."
  ]
}