Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Delete a Rebate Agreement
List Rebate Agreements
Upsert a Rebate Agreement
List Rebate Agreement Items
Get a Rebate Agreement
Add Rebate Agreement Items
Get a Quote/Contract/Rebate Agreement/Compensation Plan Header
List CLIC Objects
Update CLIC Line Items
Delete All Line Items
Import Line Items (w/o Input Types)
Undo Rebate Agreement Revocation
Undo Rebate Record Revocation
Delete a Rebate Agreement
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/rebateagreement.additems
- URL:https://companynode.pricefx.com/pricefx/companypartition/rebateagreement.additems
- 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/rebateagreement.additems \
-H 'Content-Type: application/json' \
-d '{
"data": {
"rebateAgreement": {
"version": 6,
"typedId": "2147483857.RBA",
"uniqueName": "R-2147483857",
"label": "New Rebate Agreement",
"targetDate": "2021-10-19",
"workflowStatus": "DRAFT",
"headerText": null,
"inputs": [
{
"name": "CustomerGroup",
"label": "Customer(s)",
"lookupTableId": null,
"url": null,
"type": "CUSTOMERGROUP",
"value": null,
"valueHint": null,
"readOnly": null,
"filter": null,
"parameterGroup": null,
"required": null,
"labelTranslations": null,
"addUnknownValues": null,
"typedId": null,
"alwaysEditable": null,
"inputs": [],
"parameterConfig": {},
"formattingOptions": {},
"valueOptions": null
},
{
"name": "ProductGroup",
"label": "Product(s)",
"lookupTableId": null,
"url": null,
"type": "PRODUCTGROUP",
"value": null,
"valueHint": null,
"readOnly": null,
"filter": null,
"parameterGroup": null,
"required": null,
"labelTranslations": null,
"addUnknownValues": null,
"typedId": null,
"alwaysEditable": null,
"inputs": [],
"parameterConfig": {},
"formattingOptions": {},
"valueOptions": null
}
],
"viewState": {
"gridViewState": null,
"openFolders": null,
"selectedNodes": null
},
"outputs": [],
"lastUpdateByName": "ondrej.tesar",
"createdByName": "ondrej.tesar",
"submittedByName": null,
"calculationStatus": 0,
"dirty": false,
"refreshInputs": false,
"nodeId": 0,
"userGroupEdit": null,
"userGroupViewDetails": null,
"serverMessages": null,
"additionalInfo1": null,
"additionalInfo2": null,
"additionalInfo3": null,
"additionalInfo4": null,
"numberOfAttachments": 0,
"creationWorkflowStatus": null,
"creationWorkflowCurrentStep": null,
"creationWorkflowStepCount": null,
"creationWorkflowStepLabel": null,
"signature": null,
"lineItems": [],
"seller": null,
"customerGroup": null,
"startDate": "2021-10-19",
"endDate": "2021-10-19",
"payoutDate": "2021-10-19",
"rebateRecordSetId": null,
"rebateRecordSetLabel": null,
"simulationSet": null,
"simulationType": null,
"status": "DRAFT",
"rebateAgreementStatus": "DRAFT",
"renderInfo": null,
"serverMessagesExtended": null,
"approvedByName": null,
"deniedByName": null,
"approvalRequiredEmailAttachmentsJson": null,
"hasWorkflowHistory": false,
"createDate": "2021-10-19T11:27:13",
"createdBy": 2147483751,
"lastUpdateDate": "2021-10-19T11:27:13",
"lastUpdateBy": 2147483751,
"supersededBy": null,
"prevRev": null,
"rootUniqueName": "R-2147483857",
"headerRebateType": null,
"sellerName": null
},
"parent": null,
"rebateTypes": [
"Rebates"
]
}
}'Response
application/json
{ "response": { "node": "e2e-templates-node", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/delete/RBA
- URL:https://companynode.pricefx.com/pricefx/companypartition/delete/RBA
- 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/RBA \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "2147483846.RBA"
}
}'Response
application/json
{ "response": { "node": "e2e-templates-node", "data": [ … ], "status": 0 } }
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 } }
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