Skip to content
Pricefx REST API
/Pricefx API Reference/
/
Update a Compensation Rec...

The Pricefx Backend API

Pricefx REST API Reference

Download OpenAPI description
pricefx-server_openapi.json
pricefx-server_openapi.yaml
Overview
URL
https://www.pricefx.com
Pricefx
documentation@pricefx.com
Languages
Servers
Mock server
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi
URL:
https://{baseUrl}/pricefx/{partition}

General

Operations

Products

Operations

Product Extensions

Operations

Product Image

Operations

Customers

Operations

Customer Extensions

Operations

Sellers

Operations

Seller Extensions

Operations

Condition Records

Operations

Competition Data

Operations

Imports

Operations

Data Change Requests

Operations

Lookup Tables / Company Parameters

Operations

User Admin

Operations

Authentication

Operations

Admin Tools

Operations

Logics

Operations

Logs

Operations

Custom Forms

Operations

Calculated Field Sets

Operations

Jobs & Tasks

Operations

Data Manager

Operations

Actions

Operations

Action Types

Operations

Price Lists

Operations

Manual Price Lists

Operations

Live Price Grids

Operations

Calculation Grids

Operations

Visual Configuration

Operations

Quotes

Operations

Contracts (Agreements & Promotions)

Operations

Visual Configuration

Operations

Rebate Agreements

Operations

Rebate Calculations

Operations

Rebate Record Group

Operations

Sales Compensations

Operations

List Compensation Records

Request

Retrieves all Compensation Records based on filter settings.

Security
basic or X-PriceFx-jwt
Path
compensationRecordSetIdstringrequired

ID of the CompensationRecordSet into which this Compensation Record belongs. By default it belongs to "Default" CompensationRecordSet, but you can change it when you create the Compensation Record. This can be useful if you create different "kinds" of Compensation Records which will be used to calculate different results at different times.

Bodyapplication/json
endRowinteger
oldValues(object or null)
Any of:
object or null
operationTypestring
startRowinteger
textMatchStylestring
dataobject
curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/compensationrecord.fetch/{compensationRecordSetId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "endRow": 300,
    "oldValues": null,
    "operationType": "fetch",
    "startRow": 0,
    "textMatchStyle": "exact",
    "data": {
      "_constructor": "AdvancedCriteria",
      "operator": "and",
      "criteria": [
        {
          "fieldName": "sourceId",
          "operator": "equals",
          "value": "CO-158"
        }
      ]
    }
  }'

Responses

OK

Bodyapplication/json
responseobject
Response
application/json
No response example

Update a Compensation Record

Request

Updates a CompensationRecord object.

Security
basic or X-PriceFx-jwt
Bodyapplication/json
dataobject(CompensationRecord)

The CompensationRecord object. The type code is COR.

curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/compensationrecord.update \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "typedId": "string",
      "resultPrice": 0,
      "endDate": null,
      "workflowStatus": "DRAFT",
      "intgStatus": "string",
      "payoutDate": null,
      "priceChangePct": 0,
      "attribute83": "string",
      "attribute82": "string",
      "intgStatusDetails": "string",
      "attribute81": "string",
      "attribute80": "string",
      "sourceIdNoRev": "string",
      "rank": 0,
      "attribute89": "string",
      "attribute88": "string",
      "sku": "string",
      "attribute87": "string",
      "attribute86": "string",
      "calculationResults": [
        {
          "resultName": "string",
          "resultLabel": "string",
          "result": {},
          "excludeFromExport": true,
          "warnings": [
            "string"
          ],
          "alertMessage": "string",
          "alertType": "CRITICAL",
          "displayOptions": 0,
          "formatType": "NUMERIC",
          "suffix": "string",
          "resultType": "string",
          "cssProperties": "string",
          "userGroup": "string",
          "resultGroup": "string",
          "overrideValueOptions": [
            null
          ],
          "overrideAllowEmpty": true,
          "labelTranslations": "string",
          "overridable": true,
          "overridden": true,
          "resultDescription": "string"
        }
      ],
      "attribute85": "string",
      "attribute84": "string",
      "unitOfMeasure": "string",
      "agreementTerms": {
        "Target": "string",
        "Compensation": "string",
        "Payment Period": "string",
        "property1": {},
        "property2": {}
      },
      "targetDate": "2019-08-24T14:15:22Z",
      "allowedOverrides": "string",
      "version": 0,
      "alerts": "string",
      "attribute9": "string",
      "attribute94": "string",
      "attribute8": "string",
      "attribute93": "string",
      "attribute92": "string",
      "attribute91": "string",
      "attribute5": "string",
      "attribute90": "string",
      "attribute4": "string",
      "attribute7": "string",
      "attribute6": "string",
      "attribute1": "string",
      "attribute14": "string",
      "messages": [
        "string"
      ],
      "attribute13": "string",
      "userGroupEdit": "string",
      "attribute3": "string",
      "attribute12": "string",
      "attribute2": "string",
      "attribute11": "string",
      "attribute99": "string",
      "attribute10": "string",
      "attribute98": "string",
      "attribute97": "string",
      "startDate": "2019-08-24T14:15:22Z",
      "attribute96": "string",
      "status": "DRAFT",
      "attribute95": "string",
      "formulaName": "string",
      "itemExtensions": {},
      "agreementClass": "string",
      "attribute19": "string",
      "attribute18": "string",
      "attribute17": "string",
      "attribute16": "string",
      "attribute15": "string",
      "sellerName": "string",
      "manual": true,
      "calculationDate": "2019-08-24T14:15:22Z",
      "manualOverrides": "string",
      "calculationBaseAsAdvancedFilterCriteria": {
        "_constructor": "string",
        "property1": {},
        "property2": {}
      },
      "parentTypedId": "string",
      "attribute25": "string",
      "submittedByName": "string",
      "attribute24": "string",
      "currency": "string",
      "attribute23": "string",
      "attribute22": "string",
      "attribute21": "string",
      "attribute20": "string",
      "createDate": "2019-08-24T14:15:22Z",
      "calculationBase": {
        "includedCustomerGroups": [
          {}
        ],
        "includedProductGroups": [
          {}
        ],
        "includedSellerReferences": [
          {}
        ],
        "excludedCustomerGroups": [
          {}
        ],
        "excludedproductGroups": [
          {}
        ],
        "excludedSellerReferences": [
          {}
        ],
        "includedTimePeriods": [
          {
            "timeUnit": "DAY",
            "startDate": "2019-08-24T14:15:22Z",
            "endDate": "2019-08-24T14:15:22Z",
            "single": true
          }
        ],
        "excludedTimePeriods": [
          {}
        ],
        "otherFilters": [
          "string"
        ],
        "dateDimFieldName": "string"
      },
      "approvalRequiredEmailAttachments": [
        null
      ],
      "attribute29": "string",
      "compensationStatus": "DRAFT",
      "attribute28": "string",
      "attribute27": "string",
      "attribute26": "string",
      "lineId": "string",
      "completeResultsAvailable": "s",
      "attribute36": "string",
      "attribute35": "string",
      "attribute34": "string",
      "attribute33": "string",
      "attribute32": "string",
      "attribute31": "string",
      "intgStatusErpReference": "string",
      "attribute30": "string",
      "sourceId": "string",
      "seller": {
        "sellerId": "string",
        "sellerName": "string"
      },
      "key2": "string",
      "attribute39": "string",
      "inputs": [
        {
          "name": "string",
          "label": "string",
          "lookupTableId": "string",
          "url": "string",
          "type": "string",
          "value": {},
          "valueHint": "string",
          "readOnly": true,
          "filter": {
            "property1": {},
            "property2": {}
          },
          "parameterGroup": "string",
          "required": true,
          "labelTranslations": "string",
          "addUnknownValues": true,
          "typedId": "string",
          "alwaysEditable": true,
          "inputs": [
            {}
          ],
          "parameterConfig": {
            "property1": {},
            "property2": {}
          },
          "formattingOptions": {
            "property1": {},
            "property2": {}
          },
          "valueOptions": [
            "string"
          ]
        }
      ],
      "lastUpdateDate": "2019-08-24T14:15:22Z",
      "attribute38": "string",
      "attribute37": "string",
      "compensationHeaderType": "string",
      "compensationRecordSetLabel": "string",
      "deniedByName": "string",
      "attribute47": "string",
      "attribute46": "string",
      "userGroupViewDetails": "string",
      "approvedByName": "string",
      "attribute45": "string",
      "attribute44": "string",
      "attribute43": "string",
      "attribute42": "string",
      "attribute41": "string",
      "attribute40": "string",
      "priceChange": 0,
      "agreementInputs": [
        {}
      ],
      "customerGroup": {
        "label": "string",
        "customerFieldName": "string",
        "customerFieldLabel": "string",
        "customerFieldValue": "string",
        "customerFilterCriteria": {
          "property1": {},
          "property2": {}
        }
      },
      "attribute49": "string",
      "attribute48": "string",
      "attribute50": "string",
      "attribute100": "string",
      "uniqueName": "string",
      "calculatedResultPrice": 0,
      "name": "string",
      "attribute58": "string",
      "attribute57": "string",
      "attribute56": "string",
      "attribute55": "string",
      "productFilterString": "string",
      "hasWorkflowHistory": true,
      "attribute54": "string",
      "attribute53": "string",
      "attribute52": "string",
      "allCalculationResults": [
        {
          "property1": {},
          "property2": {}
        }
      ],
      "attribute51": "string",
      "calculationBaseJson": "string",
      "approvalDate": "2019-08-24T14:15:22Z",
      "recordSetLabel": "string",
      "attribute59": "string",
      "description": "string",
      "compensationRecordSetId": 0,
      "attribute61": "string",
      "attribute60": "string",
      "customerFilterString": "string",
      "previousPrice": 0,
      "attribute69": "string",
      "formulaElementGroup": "string",
      "attribute68": "string",
      "attribute67": "string",
      "calculatedWithErrorsMsg": "SUCCESS",
      "attribute66": "string",
      "attribute65": "string",
      "attribute64": "string",
      "attribute63": "string",
      "attribute62": "string",
      "workStatus": "string",
      "manualResultPrice": 0,
      "compensationConditionType": "string",
      "comments": "string",
      "warnings": "string",
      "approvalState": "NOT_APPROVED",
      "label": "string",
      "calculatedMsg": "SUCCESS",
      "agreementInputsAsMap": {
        "property1": {},
        "property2": {}
      },
      "attribute72": "string",
      "attribute71": "string",
      "attribute70": "string",
      "productGroup": {
        "label": "string",
        "productFieldName": "string",
        "productFieldLabel": "string",
        "productFieldValue": "string",
        "productFilterCriteria": {
          "property1": {},
          "property2": {}
        }
      },
      "createdBy": 0,
      "calculationStatus": 0,
      "attribute79": "string",
      "attribute78": "string",
      "attribute77": "string",
      "attribute76": "string",
      "attribute75": "string",
      "attribute74": "string",
      "lastUpdateBy": 0,
      "attribute73": "string"
    }
  }'

