List Compensation Plans

post/fetch/CO

Retrieves Compensation Plans. A filter can be applied.

Securitybasic or X-PriceFx-jwt

Request

Request Body schema: application/json

endRow

integer

oldValues

object or null

operationType

string

startRow

integer

textMatchStyle

string

object

_constructor

string

operator

string

Array of objects

Array

fieldName	string
operator	string
value	string

Responses

200

Response Schema: application/json

object

node

string

startRow

integer

Array of objects (Compensation)

Array

	Array of objects or null Header results calculated for the Compensation Plan by the compensation header logic. Usually a summary / overall results for the whole agreement.
createdByName	string <= 255 characters
typedId	string
headerText	string or null
successfulCalculationMsg	string Possible values: "SUCCESS" "COMMAND_GENERAL_ERROR" "COMMAND_GENERAL_ERROR_WITH_MSG" "COMMAND_GENERAL_ERROR_CONFLICT" "COMMAND_GENERAL_ERROR_CONFLICT_FIELD" "COMMAND_NOT_FOUND" "COMMAND_CONFIG_ERROR" "COMMAND_CONTEXT_PATH_NOTFOUND" "COMMAND_NOT_AUTHORIZED" "COMMAND_INVALID_PARAMETERS" "COMMAND_FORBIDDEN_IN_K8S" "COMMAND_FORBIDDEN_IN_READONLYMODE" "COMMAND_FORM_TOO_LARGE" "OBJECT_NOT_FOUND" "LOGIN_FAILURE" "LOGIN_FAILURE_BANNED" "LOGIN_FAILURE_TFA" "LOGIN_FAILURE_INACTIVE_OR_EXPIRED" "PARTITION_UNKNOWN" "COPY_OF_PREFIX" … 382 more
endDate	string or null The last day of validity.
workflowStatus	string <= 255 characters Possible values: "DRAFT" "SUBMITTED" "DENIED" "APPROVED" "NO_APPROVAL_REQUIRED" "WITHDRAWN" "INVALIDATED"
	Array of objects or null Custom header input fields, created by the compensation header logic. It is used by the user to enter values/conditions needed to calculate the results.
lastUpdateDate	string <date-time>
readOnlyLineItemClass	string
compensationHeaderType	string or null
	Array of objects or null
compensationRecordSetLabel	string or null <= 255 characters
payoutDate	string or null The date on which the seller expects to receive the compensation money. If there are more payout periods during the Contract duration, such dates will be specified via custom input fields.
deniedByName	string or null
	Array of objects
userGroupViewDetails	string or null <= 255 characters
approvedByName	string or null
creationWorkflowCurrentStep	integer or null The order of the current active creation step. The first step is the number 0.
rootUniqueName	string
originUniqueName	string or null
targetDate	string or null Stands for a "calculation date" – a date which will be used to distinguish which data are used for calculation. Its value is used automatically by the system when retrieving proper versions of Company Parameters. You can also use it the logic to select correct data which change in time.
customerGroup	object or null A selection of customers (usually based on the customer hierarchy) the plan is intended for.
	string or object
originDeleted	boolean
version	integer
uniqueName	string <= 255 characters ID of the plan, generated by the system. The prefix of the uniqueName can be modified in Administration > Configuration > System Configuration > Advanced Configuration Options.
serverMessages	Array of strings or null
creationWorkflowStatus	string or null <= 255 characters Possible values: "DRAFT" "INPROGRESS" "FINISHED" null
userGroupEdit	string or null <= 255 characters
conditionTypeClass	string
hasWorkflowHistory	boolean
nodeId	integer
startDate	string or null The first day of validity of conditions negotiated on the Compensation Plan header & lines.
status	string <= 255 characters Possible values: "DRAFT" "PENDING" "SCHEDULED" "PROCESSING" "SCHEDULED_DIRTY" "ERROR" "READY" "CANCELLED"
lastUpdateByName	string <= 255 characters
originClicId	integer or null
	object or null
	object or null
creationWorkflowStepCount	integer or null The total number of all creation steps.
	(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null) or (object or null) A selection of sellers (usually based on the seller hierarchy) the plan is intended for.
compensationRecordSetId	integer or null
creationWorkflowStepLabel	string or null <= 255 characters The label of the current creation workflow step.
formulaElementGroupReadOnly	string
submittedByName	string or null <= 255 characters
formulaElementGroup	string
createDate	string <date-time>
dirty	boolean
additionalInfo4	string or null <= 255 characters
additionalInfo3	string or null <= 255 characters
refreshInputs	boolean
additionalInfo2	number or null
additionalInfo1	number or null
numberOfAttachments	integer
compensationStatus	string <= 255 characters Status of the Compensation Plan. Possible values: "DRAFT" "APPROVED" "OPEN" "CLOSED" "REVOKED" "SUPERSEDED" "INVALIDATED"
originLabel	string or null <= 255 characters
simulationType	string or null <= 255 characters
label	string <= 255 characters The name of the Compensation Plan entered by the user.
nextRevUNs	Array of strings
simulationSet	string or null <= 255 characters
createdBy	integer
calculationWithErrorsMsg	string Possible values: "SUCCESS" "COMMAND_GENERAL_ERROR" "COMMAND_GENERAL_ERROR_WITH_MSG" "COMMAND_GENERAL_ERROR_CONFLICT" "COMMAND_GENERAL_ERROR_CONFLICT_FIELD" "COMMAND_NOT_FOUND" "COMMAND_CONFIG_ERROR" "COMMAND_CONTEXT_PATH_NOTFOUND" "COMMAND_NOT_AUTHORIZED" "COMMAND_INVALID_PARAMETERS" "COMMAND_FORBIDDEN_IN_K8S" "COMMAND_FORBIDDEN_IN_READONLYMODE" "COMMAND_FORM_TOO_LARGE" "OBJECT_NOT_FOUND" "LOGIN_FAILURE" "LOGIN_FAILURE_BANNED" "LOGIN_FAILURE_TFA" "LOGIN_FAILURE_INACTIVE_OR_EXPIRED" "PARTITION_UNKNOWN" "COPY_OF_PREFIX" … 382 more
approvalRequiredEmailAttachmentsJson	string or null
	object or null Contains some (limited) information about the state of the front-end application. See View State.
