Service Directory > v31.2 > Resource_Management > Get_Supplier_Order_Contracts
 

Operation: Get_Supplier_Order_Contracts DEPRECATED

DEPRECATED: This operation is being deprecated in favor of the Get Supplier Contracts web service in W16. This service operation will get Supplier Order Contracts for the specified criteria. Supplier Order Contract data includes Supplier Contract ID, Supplier Contract Name, Resource Provider, Supplier Contract Reference Number, Company, Contract Start Date, Contract End Date, Total Contract Amount, Contract Overview, Locked in Workday Flag and Attachment data. The request criteria can be for a specific supplier order contract based on reference(s), Company or Company Hierarchies (returning contracts belonging to subordinate hierarchies and companies), Supplier(s), Start Date, End Date, Supplier Contract Number, Contract Name, Status, and Creating Worker. If no criteria are specified, all supplier order contracts will be retrieved.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Get_Supplier_Order_Contracts_Request

Contains request reference, criteria, filter and response group for getting Supplier Order Contract data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Supplier_Order_Contract_Request_References  [0..1]  Get Supplier Order Contracts Request References   
Request_Criteria [Choice]   Supplier_Order_Contract_Request_Criteria  [0..1]  Get Supplier Order Contracts Request Criteria 
Validation Description
Contract Start Date On or After must be earlier than Contract Start Date On or Before.  Contract Start Date On or After must be earlier than Contract Start Date On or Before. 
Contract End Date On or After must be earlier than Contract End Date On or Before.  Contract End Date On or After must be earlier than Contract End Date On or Before. 
Organization Reference must be Companies or Company Hierarchies  Organization Reference must be Companies or Company Hierarchies 
Supplier reference is for a supplier that can be used as a basic worktag only.  Supplier reference is for a supplier that can be used as a basic worktag only. 
 
Response_Filter  Response_Filter  [0..1]  Get Supplier Order Contracts Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Supplier_Order_Contract_Response_Group  [0..1]  Get Supplier Order Contracts Response Group   
top
 

Response Element: Get_Supplier_Order_Contracts_Response

Element containing Supplier Contract response elements including received criteria, references, data based on criteria and grouping, results filter and result summary
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Supplier_Order_Contract_Request_References  [0..1]  Get Supplier Order Contracts Request References   
Request_Criteria  Supplier_Order_Contract_Request_Criteria  [0..1]  Get Supplier Order Contracts Request Criteria 
Validation Description
Contract Start Date On or After must be earlier than Contract Start Date On or Before.  Contract Start Date On or After must be earlier than Contract Start Date On or Before. 
Contract End Date On or After must be earlier than Contract End Date On or Before.  Contract End Date On or After must be earlier than Contract End Date On or Before. 
Organization Reference must be Companies or Company Hierarchies  Organization Reference must be Companies or Company Hierarchies 
Supplier reference is for a supplier that can be used as a basic worktag only.  Supplier reference is for a supplier that can be used as a basic worktag only. 
 
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Supplier_Order_Contract_Response_Group  [0..1]  Get Supplier Order Contracts Response Group   
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Supplier_Order_Contract_Response_Data  [0..1]  Wrapper Element that includes Supplier Order Contract Reference Instance and Supplier Order Contract Data   
top
 

Supplier_Order_Contract_Request_References

part of: Get_Supplier_Order_Contracts_Request, Get_Supplier_Order_Contracts_Response
Get Supplier Order Contracts Request References
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Order_Contract_Reference  Supplier_ContractObject  [1..*]  Supplier Order Contract Reference   
top
 

Supplier_ContractObject

part of: Supplier_Order_Contract_Request_References, Supplier_Order_Contract
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Supplier_ContractObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Supplier_ContractObjectID

part of: Supplier_ContractObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Supplier_Contract_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Supplier_Order_Contract_Request_Criteria

part of: Get_Supplier_Order_Contracts_Request, Get_Supplier_Order_Contracts_Response
Get Supplier Order Contracts Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Organization_Reference  OrganizationObject  [0..*]  References to an existing Company or Company Hierarchy   
Supplier_Reference  Resource_ProviderObject  [0..*]  References to an existing Supplier   
Contract_Name  string  [0..1]  Supplier Contract Name   
Contract_Start_Date_On_or_After  date  [0..1]  Contract Effective Date On or After   
Contract_Start_Date_On_or_Before  date  [0..1]  Contract Effective Date On or Before   
Contract_End_Date_On_or_After  date  [0..1]  Contract End Date On or After   
Contract_End_Date_On_or_Before  date  [0..1]  Contract End Date On or Before   
Supplier_Order_Contract_Status  string  [0..1]  Supplier Order Contract Status. Examples of valid statuses are In Progress, Canceled, Approved, Denied, Draft   
Supplier_Contract_Reference_Number  string  [0..1]  Supplier Reference Number   
Buyer_Reference  WorkerObject  [0..*]  Reference to the Creating Worker for Supplier Order Contract   
Validation Description
Contract Start Date On or After must be earlier than Contract Start Date On or Before.  Contract Start Date On or After must be earlier than Contract Start Date On or Before. 
Contract End Date On or After must be earlier than Contract End Date On or Before.  Contract End Date On or After must be earlier than Contract End Date On or Before. 
Organization Reference must be Companies or Company Hierarchies  Organization Reference must be Companies or Company Hierarchies 
Supplier reference is for a supplier that can be used as a basic worktag only.  Supplier reference is for a supplier that can be used as a basic worktag only. 
top
 

OrganizationObject

part of: Supplier_Order_Contract_Request_Criteria, Supplier_Order_Contract_Data_for_Put_and_Get
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  OrganizationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

OrganizationObjectID

