Pricefx REST API Reference
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 Claims. A filter can be applied (for example, to retrieve a particular Claim with the specified name).
| Required Permission | Roles with the Required Permission |
|---|---|
| CLAIM_FETCH | Investigate for Support (SUPPORT), Administer Plasma (PLASMA), Manage Claims (CLM_CLAIMMANAGER), Use Claims (CLM_CLAIM) |
Security
basic or X-PriceFx-jwt
The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.
Default 300
The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results.
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/fetch/CL
- URL:https://companynode.pricefx.com/pricefx/companypartition/fetch/CL
- 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/CL \
-H 'Content-Type: application/json' \
-d '{
"operationType": "fetch",
"textMatchStyle": "exact",
"data": {
"fieldName": "uniqueName",
"operator": "equals",
"value": "CL-24",
"_constructor": "AdvancedCriteria"
},
"oldValues": null
}'Response
application/json
{ "response": { "status": 0, "startRow": 0, "node": "pricefx-cluster-app-frontend-7f9df79f47-5pp4l", "data": [ … ], "endRow": 1 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/update/CL
- URL:https://companynode.pricefx.com/pricefx/companypartition/update/CL
- 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/update/CL \
-H 'Content-Type: application/json' \
-d '{
"operationType": "update",
"textMatchStyle": "exact",
"data": {
"typedId": "24.CL",
"version": 7,
"fileHandle": "1140.BD@0",
"fileName": "DataExport-1664881422978_CLAIMS.xlsx"
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-7b54f8ddf6-hwfnn", "data": [ … ], "status": 0 } }
Request
Calculates a Claim (runs the validation logic on all items. Creates a calculation job (JST). It does not read the data from the uploaded Excel file again but works with the (potentially edited) data that are already loaded in the system.
You can also send items within the request body (no Excel file needed) – see the request example (calculateClaimRequestExample) for the request body structure.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/claimmanager.calculate/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/claimmanager.calculate/{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/claimmanager.calculate/24.CL \
-H 'Content-Type: application/json' \
-d '{
"data": {
"columnNames": [
"ProductID",
"EndCustomerID",
"ClaimQuantity",
"TotalClaimAmount",
"QuoteID",
"QuoteValidFrom",
"QuoteValidTo",
"QuoteDiscountPerItemPercent",
"InvoicePricePerItem",
"NetPricePerItem",
"DiscountPerItemAmount"
],
"data": [
{
"ProductID": "CLPRD-3",
"EndCustomerID": "EndCustomer1",
"ClaimQuantity": "2",
"TotalClaimAmount": "23",
"QuoteID": "P-2147483919",
"QuoteValidFrom": "2022-10-13",
"QuoteValidTo": "2023-04-25",
"QuoteDiscountPerItemPercent": "5",
"InvoicePricePerItem": "100",
"NetPricePerItem": "95",
"DiscountPerItemAmount": "5"
}
]
}
}'Response
application/json
{ "response": { "node": "node", "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