Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- List Rebate Agreements
Upsert a Rebate Agreement
List Rebate Agreement Items
Get a Rebate Agreement
Add Rebate Agreement Items
Delete a Rebate Agreement
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
List Rebate Agreements
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 a list of rebate agreements.
| Required Permission | Roles with the Required Permission |
|---|---|
| REBATEAGREEMENT_FETCH | Investigate for Support (SUPPORT), Administer Plasma (PLASMA), Administer RebateManager (RM_REBATEMANAGER), Administer Rebate Agreements (RM_REBATEAGREEMENTS_ADMIN), Manage Rebate Agreements (RM_REBATEAGREEMENTS), View Rebate Agreements (RM_REBATEAGREEMENTS_RO) |
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/fetch/RBA
- URL:https://companynode.pricefx.com/pricefx/companypartition/fetch/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/fetch/RBA \
-H 'Content-Type: application/json' \
-d '{
"endRow": 300,
"oldValues": null,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"data": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "createdByName",
"operator": "equals",
"value": "admin"
}
]
},
"sortBy": [
"createDate"
]
}'Response
application/json
{ "response": { "node": "string", "startRow": 0, "data": [ … ], "endRow": 0, "totalRows": 0, "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/rebateagreement.save
- URL:https://companynode.pricefx.com/pricefx/companypartition/rebateagreement.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/rebateagreement.save \
-H 'Content-Type: application/json' \
-d '{
"data": {
"rebateAgreement": {
"version": null,
"typedId": null,
"uniqueName": null,
"label": "RBA001",
"targetDate": "2021-11-26",
"workflowStatus": "DRAFT",
"headerText": "",
"inputs": [
{
"name": "CustomerGroup",
"label": "Customer(s)",
"lookupTableId": null,
"url": null,
"type": "CUSTOMERGROUP",
"value": {
"customerFieldName": "customerId",
"customerFieldValue": "00003",
"customerFieldLabel": "customerId",
"customerHint": "Kate Smith"
},
"valueHint": "Kate Smith",
"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": {
"productFilterCriteria": {
"_constructor": "AdvancedCriteria",
"operator": "or",
"criteria": [
{
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "sku",
"operator": "iEquals",
"value": "11111"
}
]
},
{
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "sku",
"operator": "iEquals",
"value": "22222"
}
]
},
{
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "sku",
"operator": "iEquals",
"value": "33333"
}
]
}
]
},
"label": "SKU equals to 11111 or SKU equals to 22222 or SKU equals to 33333"
},
"valueHint": "SKU equals to 11111 or SKU equals to 22222 or SKU equals to 33333",
"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": null,
"createdByName": null,
"submittedByName": null,
"calculationStatus": 0,
"dirty": false,
"refreshInputs": false,
"nodeId": null,
"userGroupEdit": null,
"userGroupViewDetails": null,
"serverMessages": [
"Rebates calculated successfully"
],
"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-11-26",
"endDate": "2021-11-26",
"payoutDate": "2021-11-26",
"rebateRecordSetId": null,
"rebateRecordSetLabel": null,
"simulationSet": null,
"simulationType": null,
"status": "DRAFT",
"approvedByName": null,
"deniedByName": null,
"renderInfo": null,
"serverMessagesExtended": [
{
"key": null,
"message": "Rebates calculated successfully"
}
],
"approvalRequiredEmailAttachmentsJson": null,
"hasWorkflowHistory": false,
"createDate": "2021-11-26T13:42:10",
"createdBy": 2147490696,
"lastUpdateDate": "2021-11-26T13:42:10",
"lastUpdateBy": 2147490696,
"supersededBy": null,
"prevRev": null,
"rootUniqueName": null,
"headerRebateType": null,
"sellerName": null
}
}
}'Response
application/json
{ "response": { "node": "e2e-templates-node", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/rebateagreement.fetchitems
- URL:https://companynode.pricefx.com/pricefx/companypartition/rebateagreement.fetchitems
- 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.fetchitems \
-H 'Content-Type: application/json' \
-d '{
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"oldValues": null,
"distinctResults": false,
"data": {
"rebateAgreement": {
"label": "New Rebate Agreement",
"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
}
],
"outputs": [],
"nodeId": 0,
"userGroupEdit": null,
"userGroupViewDetails": null,
"lineItems": [],
"startDate": "2021-10-19",
"endDate": "2021-10-19"
},
"filterCriteria": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": []
}
},
"endRow": 300,
"sortBy": []
}'Response
application/json
{ "response": { "node": "string", "startRow": 0, "data": [ … ], "endRow": 0, "totalRows": 0, "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