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

Delete an existing Customer Contact

unleashed_delete_customers_contacts

DELETE/Customers/{customerGuid}/Contacts/{contactGuid}

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
`customerGuid`	Yes	Provider identifier from the corresponding resource; preserve the documented identifier type.
`contactGuid`	Yes	Provider identifier from the corresponding resource; preserve the documented identifier type.

Retained Customers 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 Customers

GET Customers

Property	Type	Length
Addresses	Address collection
BankAccount	String	500
BankBranch	String	500
BankName	String	500
Contacts	Contact collection
ContactFirstName	String	500
ContactLastName	String	500
CreatedBy	String	50
CreatedOn	Nullable DateTime
CreditLimit	Decimal
Currency	Currency
CustomerCode	String	500
CustomerName	String	500
CustomerType	String	50
CustomerTypeGuid	Guid
DDINumber	String	500
DefaultWarehouse	DefaultWarehouse
DeliveryInstruction	String	500
DeliveryMethod	String	50
DiscountRate	Nullable Decimal
Email	String	500
EmailCC	String	500
EORINumber	String	20
FaxNumber	String	500
GSTVATNumber	String	500
Guid	Guid
HasCreditLimit	Boolean	true , false
LastModifiedBy	String	50
LastModifiedOn	Nullable DateTime
MobileNumber	String	500
Notes	String	1024
Obsolete	Boolean	true , false
PaymentTerm	String	100
PhoneNumber	String	500
PrintInvoice	Nullable Boolean
PrintPackingSlipInsteadOfInvoice	Nullable Boolean
Reminder	String	1024
SalesOrderGroup	String	50
Salesperson	Salesperson
SellPriceTier	String	25
SellPriceTierReference	SellPriceTierReference
StopCredit	Boolean	true , false
Taxable	Nullable Boolean
TaxCode	String	50
TaxRate	Nullable Decimal
TollFreeNumber	String	500
Website	String	500
XeroCostOfGoodsAccount	String	500
XeroSalesAccount	String	500

Available Fields for GET Address

GET Customers

Property	Type	Length
AddressName	String	500
AddressType	String	20
City	String	500
Country	String	500
DeliveryInstruction	String	500
Guid	Guid
IsDefault	Boolean	true , false
LastModifiedOn	DateTime
PostalCode	String	500
Region	String	500
StreetAddress	String	500
StreetAddress2	String	500
Suburb	String	500

Available Fields for GET Contact

GET Customers

Property	Type	Length
DeliveryAddress	String	500
DDINumber	String	500
EmailAddress	String	500
FaxNumber	String	500
FirstName	String	500
ForInvoicing	Boolean	true , false
ForOrdering	Boolean	true , false
ForShipping	Boolean	true , false
Guid	Guid	500
IsDefault	Boolean	true , false
LastName	String	500
MobilePhone	String	500
Notes	String	1024
OfficePhone	String	500
PhoneNumber	String	500
TollFreeNumber	String	500
Website	String	500

Available Fields for GET Currency

GET Customers

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

Available Fields for GET Default Warehouse

GET Customers

Property	Type	Length
Guid	Guid
WarehouseCode	String	15
WarehouseName	String	100

Available Fields for GET Salesperson

GET Customers

Property	Type	Length
Email	String	256
FullName	String	256
Guid	Guid
LastModifiedOn	DateTime
Obsolete	Boolean	true , false

Available Fields for GET Customer Contacts

GET Customer Contacts

Property	Type	Length	Notes
DeliveryAddress	String	500	Delivery Address name
DDINumber	String	500
EmailAddress	String	500
FaxNumber	String	500
FirstName	String	500
ForInvoicing	Boolean
ForOrdering	Boolean
ForShipping	Boolean
Guid	Guid	500
IsDefault	Boolean
LastName	String	500
MobilePhone	String	500
Notes	String	1024
OfficePhone	String	500
PhoneNumber	String	500
TollFreeNumber	String	500
Website	String	500

Available Fields for POST Customer

POST Customers

