younifyd
Menu

/api/vendors/{vendorRefNo}/vendorAgreementList/{vendorAgreementId} (Update vendor agreement status as 'agreed')

Update vendor agreement status as 'agreed'

PATCH/api/vendors/{vendorRefNo}/vendorAgreementList/{vendorAgreementId}

Use it in a workflow

  1. Add a step and choose the TradeBeyond connector.
  2. Pick the /api/vendors/{vendorRefNo}/vendorAgreementList/{vendorAgreementId} (Update vendor agreement status as 'agreed') action (under VendorController).
  3. Fill in the fields below, then reference the result from later steps as {{apiVendorsVendorrefnoVendoragreementlistVendoragreementidUpdateVendorAgreementStatusAsAgreed.response.data}}.

Request

Path parameters

vendorRefNostringrequired
vendorAgreementIdstringrequired

Request body

Enter the body as JSON in the step's Body field.

idstring
codestring
uniqueKeystring
typeobject
codestringrequired
namestring
versioninteger (int32)
categoryobject
codestringrequired
namestring
versioninteger (int32)
contractFileRefNostring
contractFileAttachmentobject
idstringrequired
fileNamestring
thumbnailboolean
filePathstring
fileSizestring
protocolstring
createUserstring
createUserNamestring
updateUserstring
updateUserNamestring
urlstring
angleinteger (int32)
hasMessageboolean
extraDataobject
Thumbnail urlstring
descriptionstring
instructionToVendorstring
effectiveUntilstring (date)
statusobject
codestringrequired
namestring
versioninteger (int32)
contractFileDocStatusstring
vendorSignedCopiesarray<object>
idstringrequired
fileNamestring
thumbnailboolean
filePathstring
fileSizestring
protocolstring
createUserstring
createUserNamestring
updateUserstring
updateUserNamestring
urlstring
angleinteger (int32)
hasMessageboolean
extraDataobject
Thumbnail urlstring
internalCommentsstring
lastCommentsstring
customFieldsobject
dynamicModelMapobject
terminatedOnstring (date)
acceptedOnstring (date)
verifiedOnstring (date)
verifiedBystring
hashKeystring
cleanUpAcceptedOnStatusarray<string>
readOnlyStatusarray<string>
isSignatureRequiredboolean
signatureDueDatestring (date)
isEditModeboolean
vendorActionRequiredobject
codestringrequired
namestring
versioninteger (int32)
transientDocumentIdstring
agreementIdstring
signUrlstring
signerEmailstring
signerNamestring
isDisplayDocuSignSignButtonboolean
isDisplayDocuSignResendButtonboolean
createdOnstring (date-time)
updatedOnstring (date-time)
updateUserNamestring
internalSeqNointeger (int32)
duidstring
json
{
  "id": "string",
  "code": "string",
  "uniqueKey": "string",
  "type": {
    "code": "string",
    "name": "string",
    "version": 0
  },
  "category": {
    "code": "string",
    "name": "string",
    "version": 0
  },
  "contractFileRefNo": "string",
  "contractFileAttachment": {
    "id": "string",
    "fileName": "string",
    "thumbnail": false,
    "filePath": "string",
    "fileSize": "string",
    "protocol": "string",
    "createUser": "string",
    "createUserName": "string",
    "updateUser": "string",
    "updateUserName": "string",
    "url": "string",
    "angle": 0
  },
  "description": "string",
  "instructionToVendor": "string",
  "effectiveUntil": "2025-01-01",
  "status": {
    "code": "string",
    "name": "string",
    "version": 0
  },
  "contractFileDocStatus": "string"
}

Response

Returns 200 with an object. Read it in later steps with {{apiVendorsVendorrefnoVendoragreementlistVendoragreementidUpdateVendorAgreementStatusAsAgreed.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
businessRefNostring
connectionstring
revisioninteger (int32)
entityVersioninteger (int32)
domainIdstring
hubDomainIdstring
isForReferenceboolean
versioninteger (int32)
statusstring
docStatusstring
editingStatusstring
integrationSourcestring
integrationStatusstring
createUserstring
createUserNamestring
updateUserstring
updateUserNamestring
createdOnstring (date-time)
updatedOnstring (date-time)
isLatestboolean
vendorCodestring
referencestring
businessNamestring
shortNamestring
parentGroupstring
remarksstring
address1string
address2string
address3string
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",
  "businessRefNo": "string"
}

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