Skip to content
Pricefx REST API
/Pricefx API Reference/
/
List Rebate Agreements

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

List Rebate Agreements

Request

Retrieves a list of rebate agreements.

Required PermissionRoles with the Required Permission
REBATEAGREEMENT_FETCHInvestigate 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
Bodyapplication/json
endRownumber
oldValuesany
operationTypestringnon-empty
startRownumber
textMatchStylestringnon-empty
dataobject
sortByArray of strings
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"
    ]
  }'

Responses

OK

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

Upsert a Rebate Agreement

Request

Creates or updates a Rebate Agreement. Assigns new uniqueName when a new Rebate Agreement is created. To update a Rebate Agreement, specify an existing uniqueName.

This endpoint is not allowed to modify the document status and workflow status.

Security
basic or X-PriceFx-jwt
Bodyapplication/json
dataobject
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
      }
    }
  }'

Responses

Example response

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

List Rebate Agreement Items

Request

Retrieves Rebate Agreement Items. A filter can be applied.

Security
basic or X-PriceFx-jwt
Bodyapplication/json
operationTypestringnon-empty
startRownumber
textMatchStylestringnon-empty
oldValuesany
distinctResultsboolean
dataobject
endRownumber
sortByArray of objects
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": []
  }'

Responses

OK

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

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

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