Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- List Calculations
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
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
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
List Calculations
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
Adds a Calculation (CompensationRecordSetCalculation) for the specified Compensation Record Set.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/add/CORSC
- URL:https://companynode.pricefx.com/pricefx/companypartition/add/CORSC
- 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/CORSC \
-H 'Content-Type: application/json' \
-d '{
"data": {
"label": "SC_records",
"compensationRecordSetId": 1
},
"operationType": "add"
}'Response
application/json
{ "response": { "node": "node1", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/fetch/CORSC
- URL:https://companynode.pricefx.com/pricefx/companypartition/fetch/CORSC
- 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/CORSC \
-H 'Content-Type: application/json' \
-d '{
"endRow": 300,
"oldValues": null,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"data": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "status",
"operator": "equals",
"value": "READY"
}
]
}
}'Response
application/json
{ "response": { "node": "node1", "startRow": 0, "data": [ … ], "endRow": 1, "totalRows": 1, "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/calculationrecord.savecalc
- URL:https://companynode.pricefx.com/pricefx/companypartition/calculationrecord.savecalc
- 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/calculationrecord.savecalc \
-H 'Content-Type: application/json' \
-d '{
"data": {
"version": 617,
"typedId": "3.CORSC",
"label": "Sales Compensations",
"calculationMessages": "[\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\"]",
"compensationRecordSetId": 1,
"compensationRecordSetLabel": "Sales Compensations",
"dtoFilter": {
"_constructor": "AdvancedCriteria",
"criteria": [
{
"fieldName": "sourceId",
"operator": "equals",
"value": "CO-157"
}
],
"operator": "and"
},
"calculationType": "RECORD",
"calculationConfig": {
"formulaName": "SC_Compensation",
"feederInputParams": [],
"inputParams": [],
"mappingParams": [],
"outputElements": []
},
"createDate": "2022-06-09T08:21:13",
"createdBy": 290,
"lastUpdateDate": "2022-06-24T10:44:59",
"lastUpdateBy": 290,
"status": "READY",
"calculationStartDate": "2022-06-24T10:26:20",
"calculationDate": "2022-06-24T10:44:59",
"isDefault": true,
"incremental": false,
"incCalculationDate": "2022-06-24T10:26:20",
"shouldSubmit": false,
"valid": true
},
"operationType": "update",
"textMatchStyle": "exact",
"oldValues": null
}'Response
application/json
{ "response": { "node": "node1", "data": [ … ], "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