Create a Quote

post/clicmanager.create/{TypeCode}

Creates a Quote (Q) or a Temporary Quote (QTMP).

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

Enter the type code of the entity you want to create.

Possible values: "Q" "QTMP"
Example: Q
Request Body schema: application/json
object
object (Quote)

The type code is Q.

Array of objects or null
Array
resultName
string
resultLabel
string
result
object
excludeFromExport
boolean
warnings
Array of strings
alertMessage
string
alertType
string
Possible values: "CRITICAL" "RED" "YELLOW"
displayOptions
integer
formatType
string
Possible values: "NUMERIC" "NUMERIC_LONG" "MONEY" "PERCENT" "TEXT" "MONEY_EUR" "MONEY_USD" "MONEY_GBP" "MONEY_JPY" "MONEY_CHF" "MONEY_PLN" "DATETIME" "DATE" "INTEGER" "LINK" "COMPLEX" "SPARKLINE"
suffix
string
resultType
string
cssProperties
string
userGroup
string
resultGroup
string
overrideValueOptions
Array of any
overrideAllowEmpty
boolean
labelTranslations
string
overridable
boolean
overridden
boolean
resultDescription
string
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
Array
name
string
label
string
lookupTableId
string
url
string
type
string
value
object
valueHint
string
readOnly
boolean
object
parameterGroup
string
required
boolean
labelTranslations
string
addUnknownValues
boolean
typedId
string
alwaysEditable
boolean
inputs
Array of objects
object
object
valueOptions
Array of strings
lastUpdateDate
string <date-time>
Array of objects or null
Array
key
string
message
string
externalRef
string or null <= 255 characters
deniedByName
string or null
Array of objects
Array
version
integer
typedId
string
clicId
integer
inputs
Array of objects
outputs
Array of objects
dirty
boolean
lineId
string
parentId
string
calculationStatus
integer
editabilityStatus
integer
label
string
containsProductImage
boolean
sku
string
priceRecordId
integer
folder
boolean
treeLabel
string
createDate
string
createdBy
integer
lastUpdateDate
string
lastUpdateBy
integer
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
Any of:
object
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
property name*
additional property
object
lostReason
string or null <= 255 characters
object or null
envelopeId
string
status
string
Possible values: "sent" "delivered" "signed" "completed" "declined" "voided" "processing" "error" "cancelling"
sentDateTime
string
statusChangedDateTime
string
customerName
string
customerUserOrEmail
string
sender
integer
senderName
string
templateName
string
note
string
voidedReason
string
error
string
history
Array of objects
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
gridViewState
string
openFolders
Array of strings
selectedNodes
Array of strings
prevRev
string or null
calculationStatus
integer
supersededBy
string or null
lastUpdateBy
integer
persistedClicId
integer or null
persistedClicVersion
integer
Responses
200

OK

Response Schema: application/json
object
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": {
    • "quote": {
      • "inputs": [
        • {
          }
        ],
      • "outputs": [ ],
      • "lineItems": [ ],
      • "label": "New Quote",
      • "quoteType": null,
      • "nodeId": 0,
      • "userGroupEdit": null,
      • "userGroupViewDetails": null,
      • "expiryDate": "2024-01-18",
      • "targetDate": "2024-01-18",
      • "externalRef": null,
      • "viewState": { }
      }
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "data": [
      • {
        • "outputs": [
          ],
        • "createdByName": "string",
        • "typedId": "string",
        • "headerText": "string",
        • "workflowStatus": "DRAFT",
        • "inputs": [
          ],
        • "lastUpdateDate": "2019-08-24T14:15:22Z",
        • "serverMessagesExtended": [
          ],
        • "externalRef": "string",
        • "deniedByName": "string",
        • "lineItems": [
          ],
        • "userGroupViewDetails": "string",
        • "approvedByName": "string",
        • "creationWorkflowCurrentStep": 0,
        • "rootUniqueName": "string",
        • "originUniqueName": "string",
        • "targetDate": "2019-08-24",
        • "customerGroup": "string",
        • "ioMeta": { },
        • "originDeleted": true,
        • "version": 0,
        • "customerName": "string",
        • "uniqueName": "string",
        • "serverMessages": [
          ],
        • "creationWorkflowStatus": "DRAFT",
        • "userGroupEdit": "string",
        • "hasWorkflowHistory": true,
        • "nodeId": 0,
        • "status": "DRAFT",
        • "lastUpdateByName": "string",
        • "originClicId": 0,
        • "renderInfo": {
          },
        • "lostReason": "string",
        • "signature": {
          },
        • "creationWorkflowStepCount": 0,
        • "quoteType": "string",
        • "quoteStatus": "DRAFT",
        • "lostReasonComment": "string",
        • "expiryDate": "2019-08-24",
        • "creationWorkflowStepLabel": "string",
        • "customerId": "string",
        • "submittedByName": "string",
        • "createDate": "2019-08-24T14:15:22Z",
        • "dirty": true,
        • "additionalInfo4": "string",
        • "additionalInfo3": "string",
        • "refreshInputs": true,
        • "additionalInfo2": 0,
        • "additionalInfo1": 0,
        • "numberOfAttachments": 0,
        • "originLabel": "string",
        • "label": "string",
        • "nextRevUNs": [
          ],
        • "createdBy": 0,
        • "approvalRequiredEmailAttachmentsJson": "string",
        • "viewState": {
          },
        • "prevRev": "string",
        • "calculationStatus": 0,
        • "supersededBy": "string",
        • "lastUpdateBy": 0,
        • "persistedClicId": 0,
        • "persistedClicVersion": 0
        }
      ],
    • "status": 0
    }
}