Property	Type	Length	Required	Notes
Addresses	Address			You can have the following Address Types: Postal, Physical, and Shipping.
BankAccount	String	500
BankBranch	String	500
BankName	String	500
ContactFirstName	String	500	See notes	Only the Primary Contact can be created or updated via the API.
ContactLastName	String	500	See notes	Only the Primary Contact can be created or updated via the API.
CreditLimit	Decimal
Currency	Currency
CustomerCode	String	500	Yes	Unique code. Can only be set when creating a Customer.
CustomerName	String	500	Yes
CustomerType	String	50		If CustomerTypeGuid is also provided, it must match the same Customer Type.
CustomerTypeGuid	Guid			If CustomerType is also provided, it must match the same Customer Type.
DDINumber	String	500		If supplied, Primary Contact details are required.
DefaultWarehouse	DefaultWarehouse
DeliveryInstruction	String	500		When updating, null or missing property will not override existing information.
DeliveryMethod	String	50
DiscountRate	Decimal
Email	String	500	See notes	Email address format validated. Only the Primary Contact can be created or updated via the API.
EmailCC	String	500		Email address format validated. Multiple email addresses must be comma separated.
EORINumber	String	20
FaxNumber	String	500		If supplied, Primary Contact details are required.
GSTVATNumber	String	500
Guid	Guid		Optional	Required to update an existing Customer if not provided in the URI. Automatically generates a Guid if not provided when creating a new Customer.
HasCreditLimit	Boolean
MobileNumber	String	500		If supplied, Primary Contact details are required.
Notes	String	1024
Obsolete	Boolean
PaymentTerm	String	100
PhoneNumber	String	500		If supplied, Primary Contact details are required.
PrintInvoice	Boolean
PrintPackingSlipInsteadOfInvoice	Boolean
Salesperson	Salesperson
SalesOrderGroup	String	50
SellPriceTier	String	25
SellPriceTierReference	SellPriceTierReference
StopCredit	Boolean
Taxable	Boolean
TaxCode	String	50		Code of the default tax selected on the customer.
TaxRate	Decimal			Rate of the default tax selected on the customer.
TollFreeNumber	String	500		If supplied, Primary Contact details are required.
Website	String	500		Website format validated. If supplied, Primary Contact details are required.
XeroCostOfGoodsAccount	String	500
XeroSalesAccount	String	500

Available Fields for Address

POST Customers

Property	Type	Length	Notes
AddressName	String	500
AddressType	String	20
City	String	500
Country	String	500	Either CountryCode or CountryName can be provided. 2 character country codes are validated against the ISO 3166 list
PostalCode	String	500
Region	String	500
StreetAddress	String	500
StreetAddress2	String	500
Suburb	String	500

Available Fields for Currency

POST Customers

Property	Type	Length
CurrencyCode	String	3
Guid	Guid

Available Fields for Default Warehouse

POST Customers

Property	Type	Length
Guid	Guid
WarehouseCode	String	15

Available Fields for Salesperson

POST Customers

Property	Type	Length	Required
Email	String	256
FullName	String	256
Guid	Guid		Yes

Available Fields for POST/PUT Customer Contacts

POST/PUT Customer Contacts

Property	Type	Length	Notes	POST	PUT
DeliveryAddress	String	500	If supplied, must match an existing Delivery Address name.
DDINumber	String	500
EmailAddress	String	500	See notes	Optional	Optional
FaxNumber	String	500
FirstName	String	500	See notes	Optional	Optional
ForInvoicing	Boolean
ForOrdering	Boolean
ForShipping	Boolean
Guid	Guid	500		N/A	Required
IsDefault	Boolean		If there are no existing contacts for the customer, this contact will become the customer's default contact
LastName	String	500	See notes	Optional	Optional
MobilePhone	String	500
Notes	String	1024
OfficePhone	String	500
PhoneNumber	String	500
TollFreeNumber	String	500
Website	String	500

Available Filters for GET Customers

GET Customers

