Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Upsert a Compensation Plan
Get a Quote/Contract/Rebate Agreement/Compensation Plan Header
Add a Compensation Type
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
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
Upsert a Compensation Pla...
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}
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/delete/COCT
- URL:https://companynode.pricefx.com/pricefx/companypartition/delete/COCT
- 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/delete/COCT \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "23.COCT"
}
}'Response
application/json
{ "response": { "node": "e2e-templates-node", "data": [ … ], "status": 0 } }
Request
Creates or updates a Compensation Plan. Assigns new uniqueName when a new Compensation Plan is created. To update a Compensation Plan, specify the existing uniqueName.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/compensation.save
- URL:https://companynode.pricefx.com/pricefx/companypartition/compensation.save
- 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/compensation.save \
-H 'Content-Type: application/json' \
-d '{
"data": {
"compensation": {
"inputs": [
{
"label": "Customer(s)",
"name": "CustomerGroup",
"type": "CUSTOMERGROUP"
},
{
"label": "Product(s)",
"name": "ProductGroup",
"type": "PRODUCTGROUP"
}
],
"outputs": [],
"lineItems": [],
"label": "New Compensation Plan",
"nodeId": 0,
"compensationHeaderType": null,
"userGroupEdit": null,
"userGroupViewDetails": null,
"startDate": "2022-06-22",
"endDate": "2022-06-22",
"targetDate": null,
"externalRef": null,
"viewState": {}
}
}
}'Response
application/json
{ "response": { "node": "node", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/fetch/CO
- URL:https://companynode.pricefx.com/pricefx/companypartition/fetch/CO
- 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/CO \
-H 'Content-Type: application/json' \
-d '{
"endRow": 300,
"oldValues": null,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"data": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "workflowStatus",
"operator": "equals",
"value": "SUBMITTED"
}
]
}
}'Response
application/json
{ "response": { "node": "node1", "csrfToken": "token", "startRow": 0, "data": [ … ], "endRow": 3, "totalRows": 92, "status": 0 } }
See the Key-Value Database Storage Knowledge Base article for more details.
Operations
Here you can find all fields of the corresponding entity (represented by the type code).
Use the /metadata.describe endpoint to find out the correct data type of the field that is used in your partition.
Comments