Unleashed MCP

An Unleashed MCP connector for stock, products, sales orders and purchasing. Explore the coverage and join the access waitlist.

Inventory and orders

What is Unleashed MCP?

MCP XYZ is building an independent Unleashed MCP connector so an AI assistant can work with authorised inventory and order records through the Model Context Protocol. The connector covers documented Unleashed API operations; new access is by invitation from the waitlist, and live business workflows still need validation.

Use the catalogue to check the operations and fields your work needs. If an existing connector is missing a useful action, tell us about it when joining the waitlist. Your software’s permissions and API limits still apply.

Unleashed workflows to explore

Check stock and warehouse records

Explore documented product, stock-on-hand and warehouse operations for questions about inventory across your business.

Inspect documented operations →

Find sales orders and line items

Inspect sales-order and customer operations, including the products, quantities and prices retained in their documented fields.

Inspect documented operations →

Work with purchasing and supplier records

Review the purchase-order, receipt and supplier coverage before planning an authorised purchasing workflow.

Inspect documented operations →

Example request to try after setup and validation

“Show stock on hand by warehouse for this product.”

Getting access to Unleashed MCP

New access starts with the Unleashed waitlist. Tell us which assistant you use and the work you want to do. We’ll contact you about relevant access updates; joining does not create an account or guarantee an invitation date.

Once invited, sign in to MCP XYZ, choose your workspace and add the API ID and key for your authorised Unleashed account. Run the connection check, then add its MCP URL to your assistant. Saved credentials alone do not verify a connection.

Unleashed API documentation ↗

Start with read-only access while you explore. Jiffi can handle setup with you. Live business workflows still need validation against an authorised account.

In Claude Desktop or web, open Settings → Connectors → Add custom connector, enter your connection’s MCP URL, then connect and choose access in MCP XYZ.

Join the Unleashed waitlist Existing user? Log in →

Unleashed MCP questions

What is the Unleashed MCP from MCP XYZ?

It is an independent connector being built by Jiffi to expose documented Unleashed API operations through the Model Context Protocol. It is intended to let an authorised AI assistant request inventory, customer, supplier and order information from your Unleashed account.

Can I use Unleashed MCP with Claude or ChatGPT?

MCP XYZ connection and tool-discovery flows have been tested with Claude Desktop and web, Codex and Claude Code. Those checks did not verify live Unleashed business requests. ChatGPT acceptance has not yet been verified. Tell us which assistant you use when joining the waitlist.

What Unleashed access will I need?

After an access invitation, setup requires an authorised Unleashed account with API access, its API ID and API key, and an MCP XYZ workspace. Your account permissions and the provider’s API limits still apply. Never put API keys into the waitlist form.

Can this connector update orders or inventory?

The documented catalogue includes reads and writes. A documented write does not establish a tested business workflow. Changes require the relevant permissions and validation in an authorised scope; ambiguous mutating requests are not automatically retried.

How do I get access, and what does it cost?

Join the Unleashed waitlist and describe the job you want to do. We will contact you about access; joining does not create an account or guarantee a launch date. MCP access is included for clients under contract with Jiffi. Standalone access and any applicable terms are discussed before activation.

Read the AI client guide → How access and permissions work →

Documented coverage

Operations and fields

View a Product with the specified Guid

/Products/{productGuid}Inspect fields and contract →

Documented contract, live behaviour unverified

Create Credit Note Lines against an existing free entry Credit Note

unleashed_create_credit_notes_lines

POST/CreditNotes/{creditNoteGuid}/Lines

Read the provider documentation ↗

Provider notes and connector behaviour

Do not automatically replay after an ambiguous transport failure. The documentation does not establish an idempotency-key contract for this operation.

Unresolved behaviour

No authenticated sandbox or production request has verified this operation.

Path parameters

Parameter	Required	Provider description
`creditNoteGuid`	Yes	Provider identifier from the corresponding resource; preserve the documented identifier type.

Retained Credit Notes field and filter tables

These source tables cover the resource’s documented methods. Read each table’s heading for its request or response context.

Available Fields for GET Credit Notes

GET Credit Notes