Responses

OK

Bodyapplication/json
responseobject
Response
application/json
{
  "response": {
    "node": "string",
    "data": [ … ],
    "status": 0
  }
}

Revoke a Compensation Record

Request

The Revoke action is available only for approved records. This action is useful when the Compensation Record was approved in Pricefx, integration did not happen yet and there is nothing to reverse in ERP. When this action is used, the record changes its status to Revoked.
The Administer Compensation Records user role is needed to perform the Revoke action.

Security
basic or X-PriceFx-jwt
Path
typedIdstringrequired

typedId of the Compensation Record you want to revoke.

curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/compensationrecord.revoke/{typedId}'

Responses

A general response that contains data property with a content depending on returned objects (e.g., Product master table fields when calling the /fetch/P endpoint). Can be null.

Bodyapplication/json
responseobject
Response
application/json
{
  "response": {
    "node": "string",
    "data": null,
    "status": 0,
    "startRow": 0,
    "endRow": 0
  }
}

Claim Types

Operations

Claims

Operations

Optimization

Operations

Workflow

Operations

Workflow Delegation

Operations

Attachments

To upload a file you need to perform the following actions using endpoints in this category:

  1. Create an Upload Slot
  2. Upload a File
  3. Delete an Upload Slot
Operations

Product Image

Operations

Configuration

Operations

Internationalization

Operations

Metadata

Operations

Clicmanager

Clicmanager (CLIC = "Calculable Line Item Collection") endpoints are used in the REACT version to manipulate Quote/Agreements & Promotions (Contract)/Rebate Agreement/Compensation Plan objects.

Operations

Comments

Operations

Notifications

Operations

Heartbeat

Operations

Key-Value Store

See the Key-Value Database Storage Knowledge Base article for more details.

Operations

Entities

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.

otherSchemas

Schemas