Filter	Description
contactEmail	Only returns Customers that have a contact email that starts with the specified email address.
currency	Only returns Customers with currency code exactly matching the specified value.
customer	Returns Customers whose customer code or customer name contains the specified value. It is case-sensitive.
customerCode	Only returns Customers that start with the specific customer code.
customerName	Only returns Customers that start with the specific customer name.
customerType	Only returns Customers that matches the specified customer type.
includeAllContacts	Returns the first 100 contacts of each Customer record, if set to true. If set to false only the primary contact details will be returned as part of the response.
includeObsolete	Returns all Customers, including obsolete, if set to true. If set to false or if it is not specified then returns only active (ie. non-obsolete) Customers.
modifiedSince	Returns Customers created or modified since the specified date.
orderBy	Orders the list by LastModifiedOn or CreatedOn date. By default the list is ordered by CustomerCode
pageSize	Specifies the page size for pagination. Default page size is 200 customers. Note: Requesting large numbers of customers can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests.
salesOrderGroup	Only returns Customers with the specified sales order group.
sellPriceTier	Only returns Customers that are assigned to the specified sell price tier.
sort	Orders the list by CreatedOn date sorted in ascending or descending order.
stopCredit	Returns Customers who have had their credit stopped, if set to true. If set to false or if not specified, returns all customers.
xeroContactId	Only returns Customers that start with the specific Xero Contact Id.

Available Filters for GET Customer Contacts

GET Customer Contacts

Filter	Description
orderBy	Orders the list by LastModifiedOn or CreatedOn date. By default the list is ordered by Primary Contact then alphabetically by First Name, Last Name.
page	Specifies which page number will be shown.
pageSize	Specifies the page size for pagination, the default page size is 200 customer contacts. Note: Requesting large numbers of customer contacts can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests.
sort	Orders the list by CreatedOn date sorted in ascending or descending order.

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": "delete_customers_contacts",
  "name": "unleashed_delete_customers_contacts",
  "resourceId": "Customers",
  "description": "Delete an existing Customer Contact",
  "method": "DELETE",
  "path": "/Customers/{customerGuid}/Contacts/{contactGuid}",
  "documentationUrl": "https://apidocs.unleashedsoftware.com/Customers",
  "readOnly": false,
  "destructive": true,
  "idempotent": false,
  "pathParameters": [
    {
      "name": "customerGuid",
      "required": true,
      "schema": {
        "type": "string",
        "minLength": 1
      },
      "description": "Provider identifier from the corresponding resource; preserve the documented identifier type."
    },
    {
      "name": "contactGuid",
      "required": true,
      "schema": {
        "type": "string",
        "minLength": 1
      },
      "description": "Provider identifier from the corresponding resource; preserve the documented identifier type."
    }
  ],
  "queryParameters": [],
  "requestBodySchema": null,
  "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/Customers",
      "sourceSha256": "d8f222d1bb5e04dbade31ca5ac9fa13d30aa586ef9379a43178587131900e490",
      "section": "The full range of URIs and HTTP Verbs supported are",
      "evidence": "DELETE /Customers/{customerGuid}/Contacts/{contactGuid}",
      "operationDescriptions": [
        "Delete an existing Customer Contact"
      ]
    }
  ],
  "confidence": "documented-route",
  "unresolved": [
    "No authenticated sandbox or production request has verified this operation."
  ],
  "requestFieldTable": null,
  "responseFieldTable": null
}

Inspect the complete resource record