Property	Type	Length
BCSubTotal	Decimal
BCTotal	Decimal
Comments	String	2048
CreatedBy	String	50
CreatedOn	DateTime
CreditDate	Nullable DateTime
CreditLines	CreditLine collection
CreditNumber	String	20
CreditType	String	20
Customer	Customer
Currency	Currency
Guid	Guid
InvoiceNumber	String	20
LastModifiedBy	String	50
LastModifiedOn	Nullable DateTime
RequiredDeliveryDate	Nullable DateTime
Reference	String	500
SalesInvoiceDate	Nullable DateTime
SalesOrder	SalesOrder
Status	String	20
SubTotal	Decimal
Tax	Tax
TaxRate	Nullable Decimal
TaxTotal	Decimal
Total	Decimal
Warehouse	Warehouse

Available Fields for Currency

GET Credit Notes

Property	Type	Length
CurrencyCode	String	3
DefaultBuyRate	Nullable Decimal
DefaultSellRate	Nullable Decimal
Description	String	200
Guid	Guid
LastModifiedOn	DateTime

Available Fields for Customer

GET Credit Notes

Property	Type	Length
CustomerCode	String	500
CustomerName	String	500
Guid	Guid
LastModifiedOn	DateTime

Available Fields for Sales Orders

GET Credit Notes

Property	Type	Length
Guid	Guid
OrderNumber	String	20

Available Fields for Tax

GET Credit Notes

Property	Type	Length
CanApplyToExpenses	Boolean
CanApplyToRevenue	Boolean
Description	String	50
Guid	Guid
LastModifiedOn	DateTime
Obsolete	Boolean
TaxCode	String	25
TaxRate	Decimal

Available Fields for Warehouse

GET Credit Notes

Property	Type	Length
AddressLine1	String	500
AddressLine2	String	50
City	String	500
Comments	String	2048
ContactName	String	50
Country	String	500
DDINumber	String	25
ExchangeRate	Nullable Decimal
FaxNumber	String	25
Guid	Guid
IsDefault	Boolean
LastModifiedOn	DateTime
MobileNumber	String	25
Obsolete	Boolean
PhoneNumber	String	25
PostCode	String	500
Region	String	500
StreetNo	String	500
WarehouseCode	String	15
WarehouseName	String	100

Available Fields for Credit Lines

GET Credit Notes

Property	Type	Length
AverageLandedPriceAtTimeOfSale	Nullable Decimal
BatchNumbers	BatchNumber Collection
BCLineTax	Nullable Decimal
BCLineTotal	Decimal
Comments	String	1024
CostOfGoodsAccount	String	500
CreditPrice	Decimal
CreditQuantity	Decimal
Disassemble	Boolean
LineNumber	Integer
LastModifiedOn	DateTime
LineTax	Nullable Decimal
LineTaxCode	String	50
LineTotal	Decimal
LineType	String
OrderQuantity	Decimal
PendingBatchNumbers	PendingBatchNumber Collection
PendingSerialNumbers	PendingSerialNumber Collection
Product	Product
Reason	String	100
ReturnToStock	Boolean
SerialNumbers	SerialNumber Collection
TaxRate	Decimal
XeroSalesAccount	String	50
XeroTaxCode	String	50

Available Fields for Batch Number

GET Credit Notes

Property	Type	Length
ExpiryDate	Nullable DateTime
Guid	Guid
LastModifiedOn	DateTime
Number	String	50
Quantity	Decimal

Available Fields for Pending Batch Number

GET Credit Notes

Property	Type	Length
CreatedOn	DateTime
ExpiryDate	Nullable DateTime
Number	String	50
Quantity	Decimal

Available Fields for Pending Serial Numbers

GET Credit Notes

Property	Type	Length
CreatedOn	DateTime
Identifier	String	50

Available Fields for Product

GET Credit Notes

Property	Type	Length
Guid	Guid
ProductCode	String	100
ProductDescription	String	500

Available Fields for Serial Numbers

GET Credit Notes

Property	Type	Length
Guid	Guid
Identifier	String	50
LastModifiedOn	DateTime

Available Fields for POST/PUT Credit Notes

POST/PUT Credit Notes

Property	Type	Length	POST	PUT
Comments	String	1024
CreditDate	DateTime		Required	Required
CreditLines	CreditLine collection
Customer	Customer		Required	N/A
ExchangeRate	Decimal		Required	Required
Reference	String	500
Warehouse	Warehouse		Required	Required

Available Fields for Customer

POST/PUT Credit Notes

Property	Type	Length	POST	PUT
CustomerCode	String	500	Optional	N/A
Guid	Guid	15	Optional	N/A