prevRev	string or null
calculationStatus	integer
supersededBy	string or null
lastUpdateBy	integer

endRow

integer

totalRows

integer

status

integer

Request samples

application/json

{"endRow": 300,
"oldValues": null,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"data": {"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [{"fieldName": "workflowStatus",
"operator": "equals",
"value": "SUBMITTED"
}
]
}
}

Response samples

application/json

{"response": {"node": "node1",
"csrfToken": "token",
"startRow": 0,
"data": [{"version": 6,
"typedId": "1.CO",
"uniqueName": "CO-1",
"label": "New Compensation Plan",
"targetDate": "2022-04-28",
"workflowStatus": "DRAFT",
"lastUpdateByName": "billy.graham",
"createdByName": "billy.graham",
"calculationStatus": 0,
"dirty": true,
"refreshInputs": false,
"nodeId": 0,
"numberOfAttachments": 0,
"startDate": "2022-04-28",
"endDate": "2022-04-28",
"payoutDate": "2022-04-28",
"status": "DRAFT",
"compensationStatus": "DRAFT",
"conditionTypeClass": "net.pricefx.domain.CompensationConditionType",
"formulaElementGroup": "compensation",
"readOnlyLineItemClass": "net.pricefx.domain.CompensationReadOnlyLineItem",
"calculationWithErrorsMsg": "COMPENSATION_CALCULATED_WITHERRORS",
"formulaElementGroupReadOnly": "compensationReadOnly",
"successfulCalculationMsg": "COMPENSATION_CALCULATED",
"hasWorkflowHistory": false,
"createDate": "2022-04-28T09:58:56",
"createdBy": 492,
"lastUpdateDate": "2022-04-28T14:07:04",
"lastUpdateBy": 492,
"rootUniqueName": "CO-1"
},
{"version": 143,
"typedId": "9.CO",
"uniqueName": "CO-9",
"label": "Test Migration",
"targetDate": "2022-05-09",
"workflowStatus": "SUBMITTED",
"lastUpdateByName": "tram1",
"createdByName": "tram1",
"submittedByName": "tram1",
"calculationStatus": 2,
"dirty": false,
"refreshInputs": false,
"nodeId": 0,
"numberOfAttachments": 0,
"startDate": "2022-01-01",
"endDate": "2022-12-31",
"payoutDate": "2022-05-09",
"status": "DRAFT",
"compensationStatus": "DRAFT",
"conditionTypeClass": "net.pricefx.domain.CompensationConditionType",
"formulaElementGroup": "compensation",
"readOnlyLineItemClass": "net.pricefx.domain.CompensationReadOnlyLineItem",
"calculationWithErrorsMsg": "COMPENSATION_CALCULATED_WITHERRORS",
"formulaElementGroupReadOnly": "compensationReadOnly",
"successfulCalculationMsg": "COMPENSATION_CALCULATED",
"approvalRequiredEmailAttachmentsJson": "[{\"fieldName\":\"id\",\"operator\":\"inSet\",\"value\":[],\"_constructor\":\"AdvancedCriteria\"}]",
"hasWorkflowHistory": true,
"approvedByName": "tram1",
"createDate": "2022-05-09T06:20:21",
"createdBy": 290,
"lastUpdateDate": "2022-05-11T07:42:22",
"lastUpdateBy": 290,
"rootUniqueName": "CO-9",
"compensationHeaderType": "[SC] Direct Compensation"
},
{"version": 60,
"typedId": "15.CO",
"uniqueName": "CO-15",
"label": "Test migration 2",
"targetDate": "2022-05-11",
"workflowStatus": "DRAFT",
"lastUpdateByName": "tram1",
"createdByName": "tram1",
"calculationStatus": 2,
"dirty": false,
"refreshInputs": false,
"nodeId": 0,
"numberOfAttachments": 0,
"sellerGroup": {"sellerFilterCriteria": {"_constructor": "AdvancedCriteria",
"criteria": [{"fieldName": "sellerId",
"operator": "inSet",
"value": ["SC-006"
]
}
],
"operator": "and"
}
},
"customerGroup": {"label": "B (Customer Class)",
"customerFieldName": "attribute3",
"customerFieldLabel": "Customer Class",
"customerFieldValue": "B"
},
"startDate": "2022-01-01",
"endDate": "2022-12-31",
"payoutDate": "2022-05-11",
"status": "DRAFT",
"compensationStatus": "DRAFT",
"conditionTypeClass": "net.pricefx.domain.CompensationConditionType",
"formulaElementGroup": "compensation",
"readOnlyLineItemClass": "net.pricefx.domain.CompensationReadOnlyLineItem",
"calculationWithErrorsMsg": "COMPENSATION_CALCULATED_WITHERRORS",
"formulaElementGroupReadOnly": "compensationReadOnly",
"successfulCalculationMsg": "COMPENSATION_CALCULATED",
"hasWorkflowHistory": false,
"createDate": "2022-05-11T09:02:59",
"createdBy": 290,
"lastUpdateDate": "2022-05-13T08:05:05",
"lastUpdateBy": 290,
"rootUniqueName": "CO-15",
"compensationHeaderType": "[SC] Direct Compensation"
}
],
"endRow": 3,
"totalRows": 92,
"status": 0
}
}