Reads /serviceLines entries from the SupplierContracts table.

Workday Resource Information

Retrieves a supplier contract with the specified ID.

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

Scope: Procurement, Supplier Contracts

Aggregate Fields

The driver 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.

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. */
      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	Id of the instance
SupplierContracts_Id [KEY]	String	The Workday ID of the SupplierContracts that contains this.
ChargeControls_Aggregate	String	Supported for: SELECT. A JSON aggregate. The charge control rules applied to the transaction or transaction line.
CompanyForInvoice_Descriptor	String	Supported for: SELECT. A preview of the instance
CompanyForInvoice_Id	String	Supported for: SELECT. Id of the instance
Descriptor	String	Supported for: SELECT. A preview of the instance
DoNotAutoRenew	Bool	Supported for: SELECT. True if the supplier contract line is marked as Do Not Auto Renew. The line checkbox is only editable when the supplier contract type allows Renewal Terms.
ExtendedAmount_Currency	String	Supported for: SELECT. The extended amount for the document line. Excludes Extended Amounts on Tax Only Invoices. (Currency name)
ExtendedAmount_Value	Decimal	Supported for: SELECT. The extended amount for the document line. Excludes Extended Amounts on Tax Only Invoices. (Value)
Item_Descriptor	String	Supported for: SELECT. A description of the instance
Item_Href	String	Supported for: SELECT. A link to the instance
Item_Id	String	Supported for: SELECT. wid / id / reference id
LineDescription	String	Supported for: SELECT. The line item description for the document line.
LineEndDate	Datetime	Supported for: SELECT. The end date of this Supplier Contract Line.
LineIsCanceled	Bool	Supported for: SELECT. True if this Supplier Contract Line is canceled. Canceled contract lines can't be ordered, received, or invoiced.
LineNumber	String	Supported for: SELECT. The line number of this Supplier Contract Line.
LineOnHold	Bool	Supported for: SELECT. True if the supplier contract line is On Hold. You can't add On Hold lines to purchase orders, supplier invoices, receipts, or installments. Lines already associated with downstream documents can't be marked as On Hold.
LineStartDate	Datetime	Supported for: SELECT. The start date of the Supplier Contract Line.
Location_Descriptor	String	Supported for: SELECT. A description of the instance
Location_Href	String	Supported for: SELECT. A link to the instance
Location_Id	String	Supported for: SELECT. wid / id / reference id
Memo	String	Supported for: SELECT. The memo on the document line.
RenewalAmount_Currency	String	Supported for: SELECT. The amount to be renewed for this Supplier Contract Line. When supplier contracts are auto-renewed, the renewal amount automatically persists on the renewed supplier contract line. (Currency name)
RenewalAmount_Value	Decimal	Supported for: SELECT. The amount to be renewed for this Supplier Contract Line. When supplier contracts are auto-renewed, the renewal amount automatically persists on the renewed supplier contract line. (Value)
Retention	Bool	Supported for: SELECT. Returns true if the Retention check box is selected on the line.
ShipToAddress_Descriptor	String	Supported for: SELECT. A description of the instance
ShipToAddress_Href	String	Supported for: SELECT. A link to the instance
ShipToAddress_Id	String	Supported for: SELECT. wid / id / reference id
ShipToContact_Descriptor	String	Supported for: SELECT. A description of the instance
ShipToContact_Href	String	Supported for: SELECT. A link to the instance
ShipToContact_Id	String	Supported for: SELECT. wid / id / reference id
SpendCategory_Descriptor	String	Supported for: SELECT. A description of the instance
SpendCategory_Href	String	Supported for: SELECT. A link to the instance
SpendCategory_Id	String	Supported for: SELECT. wid / id / reference id
TaxApplicability_Descriptor	String	Supported for: SELECT. A description of the instance
TaxApplicability_Href	String	Supported for: SELECT. A link to the instance
TaxApplicability_Id	String	Supported for: SELECT. wid / id / reference id
TaxCode_Descriptor	String	Supported for: SELECT. A description of the instance
TaxCode_Href	String	Supported for: SELECT. A link to the instance
TaxCode_Id	String	Supported for: SELECT. wid / id / reference id
TaxRecoverabilities_Aggregate	String	Supported for: SELECT. A JSON aggregate. Tax Recoverabilities on a Taxable Document Line.
Worktags_Aggregate	String	Supported for: SELECT. A JSON aggregate. All worktags for the related business object.
CompanyOrHierarchy_Prompt	String	Accepts multiple inputs. Filters the contracts by company or company hierarchy. Specify the Workday ID of the company or company hierarchy.
ContractSpecialist_Prompt	String	Filters the contracts by the supplier contract specialist. Specify the Workday ID or reference ID of the specialist on the contract.
ContractType_Prompt	String	Accepts multiple inputs. Filters the contracts by type. Specify the Workday ID of the contract type.
EndDateOnOrAfter_Prompt	Date	Filters the contracts with an end date on or after the specified date. Use the yyyy-mm-dd format.
EndDateOnOrBefore_Prompt	Date	Filters the contracts with an end date on or before the specified date. Use the yyyy-mm-dd format.
ExternalSystemReference_Prompt	String	Accepts multiple inputs. Filters the contracts with the external system reference ID.
OnHold_Prompt	Bool	Filters the contracts that are on hold.
StartDateOnOrAfter_Prompt	Date	Filters the contracts with a start date on or after the specified date. Use the yyyy-mm-dd format.
StartDateOnOrBefore_Prompt	Date	Filters the contracts with a start date on or before the specified date. Use the yyyy-mm-dd format.
Status_Prompt	String	Accepts multiple inputs. Filters the contracts by status. Specify the Workday ID of the status.
Supplier_Prompt	String	Accepts multiple inputs. Filters the contracts by the supplier. Specify the Workday ID of the supplier.