Documentation

{{docApp.title}}

{{docApp.description}}

INDEX

Documentation Library

Search for information on Hornbill Documentation.

{{docApp.searchError}}

{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}

Have questions about this site?


What is this site?

  • This website is Hornbill's new product documentation website and is currently under development.
  • It is intended that all existing and future public-facing documentation we produce will be available to search, browse and share.
  • Hornbill's current documentation is available at Hornbill Wiki but over time this content will be migrated to this documentation site.
  • Please feel free to have a look around at any time.

Why has Hornbill created this site?

  • Hornbill's products have moved on considerably since we introduced it almost 10 years ago. At the time, the MediaWiki tool was sufficient, but we have outgrown it.
  • Our customers are more enterprise focused and more self-sufficient than ever before, so for 2023 and beyond we have established a new documentation platform and team to drive our documentation initiative forwards.
  • We are aiming to deprecate the use of Hornbill Wiki for most Hornbill related documentation.
  • We want to enable our growing partner network with product resources and information, documentation beyond our Wiki approach is required.
  • We could definitely do with some help, and may even pay for some! If you have domain knowledge and would like to help, please check out our Hornbill Docs Contributor Guide and contact the Hornbill docs team at docs@hornbill.com.

What will this site be good for?

  • Community contribution will be facilitated, encouraged, and most welcome.
  • High quality documentation, will be kept up to date as rapidly as our products evolve.
  • Real-time content search and discovery.
  • Articles organized into books, books into libraries, creating a more natural and logical structure to our documentation.
  • Legacy API documentation and various other documentation sources will all be consolidated into a single unified documentation system.
  • Documentation available in browser as well as printable/viewable as PDF on demand.
  • Personalized documentation experience, allowing dark/light mode, article subscriptions, social media sharing and other useful features.
  • Almost all publicly available documentation on docs.hornbill.com will be open-source and available to fork on GitHub, allowing customers to derive their own custom documentation around Hornbill products should they wish to.

What is the timeline for this site?

  • We have taken the decision to publish and make available early, there is very little content at this time.
  • As and when we have completed/usable documentation, it will be published here.
  • We have a host of additional features we wish to add over time, so please watch this space.
  • We expect most of our existing documentation should be reviewed/migrated to docs.hornbill.com over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{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 / addSupplierContract

Operation Information

Description

This flowcode operation creates a new supplier contract.

Request Parameters

The addSupplierContract 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
supplierId xs:integer Yes The supplier primary key.
name xs:string Yes The name of the new supplier contract.
description xs:string No A description of the new supplier contract.
type xs:string No The type of the new supplier contract.
startDate xs:dateTime No The start date of the new supplier contract.
endDate xs:dateTime No The end date of the new supplier contract.
renewalStartDate xs:dateTime No The renewal start date of the new supplier contract.
renewalEndDate xs:dateTime No The renewal end date of the new supplier contract.
currency xs:string No The currency of the new supplier contract.
value xs:decimal No The value of the new supplier contract.
acquisitionMethod xs:string No The acquisition method of the new supplier contract.
cancellationNoticePeriod xs:string No The cancellation notice period of the new supplier contract.
costCentre xs:string No The cost centre of the new supplier contract.
invoiceNumber xs:string No The invoice number of the new supplier contract.
orderNumber xs:string No The order number of the new supplier contract.
paymentType xs:string No The payment type of the new supplier contract.
status xs:string No The status of the new supplier contract. Accepted values are (status.draft,status.active,status.archived). If no value is provided, status.active will be used.
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 new supplier contract.
budgetOwner xs:string No The user id of the budget owner of the new supplier contract.
businessOwner xs:string No The user id of the business owner of the new supplier contract.
workingTimeCalendar xs:string No The working time calendar to be used against the new supplier contract to record events.
targetMinutesPerEvent xs:integer No The target number of minutes to complete each event against the new supplier contract.
agreedComplianceTargetPercentage xs:decimal No The agreed compliance target percentage for the new supplier contract.
contactEmailAddress xs:string No A contact email address for the parent supplier for the new supplier contract.
penaltyDescription xs:string No A description of any penalties occurred for missing the agreed compliance target percentage for the new supplier contract.
notes xs:string No Any additional notes for the new supplier contract.
custom0 xs:string No Custom data held against the new supplier contract.
custom1 xs:string No Custom data held against the new supplier contract.
custom2 xs:string No Custom data held against the new supplier contract.
custom3 xs:string No Custom data held against the new supplier contract.
custom4 xs:string No Custom data held against the new supplier contract.
custom5 xs:string No Custom data held against the new supplier contract.
custom6 xs:string No Custom data held against the new supplier contract.
custom7 xs:string No Custom data held against the new supplier contract.
custom8 xs:string No Custom data held against the new supplier contract.
custom9 xs:string No Custom data held against the new supplier contract.
custom10 xs:string No Custom data held against the new supplier contract.
custom11 xs:dateTime No Custom data held against the new supplier contract.
custom12 xs:dateTime No Custom data held against the new supplier contract.
custom13 xs:dateTime No Custom data held against the new supplier contract.
custom14 xs:dateTime No Custom data held against the new supplier contract.
custom15 xs:dateTime No Custom data held against the new supplier contract.
custom16 xs:integer No Custom data held against the new supplier contract.
custom17 xs:integer No Custom data held against the new supplier contract.
custom18 xs:integer No Custom data held against the new supplier contract.
custom19 xs:integer No Custom data held against the new supplier contract.
custom20 xs:integer No Custom data held against the new supplier contract.
custom21 xs:decimal No Custom data held against the new supplier contract.
custom22 xs:decimal No Custom data held against the new supplier contract.
custom23 xs:decimal No Custom data held against the new supplier contract.
custom24 xs:decimal No Custom data held against the new supplier contract.
custom25 xs:decimal No Custom data held against the new supplier contract.

Response Parameters

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

Code Examples

In This Document