younifyd
Menu

/api/vpoAcks (Execute vpo action)

Execute vpo action

POST/api/vpoAcks

Use it in a workflow

  1. Add a step and choose the TradeBeyond connector.
  2. Pick the /api/vpoAcks (Execute vpo action) action (under VpoAckController).
  3. Fill in the fields below, then reference the result from later steps as {{apiVpoacksExecuteVpoAction.response.data}}.

Request

Query parameters

actionstringrequired

One ofNONEREFRESH_ITEMSAMENDEDITEDIT_CANCELSAVELOAD_DOCSAVE_AND_CONFIRMLOAD_VIEW_DEFINITIONDONE_DOCSEND_TO_VENDORSEND_TO_BUYERMARK_AS_OUT_OF_SIGNATUREMARK_AS_SIGNEDSEND_REMINDER_TO_VENDORSUBMITSET_TO_ACTIVESET_TO_INACTIVESET_TO_CANCELEDSET_AS_DEFAULTMARK_AS_CONCEPTMARK_AS_COSTINGMARK_AS_ADOPTEDMARK_AS_FINALIZEDMARK_AS_QUOTEDMARK_AS_SHORTLISTEDREMOVE_FROM_SHORTLISTMARK_AS_CONFIRMTOBUYMARK_AS_REJECTTOBUYMARK_AS_REVISEMARK_AS_PROPOSEDMARK_AS_OVERRIDDENMARK_AS_SOURCINGMARK_AS_PHASE_1_TRACKING_COMPLETEDMARK_AS_DRAFTMARK_AS_OFFICIALMARK_AS_READY_FOR_ONBOARDINGMARK_AS_CONFIRMEDMARK_AS_DEFAULTMARK_AS_SUBMITTED

approvalTemplateIdstring

Request body

Enter the body as JSON in the step's Body 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
vpoNostring
remarksstring
vpoDatestring (date)
projRefstring
vpoaNostring
ackInstructionsstring
totalQtyinteger (int32)
totalAmtnumber
paymentInstructionsstring
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
}

Response

Returns 200 with an object. Read it in later steps with {{apiVpoacksExecuteVpoAction.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
vpoNostring
remarksstring
vpoDatestring (date)
projRefstring
vpoaNostring
ackInstructionsstring
totalQtyinteger (int32)
totalAmtnumber
paymentInstructionsstring
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.