MCP Server and Resource Metrics
- Server URL:
https://<domain>/account/mcp - Total Tools: 103
- Total Error Codes: 7
Server Overview
The MCP server provides robust data management and operational capabilities, enabling businesses to efficiently handle collections, accounts, contracts, payments, workflows, and caching through 103 specialized tools, offering streamlined integration, validation, and automation for enhanced scalability and decision-making.
Tools
The following table lists the available MCP tools for Accounts service along with their descriptions and required/optional parameters:
| Tool Name | Tool Description | Required Parameters | Optional Parameters |
|---|---|---|---|
| getCollection | This tool retrieves a specific collection and its properties based on provided businessId and collectionId. |
|
|
| replaceCollection | This tool updates an accounts collection by requiring all associated properties in the request, identified via collectionId and businessId, with responses for success, errors, or resource not found. |
|
|
| deleteCollection | This tool deletes a specified collection and its properties using collectionId and businessId, returning appropriate responses based on the operation’s outcome. |
|
|
| getProperties | This tool retrieves collection properties for a given collectionId, filtered by sort, page, and size parameters, with detailed response codes. |
|
|
| replaceProperties | This tool bulk updates properties for a specified collectionId, replacing existing ones, with responses indicating success or various errors. |
|
|
| putUpdateProperties | This tool updates account properties for a valid account and collection ID, validating and modifying specified fields or creating new properties, with responses indicating success or errors. |
|
|
| putUpdateContractProperties | This tool manages contract properties by creating or updating them for a valid contract ID, account ID, and collection ID, with detailed response codes and property specifications. |
|
|
| refreshApi | This tool updates secret keys without restart, clears instance data for AWS calls, and requires keyName and resetRequired parameters. |
|
None |
| getPaymentTerms | This tool retrieves payment terms for a valid collection ID, supporting pagination, sorting, filtering, and various response codes. |
|
|
| createPaymentTerm | This tool creates a payment term for a valid collection, specifying the buyer’s allowed payment period, with responses for success, bad request, forbidden, or not found. |
|
|
| cacheClear | This tool clears cached data for specified cache names, supports string-type keys, and can clear entire cache if no key or pattern is provided. |
|
|
| cacheClear_1 | This tool clears cached data using dynamic cache keys and returns a JSON response with code, message, and timestamp. |
|
|
| getCollections | This tool retrieves collections linked to a businessId based on search, sort, pagination, and filter criteria, returning results in JSON format with appropriate response codes. |
|
|
| createCollection | This tool manages account collections by updating existing properties or using defaults, with responses indicating success, errors, or resource status. |
|
|
| getAttributes | This tool retrieves attributes based on valid `collectionId`, with sorting, paging, filtering, and error handling options. |
|
|
| createAttribute | This tool creates an attribute and provides detailed response codes, properties, and examples for various statuses. |
|
|
| getAccountTypes | This tool retrieves account types linked to a valid collectionId, with options for pagination, filtering, sorting, and detailed response codes. |
|
|
| createAccountType | This tool creates a new account type at the collection level based on valid request parameters, with responses indicating success, errors, or resource unavailability. |
|
|
| getAccounts | This tool retrieves accounts from a valid collection based on search criteria, sort, pagination, and filters, returning appropriate responses for success or errors. |
|
|
| createAccount | This tool creates accounts based on request parameters, associates them with a valid collection ID, and provides detailed response codes and properties for success or errors. |
|
|
| getTeams | This tool retrieves team information for an account based on sorting, pagination, and filtering criteria. |
|
|
| createTeam | This tool creates a team for a specific account in a collection, optionally associating buyer users, with responses indicating success, errors, or resource status. |
|
|
| getAccountSellers | This tool retrieves seller users linked to a valid account and collection ID, with pagination and sorting options. |
|
|
| createAccountSeller | This tool links a seller user to an account using a valid accountId and collectionId, with responses indicating success, errors, or resource unavailability. |
|
|
| getPayments | This tool retrieves payments linked to a valid account and collection ID, with optional sorting, pagination, and size parameters, returning responses based on success or error conditions. |
|
|
| createPayment | This tool creates a payment linked to a valid account and collection ID, with responses indicating success, errors, or resource issues. |
|
|
| getCostCentres | This tool retrieves cost centers and budgets for a valid account and collection ID, with optional pagination, filtering, and sorting. |
|
|
| createCostCentre | This tool enables the creation of cost centers and budgets for valid accounts, with responses indicating success, errors, or resource status. |
|
|
| getContracts | This tool retrieves contracts linked to a valid account and collection, with pagination, filtering, sorting, and detailed response codes. |
|
|
| createContract | This tool facilitates the creation of account-specific contracts, including associated documents, and requires valid account and collection IDs for operation. |
|
|
| getAccountBuyers | This tool retrieves buyer users by account ID and collection ID, with sorting, pagination, and filtering options, requiring valid parameters and associations. |
|
|
| createAccountBuyer | This tool associates a buyer user with a valid accountId and optional TeamId, enabling them to access products, with responses indicating success, errors, or resource status. |
|
|
| findAllApprovalWorkflowRule | This tool retrieves all Approval Workflow Rules using a specified account ID, returning responses with status codes like 202, 400, 403, 404, or default. |
|
|
| createApprovalRule | This tool creates an Approval Workflow Rule linked to a valid account and collection ID, with various response codes for success or errors. |
|
|
| validateApprovalRule | This tool validates the BPMN process provided in the request and returns structured responses based on the outcome. |
|
|
| applyApprovalWorkflowRule | This tool processes the Approval Workflow for a specified account using a `Cart` request object and provides detailed responses based on execution status. |
|
|
| getAddresses | This tool retrieves all addresses linked to a valid account and collection ID, with options for sorting, pagination, filtering, and error responses. |
|
|
| createAddress | This tool associates a valid address with an account, requiring valid accountId and collectionId, and supports multiple addresses per account with various response codes. |
|
|
| getPaymentTerm | This tool retrieves payment term details for a valid collectionId, returning success, error, or not found responses based on the request. |
|
|
| deletePaymentTerm | This tool deletes a payment term linked to a collection, requiring valid `collectionId` and `paymentTermId`, with responses indicating success, errors, or resource unavailability. |
|
|
| updatePaymentTerm | This tool updates specific fields of a payment term using a valid paymentTermId and collectionId, validating only the provided fields in the request. |
|
|
| getProperty | This tool retrieves a specific property using collectionId, businessId, and property name, with detailed response codes and examples. |
|
|
| updateProperty | This tool updates specific property fields based on the provided propertyName, validates inputs, and returns success or error responses. |
|
|
| getAttribute | This tool retrieves an attribute using a valid `collectionId` and `attribute ID`, returning detailed attribute properties or error responses based on the request status. |
|
|
| deleteAttribute | This tool deletes an attribute using its unique ID and provides status responses like success, bad request, forbidden, or not found. |
|
|
| updateAttribute | This tool updates specified attribute fields based on `AttributeID`, validates inputs, and provides detailed responses for success or errors. |
|
|
| getAccountType | This tool retrieves an account type by accountTypeId and collectionId, returning success, error, or not found responses with relevant details. |
|
|
| deleteAccountType | This tool deletes an account type by its ID within a valid collection, requiring the account type to exist beforehand. |
|
|
| updateAccountType | This tool updates account type information in a collection, requiring a valid collectionId and existing AccountType, with various response codes for success or errors. |
|
|
| getAccountById | This tool retrieves detailed account information based on a valid `accountId` and `collectionId`, including properties, attributes, and status. |
|
|
| deleteAccountById | This tool deletes an account and its properties based on valid collectionId and accountId, returning appropriate responses for success or errors. |
|
|
| updateAccountById | This tool updates account fields based on account ID and collection ID, validates inputs, allows property creation, and returns detailed responses for success or errors. |
|
|
| getTeam | This tool retrieves a team and its associated buyer users based on the provided accountId and teamId, returning detailed team information or error responses. |
|
|
| deleteTeam | This tool deletes a team using accountId and teamId, disassociating mapped account buyers, with responses for success, errors, or resource not found. |
|
|
| updateTeam | This tool patch updates team information for a specific account within a collection, requiring valid account and team IDs, and provides responses for success or errors. |
|
|
| getAccountSeller | This tool retrieves seller user information from a valid account and collection ID, returning success or error responses based on conditions. |
|
|
| deleteAccountSeller | This tool deletes a seller user based on accountId and sellerId, requiring valid account and collection IDs, with responses indicating success or specific errors. |
|
|
| updateAccountSeller | This tool updates seller user information in an account, validating provided fields, collectionId, accountId, and sellerId, with responses indicating success or specific errors. |
|
|
| getPayment | This tool retrieves a specific payment for a valid account and collection, requiring valid accountId and paymentId, with responses indicating success, errors, or resource unavailability. |
|
|
| deletePayment | This tool deletes a specified payment from a valid account and collection, returning success or error responses based on the operation’s outcome. |
|
|
| updatePayment | This tool updates specific payment fields based on paymentId, validates inputs, and requires valid accountId and collectionId. |
|
|
| getCostCentre | This tool retrieves cost center information for a valid account and collection ID, returning details like name, status, and budgets, with specific response codes for success or errors. |
|
|
| deleteCostCentre | This tool deletes a cost center and its budgets using valid accountId, costCenterId, and collectionId, with specific response codes for success or errors. |
|
|
| updateCostCentre | This tool updates specified fields of a cost center and its budgets based on valid account, collection, and address IDs, returning appropriate responses for success or errors. |
|
|
| getContract | This tool retrieves an account’s contract and its properties based on valid account, contract, and collection IDs, with structured responses for success or errors. |
|
|
| deleteContract | This tool deletes a contract and its associated documents if valid accountId, collectionId, and contractId are provided. |
|
|
| updateContract | This tool updates account-specific contract information, validating provided fields, requiring valid account, collection, and contract IDs. |
|
|
| getAccountBuyerId | This tool retrieves a buyer user from a valid account and collection ID, returning success or error responses based on input validity. |
|
|
| deleteAccountBuyerId | This tool deletes a buyer user based on valid accountId, accountBuyerId, and collectionId, returning appropriate success or error responses. |
|
|
| updateAccountBuyerByAccountId | This tool updates buyer user information in an account, validating provided fields and requiring valid account, collection, and buyer IDs. |
|
|
| getApprovalWorkflowRule | This tool retrieves an Approval Workflow Rule using the specified Approval Workflow Rule ID and account ID, returning various responses based on the request’s outcome. |
|
|
| DeleteApprovalRule | This tool deletes an Approval Workflow Rule using the specified Approval Workflow Rule ID and returns various responses based on the request outcome. |
|
|
| PatchApprovalRule | This tool updates an Approval Workflow Rule based on the provided request object and returns various response codes depending on the outcome. |
|
|
| getAddress | This tool retrieves an address linked to a valid account and collection ID, returning detailed address properties or error responses based on the request’s validity. |
|
|
| deleteAddress | This tool deletes an address linked to an account, requiring valid accountId, collectionId, and addressId parameters. |
|
|
| updateAddress | This tool updates specific fields of an existing address using addressId and validates accountId and collectionId for proper association. |
|
|
| getVersions | This tool retrieves all versions linked to a price list, with customizable sorting, filtering, locale, and pagination options. |
|
|
| getVersion | This tool loads a specified version of a price list based on unique identifiers and locale settings. |
|
|
| getAccountsBySellerId | This tool retrieves seller-associated accounts using a valid collectionId, with filtering options and defined response codes. |
|
|
| refreshApi_1 | This tool updates secret keys without restarting, cleans instance data, and requires keyName and resetRequired parameters. |
|
None |
| rabbitMQUpdateCredentials | This tool updates RabbitMQ credentials, clears instance data for AWS calls, and requires keyName and resetRequired parameters. |
|
None |
| refreshApi_2 | This tool updates secret keys without restart, clears instance data for AWS calls, and uses keyName and resetRequired parameters. |
|
None |
| getAllStandrdRoles | This tool retrieves and filters standard roles and privileges from `roles_privileges.json` but has been deprecated since Infosys Equinox Commerce Release 8.3.0. |
|
|
| getReleaseDefinition | This tool retrieves the release definition of a service with responses indicating success, errors, or resource unavailability. |
|
None |
| getAllPrivileges | This tool fetches service privileges listed in `roles_privileges.json` within the microservice’s classpath, returning them in JSON format upon success. |
|
None |
| getAllPrivilegeGroups | This tool retrieves and filters privilege groups and privileges from `roles_privileges.json` based on the `privilegeGroupName` parameter. |
|
|
| ping | This tool verifies if the accounts service is operational, returning a success response with JSON content. |
|
None |
| getCacheValue | This tool retrieves cached data for a specified service using a string-based cache name and cache key. |
|
None |
| getCacheKeys | This tool retrieves cache keys for a service using a specified Redis-supported regex pattern, defaulting to ‘*’. |
|
None |
| getCollectionAttributes | This tool retrieves all collection attributes in the system, with responses indicating success, errors, or resource unavailability. |
|
|
| cacheClear_2 | This tool clears all caches and returns a success response with JSON content. |
|
None |
| cacheClearByName | This tool clears the cache by specifying the required cache name as a path parameter. |
|
None |
| cacheClearByNameAndKey | This tool clears the cache using specified cache name and cache key, returning a success response upon completion. |
|
None |
| getAccountByBuyerId | This tool retrieves account details linked to a valid buyerUserId and collectionId, with responses indicating success, errors, or resource status. |
|
|
| getPropertyId | This tool retrieves an account property using valid account and property IDs, ensuring associated accounts and collections exist. |
|
|
| deletePropertyId | This tool deletes an account property linked to a valid account and collection, requiring valid `accountId`, `collectionId`, and `attributeId`. |
|
|
| getBudgteById | This tool retrieves a budget based on valid accountId, costCentreId, and budgetId, ensuring associated entities exist in the system. |
|
|
| deleteBudgetById | This tool deletes a budget linked to a valid cost center, account, and collection, requiring valid IDs for each parameter. |
|
|
| getPropertyById | This tool retrieves a contract property linked to a valid account, contract, and attribute IDs, returning success or error responses based on validation. |
|
|
| deletePropertyById | This tool deletes a contract property using `accountId`, `contractId`, `attributeId`, and a valid `collectionId`, ensuring all identifiers exist and are associated correctly. |
|
|
| getDocumentById | This tool retrieves documents linked to a specific account contract, requiring valid account, collection, contract, and document IDs, with responses for success, errors, or resource unavailability. |
|
|
| deleteDocumentById | This tool deletes a document based on accountId, contractId, and documentId, requiring valid associations and existing resources. |
|
|
| getAccountHistorys | This tool retrieves account histories for a valid accountId based on filter, sort, page, and size parameters, with detailed response codes for success or errors. |
|
|
Error Responses
The table below lists standard error codes with their corresponding descriptions for API responses:
| Error Code | Error Description |
|---|---|
| 200 | (Success): Success |
| 201 | (Success): Accepted |
| 202 | Accepted |
| 400 | Bad Request |
| 403 | Forbidden. |
| 404 | The resource you are trying to reach is not found |
| 500 | Server exception caused by non-client errors |
Useful Resources
- API Specifications: API Endpoints – Accounts
- Services Details: Accounts Service
Revision History
2025-11-19 | JP – Updated domain
2025-09-29 | SD – Page created and content added