Mark an Offer as Lost (with reason)

post/clicmanager.setlostreason/{typedId}

Sets the specified Quote as LOST and sets the loss reason (lostReason). Optionally, an additional comment (lostReasonComment) can be added.
Returns the updated Quote object.

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

typedId of the Quote you want set as lost.

Example: 2147493285.Q
Request Body schema: application/json
required
object
lostReason
required
string

The name of the lost reason. The name of the reason must be set in Administration > Configuration > Quoting > Quote Reasons.

lostReasonComment
string

An additional comment.

Responses
200

OK

Response Schema: application/json
object (markOfferLostWithReasonResponse)
node
string
Array of objects (Quote)
Array
Array of objects or null
createdByName
string <= 255 characters
typedId
string
headerText
string
workflowStatus
string <= 255 characters
Possible values: "DRAFT" "SUBMITTED" "DENIED" "APPROVED" "NO_APPROVAL_REQUIRED" "WITHDRAWN" "INVALIDATED"
Array of objects or null
lastUpdateDate
string <date-time>
Array of objects or null
externalRef
string or null <= 255 characters
deniedByName
string or null
Array of objects
userGroupViewDetails
string or null <= 255 characters
approvedByName
string or null
creationWorkflowCurrentStep
integer or null
rootUniqueName
string
originUniqueName
string or null
targetDate
string or null <date>
customerGroup
string or null
object or string
originDeleted
boolean or null
version
integer
customerName
string or null <= 255 characters
uniqueName
string <= 255 characters
serverMessages
Array of strings or null
creationWorkflowStatus
string <= 255 characters
Possible values: "DRAFT" "INPROGRESS" "FINISHED"
userGroupEdit
string or null <= 255 characters
hasWorkflowHistory
boolean
nodeId
integer
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
lostReason
string or null <= 255 characters
object or null
creationWorkflowStepCount
integer or null
quoteType
string or null
quoteStatus
string <= 255 characters
Possible values: "DRAFT" "OFFER" "DEAL" "REVOKED" "SUPERSEDED" "INVALIDATED" "LOST" "PARTIALDEAL"
lostReasonComment
string or null <= 255 characters
expiryDate
string or null <date>
creationWorkflowStepLabel
string or null <= 255 characters
customerId
string or null <= 255 characters
submittedByName
string or null <= 255 characters
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
originLabel
string or null
label
string <= 255 characters
nextRevUNs
Array of strings
createdBy
integer
approvalRequiredEmailAttachmentsJson
string or null
object or null
prevRev
string or null
calculationStatus
integer
supersededBy
string or null
lastUpdateBy
integer
persistedClicId
integer or null
persistedClicVersion
integer
status
integer
Request samples
application/json
{
  • "data": {
    • "lostReason": "string",
    • "lostReasonComment": "string"
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "pricefx-cluster-app-frontend-689d96f98d-hnkt9",
    • "data": [
      • {
        • "version": 17,
        • "typedId": "2147493285.Q",
        • "uniqueName": "P-2147493285",
        • "label": "New Quote",
        • "targetDate": "2022-11-18",
        • "workflowStatus": "NO_APPROVAL_REQUIRED",
        • "inputs": null,
        • "viewState": null,
        • "outputs": null,
        • "lastUpdateByName": "admin",
        • "createdByName": "admin",
        • "submittedByName": "admin",
        • "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": "FINISHED",
        • "creationWorkflowCurrentStep": null,
        • "creationWorkflowStepCount": null,
        • "creationWorkflowStepLabel": null,
        • "originDeleted": false,
        • "originLabel": null,
        • "originUniqueName": null,
        • "signature": null,
        • "expiryDate": "2022-11-18",
        • "externalRef": null,
        • "customerId": null,
        • "customerName": null,
        • "originClicId": null,
        • "lostReason": "Reason2",
        • "lostReasonComment": "lost",
        • "customerGroup": null,
        • "quoteStatus": "LOST",
        • "approvalRequiredEmailAttachmentsJson": "[{\"fieldName\":\"id\",\"operator\":\"inSet\",\"value\":[],\"_constructor\":\"AdvancedCriteria\"}]",
        • "renderInfo": null,
        • "serverMessagesExtended": null,
        • "approvedByName": "admin",
        • "deniedByName": null,
        • "hasWorkflowHistory": false,
        • "createDate": "2022-11-18T14:21:47",
        • "createdBy": 2147490696,
        • "lastUpdateDate": "2022-11-18T14:22:41",
        • "lastUpdateBy": 2147490696,
        • "supersededBy": null,
        • "prevRev": null,
        • "rootUniqueName": "P-2147493285",
        • "quoteType": "__DEFAULT__",
        • "status": "DRAFT"
        }
      ],
    • "status": 0
    }
}