younifyd
Menu

/api/vendorInvoices (Execute VendorInvoice action)

Execute VendorInvoice action

POST/api/vendorInvoices

Use it in a workflow

  1. Add a step and choose the TradeBeyond connector.
  2. Pick the /api/vendorInvoices (Execute VendorInvoice action) action (under VendorInvoiceController).
  3. Fill in the fields below, then reference the result from later steps as {{apiVendorinvoicesExecuteVendorinvoiceAction.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
createUserstring
createUserNamestring
updateUserstring
updateUserNamestring
createdOnstring (date-time)
updatedOnstring (date-time)
refNostring
domainIdstring
versioninteger (int32)
isLatestboolean
editingStatusstring
docStatusstring
revisioninteger (int32)
entityVersioninteger (int32)
hubDomainIdstring
isForReferenceboolean
statusstring
integrationSourcestring
integrationStatusstring
integrationNotestring
isCpmInitializedboolean
invoiceNostring
shortDescriptionstring
invoiceDatestring (date)
bankLCNostring
totalItemsinteger (int32)
totalQtyinteger (int32)
totalAmtnumber
paymentInstructionsstring
otherTermsstring
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",
  "createUser": "string",
  "createUserName": "string"
}

Response

Returns 200 with an object. Read it in later steps with {{apiVendorinvoicesExecuteVendorinvoiceAction.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
createUserstring
createUserNamestring
updateUserstring
updateUserNamestring
createdOnstring (date-time)
updatedOnstring (date-time)
refNostring
domainIdstring
versioninteger (int32)
isLatestboolean
editingStatusstring
docStatusstring
revisioninteger (int32)
entityVersioninteger (int32)
hubDomainIdstring
isForReferenceboolean
statusstring
integrationSourcestring
integrationStatusstring
integrationNotestring
isCpmInitializedboolean
invoiceNostring
shortDescriptionstring
invoiceDatestring (date)
bankLCNostring
totalItemsinteger (int32)
totalQtyinteger (int32)
totalAmtnumber
paymentInstructionsstring
otherTermsstring
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",
  "createUser": "string",
  "createUserName": "string"
}

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