/api/custInvs/{refNo} (Update item's docStatus by refNo)

update item's docStatus by refNo.

PATCH/api/custInvs/{refNo}

Use it in a workflow

Add a step and choose the TradeBeyond connector.
Pick the /api/custInvs/{refNo} (Update item's docStatus by refNo) action (under CustInvController).
Fill in the fields below, then reference the result from later steps as {{apiCustinvsRefnoUpdateItemSDocstatusByRefno.response.data}}.

Request

Path parameters

refNostringrequired

Query parameters

statusstringrequired

the status for marking.

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

approval template Id for 'request for approval'.

versioninteger (int32)

docStatusstringrequired

the docStatus for setting.

One ofactive, inactive, canceled

Response

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

idstring

fromImportboolean

deleteCommentFieldInfoListarray<object>

uiIdstring

businessKeystring

internalSeqNointeger (int32)

get_overrideCreateUserstring

get_overrideCreateUserNamestring

get_overrideUpdateUserstring

get_overrideUpdateUserNamestring

get_overrideCreatedOnstring (date-time)

get_overrideUpdatedOnstring (date-time)

get_overrideStatusstring

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

invNostring

remarksstring

shortDescriptionstring

invDatestring (date)

deliveryDatestring (date)

totalItemsinteger (int32)

totalQtyinteger (int32)

totalAmtnumber

totalAmtBeforeChargeTypenumber

json

{
  "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",
  "revision": 0
}

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

Was this page helpful?