Skip to content
Pricefx REST API
/Pricefx API Reference/
/
List CLIC Objects

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

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

Submit a Quote/Contract/Rebate Agreement

Request

Submits a Contract, Quote, or Rebate Agreement.

This endpoint is used in the REACT version only. It is not advisable to mix REACT endpoints together with Ember endpoints.

Security
basic or X-PriceFx-jwt
Path
typedIdstringrequired

The typedId of the Contract, Quote, or Rebate Agreement you want to submit.

Example: 127.CT
Bodyapplication/json
dataobject
curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.submit/127.CT \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "approvalRequiredEmailAttachments": [
        {
          "fieldName": "id",
          "operator": "inSet",
          "value": [],
          "_constructor": "AdvancedCriteria"
        }
      ]
    }
  }'

Responses

OK

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

List CLIC Objects

Request

Retrieves line items of the specified CLIC entity (Quote/Contract/Rebate Agreement/Compensation Plan Line Items).

This endpoint is used in the REACT version only. It is not advisable to mix REACT endpoints together with Ember endpoints.

Security
basic or X-PriceFx-jwt
Path
typedIdstringrequired

The typedId of the Quote/Contract/Rebate Agreement/Compensation Plan you want to retrieve line items for.

Query
noComplexResultsboolean

Set to true to exclude large results (e.g., charts, matrix table, etc.) from response. Use the /clicmanager.fetchoutput/{typedId}/{resultName} (e.g., /clicmanager.fetchoutput/2147490386.Q/FlexChart) to download the result separately.

getMyItemsForReviewboolean

The parameter is allowed only if Creation workflow is in Review step.
- if set to true - the line items assigned to a line item group in the Review step of the Creation workflow are returned.
- if set to false - the line items from other line item groups are returned.

Bodyapplication/json
endRowinteger
oldValuesobject or null
operationTypestring
startRowinteger
textMatchStylestring
dataobject
curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.fetch/{typedId}?noComplexResults=true&getMyItemsForReview=true' \
  -H 'Content-Type: application/json' \
  -d '{
    "endRow": 0,
    "oldValues": {},
    "operationType": "string",
    "startRow": 0,
    "textMatchStyle": "string",
    "data": {
      "operator": "string",
      "_constructor": "string",
      "criteria": [
        {
          "fieldName": "string",
          "operator": "string"
        }
      ]
    }
  }'

Responses

OK

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

Update a Quote/Contract/Rebate Agreement/Compensation Plan

Request

Updates a Quote, Contract, Rebate Agreement, or Compensation Plan.
attributeExtension can be updated as follows:

{
                "data": {
                    "typedId": "{typedId}",
                    "version": {version},
                    "attributeExtension___AttributeExtensionColumn2": "testValue"
                }
            }

This endpoint is not allowed to modify the document status and workflow status. This endpoint is used in the REACT version only. It is not advisable to mix REACT endpoints together with Ember endpoints.

Security
basic or X-PriceFx-jwt
Path
typedIdstringrequired

The typedId of the Compensation Plan you want to update.

Bodyapplication/json
dataQuote (object) or Compensation (object) or Contract (object) or RebateAgreement (object)
Any of:

The type code is Q.

curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.update/{typedId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "version": 10,
      "typedId": "8.CO",
      "uniqueName": "CO-8",
      "label": "New Compensation Plan",
      "targetDate": "2022-06-22",
      "workflowStatus": "DRAFT",
      "inputs": [
        {
          "name": "CustomerGroup",
          "label": "Customer(s)",
          "lookupTableId": null,
          "url": null,
          "type": "CUSTOMERGROUP",
          "value": {
            "customerFilterCriteria": {
              "_constructor": "AdvancedCriteria",
              "operator": "and",
              "criteria": [
                {
                  "fieldName": "customerId",
                  "operator": "inSet",
                  "value": [
                    "001",
                    "00001"
                  ]
                }
              ]
            },
            "label": "001,00001"
          },
          "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": "admin",
      "createdByName": "admin",
      "submittedByName": null,
      "calculationStatus": 0,
      "dirty": true,
      "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,
      "sellerGroup": null,
      "customerGroup": null,
      "startDate": "2022-06-22",
      "endDate": "2022-06-22",
      "payoutDate": "2022-06-22",
      "compensationRecordSetId": null,
      "compensationRecordSetLabel": null,
      "simulationSet": null,
      "simulationType": null,
      "status": "DRAFT",
      "compensationStatus": "DRAFT",
      "readOnlyLineItemClass": "net.pricefx.domain.CompensationReadOnlyLineItem",
      "formulaElementGroupReadOnly": "compensationReadOnly",
      "successfulCalculationMsg": "COMPENSATION_CALCULATED",
      "calculationWithErrorsMsg": "COMPENSATION_CALCULATED_WITHERRORS",
      "conditionTypeClass": "net.pricefx.domain.CompensationConditionType",
      "formulaElementGroup": "compensation",
      "approvalRequiredEmailAttachmentsJson": null,
      "renderInfo": null,
      "serverMessagesExtended": null,
      "approvedByName": null,
      "deniedByName": null,
      "hasWorkflowHistory": false,
      "createDate": "2022-06-22T11:44:40",
      "createdBy": 2147490696,
      "lastUpdateDate": "2022-06-22T11:55:08",
      "lastUpdateBy": 2147490696,
      "supersededBy": null,
      "prevRev": null,
      "rootUniqueName": "CO-8",
      "ioMeta": {
        "inputs": {},
        "outputs": {}
      },
      "compensationHeaderType": null,
      "headerText": "<p>testno</p>"
    }
  }'

Responses

OK

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

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