part of: OrganizationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Company_Reference_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Organization_Reference_ID, Region_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Resource_ProviderObject

part of: Supplier_Order_Contract_Request_Criteria, Supplier_Order_Contract_Data_for_Put_and_Get
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Resource_ProviderObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Resource_ProviderObjectID

part of: Resource_ProviderObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Contingent_Worker_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Supplier_ID, Supplier_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

WorkerObject

part of: Supplier_Order_Contract_Request_Criteria, Supplier_Order_Contract_Data_for_Put_and_Get
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  WorkerObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

WorkerObjectID

part of: WorkerObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Contingent_Worker_ID, Employee_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Response_Filter

part of: Get_Supplier_Order_Contracts_Request, Get_Supplier_Order_Contracts_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Supplier_Order_Contract_Response_Group

part of: Get_Supplier_Order_Contracts_Request, Get_Supplier_Order_Contracts_Response
Get Supplier Order Contracts Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Supplier_Order_Contracts_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Supplier_Order_Contract_Response_Data

part of: Get_Supplier_Order_Contracts_Response
Wrapper Element that includes Supplier Order Contract Reference Instance and Supplier Order Contract Data
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Order_Contract  Supplier_Order_Contract  [0..*]  Contains data for adding a Supplier Order Contract   
top
 

Supplier_Order_Contract

part of: Supplier_Order_Contract_Response_Data
Element containing supplier contract reference and data
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Order_Contract_Reference  Supplier_ContractObject  [0..1]  Supplier Order Contract Reference   
Supplier_Order_Contract_Data  Supplier_Order_Contract_Data_for_Put_and_Get  [0..1]  Supplier Order Contract Data 
Validation Description
The End Date must be greater than the Start Date.  The End Date must be greater than the Start Date. 
Resource Provider must be a Supplier or an Independent Contingent Worker.  Resource Provider must be a Supplier or an Independent Contingent Worker. 
Resource Provider must be active or on hold.  Resource Provider must be active or on hold. 
Resource Provider reference is for a supplier that can be used as a basic worktag only.  Resource Provider reference is for a supplier that can be used as a basic worktag only. 
 
top
 

Supplier_Order_Contract_Data_for_Put_and_Get

part of: Supplier_Order_Contract
Supplier Order Contract Data
 
Parameter name Type/Value Cardinality Description Validations
Contract_ID  string  [0..1]  Contract ID. This is the unique identifier for supplier order contract.   
Contract_Name  string  [1..1]  Supplier Order Contract Name   
Resource_Provider_Reference  Resource_ProviderObject  [1..1]  Resource Provider Reference   
Supplier_Contract_Reference_Number  string  [0..1]  Supplier Contract Reference Number   
Company_Reference [Choice]   CompanyObject  [1..1]  Company Reference   
Company_Hierarchy_Reference [Choice]   OrganizationObject  [1..1]  Company Hierarchy Reference. Can only specify either a Company Reference or a Company Hierarchy Reference, not both   
Buyer_Reference  WorkerObject  [0..1]  Reference to the named Buyer for the Supplier Order Contract   
Contract_Start_Date  date  [1..1]  Contract Start Date   
Contract_End_Date  date  [0..1]  Contract End Date   
Total_Contract_Amount  decimal (26, 6) >0   [0..1]  Total Contract Amount   
Currency_Reference  CurrencyObject  [0..1]  Currency Reference 
Validation Description
Currency Conversion Rates between currency and company's default currency are not defined.   
Currency entered is not listed as an Accepted Currency by Supplier.   
 
Contract_Overview  RichText  [0..1]  Contract Overview   
Locked_in_Workday  boolean  [0..1]  Set to True to disable editing of supplier order contract inside the Workday application. Supplier order contract can only be updated from the web service.   
Attachment_Replacement_Data  Financials_Attachment_Data  [0..*]  Encapsulating element containing all Business Document Attachment data. 
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
 
Validation Description
The End Date must be greater than the Start Date.  The End Date must be greater than the Start Date. 
Resource Provider must be a Supplier or an Independent Contingent Worker.  Resource Provider must be a Supplier or an Independent Contingent Worker. 
Resource Provider must be active or on hold.  Resource Provider must be active or on hold. 
Resource Provider reference is for a supplier that can be used as a basic worktag only.  Resource Provider reference is for a supplier that can be used as a basic worktag only. 
top
 

CompanyObject

part of: Supplier_Order_Contract_Data_for_Put_and_Get
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  CompanyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CompanyObjectID

part of: CompanyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Company_Reference_ID, Organization_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

CurrencyObject

part of: Supplier_Order_Contract_Data_for_Put_and_Get
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  CurrencyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CurrencyObjectID

part of: CurrencyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Currency_ID, Currency_Numeric_Code  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Financials_Attachment_Data

part of: Supplier_Order_Contract_Data_for_Put_and_Get
Encapsulating element containing all Business Document Attachment data.
 
Parameter name Type/Value Cardinality Description Validations
@Content_Type  string (80)   [1..1]  Text attribute identifying Content Type of the Attachment.   
@Filename  string (255)   [1..1]  Text attribute identifying Filename of the Attachment.   
@Encoding  string  [1..1]  Text attribute identifying Encoding of the Attachment.   
@Compressed  boolean  [1..1]  Boolean attribute identifying whether the Attachment is compressed.   
File_Content  base64Binary  [0..1]  File content in binary format.   
Comment  string  [0..1]  Comment   
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
top
 

Supplier_ContractReferenceEnumeration

part of: Supplier_ContractObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

Resource_ProviderReferenceEnumeration

part of: Resource_ProviderObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

RichText

part of: Supplier_Order_Contract_Data_for_Put_and_Get
Base Type
string
top