Available Fields for Warehouse

POST/PUT Credit Notes

Property	Type	Length	POST	PUT
Guid	Guid		Optional	N/A
WarehouseCode	String	15	Optional	N/A

Available Fields for Credit Lines

POST/PUT Credit Notes

Property	Type	Length	POST	PUT
BatchNumbers	BatchNumber Collection
Comments	String	1024
CreditPrice	Decimal		Required	Required
CreditQuantity	Decimal		Required	Required
Guid	Guid		N/A	Required
Product	Product		Required	N/A
Reason	String		Required	Required
Return	Boolean		Required	Required
SerialNumbers	SerialNumber Collection

Available Fields for Batch Number

POST/PUT Credit Notes

Property	Type	Length	POST	PUT
BatchNumber (XML) / Number (JSON)	String	50	Required	Required
ExpiryDate	Nullable DateTime
Quantity	Decimal		Required	Required

Available Fields for Product

POST/PUT Credit Notes

Property	Type	Length	POST	PUT
Guid	Guid		Optional	N/A
ProductCode	String	100	Optional	N/A

Available Fields for Serial Number

POST/PUT Credit Notes

Property	Type	Length	POST	PUT
SerialNumber (XML) / Identifier (JSON)	String	50	Required	Required

Available Fields for POST/PUT Credit Lines

Examples for Request PUT /CreditNotes/{CreditNoteGuid}

Property	Type	Length	POST	PUT
Comments	String	1024
BatchNumbers	BatchNumber Collection
CreditPrice	Decimal		Required	Required
CreditQuantity	Decimal		Required	Required
Guid	Guid		N/A	Required
Product	Product		Required	N/A
Reason	String		Required	Required
Return	Boolean		Required	Required
SerialNumbers	SerialNumber Collection

Available Fields for Batch Number

Examples for Request PUT /CreditNotes/{CreditNoteGuid}

Property	Type	Length	POST	PUT
BatchNumber (XML) / Number (JSON)	String	50	Required	Required
ExpiryDate	Nullable DateTime
Quantity	Decimal		Required	Required

Available Fields for Product

Examples for Request PUT /CreditNotes/{CreditNoteGuid}

Property	Type	Length	POST	PUT
Guid	Guid		Optional	N/A
ProductCode	String	100	Optional	N/A

Available Fields for Serial Number

Examples for Request PUT /CreditNotes/{CreditNoteGuid}

Property	Type	Length	POST	PUT
SerialNumber (XML) / Identifier (JSON)	String	50	Required	Required

Available Filters for GET Credit Notes

GET Credit Notes

Filter	Description
creditNumber	Returns a single credit note with the specified credit number. If specified, it overrides all other filters.
creditStatus	Returns credits for the specified status.
endDate	Returns credits created before a specified date.
modifiedSince	Returns credits created or edited after a specified date.
pageSize	Specifies the page size for pagination. Default page size is 200 credits. Note: Requesting large numbers of contacts can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests.
startDate	Returns credits created after a specified date.

Inspect the complete operation contract

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

