Documentation

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

Entity API / updateSupplierContract

Operation Information

Description

This flowcode operation updates the specified supplier contract.

Request Parameters

The updateSupplierContract API takes the following input parameters. It is important to note that the parameters must satisfy the requirement of the input validation checks.

Name Type Required Description
supplierContractId xs:string Yes The supplier contract id.
name xs:string No The name of the existing supplier contract
description xs:string No A description of the existing supplier contract
type xs:string No The type of the existing supplier contract.
startDate xs:dateTime No The start date of the existing supplier contract.
endDate xs:dateTime No The end date of the existing supplier contract.
renewalStartDate xs:dateTime No The renewal start date of the existing supplier contract.
renewalEndDate xs:dateTime No The renewal end date of the existing supplier contract.
currency xs:string No The currency of the existing supplier contract.
value xs:decimal No The value of the existing supplier contract.
acquisitionMethod xs:string No The acquisition method of the existing supplier contract.
cancellationNoticePeriod xs:string No The cancellation notice period of the existing supplier contract.
costCentre xs:string No The cost centre of the existing supplier contract.
invoiceNumber xs:string No The invoice number of the existing supplier contract.
orderNumber xs:string No The order number of the existing supplier contract.
paymentType xs:string No The payment type of the existing supplier contract.
status xs:string No The status of the existing supplier contract. Accepted values are (status.draft,status.active,status.archived).
subStatus xs:string No The Supplier Contract Sub Status value taken from the simple list. e.g. 'subStatus.rolling'
ownedBy xs:string No The user id of the owner of the existing supplier contract.
budgetOwner xs:string No The user id of the budget owner of the existing supplier contract.
businessOwner xs:string No The user id of the business owner of the existing supplier contract.
workingTimeCalendar xs:string No The working time calendar to be used against the existing supplier contract to record events.
targetMinutesPerEvent xs:integer No The target number of minutes to complete each event against the existing supplier contract.
agreedComplianceTargetPercentage xs:decimal No The agreed compliance target percentage for the existing supplier contract.
contactEmailAddress xs:string No A contact email address for the parent supplier for the existing supplier contract.
penaltyDescription xs:string No A description of any penalties occurred for missing the agreed compliance target percentage for the existing supplier contract.
notes xs:string No Any additional notes for the existing supplier contract.
custom0 xs:string No Custom data held against the existing supplier contract.
custom1 xs:string No Custom data held against the existing supplier contract.
custom2 xs:string No Custom data held against the existing supplier contract.
custom3 xs:string No Custom data held against the existing supplier contract.
custom4 xs:string No Custom data held against the existing supplier contract.
custom5 xs:string No Custom data held against the existing supplier contract.
custom6 xs:string No Custom data held against the existing supplier contract.
custom7 xs:string No Custom data held against the existing supplier contract.
custom8 xs:string No Custom data held against the existing supplier contract.
custom9 xs:string No Custom data held against the existing supplier contract.
custom10 xs:string No Custom data held against the existing supplier contract.
custom11 xs:dateTime No Custom data held against the existing supplier contract.
custom12 xs:dateTime No Custom data held against the existing supplier contract.
custom13 xs:dateTime No Custom data held against the existing supplier contract.
custom14 xs:dateTime No Custom data held against the existing supplier contract.
custom15 xs:dateTime No Custom data held against the existing supplier contract.
custom16 xs:integer No Custom data held against the existing supplier contract.
custom17 xs:integer No Custom data held against the existing supplier contract.
custom18 xs:integer No Custom data held against the existing supplier contract.
custom19 xs:integer No Custom data held against the existing supplier contract.
custom20 xs:integer No Custom data held against the existing supplier contract.
custom21 xs:decimal No Custom data held against the existing supplier contract.
custom22 xs:decimal No Custom data held against the existing supplier contract.
custom23 xs:decimal No Custom data held against the existing supplier contract.
custom24 xs:decimal No Custom data held against the existing supplier contract.
custom25 xs:decimal No Custom data held against the existing supplier contract.

Response Parameters

Name Type Description
outcome xs:string The outcome of the flowcode operation.
supplierContractId xs:string The supplier contract id.

Code Examples

In This Document