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 / getSupplierContracts

Operation Information

  • Application Reference: com.hornbill.suppliermanager
  • Scope: Entity - SupplierContracts
  • Class: Entity
  • Required Privilege Level: user
  • Required Rights: Group C - canViewSupplierContracts

Description

This flowcode operation gets details of all supplier contracts based on the search criteria provided.

Request Parameters

The getSupplierContracts 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
searchFilter xs:string No Search criteria for supplier contracts.
filterBySupplier xs:integer No Filters the results by supplier.
filterByOwner xs:string No Filters the results by supplier contract owner (user id)
filterByStatus xs:string No Filters the results by supplier contract status
filterByExpiry xs:string No Filters the results by supplier contract expiry date. Accepted values are: 'within30Days', 'within60Days', 'within90Days', 'within180Days', 'over180Days'
filterByAssets xs:string No Filters the results by associated assets. Accepts an array of asset id's
rowStart xs:integer Yes Row Start for Paging.
rowLimit xs:integer Yes Page Size.
sortDirection xs:string No Either ASC or DESC. Required if sortng by supplier, start date, end date or value, otherwise the filter will not apply.
sortOnSupplier xs:boolean No Sorts the result set by supplier name rather than supplier contract name. Default is false.
sortOnStartDate xs:boolean No Sorts the result set by start date rather than supplier contract name. Default is false.
sortOnEndDate xs:boolean No Sorts the result set by end date rather than supplier contract name. Default is false.
sortOnValue xs:boolean No Sorts the result set by value rather than supplier contract name. Default is false.

Response Parameters

Name Type Description
outcome xs:string The outcome of the flowcode operation.
totalRecordCount xs:integer The total number of supplier contracts that match the search criteria.
supplierContracts xs:string A JSON string of supplier contracts.
supplierContractOwners xs:string A JSON string of unique supplier contract owners for all supplier contracts.
expiresWithin30DaysCount xs:integer The number of supplier contracts that expire (reach their end date) within 30 days from the current date and time.
expiresWithin60DaysCount xs:integer The number of supplier contracts that expire (reach their end date) within 60 days from the current date and time.
expiresWithin90DaysCount xs:integer The number of supplier contracts that expire (reach their end date) within 90 days from the current date and time.
expiresWithin180DaysCount xs:integer The number of supplier contracts that expire (reach their end date) within 180 days from the current date and time.

Code Examples

In This Document