younifyd
Menu

/api/factories/{factRefNo}/factAgreementList/{factAgreementId} (Update fact agreement status as 'agreed')

Update fact agreement status as 'agreed'

PATCH/api/factories/{factRefNo}/factAgreementList/{factAgreementId}

Use it in a workflow

  1. Add a step and choose the TradeBeyond connector.
  2. Pick the /api/factories/{factRefNo}/factAgreementList/{factAgreementId} (Update fact agreement status as 'agreed') action (under FactoryController).
  3. Fill in the fields below, then reference the result from later steps as {{apiFactoriesFactrefnoFactagreementlistFactagreementidUpdateFactAgreementStatusAsAgreed.response.data}}.

Request

Path parameters

factRefNostringrequired
factAgreementIdstringrequired

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)
docStatusobject
codestringrequired
namestring
versioninteger (int32)
vendorSignedCopiesarray<object>
idstringrequired
fileNamestring
thumbnailboolean
filePathstring
fileSizestring
protocolstring
createUserstring
createUserNamestring
updateUserstring
updateUserNamestring
urlstring
angleinteger (int32)
hasMessageboolean
extraDataobject
Thumbnail urlstring
lastCommentsstring
internalCommentsstring
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
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
  },
  "docStatus": {
    "code": "string",
    "name": "string",
    "version": 0
  }
}

Response

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

idstring
refNostring
versioninteger (int32)
businessNamestring
factCodestring
factAuditNostring
baselineYearCodestring
editingStatusstring
statusstring
factTypeValuestring
baselineEmissionsinteger (int64)
countryobject
codestringrequired
namestring
versioninteger (int32)
energyTrackingListarray<object>
yearobject3 fields
energyUnitobject3 fields
energySourceobject3 fields
heatValuenumber
emissionFactornumber
json
{
  "id": "string",
  "refNo": "string",
  "version": 0,
  "businessName": "string",
  "factCode": "string",
  "factAuditNo": "string",
  "baselineYearCode": "string",
  "editingStatus": "string",
  "status": "string",
  "factTypeValue": "string",
  "baselineEmissions": 0,
  "country": {
    "code": "string",
    "name": "string",
    "version": 0
  }
}

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