List CLIC Objects

post/clicmanager.fetch/{typedId}

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.

Securitybasic or X-PriceFx-jwt
Request
path Parameters
typedId
required
string

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

query Parameters
noComplexResults
boolean

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.

getMyItemsForReview
boolean

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.

Request Body schema: application/json
endRow
integer
oldValues
object or null
operationType
string
startRow
integer
textMatchStyle
string
object
operator
string
_constructor
string
Array of objects
Array
fieldName
string
operator
string
Responses
200

OK

Response Schema: application/json
object
node
string
startRow
integer
Array of objects
Array
version
integer
typedId
string
clicId
integer
Array of objects
Array of objects
dirty
boolean
lineId
string
calculationStatus
integer
editabilityStatus
integer
label
string
startDate
string
endDate
string
payoutDate
string
calculationBaseJson
string
object
folder
boolean
treeLabel
string
createDate
string
createdBy
integer
lastUpdateDate
string
lastUpdateBy
integer
compensationConditionType
string
compensationConditionTypeLabel
string
endRow
integer
totalRows
integer
status
integer
Request samples
application/json
{
  • "endRow": 0,
  • "oldValues": { },
  • "operationType": "string",
  • "startRow": 0,
  • "textMatchStyle": "string",
  • "data": {
    • "operator": "string",
    • "_constructor": "string",
    • "criteria": [
      • {
        • "fieldName": "string",
        • "operator": "string"
        }
      ]
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "startRow": 0,
    • "data": [
      • {
        • "version": 0,
        • "typedId": "string",
        • "clicId": 0,
        • "inputs": [
          ],
        • "outputs": [
          ],
        • "dirty": true,
        • "lineId": "string",
        • "calculationStatus": 0,
        • "editabilityStatus": 0,
        • "label": "string",
        • "startDate": "string",
        • "endDate": "string",
        • "payoutDate": "string",
        • "calculationBaseJson": "string",
        • "calculationBase": {
          },
        • "folder": true,
        • "treeLabel": "string",
        • "createDate": "string",
        • "createdBy": 0,
        • "lastUpdateDate": "string",
        • "lastUpdateBy": 0,
        • "compensationConditionType": "string",
        • "compensationConditionTypeLabel": "string"
        }
      ],
    • "endRow": 0,
    • "totalRows": 0,
    • "status": 0
    }
}