Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Add a Compensation Type
Get a Quote/Contract/Rebate Agreement/Compensation Plan Header
List Compensation Types
Update a Compensation Type
Delete a Compensation Type
Add a Condition Type
List Condition Types
Update a Condition Type
Delete a Condition Type
Upsert a Compensation Plan
List Compensation Plans
List CLIC Objects
Update a Quote/Contract/Rebate Agreement/Compensation Plan
Delete a Compensation Plan
Duplicate a Compensation Plan
Recalculate a Quote/Contract/Rebate Agreement/Compensation Plan
Add a Calculation
List Calculations
Save Calculation
Run a Calculation
Delete a Calculation
Save a Compensation Record
List Compensation Records
Update a Compensation Record
Revoke a Compensation Record
List Accrual Records
Send a Document to Sign
Get a Signed Document
Get a Signature Status
Update CLIC Line Items
Delete All Line Items
Import Line Items (w/o Input Types)
Undo Compensation Plan Revocation
Undo Compensation Record Revocation
Add a Compensation 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}
Request
Retrieves details of the specified Compensation Plan, Contract, Quote, or Rebate Agreement - without line items.
This endpoint is used in the REACT version only. It is not advisable to mix REACT endpoints together with Ember endpoints.
Use the clicmanager.fetch/{typedId} endpoint to return line items of the specified entity.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.fetchheader/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/clicmanager.fetchheader/{typedId}
- 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/clicmanager.fetchheader/127.CTResponse
application/json
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/add/COHT
- URL:https://companynode.pricefx.com/pricefx/companypartition/add/COHT
- 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/COHT \
-H 'Content-Type: application/json' \
-d '{
"data": {
"uniqueName": "The Test Compensation Type",
"headerFormulaName": "SC_CompensationHeader",
"workflowFormulaName": "SC_SalesCompensationAgreement",
"configuration": null,
"scRecordWorkflowFormulaName": "SC_AgreementRecord"
},
"operation": "add"
}'Response
application/json
{ "response": { "node": "node", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/fetch/COHT
- URL:https://companynode.pricefx.com/pricefx/companypartition/fetch/COHT
- 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/COHT \
-H 'Content-Type: application/json' \
-d '{
"endRow": 300,
"oldValues": null,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"data": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "uniqueName",
"operator": "iEquals",
"value": "The Test Compensation Type"
}
]
}
}'Response
application/json
{ "response": { "node": "node1", "startRow": 0, "data": [ … ], "endRow": 1, "totalRows": 1, "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