younifyd
Menu

/api/quotations/{refNo} (Update vq's docStatus by refNo)

update vq's docStatus by refNo.

PATCH/api/quotations/{refNo}

Use it in a workflow

  1. Add a step and choose the TradeBeyond connector.
  2. Pick the /api/quotations/{refNo} (Update vq's docStatus by refNo) action (under QuotationController).
  3. Fill in the fields below, then reference the result from later steps as {{apiQuotationsRefnoUpdateVqSDocstatusByRefno.response.data}}.

Request

Path parameters

refNostringrequired

Query parameters

statusstringrequired

One ofCONCEPTCOSTINGADOPTEDFINALIZEDNEWQUOTEDCONFIRMEDTOBUYREJECTEDTOBUYREVISEPROPOSEDOVERRIDDENSHORTLISTEDREMOVE_FROM_SHORTLISTSOURCINGPHASE_1_TRACKING_COMPLETEDMARK_AS_DEFAULTDRAFTCONFIRMEDOFFICIALSUBMITTEDREQUESTEDRELEASED_TO_VENDORVENDOR_CONFIRMEDBUYER_CONFIRMEDVENDOR_CHANGE_PROPOSEDVENDOR_REJECTEDBUYER_REJECTEDVENDOR_CONFIRMATION_SENTVENDOR_REJECTION_SENTCOMPLETEDSCHEDULEDPO_CHANGE_PROPOSEDCHANGE_ACCEPTEDCHANGE_REJECTEDPO_ACCEPTEDPO_REJECTEDOUT_OF_SIGNATURESIGNEDREVISION_REQUESTCLOSED

approvalTemplateIdstring
versioninteger (int32)
docStatusstringrequired

One ofACTIVEINACTIVECANCELED

Response

Returns 200 with an object. Read it in later steps with {{apiQuotationsRefnoUpdateVqSDocstatusByRefno.response.data.<field>}}.

idstring
refNostring
versioninteger (int32)
domainIdstring
statusstring
editingStatusstring
statusLabelstring
vqTypeobject
codestringrequired
namestring
versioninteger (int32)
countryOfOriginobject
codestringrequired
namestring
versioninteger (int32)
openCostingboolean
vendorobject
idstring
fromImportboolean
deleteCommentFieldInfoListarray<object>3 fields
get_overrideCreateUserstring
get_overrideCreateUserNamestring
get_overrideUpdateUserstring
get_overrideUpdateUserNamestring
get_overrideCreatedOnstring (date-time)
get_overrideUpdatedOnstring (date-time)
get_overrideStatusstring
versioninteger (int32)
refNostring
shortNamestring
businessNamestring
vendorCodestring
address1string
postalCodestring
isVendorAccessboolean
countryobject3 fields
referencestring
customFieldsobject1 fields
productCategoryListarray<object>3 fields
factoryobject
idstring
fromImportboolean
deleteCommentFieldInfoListarray<object>3 fields
get_overrideCreateUserstring
get_overrideCreateUserNamestring
get_overrideUpdateUserstring
get_overrideUpdateUserNamestring
get_overrideCreatedOnstring (date-time)
get_overrideUpdatedOnstring (date-time)
get_overrideStatusstring
refNostring
refVerinteger (int32)
businessNamestring
factCodestring
customFieldsobject1 fields
unitCostnumber
totalCostnumber
totalComponentCostsnumber
totalFormulaCostnumber
totalAdditionalCostsnumber
totalLabourCostsnumber
totalOtherChargesnumber
quoteDatestring (date)
effectiveFromstring (date)
expiryDatestring (date)
moqinteger (int32)
productLeadTimeinteger (int32)
incotermobject
codestringrequired
namestring
versioninteger (int32)
countryOfShipmentobject
codestringrequired
namestring
versioninteger (int32)
portOfLoadingobject
codestringrequired
namestring
versioninteger (int32)
shortDescriptionstring
vqNostring
currencyobject
codestringrequired
namestring
versioninteger (int32)
baseELCnumber
salesGrossProfitnumber
grossMarginnumber
itemobject
versioninteger (int32)
refNostring
itemNostring
itemNamestring
itemDescstring
masterEanstring
buyerItemNostring
masterCasePackinteger (int32)
eanTypeobject3 fields
customFieldsobject1 fields
vqCostSummaryRefstring
vqCostSummaryVerinteger (int32)
vqCostSummaryDomainIdstring
customFieldsobject
dynamicModelMapobject
vqCostSummaryListarray<object>
idstring
refNostring
revisioninteger (int32)
entityVersioninteger (int32)
domainIdstring
hubDomainIdstring
isForReferenceboolean
versioninteger (int32)
statusstring
docStatusstring
editingStatusstring
createUserstring
createUserNamestring
updateUserstring
updateUserNamestring
createdOnstring (date-time)
updatedOnstring (date-time)
integrationSourcestring
integrationStatusstring
integrationNotestring
isCpmInitializedboolean
isLatestboolean
templateNamestring
templateAltExRateFixednumber
docIdstring
costSheetNostring
allowAddDeleteElementsboolean
altExRateSourcestring
exRateAnchorDateFieldIdstring
altExRateSrcValuenumber
altExRateFixednumber
baseCostnumber
baseAltCostnumber
costnumber
altCostnumber
calErrorboolean
shortDescriptionstring
customerNamestring
vatnumber
colorOrPatternSeqinteger (int32)
vqobject
refNostring
versioninteger (int32)
domainIdstring
unitCostnumber
json
{
  "id": "string",
  "refNo": "string",
  "version": 0,
  "domainId": "string",
  "status": "string",
  "editingStatus": "string",
  "statusLabel": "string",
  "vqType": {
    "code": "string",
    "name": "string",
    "version": 0
  },
  "countryOfOrigin": {
    "code": "string",
    "name": "string",
    "version": 0
  },
  "openCosting": false,
  "vendor": {
    "id": "string",
    "fromImport": false,
    "deleteCommentFieldInfoList": [
      {
        "uiId": "string",
        "businessKey": "string",
        "internalSeqNo": 0
      }
    ],
    "get_overrideCreateUser": "string",
    "get_overrideCreateUserName": "string",
    "get_overrideUpdateUser": "string",
    "get_overrideUpdateUserName": "string",
    "get_overrideCreatedOn": "2025-01-01T00:00:00Z",
    "get_overrideUpdatedOn": "2025-01-01T00:00:00Z",
    "get_overrideStatus": "string",
    "version": 0,
    "refNo": "string"
  },
  "factory": {
    "id": "string",
    "fromImport": false,
    "deleteCommentFieldInfoList": [
      {
        "uiId": "string",
        "businessKey": "string",
        "internalSeqNo": 0
      }
    ],
    "get_overrideCreateUser": "string",
    "get_overrideCreateUserName": "string",
    "get_overrideUpdateUser": "string",
    "get_overrideUpdateUserName": "string",
    "get_overrideCreatedOn": "2025-01-01T00:00:00Z",
    "get_overrideUpdatedOn": "2025-01-01T00:00:00Z",
    "get_overrideStatus": "string",
    "refNo": "string",
    "refVer": 0
  }
}

Need more? See the TradeBeyond guide for connection setup and behaviour shared by every action.

/api/quotations/{refNo} (Update vq's docStatus by refNo) — TradeBeyond — Documentation