Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Execute Form Logic
Get a Logic
Get a Default Pricing Logic Name
Set a Default Pricing Logic
Update a Logic
Update a Logic (Partial)
Update a Logic (No syntax check)
List Elements
Execute an Assigned Logic
Execute a Logic
Delete a Logic
List Logics
Generate Parameters
Syntax Check
List Logic Parameters (Input Fields)
List Libraries
Execute a Logic (Without a Context)
Execute a Logic Without a Context in a Service
Execute a Logic (Read-Only)
Execute a Logic Without a Context in a Service (Read-Only)
Copy a Logic
List Functions
Test a Logic
Execute Library Function
Execute Form Logic
The Pricefx Backend API
Download OpenAPI description
Overview
URL
Pricefx
Languages
Servers
Mock server
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi
URL:
https://{baseUrl}/pricefx/{partition}
Request
Executes a specific function from a formula library element without requiring a full formula logic implementation.
Parameters are provided via the request payload and the calculated result is returned.
Note:
- This endpoint does not work with
inputsbindings. Provide ordered function arguments instead.- Used by the Pricefx MCP server to enable Groovy-configured MCP Tools.
- Requires the
PRICINGFORMULA_EXECUTEpermission.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/formulamanager.executelibraryfunction/{formulaName}/{elementName}/{functionName}
- URL:https://companynode.pricefx.com/pricefx/companypartition/formulamanager.executelibraryfunction/{formulaName}/{elementName}/{functionName}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/formulamanager.executelibraryfunction/{formulaName}/{elementName}/{functionName}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"allowObjectMods": true,
"functionArgs": [
null
]
}
}'Request
Executes a form logic in one of the following modes: init, valueOptions, onValueChange, onClick. Only one mode can be used in a single call, and only the formula elements matching that mode are executed.
Use this endpoint to generate the initial form, lazy-load value options, or return changes that should be applied to the form after a user interaction. The request payload exposes typedId, sourceInputName, and inputValues to the form logic.
Security
basic or X-PriceFx-jwt
The endpoint accepts these payload fields:
- typedId – current object identifier, available in the form logic via form.currentItem(). A later follow-up made this parameter optional.
- sourceInputName – name of the input that triggered the request, available via form.sourceInputName().
- inputValues – current form values, available via inputs.
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/formulamanager.executeform/{uniqueName}/{mode}
- URL:https://companynode.pricefx.com/pricefx/companypartition/formulamanager.executeform/{uniqueName}/{mode}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/formulamanager.executeform/{uniqueName}/{mode}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "1.DB",
"sourceInputName": "Country",
"inputValues": {
"Country": "CZ",
"Comment": "Initial note"
}
}
}'
CommentsCopy for LLM Copy page as Markdown for LLMs View as Markdown Open this page as Markdown Open in ChatGPT Get insights from ChatGPT Open in Claude Get insights from Claude Connect to Cursor Install MCP server on Cursor Connect to VS Code Install MCP server on VS Code