younifyd
Menu

/api/factories/{refNo} (Update fact's docStatus by refNo)

update fact's docStatus by refNo.

PATCH/api/factories/{refNo}

Use it in a workflow

  1. Add a step and choose the TradeBeyond connector.
  2. Pick the /api/factories/{refNo} (Update fact's docStatus by refNo) action (under FactoryController).
  3. Fill in the fields below, then reference the result from later steps as {{apiFactoriesRefnoUpdateFactSDocstatusByRefno.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 {{apiFactoriesRefnoUpdateFactSDocstatusByRefno.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.