{
  "id": "create_credit_notes_lines",
  "name": "unleashed_create_credit_notes_lines",
  "resourceId": "CreditNotes",
  "description": "Create Credit Note Lines against an existing free entry Credit Note",
  "method": "POST",
  "path": "/CreditNotes/{creditNoteGuid}/Lines",
  "documentationUrl": "https://apidocs.unleashedsoftware.com/CreditNotes",
  "readOnly": false,
  "destructive": true,
  "idempotent": false,
  "pathParameters": [
    {
      "name": "creditNoteGuid",
      "required": true,
      "schema": {
        "type": "string",
        "minLength": 1
      },
      "description": "Provider identifier from the corresponding resource; preserve the documented identifier type."
    }
  ],
  "queryParameters": [],
  "requestBodySchema": {
    "type": "object",
    "properties": {
      "Comments": {
        "description": "String",
        "type": "string",
        "maxLength": 1024
      },
      "BatchNumbers": {
        "description": "BatchNumber Collection",
        "x-unleashed-type": "BatchNumber Collection"
      },
      "CreditPrice": {
        "description": "Decimal; POST: Required; PUT: Required",
        "type": "number",
        "x-documentation-requirements": {
          "POST": "Required",
          "PUT": "Required"
        }
      },
      "CreditQuantity": {
        "description": "Decimal; POST: Required; PUT: Required",
        "type": "number",
        "x-documentation-requirements": {
          "POST": "Required",
          "PUT": "Required"
        }
      },
      "Guid": {
        "description": "Guid; POST: N/A; PUT: Required",
        "type": "string",
        "x-documentation-requirements": {
          "POST": "N/A",
          "PUT": "Required"
        }
      },
      "Product": {
        "description": "Product; POST: Required; PUT: N/A",
        "x-unleashed-type": "Product",
        "x-documentation-requirements": {
          "POST": "Required",
          "PUT": "N/A"
        }
      },
      "Reason": {
        "description": "String; POST: Required; PUT: Required",
        "type": "string",
        "x-documentation-requirements": {
          "POST": "Required",
          "PUT": "Required"
        }
      },
      "Return": {
        "description": "Boolean; POST: Required; PUT: Required",
        "type": "boolean",
        "x-documentation-requirements": {
          "POST": "Required",
          "PUT": "Required"
        }
      },
      "SerialNumbers": {
        "description": "SerialNumber Collection",
        "x-unleashed-type": "SerialNumber Collection"
      }
    },
    "additionalProperties": true,
    "description": "Payload fields from Available Fields for POST/PUT Credit Lines. Nested types and conditional requirements are detailed in the resource documentation. All documented fields remain passable.",
    "x-schema-status": "documentation-derived; complex types and conditional rules require connector validation"
  },
  "responseSchema": null,
  "pagination": null,
  "notes": [
    "Do not automatically replay after an ambiguous transport failure. The documentation does not establish an idempotency-key contract for this operation."
  ],
  "provenance": [
    {
      "sourceUrl": "https://apidocs.unleashedsoftware.com/CreditNotes",
      "sourceSha256": "f5b734efab1552ebd1f250311651849930883b84ea672929361229a20d25d99d",
      "section": "The full range of URIs and HTTP Verbs supported are",
      "evidence": "POST /CreditNotes/{creditNoteGuid}/Lines",
      "operationDescriptions": [
        "Create Credit Note Lines against an existing free entry Credit Note"
      ]
    }
  ],
  "confidence": "documented-route",
  "unresolved": [
    "No authenticated sandbox or production request has verified this operation."
  ],
  "requestFieldTable": "Available Fields for POST/PUT Credit Lines",
  "responseFieldTable": null
}

Inspect the complete resource record

