Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Create a Custom Form Type
List Custom Form Types
Update a Custom Form Type
Delete a Custom Form Type
Create a Custom Form
Get a Custom Form
List Custom Forms
Change a Custom Form Status
Update a Custom Form
Delete a Custom Form
Duplicate a Custom Form
Create a Custom Form Revision
Preview a Custom Form Workflow
Create a Custom Form Type
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}
Bodyapplication/json
A Custom Form header logic that defines the inputs, calculation results or a custom header. For embedded Custom Forms, it also defines communication with the parent object.
Sets whether the Custom Form will be standalone or embedded in a module.
List of entities, which are allowed to embed this custom form type (Quote, standalone Custom Form). This is meaningful only when embedded is true.
Applies to standalone Custom Forms. Select a module in whose main menu you want to have this Custom Form available.
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/add/CFOT
- URL:https://companynode.pricefx.com/pricefx/companypartition/add/CFOT
- 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/add/CFOT \
-H 'Content-Type: application/json' \
-d '{
"operation": "add",
"data": {
"uniqueName": "CFOT01",
"label": "CustomFormType01",
"headerFormulaName": "cflogic",
"embedded": false,
"configuration": {
"default": {
"name": "default",
"translationKey": "common_default",
"icon": "compress-arrows",
"tabs": {
"details": {
"name": "details",
"translationKey": "dynamicTab_details",
"type": "details",
"icon": "file-info-alt"
}
}
}
},
"module": "PRICESETTING"
}
}'Response
application/json
{ "response": { "node": "string", "data": { … }, "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/fetch/CFOT
- URL:https://companynode.pricefx.com/pricefx/companypartition/fetch/CFOT
- 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/fetch/CFOT \
-H 'Content-Type: application/json' \
-d '{
"endRow": 300,
"oldValues": null,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"data": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "module",
"operator": "equals",
"value": "QUOTING"
}
]
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-7f5685597f-7p2tn", "startRow": 0, "data": [ … ], "endRow": 1, "totalRows": 1, "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/update/CFOT
- URL:https://companynode.pricefx.com/pricefx/companypartition/update/CFOT
- 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/update/CFOT \
-H 'Content-Type: application/json' \
-d '{
"oldValues": {
"version": 3,
"typedId": "7.CFOT",
"uniqueName": "CFOT",
"label": "MyCustomFormType",
"headerFormulaName": "cflogic",
"embedded": false,
"module": "QUOTING",
"configuration": {
"default": {
"icon": "compress-arrows",
"name": "default",
"tabs": {
"details": {
"icon": "file-info-alt",
"name": "details",
"type": "details",
"translationKey": "dynamicTab_details"
}
},
"translationKey": "common_default"
}
},
"createDate": "2022-05-20T15:02:00",
"createdBy": 2147490696,
"lastUpdateDate": "2022-05-23T10:18:46",
"lastUpdateBy": 2147490696
},
"operationType": "update",
"textMatchStyle": "exact",
"data": {
"embedded": true,
"configuration": null,
"module": null,
"supportedParentTypeCodes": null,
"typedId": "7.CFOT",
"workflowFormulaName": null
}
}'Response
application/json
{ "response": { "node": "node", "data": [ … ], "status": 0 } }
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