Tracks service line details within supplier contracts.

Workday Resource Information

Retrieves all supplier contracts.

Secured by: Process: Supplier Contract - View, View: Organization Supplier Contract

Scope: Procurement, Supplier Contracts

Aggregate Fields

The cmdlet represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.

This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.

ChargeControls_Aggregate

[{
  descriptor: Text /* A preview of the instance */
  id: Text /* Id of the instance */
  maximumAmount: Currency /* The \~maximum charge control amount\~ of the charge control rule for the source transaction or transaction line.  The amount can be used in condition rules to control spending on target transactions or transaction lines. */
  minimumAmount: Currency /* The \~minimum charge control amount\~ of the charge control rule for the source transaction or transaction line. The amount can be used in condition rules to control spending on target transactions or transaction lines. */
}]

TaxRecoverabilities_Aggregate

[{
  descriptor: Text /* A preview of the instance */
  id: Text /* Id of the instance */
  percentRecoverable: Numeric /* The tax recoverable percentage for tax recoverability. */
}]

Worktags_Aggregate

[{
  descriptor: Text /* A preview of the instance */
  href: Text /* A link to the instance */
  id: Text /* Id of the instance */
  worktagType: { /* The worktag type for the worktag. */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
}]

Columns

Name	Type	Description
Id [KEY]	String	Unique identifier for this supplier contract line instance.
SupplierContracts_Id [KEY]	String	Workday-generated unique ID linking this record to the associated supplier contract.
ChargeControls_Aggregate	String	A list of charge control rules applied to the transaction or transaction line.
CompanyForInvoice_Descriptor	String	A human-readable description of the company associated with the invoice.
CompanyForInvoice_Id	String	Unique identifier for the company associated with the invoice.
Descriptor	String	A brief, human-readable summary of the instance.
DoNotAutoRenew	Bool	Indicates whether the supplier contract line is marked as 'Do Not Auto Renew' (true/false). Editable only when the contract type allows renewal terms.
ExtendedAmount_Currency	String	The currency of the extended amount for the document line, excluding tax-only invoices.
ExtendedAmount_Value	Decimal	The extended amount for the document line, excluding tax-only invoices.
Item_Descriptor	String	A human-readable description of the item associated with the contract line.
Item_Href	String	A URL or reference link to the item instance.
Item_Id	String	Unique identifier associated with the item.
LineDescription	String	The description of the supplier contract line item.
LineEndDate	Datetime	The end date of the supplier contract line.
LineIsCanceled	Bool	Indicates whether the supplier contract line is canceled (true/false). Canceled lines cannot be ordered, received, or invoiced.
LineNumber	String	The line number of the supplier contract line.
LineOnHold	Bool	Indicates whether the supplier contract line is on hold (true/false). On-hold lines cannot be added to purchase orders, supplier invoices, or installments.
LineStartDate	Datetime	The start date of the supplier contract line.
Location_Descriptor	String	A human-readable description of the location associated with the contract line.
Location_Href	String	A URL or reference link to the location instance.
Location_Id	String	Unique identifier associated with the location.
Memo	String	The memo associated with the document line.
RenewalAmount_Currency	String	The currency of the renewal amount for this supplier contract line.
RenewalAmount_Value	Decimal	The amount to be renewed for the supplier contract line when auto-renewed.
Retention	Bool	Indicates whether the retention checkbox is selected for the line (true/false).
ShipToAddress_Descriptor	String	A human-readable description of the shipping address.
ShipToAddress_Href	String	A URL or reference link to the shipping address instance.
ShipToAddress_Id	String	Unique identifier associated with the shipping address.
ShipToContact_Descriptor	String	A human-readable description of the shipping contact.
ShipToContact_Href	String	A URL or reference link to the shipping contact instance.
ShipToContact_Id	String	Unique identifier associated with the shipping contact.
SpendCategory_Descriptor	String	A human-readable description of the spend category.
SpendCategory_Href	String	A URL or reference link to the spend category instance.
SpendCategory_Id	String	Unique identifier associated with the spend category.
TaxApplicability_Descriptor	String	A human-readable description of the tax applicability.
TaxApplicability_Href	String	A URL or reference link to the tax applicability instance.
TaxApplicability_Id	String	Unique identifier associated with the tax applicability.
TaxCode_Descriptor	String	A human-readable description of the tax code.
TaxCode_Href	String	A URL or reference link to the tax code instance.
TaxCode_Id	String	Unique identifier associated with the tax code.
TaxRecoverabilities_Aggregate	String	A list of tax recoverabilities on a taxable document line.
Worktags_Aggregate	String	All worktags associated with the related business object.
CompanyOrHierarchy_Prompt	String	Filter supplier contracts by company or company hierarchy using the Workday ID.
ContractSpecialist_Prompt	String	Filter supplier contracts by contract specialist using the Workday ID or reference ID.
ContractType_Prompt	String	Filter supplier contracts by type using the Workday ID of the contract type.
EndDateOnOrAfter_Prompt	Date	Filter supplier contracts with an end date on or after the specified date (yyyy-mm-dd).
EndDateOnOrBefore_Prompt	Date	Filter supplier contracts with an end date on or before the specified date (yyyy-mm-dd).
ExternalSystemReference_Prompt	String	Filter supplier contracts using the external system reference ID.
OnHold_Prompt	Bool	Filter supplier contracts that are on hold (true/false).
StartDateOnOrAfter_Prompt	Date	Filter supplier contracts with a start date on or after the specified date (yyyy-mm-dd).
StartDateOnOrBefore_Prompt	Date	Filter supplier contracts with a start date on or before the specified date (yyyy-mm-dd).
Status_Prompt	String	Filter supplier contracts by status using the Workday ID.
Supplier_Prompt	String	Filter supplier contracts by supplier using the Workday ID of the supplier.