Send a Document to Sign

post/compensation.createsignature/{typedId}

Sends the template with the specified Compensation document data via the e-signature system (DocuSign) and returns the Compensation object.

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

typedId of the Compensation whose data you want to send via the e-signature system.

Example: 123.CO
Request Body schema: application/json
object
templateName
required
string
customerUserOrEmail
required
string
customerName
required
string
note
required
string
Responses
200

OK

Response Schema: application/json
object
node
string
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
status
integer
Request samples
application/json
{
  • "data": {
    • "templateName": "string",
    • "customerUserOrEmail": "string",
    • "customerName": "string",
    • "note": "string"
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "pricefx-cluster-app-frontend-6bdcf77bcd-9c7tx",
    • "data": [
      • {
        • "version": 23,
        • "typedId": "27.CO",
        • "uniqueName": "CO-27",
        • "label": "New Compensation Plan",
        • "targetDate": "2022-11-18",
        • "workflowStatus": "APPROVED",
        • "headerText": null,
        • "inputs": null,
        • "viewState": null,
        • "outputs": null,
        • "lastUpdateByName": "ondrej.tesar",
        • "createdByName": "ondrej.tesar",
        • "submittedByName": "ondrej.tesar",
        • "calculationStatus": 0,
        • "dirty": false,
        • "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,
        • "originDeleted": false,
        • "originLabel": null,
        • "originUniqueName": null,
        • "signature": {
          },
        • "lineItems": [ ],
        • "sellerGroup": null,
        • "customerGroup": null,
        • "productGroup": null,
        • "startDate": "2022-11-18",
        • "endDate": "2022-11-18",
        • "payoutDate": "2022-11-18",
        • "compensationRecordSetId": null,
        • "compensationRecordSetLabel": null,
        • "simulationSet": null,
        • "simulationType": null,
        • "status": "DRAFT",
        • "externalRef": null,
        • "originClicId": null,
        • "compensationStatus": "APPROVED",
        • "readOnlyLineItemClass": "net.pricefx.domain.CompensationReadOnlyLineItem",
        • "conditionTypeClass": "net.pricefx.domain.CompensationConditionType",
        • "formulaElementGroup": "compensation",
        • "formulaElementGroupReadOnly": "compensationReadOnly",
        • "successfulCalculationMsg": "COMPENSATION_CALCULATED",
        • "calculationWithErrorsMsg": "COMPENSATION_CALCULATED_WITHERRORS",
        • "approvalRequiredEmailAttachmentsJson": "[{\"fieldName\":\"id\",\"operator\":\"inSet\",\"value\":[],\"_constructor\":\"AdvancedCriteria\"}]",
        • "renderInfo": null,
        • "serverMessagesExtended": null,
        • "approvedByName": "ondrej.tesar",
        • "deniedByName": null,
        • "hasWorkflowHistory": true,
        • "createDate": "2022-11-18T11:01:15",
        • "createdBy": 2147490187,
        • "lastUpdateDate": "2022-11-18T11:04:24",
        • "lastUpdateBy": 2147490187,
        • "supersededBy": null,
        • "prevRev": null,
        • "rootUniqueName": "CO-27",
        • "compensationHeaderType": "__DEFAULT__"
        }
      ],
    • "status": 0
    }
}