{
  "id": "CreditNotes",
  "name": "Credit Notes",
  "group": "Editable resources",
  "documentationUrl": "https://apidocs.unleashedsoftware.com/CreditNotes",
  "snapshot": "snapshots/CreditNotes.html",
  "sourceSha256": "f5b734efab1552ebd1f250311651849930883b84ea672929361229a20d25d99d",
  "fetchedAt": "2026-10-23T14:00:31.228629+00:00",
  "operationIds": [
    "list_credit_notes",
    "get_credit_notes",
    "create_credit_notes_free_credit",
    "update_credit_notes",
    "delete_credit_notes",
    "complete_credit_notes",
    "create_credit_notes_lines",
    "update_credit_notes_lines",
    "delete_credit_notes_lines"
  ],
  "fieldTables": [
    {
      "heading": "GET Credit Notes",
      "anchor": "get-credit-notes",
      "summary": "Available Fields for GET Credit Notes",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "BCSubTotal",
          "Decimal",
          ""
        ],
        [
          "BCTotal",
          "Decimal",
          ""
        ],
        [
          "Comments",
          "String",
          "2048"
        ],
        [
          "CreatedBy",
          "String",
          "50"
        ],
        [
          "CreatedOn",
          "DateTime",
          ""
        ],
        [
          "CreditDate",
          "Nullable DateTime",
          ""
        ],
        [
          "CreditLines",
          "CreditLine collection",
          ""
        ],
        [
          "CreditNumber",
          "String",
          "20"
        ],
        [
          "CreditType",
          "String",
          "20"
        ],
        [
          "Customer",
          "Customer",
          ""
        ],
        [
          "Currency",
          "Currency",
          ""
        ],
        [
          "Guid",
          "Guid",
          ""
        ],
        [
          "InvoiceNumber",
          "String",
          "20"
        ],
        [
          "LastModifiedBy",
          "String",
          "50"
        ],
        [
          "LastModifiedOn",
          "Nullable DateTime",
          ""
        ],
        [
          "RequiredDeliveryDate",
          "Nullable DateTime",
          ""
        ],
        [
          "Reference",
          "String",
          "500"
        ],
        [
          "SalesInvoiceDate",
          "Nullable DateTime",
          ""
        ],
        [
          "SalesOrder",
          "SalesOrder",
          ""
        ],
        [
          "Status",
          "String",
          "20"
        ],
        [
          "SubTotal",
          "Decimal",
          ""
        ],
        [
          "Tax",
          "Tax",
          ""
        ],
        [
          "TaxRate",
          "Nullable Decimal",
          ""
        ],
        [
          "TaxTotal",
          "Decimal",
          ""
        ],
        [
          "Total",
          "Decimal",
          ""
        ],
        [
          "Warehouse",
          "Warehouse",
          ""
        ]
      ]
    },
    {
      "heading": "GET Credit Notes",
      "anchor": "get-credit-notes",
      "summary": "Available Fields for Currency",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "CurrencyCode",
          "String",
          "3"
        ],
        [
          "DefaultBuyRate",
          "Nullable Decimal",
          ""
        ],
        [
          "DefaultSellRate",
          "Nullable Decimal",
          ""
        ],
        [
          "Description",
          "String",
          "200"
        ],
        [
          "Guid",
          "Guid",
          ""
        ],
        [
          "LastModifiedOn",
          "DateTime",
          ""
        ]
      ]
    },
    {
      "heading": "GET Credit Notes",
      "anchor": "get-credit-notes",
      "summary": "Available Fields for Customer",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "CustomerCode",
          "String",
          "500"
        ],
        [
          "CustomerName",
          "String",
          "500"
        ],
        [
          "Guid",
          "Guid",
          ""
        ],
        [
          "LastModifiedOn",
          "DateTime",
          ""
        ]
      ]
    },
    {
      "heading": "GET Credit Notes",
      "anchor": "get-credit-notes",
      "summary": "Available Fields for Sales Orders",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "Guid",
          "Guid",
          ""
        ],
        [
          "OrderNumber",
          "String",
          "20"
        ]
      ]
    },
    {
      "heading": "GET Credit Notes",
      "anchor": "get-credit-notes",
      "summary": "Available Fields for Tax",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "CanApplyToExpenses",
          "Boolean",
          ""
        ],
        [
          "CanApplyToRevenue",
          "Boolean",
          ""
        ],
        [
          "Description",
          "String",
          "50"
        ],
        [
          "Guid",
          "Guid",
          ""
        ],
        [
          "LastModifiedOn",
          "DateTime",
          ""
        ],
        [
          "Obsolete",
          "Boolean",
          ""
        ],
        [
          "TaxCode",
          "String",
          "25"
        ],
        [
          "TaxRate",
          "Decimal",
          ""
        ]
      ]
    },
    {
      "heading": "GET Credit Notes",
      "anchor": "get-credit-notes",
      "summary": "Available Fields for Warehouse",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "AddressLine1",
          "String",
          "500"
        ],
        [
          "AddressLine2",
          "String",
          "50"
        ],
        [
          "City",
          "String",
          "500"
        ],
        [
          "Comments",
          "String",
          "2048"
        ],
        [
          "ContactName",
          "String",
          "50"
        ],
        [
          "Country",
          "String",
          "500"
        ],
        [
          "DDINumber",
          "String",
          "25"
        ],
        [
          "ExchangeRate",
          "Nullable Decimal",
          ""
        ],
        [
          "FaxNumber",
          "String",
          "25"
        ],
        [
          "Guid",
          "Guid",
          ""
        ],
        [
          "IsDefault",
          "Boolean",
          ""
        ],
        [
          "LastModifiedOn",
          "DateTime",
          ""
        ],
        [
          "MobileNumber",
          "String",
          "25"
        ],
        [
          "Obsolete",
          "Boolean",
          ""
        ],
        [
          "PhoneNumber",
          "String",
          "25"
        ],
        [
          "PostCode",
          "String",
          "500"
        ],
        [
          "Region",
          "String",
          "500"
        ],
        [
          "StreetNo",
          "String",
          "500"
        ],
        [
          "WarehouseCode",
          "String",
          "15"
        ],
        [
          "WarehouseName",
          "String",
          "100"
        ]
      ]
    },
    {
      "heading": "GET Credit Notes",
      "anchor": "get-credit-notes",
      "summary": "Available Fields for Credit Lines",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "AverageLandedPriceAtTimeOfSale",
          "Nullable Decimal",
          ""
        ],
        [
          "BatchNumbers",
          "BatchNumber Collection",
          ""
        ],
        [
          "BCLineTax",
          "Nullable Decimal",
          ""
        ],
        [
          "BCLineTotal",
          "Decimal",
          ""
        ],
        [
          "Comments",
          "String",
          "1024"
        ],
        [
          "CostOfGoodsAccount",
          "String",
          "500"
        ],
        [
          "CreditPrice",
          "Decimal",
          ""
        ],
        [
          "CreditQuantity",
          "Decimal",
          ""
        ],
        [
          "Disassemble",
          "Boolean",
          ""
        ],
        [
          "LineNumber",
          "Integer",
          ""
        ],
        [
          "LastModifiedOn",
          "DateTime",
          ""
        ],
        [
          "LineTax",
          "Nullable Decimal",
          ""
        ],
        [
          "LineTaxCode",
          "String",
          "50"
        ],
        [
          "LineTotal",
          "Decimal",
          ""
        ],
        [
          "LineType",
          "String",
          ""
        ],
        [
          "OrderQuantity",
          "Decimal",
          ""
        ],
        [
          "PendingBatchNumbers",
          "PendingBatchNumber Collection",
          ""
        ],
        [
          "PendingSerialNumbers",
          "PendingSerialNumber Collection",
          ""
        ],
        [
          "Product",
          "Product",
          ""
        ],
        [
          "Reason",
          "String",
          "100"
        ],
        [
          "ReturnToStock",
          "Boolean",
          ""
        ],
        [
          "SerialNumbers",
          "SerialNumber Collection",
          ""
        ],
        [
          "TaxRate",
          "Decimal",
          ""
        ],
        [
          "XeroSalesAccount",
          "String",
          "50"
        ],
        [
          "XeroTaxCode",
          "String",
          "50"
        ]
      ]
    },
    {
      "heading": "GET Credit Notes",
      "anchor": "get-credit-notes",
      "summary": "Available Fields for Batch Number",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "ExpiryDate",
          "Nullable DateTime",
          ""
        ],
        [
          "Guid",
          "Guid",
          ""
        ],
        [
          "LastModifiedOn",
          "DateTime",
          ""
        ],
        [
          "Number",
          "String",
          "50"
        ],
        [
          "Quantity",
          "Decimal",
          ""
        ]
      ]
    },
    {
      "heading": "GET Credit Notes",
      "anchor": "get-credit-notes",
      "summary": "Available Fields for Pending Batch Number",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "CreatedOn",
          "DateTime",
          ""
        ],
        [
          "ExpiryDate",
          "Nullable DateTime",
          ""
        ],
        [
          "Number",
          "String",
          "50"
        ],
        [
          "Quantity",
          "Decimal",
          ""
        ]
      ]
    },
    {
      "heading": "GET Credit Notes",
      "anchor": "get-credit-notes",
      "summary": "Available Fields for Pending Serial Numbers",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "CreatedOn",
          "DateTime",
          ""
        ],
        [
          "Identifier",
          "String",
          "50"
        ]
      ]
    },
    {
      "heading": "GET Credit Notes",
      "anchor": "get-credit-notes",
      "summary": "Available Fields for Product",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "Guid",
          "Guid",
          ""
        ],
        [
          "ProductCode",
          "String",
          "100"
        ],
        [
          "ProductDescription",
          "String",
          "500"
        ]
      ]
    },
    {
      "heading": "GET Credit Notes",
      "anchor": "get-credit-notes",
      "summary": "Available Fields for Serial Numbers",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "Guid",
          "Guid",
          ""
        ],
        [
          "Identifier",
          "String",
          "50"
        ],
        [
          "LastModifiedOn",
          "DateTime",
          ""
        ]
      ]
    },
    {
      "heading": "POST/PUT Credit Notes",
      "anchor": "postput-credit-notes",
      "summary": "Available Fields for POST/PUT Credit Notes",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "POST",
          "PUT"
        ],
        [
          "Comments",
          "String",
          "1024",
          "",
          ""
        ],
        [
          "CreditDate",
          "DateTime",
          "",
          "Required",
          "Required"
        ],
        [
          "CreditLines",
          "CreditLine collection",
          "",
          "",
          ""
        ],
        [
          "Customer",
          "Customer",
          "",
          "Required",
          "N/A"
        ],
        [
          "ExchangeRate",
          "Decimal",
          "",
          "Required",
          "Required"
        ],
        [
          "Reference",
          "String",
          "500",
          "",
          ""
        ],
        [
          "Warehouse",
          "Warehouse",
          "",
          "Required",
          "Required"
        ]
      ]
    },
    {
      "heading": "POST/PUT Credit Notes",
      "anchor": "postput-credit-notes",
      "summary": "Available Fields for Customer",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "POST",
          "PUT"
        ],
        [
          "CustomerCode",
          "String",
          "500",
          "Optional",
          "N/A"
        ],
        [
          "Guid",
          "Guid",
          "15",
          "Optional",
          "N/A"
        ]
      ]
    },
    {
      "heading": "POST/PUT Credit Notes",
      "anchor": "postput-credit-notes",
      "summary": "Available Fields for Warehouse",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "POST",
          "PUT"
        ],
        [
          "Guid",
          "Guid",
          "",
          "Optional",
          "N/A"
        ],
        [
          "WarehouseCode",
          "String",
          "15",
          "Optional",
          "N/A"
        ]
      ]
    },
    {
      "heading": "POST/PUT Credit Notes",
      "anchor": "postput-credit-notes",
      "summary": "Available Fields for Credit Lines",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "POST",
          "PUT"
        ],
        [
          "BatchNumbers",
          "BatchNumber Collection",
          "",
          "",
          ""
        ],
        [
          "Comments",
          "String",
          "1024",
          "",
          ""
        ],
        [
          "CreditPrice",
          "Decimal",
          "",
          "Required",
          "Required"
        ],
        [
          "CreditQuantity",
          "Decimal",
          "",
          "Required",
          "Required"
        ],
        [
          "Guid",
          "Guid",
          "",
          "N/A",
          "Required"
        ],
        [
          "Product",
          "Product",
          "",
          "Required",
          "N/A"
        ],
        [
          "Reason",
          "String",
          "",
          "Required",
          "Required"
        ],
        [
          "Return",
          "Boolean",
          "",
          "Required",
          "Required"
        ],
        [
          "SerialNumbers",
          "SerialNumber Collection",
          "",
          "",
          ""
        ]
      ]
    },
    {
      "heading": "POST/PUT Credit Notes",
      "anchor": "postput-credit-notes",
      "summary": "Available Fields for Batch Number",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "POST",
          "PUT"
        ],
        [
          "BatchNumber (XML) / Number (JSON)",
          "String",
          "50",
          "Required",
          "Required"
        ],
        [
          "ExpiryDate",
          "Nullable DateTime",
          "",
          "",
          ""
        ],
        [
          "Quantity",
          "Decimal",
          "",
          "Required",
          "Required"
        ]
      ]
    },
    {
      "heading": "POST/PUT Credit Notes",
      "anchor": "postput-credit-notes",
      "summary": "Available Fields for Product",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "POST",
          "PUT"
        ],
        [
          "Guid",
          "Guid",
          "",
          "Optional",
          "N/A"
        ],
        [
          "ProductCode",
          "String",
          "100",
          "Optional",
          "N/A"
        ]
      ]
    },
    {
      "heading": "POST/PUT Credit Notes",
      "anchor": "postput-credit-notes",
      "summary": "Available Fields for Serial Number",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "POST",
          "PUT"
        ],
        [
          "SerialNumber (XML) / Identifier (JSON)",
          "String",
          "50",
          "Required",
          "Required"
        ]
      ]
    },
    {
      "heading": "Examples for Request PUT /CreditNotes/{CreditNoteGuid}",
      "anchor": "examples-for-request-put-creditnotescreditnoteguid",
      "summary": "Available Fields for POST/PUT Credit Lines",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "POST",
          "PUT"
        ],
        [
          "Comments",
          "String",
          "1024",
          "",
          ""
        ],
        [
          "BatchNumbers",
          "BatchNumber Collection",
          "",
          "",
          ""
        ],
        [
          "CreditPrice",
          "Decimal",
          "",
          "Required",
          "Required"
        ],
        [
          "CreditQuantity",
          "Decimal",
          "",
          "Required",
          "Required"
        ],
        [
          "Guid",
          "Guid",
          "",
          "N/A",
          "Required"
        ],
        [
          "Product",
          "Product",
          "",
          "Required",
          "N/A"
        ],
        [
          "Reason",
          "String",
          "",
          "Required",
          "Required"
        ],
        [
          "Return",
          "Boolean",
          "",
          "Required",
          "Required"
        ],
        [
          "SerialNumbers",
          "SerialNumber Collection",
          "",
          "",
          ""
        ]
      ]
    },
    {
      "heading": "Examples for Request PUT /CreditNotes/{CreditNoteGuid}",
      "anchor": "examples-for-request-put-creditnotescreditnoteguid",
      "summary": "Available Fields for Batch Number",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "POST",
          "PUT"
        ],
        [
          "BatchNumber (XML) / Number (JSON)",
          "String",
          "50",
          "Required",
          "Required"
        ],
        [
          "ExpiryDate",
          "Nullable DateTime",
          "",
          "",
          ""
        ],
        [
          "Quantity",
          "Decimal",
          "",
          "Required",
          "Required"
        ]
      ]
    },
    {
      "heading": "Examples for Request PUT /CreditNotes/{CreditNoteGuid}",
      "anchor": "examples-for-request-put-creditnotescreditnoteguid",
      "summary": "Available Fields for Product",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "POST",
          "PUT"
        ],
        [
          "Guid",
          "Guid",
          "",
          "Optional",
          "N/A"
        ],
        [
          "ProductCode",
          "String",
          "100",
          "Optional",
          "N/A"
        ]
      ]
    },
    {
      "heading": "Examples for Request PUT /CreditNotes/{CreditNoteGuid}",
      "anchor": "examples-for-request-put-creditnotescreditnoteguid",
      "summary": "Available Fields for Serial Number",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "POST",
          "PUT"
        ],
        [
          "SerialNumber (XML) / Identifier (JSON)",
          "String",
          "50",
          "Required",
          "Required"
        ]
      ]
    }
  ],
  "filterTables": [
    {
      "heading": "GET Credit Notes",
      "anchor": "get-credit-notes",
      "summary": "Available Filters for GET Credit Notes",
      "rows": [
        [
          "Filter",
          "Description"
        ],
        [
          "creditNumber",
          "Returns a single credit note with the specified credit number. If specified, it overrides all other filters."
        ],
        [
          "creditStatus",
          "Returns credits for the specified status."
        ],
        [
          "endDate",
          "Returns credits created before a specified date."
        ],
        [
          "modifiedSince",
          "Returns credits created or edited after a specified date."
        ],
        [
          "pageSize",
          "Specifies the page size for pagination. Default page size is 200 credits. Note: Requesting large numbers of contacts can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests."
        ],
        [
          "startDate",
          "Returns credits created after a specified date."
        ]
      ]
    }
  ],
  "documentationNotes": [
    "The Credit Notes resource allows credit notes to be listed and viewed. An individual credit note details can be viewed by appending its identifier (a GUID formatted as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX ) to the URI.",
    "Tip: To efficiently retrieve a count of credit notes that match a filter, specify a pageSize of 0: /CreditNotes?creditStatus=Parked&pageSize=0 . The default ordering is by LastModifiedOn descending.",
    "Note: GET requests in XML will not include the Sales Order collection for Free Credits.",
    "Note: Please note that only ‘FreeCredit’ Credit notes can be created or updated via the API, but any note can be completed with the POST/Complete filter.",
    "Note: At a minimum, a valid Guid or CustomerCode is required.",
    "Note: At a minimum, a valid Guid or WarehouseCode is required.",
    "Note: At a minimum, a valid Guid or ProductCode is required.",
    "Note: At a minimum, a valid Guid or ProductCode is required."
  ]
}

What has been verified

Documented coverage: 145 operation variants retained from official provider documentation, with 43 resource records and their field and filter tables. These counts describe documentation, not proven live workflows.
Agent connection: Actual Claude Desktop and web connection, model-selected platform utility calls, renewal after natural token expiry and revoked-access rejection passed. Codex and Claude Code authentication and discovery were also checked. These tests made no provider business requests.
Live business workflows: Awaiting an authorised Unleashed account. Provider reads, writes and business workflows are not yet verified.

More software, the same workspace

Explore Procore MCP

Inspect the Procore catalogue and the approval and account requirements while live acceptance is still pending.

Explore Procore →