{
  "id": "Customers",
  "name": "Customers",
  "group": "Editable resources",
  "documentationUrl": "https://apidocs.unleashedsoftware.com/Customers",
  "snapshot": "snapshots/Customers.html",
  "sourceSha256": "d8f222d1bb5e04dbade31ca5ac9fa13d30aa586ef9379a43178587131900e490",
  "fetchedAt": "2026-10-23T14:00:31.395147+00:00",
  "operationIds": [
    "list_customers",
    "get_customers",
    "list_customers_contacts",
    "create_or_update_customers",
    "create_or_update_customers_with_guid",
    "create_customers_contacts",
    "update_customers_contacts",
    "delete_customers_contacts"
  ],
  "fieldTables": [
    {
      "heading": "GET Customers",
      "anchor": "get-customers",
      "summary": "Available Fields for GET Customers",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "Addresses",
          "Address collection",
          ""
        ],
        [
          "BankAccount",
          "String",
          "500"
        ],
        [
          "BankBranch",
          "String",
          "500"
        ],
        [
          "BankName",
          "String",
          "500"
        ],
        [
          "Contacts",
          "Contact collection",
          ""
        ],
        [
          "ContactFirstName",
          "String",
          "500"
        ],
        [
          "ContactLastName",
          "String",
          "500"
        ],
        [
          "CreatedBy",
          "String",
          "50"
        ],
        [
          "CreatedOn",
          "Nullable DateTime",
          ""
        ],
        [
          "CreditLimit",
          "Decimal",
          ""
        ],
        [
          "Currency",
          "Currency",
          ""
        ],
        [
          "CustomerCode",
          "String",
          "500"
        ],
        [
          "CustomerName",
          "String",
          "500"
        ],
        [
          "CustomerType",
          "String",
          "50"
        ],
        [
          "CustomerTypeGuid",
          "Guid",
          ""
        ],
        [
          "DDINumber",
          "String",
          "500"
        ],
        [
          "DefaultWarehouse",
          "DefaultWarehouse",
          ""
        ],
        [
          "DeliveryInstruction",
          "String",
          "500"
        ],
        [
          "DeliveryMethod",
          "String",
          "50"
        ],
        [
          "DiscountRate",
          "Nullable Decimal",
          ""
        ],
        [
          "Email",
          "String",
          "500"
        ],
        [
          "EmailCC",
          "String",
          "500"
        ],
        [
          "EORINumber",
          "String",
          "20"
        ],
        [
          "FaxNumber",
          "String",
          "500"
        ],
        [
          "GSTVATNumber",
          "String",
          "500"
        ],
        [
          "Guid",
          "Guid",
          ""
        ],
        [
          "HasCreditLimit",
          "Boolean",
          "true , false"
        ],
        [
          "LastModifiedBy",
          "String",
          "50"
        ],
        [
          "LastModifiedOn",
          "Nullable DateTime",
          ""
        ],
        [
          "MobileNumber",
          "String",
          "500"
        ],
        [
          "Notes",
          "String",
          "1024"
        ],
        [
          "Obsolete",
          "Boolean",
          "true , false"
        ],
        [
          "PaymentTerm",
          "String",
          "100"
        ],
        [
          "PhoneNumber",
          "String",
          "500"
        ],
        [
          "PrintInvoice",
          "Nullable Boolean",
          ""
        ],
        [
          "PrintPackingSlipInsteadOfInvoice",
          "Nullable Boolean",
          ""
        ],
        [
          "Reminder",
          "String",
          "1024"
        ],
        [
          "SalesOrderGroup",
          "String",
          "50"
        ],
        [
          "Salesperson",
          "Salesperson",
          ""
        ],
        [
          "SellPriceTier",
          "String",
          "25"
        ],
        [
          "SellPriceTierReference",
          "SellPriceTierReference",
          ""
        ],
        [
          "StopCredit",
          "Boolean",
          "true , false"
        ],
        [
          "Taxable",
          "Nullable Boolean",
          ""
        ],
        [
          "TaxCode",
          "String",
          "50"
        ],
        [
          "TaxRate",
          "Nullable Decimal",
          ""
        ],
        [
          "TollFreeNumber",
          "String",
          "500"
        ],
        [
          "Website",
          "String",
          "500"
        ],
        [
          "XeroCostOfGoodsAccount",
          "String",
          "500"
        ],
        [
          "XeroSalesAccount",
          "String",
          "500"
        ]
      ]
    },
    {
      "heading": "GET Customers",
      "anchor": "get-customers",
      "summary": "Available Fields for GET Address",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "AddressName",
          "String",
          "500"
        ],
        [
          "AddressType",
          "String",
          "20"
        ],
        [
          "City",
          "String",
          "500"
        ],
        [
          "Country",
          "String",
          "500"
        ],
        [
          "DeliveryInstruction",
          "String",
          "500"
        ],
        [
          "Guid",
          "Guid",
          ""
        ],
        [
          "IsDefault",
          "Boolean",
          "true , false"
        ],
        [
          "LastModifiedOn",
          "DateTime",
          ""
        ],
        [
          "PostalCode",
          "String",
          "500"
        ],
        [
          "Region",
          "String",
          "500"
        ],
        [
          "StreetAddress",
          "String",
          "500"
        ],
        [
          "StreetAddress2",
          "String",
          "500"
        ],
        [
          "Suburb",
          "String",
          "500"
        ]
      ]
    },
    {
      "heading": "GET Customers",
      "anchor": "get-customers",
      "summary": "Available Fields for GET Contact",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "DeliveryAddress",
          "String",
          "500"
        ],
        [
          "DDINumber",
          "String",
          "500"
        ],
        [
          "EmailAddress",
          "String",
          "500"
        ],
        [
          "FaxNumber",
          "String",
          "500"
        ],
        [
          "FirstName",
          "String",
          "500"
        ],
        [
          "ForInvoicing",
          "Boolean",
          "true , false"
        ],
        [
          "ForOrdering",
          "Boolean",
          "true , false"
        ],
        [
          "ForShipping",
          "Boolean",
          "true , false"
        ],
        [
          "Guid",
          "Guid",
          "500"
        ],
        [
          "IsDefault",
          "Boolean",
          "true , false"
        ],
        [
          "LastName",
          "String",
          "500"
        ],
        [
          "MobilePhone",
          "String",
          "500"
        ],
        [
          "Notes",
          "String",
          "1024"
        ],
        [
          "OfficePhone",
          "String",
          "500"
        ],
        [
          "PhoneNumber",
          "String",
          "500"
        ],
        [
          "TollFreeNumber",
          "String",
          "500"
        ],
        [
          "Website",
          "String",
          "500"
        ]
      ]
    },
    {
      "heading": "GET Customers",
      "anchor": "get-customers",
      "summary": "Available Fields for GET Currency",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "CurrencyCode",
          "String",
          "3"
        ],
        [
          "DefaultBuyRate",
          "Nullable Decimal",
          ""
        ],
        [
          "DefaultSellRate",
          "Nullable Decimal",
          ""
        ],
        [
          "Description",
          "String",
          "200"
        ],
        [
          "Guid",
          "Guid",
          ""
        ],
        [
          "LastModifiedOn",
          "DateTime",
          ""
        ]
      ]
    },
    {
      "heading": "GET Customers",
      "anchor": "get-customers",
      "summary": "Available Fields for GET Default Warehouse",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "Guid",
          "Guid",
          ""
        ],
        [
          "WarehouseCode",
          "String",
          "15"
        ],
        [
          "WarehouseName",
          "String",
          "100"
        ]
      ]
    },
    {
      "heading": "GET Customers",
      "anchor": "get-customers",
      "summary": "Available Fields for GET Salesperson",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "Email",
          "String",
          "256"
        ],
        [
          "FullName",
          "String",
          "256"
        ],
        [
          "Guid",
          "Guid",
          ""
        ],
        [
          "LastModifiedOn",
          "DateTime",
          ""
        ],
        [
          "Obsolete",
          "Boolean",
          "true , false"
        ]
      ]
    },
    {
      "heading": "GET Customer Contacts",
      "anchor": "get-customer-contacts",
      "summary": "Available Fields for GET Customer Contacts",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "Notes"
        ],
        [
          "DeliveryAddress",
          "String",
          "500",
          "Delivery Address name"
        ],
        [
          "DDINumber",
          "String",
          "500",
          ""
        ],
        [
          "EmailAddress",
          "String",
          "500",
          ""
        ],
        [
          "FaxNumber",
          "String",
          "500",
          ""
        ],
        [
          "FirstName",
          "String",
          "500",
          ""
        ],
        [
          "ForInvoicing",
          "Boolean",
          "",
          ""
        ],
        [
          "ForOrdering",
          "Boolean",
          "",
          ""
        ],
        [
          "ForShipping",
          "Boolean",
          "",
          ""
        ],
        [
          "Guid",
          "Guid",
          "500",
          ""
        ],
        [
          "IsDefault",
          "Boolean",
          "",
          ""
        ],
        [
          "LastName",
          "String",
          "500",
          ""
        ],
        [
          "MobilePhone",
          "String",
          "500",
          ""
        ],
        [
          "Notes",
          "String",
          "1024",
          ""
        ],
        [
          "OfficePhone",
          "String",
          "500",
          ""
        ],
        [
          "PhoneNumber",
          "String",
          "500",
          ""
        ],
        [
          "TollFreeNumber",
          "String",
          "500",
          ""
        ],
        [
          "Website",
          "String",
          "500",
          ""
        ]
      ]
    },
    {
      "heading": "POST Customers",
      "anchor": "post-customers",
      "summary": "Available Fields for POST Customer",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "Required",
          "Notes"
        ],
        [
          "Addresses",
          "Address",
          "",
          "",
          "You can have the following Address Types: Postal, Physical, and Shipping."
        ],
        [
          "BankAccount",
          "String",
          "500",
          "",
          ""
        ],
        [
          "BankBranch",
          "String",
          "500",
          "",
          ""
        ],
        [
          "BankName",
          "String",
          "500",
          "",
          ""
        ],
        [
          "ContactFirstName",
          "String",
          "500",
          "See notes",
          "Only the Primary Contact can be created or updated via the API."
        ],
        [
          "ContactLastName",
          "String",
          "500",
          "See notes",
          "Only the Primary Contact can be created or updated via the API."
        ],
        [
          "CreditLimit",
          "Decimal",
          "",
          "",
          ""
        ],
        [
          "Currency",
          "Currency",
          "",
          "",
          ""
        ],
        [
          "CustomerCode",
          "String",
          "500",
          "Yes",
          "Unique code. Can only be set when creating a Customer."
        ],
        [
          "CustomerName",
          "String",
          "500",
          "Yes",
          ""
        ],
        [
          "CustomerType",
          "String",
          "50",
          "",
          "If CustomerTypeGuid is also provided, it must match the same Customer Type."
        ],
        [
          "CustomerTypeGuid",
          "Guid",
          "",
          "",
          "If CustomerType is also provided, it must match the same Customer Type."
        ],
        [
          "DDINumber",
          "String",
          "500",
          "",
          "If supplied, Primary Contact details are required."
        ],
        [
          "DefaultWarehouse",
          "DefaultWarehouse",
          "",
          "",
          ""
        ],
        [
          "DeliveryInstruction",
          "String",
          "500",
          "",
          "When updating, null or missing property will not override existing information."
        ],
        [
          "DeliveryMethod",
          "String",
          "50",
          "",
          ""
        ],
        [
          "DiscountRate",
          "Decimal",
          "",
          "",
          ""
        ],
        [
          "Email",
          "String",
          "500",
          "See notes",
          "Email address format validated. Only the Primary Contact can be created or updated via the API."
        ],
        [
          "EmailCC",
          "String",
          "500",
          "",
          "Email address format validated. Multiple email addresses must be comma separated."
        ],
        [
          "EORINumber",
          "String",
          "20",
          "",
          ""
        ],
        [
          "FaxNumber",
          "String",
          "500",
          "",
          "If supplied, Primary Contact details are required."
        ],
        [
          "GSTVATNumber",
          "String",
          "500",
          "",
          ""
        ],
        [
          "Guid",
          "Guid",
          "",
          "Optional",
          "Required to update an existing Customer if not provided in the URI. Automatically generates a Guid if not provided when creating a new Customer."
        ],
        [
          "HasCreditLimit",
          "Boolean",
          "",
          "",
          ""
        ],
        [
          "MobileNumber",
          "String",
          "500",
          "",
          "If supplied, Primary Contact details are required."
        ],
        [
          "Notes",
          "String",
          "1024",
          "",
          ""
        ],
        [
          "Obsolete",
          "Boolean",
          "",
          "",
          ""
        ],
        [
          "PaymentTerm",
          "String",
          "100",
          "",
          ""
        ],
        [
          "PhoneNumber",
          "String",
          "500",
          "",
          "If supplied, Primary Contact details are required."
        ],
        [
          "PrintInvoice",
          "Boolean",
          "",
          "",
          ""
        ],
        [
          "PrintPackingSlipInsteadOfInvoice",
          "Boolean",
          "",
          "",
          ""
        ],
        [
          "Salesperson",
          "Salesperson",
          "",
          "",
          ""
        ],
        [
          "SalesOrderGroup",
          "String",
          "50",
          "",
          ""
        ],
        [
          "SellPriceTier",
          "String",
          "25",
          "",
          ""
        ],
        [
          "SellPriceTierReference",
          "SellPriceTierReference",
          "",
          "",
          ""
        ],
        [
          "StopCredit",
          "Boolean",
          "",
          "",
          ""
        ],
        [
          "Taxable",
          "Boolean",
          "",
          "",
          ""
        ],
        [
          "TaxCode",
          "String",
          "50",
          "",
          "Code of the default tax selected on the customer."
        ],
        [
          "TaxRate",
          "Decimal",
          "",
          "",
          "Rate of the default tax selected on the customer."
        ],
        [
          "TollFreeNumber",
          "String",
          "500",
          "",
          "If supplied, Primary Contact details are required."
        ],
        [
          "Website",
          "String",
          "500",
          "",
          "Website format validated. If supplied, Primary Contact details are required."
        ],
        [
          "XeroCostOfGoodsAccount",
          "String",
          "500",
          "",
          ""
        ],
        [
          "XeroSalesAccount",
          "String",
          "500",
          "",
          ""
        ]
      ]
    },
    {
      "heading": "POST Customers",
      "anchor": "post-customers",
      "summary": "Available Fields for Address",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "Required",
          "Notes"
        ],
        [
          "AddressName",
          "String",
          "500",
          "",
          ""
        ],
        [
          "AddressType",
          "String",
          "20",
          "",
          ""
        ],
        [
          "City",
          "String",
          "500",
          "",
          ""
        ],
        [
          "Country",
          "String",
          "500",
          "",
          "Either CountryCode or CountryName can be provided. 2 character country codes are validated against the ISO 3166 list"
        ],
        [
          "PostalCode",
          "String",
          "500",
          "",
          ""
        ],
        [
          "Region",
          "String",
          "500",
          "",
          ""
        ],
        [
          "StreetAddress",
          "String",
          "500",
          "",
          ""
        ],
        [
          "StreetAddress2",
          "String",
          "500",
          "",
          ""
        ],
        [
          "Suburb",
          "String",
          "500",
          "",
          ""
        ]
      ]
    },
    {
      "heading": "POST Customers",
      "anchor": "post-customers",
      "summary": "Available Fields for Currency",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "CurrencyCode",
          "String",
          "3"
        ],
        [
          "Guid",
          "Guid",
          ""
        ]
      ]
    },
    {
      "heading": "POST Customers",
      "anchor": "post-customers",
      "summary": "Available Fields for Default Warehouse",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "Guid",
          "Guid",
          ""
        ],
        [
          "WarehouseCode",
          "String",
          "15"
        ]
      ]
    },
    {
      "heading": "POST Customers",
      "anchor": "post-customers",
      "summary": "Available Fields for Salesperson",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "Required"
        ],
        [
          "Email",
          "String",
          "256",
          ""
        ],
        [
          "FullName",
          "String",
          "256",
          ""
        ],
        [
          "Guid",
          "Guid",
          "",
          "Yes"
        ]
      ]
    },
    {
      "heading": "POST/PUT Customer Contacts",
      "anchor": "postput-customer-contacts",
      "summary": "Available Fields for POST/PUT Customer Contacts",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "Notes",
          "POST",
          "PUT"
        ],
        [
          "DeliveryAddress",
          "String",
          "500",
          "If supplied, must match an existing Delivery Address name.",
          "",
          ""
        ],
        [
          "DDINumber",
          "String",
          "500",
          "",
          "",
          ""
        ],
        [
          "EmailAddress",
          "String",
          "500",
          "See notes",
          "Optional",
          "Optional"
        ],
        [
          "FaxNumber",
          "String",
          "500",
          "",
          "",
          ""
        ],
        [
          "FirstName",
          "String",
          "500",
          "See notes",
          "Optional",
          "Optional"
        ],
        [
          "ForInvoicing",
          "Boolean",
          "",
          "",
          "",
          ""
        ],
        [
          "ForOrdering",
          "Boolean",
          "",
          "",
          "",
          ""
        ],
        [
          "ForShipping",
          "Boolean",
          "",
          "",
          "",
          ""
        ],
        [
          "Guid",
          "Guid",
          "500",
          "",
          "N/A",
          "Required"
        ],
        [
          "IsDefault",
          "Boolean",
          "",
          "If there are no existing contacts for the customer, this contact will become the customer's default contact",
          "",
          ""
        ],
        [
          "LastName",
          "String",
          "500",
          "See notes",
          "Optional",
          "Optional"
        ],
        [
          "MobilePhone",
          "String",
          "500",
          "",
          "",
          ""
        ],
        [
          "Notes",
          "String",
          "1024",
          "",
          "",
          ""
        ],
        [
          "OfficePhone",
          "String",
          "500",
          "",
          "",
          ""
        ],
        [
          "PhoneNumber",
          "String",
          "500",
          "",
          "",
          ""
        ],
        [
          "TollFreeNumber",
          "String",
          "500",
          "",
          "",
          ""
        ],
        [
          "Website",
          "String",
          "500",
          "",
          "",
          ""
        ]
      ]
    }
  ],
  "filterTables": [
    {
      "heading": "GET Customers",
      "anchor": "get-customers",
      "summary": "Available Filters for GET Customers",
      "rows": [
        [
          "Filter",
          "Description"
        ],
        [
          "contactEmail",
          "Only returns Customers that have a contact email that starts with the specified email address."
        ],
        [
          "currency",
          "Only returns Customers with currency code exactly matching the specified value."
        ],
        [
          "customer",
          "Returns Customers whose customer code or customer name contains the specified value. It is case-sensitive."
        ],
        [
          "customerCode",
          "Only returns Customers that start with the specific customer code."
        ],
        [
          "customerName",
          "Only returns Customers that start with the specific customer name."
        ],
        [
          "customerType",
          "Only returns Customers that matches the specified customer type."
        ],
        [
          "includeAllContacts",
          "Returns the first 100 contacts of each Customer record, if set to true. If set to false only the primary contact details will be returned as part of the response."
        ],
        [
          "includeObsolete",
          "Returns all Customers, including obsolete, if set to true. If set to false or if it is not specified then returns only active (ie. non-obsolete) Customers."
        ],
        [
          "modifiedSince",
          "Returns Customers created or modified since the specified date."
        ],
        [
          "orderBy",
          "Orders the list by LastModifiedOn or CreatedOn date. By default the list is ordered by CustomerCode"
        ],
        [
          "pageSize",
          "Specifies the page size for pagination. Default page size is 200 customers. Note: Requesting large numbers of customers can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests."
        ],
        [
          "salesOrderGroup",
          "Only returns Customers with the specified sales order group."
        ],
        [
          "sellPriceTier",
          "Only returns Customers that are assigned to the specified sell price tier."
        ],
        [
          "sort",
          "Orders the list by CreatedOn date sorted in ascending or descending order."
        ],
        [
          "stopCredit",
          "Returns Customers who have had their credit stopped, if set to true. If set to false or if not specified, returns all customers."
        ],
        [
          "xeroContactId",
          "Only returns Customers that start with the specific Xero Contact Id."
        ]
      ]
    },
    {
      "heading": "GET Customer Contacts",
      "anchor": "get-customer-contacts",
      "summary": "Available Filters for GET Customer Contacts",
      "rows": [
        [
          "Filter",
          "Description"
        ],
        [
          "orderBy",
          "Orders the list by LastModifiedOn or CreatedOn date. By default the list is ordered by Primary Contact then alphabetically by First Name, Last Name."
        ],
        [
          "page",
          "Specifies which page number will be shown."
        ],
        [
          "pageSize",
          "Specifies the page size for pagination, the default page size is 200 customer contacts. Note: Requesting large numbers of customer contacts can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests."
        ],
        [
          "sort",
          "Orders the list by CreatedOn date sorted in ascending or descending order."
        ]
      ]
    }
  ],
  "documentationNotes": [
    "The Customers resource allows Customers to be viewed, created, and updated. An individual Customer’s details can be viewed, or updated by appending its identifier (a GUID formatted as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX ) to the URI.",
    "Note: Date filters should be provided in the ISO format YYYY-MM-DD.",
    "Note: Any changes to the Primary Contact, requires Primary contact details with ContactFirstName , ContactLastName , and/or Email to be supplied. Updates made to existing Primary Contact will overwrite existing information, fields left blank will be removed.",
    "Note: At a minimum, a valid Guid or CurrencyCode is required.",
    "Note: At a minimum, a valid Guid or WarehouseCode is required.",
    "Note: At a minimum, a valid FirstName , LastName , and/or EmailAddress are required, and the combination of the three must be unique.",
    "Warning: POST does not accept user-generated GUIDs."
  ]
}

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 →