Service Directory > v32.1 > Resource_Management > Submit_Purchase_Order_Schedule
 

Operation: Submit_Purchase_Order_Schedule

This service operation will add or update Supplier Invoice Schedules to Supplier Contracts and submit to the Supplier Invoice Schedule business process. The Purchase Order data includes: Purchase Order Schedule ID; Submit; Schedule Status; Company or Company Hierarchy; Supplier; Currency; Supplier Contract; Supplier Contract Lines; Schedule Description; On Hold Flag; Buyer; Issue Option; Default Tax Code; Payment Terms; Auto-submit for Approval flag; Override Payment Type; Procurement Card; Bill-To Contact; Bill-To Address; Ship-To Contact; Ship-To Address; Distribution Method; Frequency Behavior; Schedule From Date; Schedule To Date; Number of Installments; Date Option; Day of Month; Automatically Regenerate Schedules; Automatically Submit Schedules and Purchase Order Installment Data. The Purchase Order Installment Data includes: Purchase Order Installment ID; Purchase Order Installment; Installment Number; Installment Status; Installment (Purchase Order) Date; Installment Start(From) Date; Installment End(To) Date; Purchase Order reference; On Hold Flag; Use Installment Overrides Flag; Override Buyer; Override Tax Code; Override Purchase Order Issue Option; Override Payment Terms; Override Bill-To Contact; Override Bill-To Address; Override Ship-To Contact; Override Ship-To Address; Override Payment Type; Override Procurement Card; Override Memo and Purchase Order Installment Line Data. The Purchase Order Installment Line Data includes: Supplier Contract Line; Line Order; Use Line Overrides; Quantity; From Date; To Date; Amount; Override Unit Of Measure; Override Line Description; Override Spend Category and Override Worktags.


@ - 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: Submit_Purchase_Order_Schedule_Request

Submit Purchase Order Schedule Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update. If an existing instance is found and this flag is set there will be an error.   
Purchase_Order_Schedule_Reference  Purchase_Order_ScheduleObject  [0..1]  Reference to an existing Purchase Order Schedule   
Business_Process_Parameters  Financials_Business_Process_Parameters  [0..*]  Contains data for business processing   
Purchase_Order_Schedule_Data  Purchase_Order_Schedule_Data  [0..1]  Element containing Purchase Order Schedule Data 
Validation Description
Only Distribution Method of "CUSTOM" is currently allowed for Supplier Contract type Schedules.   
The Supplier Contract Lines provided are for a Supplier Contract that does not allow Purchase Order Schedules.   
Either a Date Option or a Day of Month is required if Distribution Method is not Custom.   
You may provide either the Number of Installments or the To Date but not both.   
You may provide either a Date Option Reference or a Day of the Month but not both.   
Supplier Contract Lines must be for the same Supplier Contract.   
At Least one Supplier Contract Line provided is used by a different Supplier Contract Schedule. Each Supplier Contract Line may only be used by a single Supplier Contract Schedule.   
You must submit at least one contract line.   
"Automatically regenerate installments" may only be used with Spread Even Distribution Type.   
In Order to use "Automatically submit schedules" you must also use "Automatically regenerate installments".   
Schedule Start Date can't be changed with completed installments.   
Schedule Number of Installments can't be less than the number of Installments already completed or in progress.   
Frequency Behavior can't be changed with already completed Installments.   
End Date can't be before the date of completed installments or installments in progress.   
Billing Frequency is required unless Billing Method is Custom.   
When Schedule Method is not Custom, then Schedule From Date and either Number of Installments or To Date are required.   
A To Date must be entered when the Date Option is Use To Date.   
A From Date must be entered when the Date Option is Use From Date.   
The Contract does not have a Signed Date therefore you cannot select the Contract Signed Date Option.   
The Contract Type does not allow Receipts therefore you cannot select the Receipt Date Option.   
Day of Month can only be selected with Monthly, Quarterly, or Yearly frequencies.   
You can't specify a Purchase Order Type that is marked Bill Only on the Purchase Order Schedule.   
You can't specify a Purchase Order Type that is marked Consignment on the Purchase Order Schedule.   
 
Validation Description
The Web Service is set to Add Only; documents cannot be resubmitted.  The Web Service is set to Add Only; documents cannot be resubmitted. 
top
 

Response Element: Submit_Purchase_Order_Schedule_Response

Submit Purchase Order Schedule Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Purchase_Order_Schedule_Reference  Purchase_Order_ScheduleObject  [0..1]  Reference to an existing Purchase Order Schedule   
top
 

Purchase_Order_ScheduleObject

part of: Submit_Purchase_Order_Schedule_Request, Submit_Purchase_Order_Schedule_Response
 
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  Purchase_Order_ScheduleObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Purchase_Order_ScheduleObjectID

part of: Purchase_Order_ScheduleObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Purchase_Order_Schedule_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
 

Financials_Business_Process_Parameters

part of: Submit_Purchase_Order_Schedule_Request
Contains data for business processing
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures the Comment for the Business Process.   
top
 

Business_Process_Comment_Data

part of: Financials_Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

part of: Business_Process_Comment_Data, Purchase_Order_Installment_Replacement_Data, Purchase_Order_Schedule_Data
 
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
 

Purchase_Order_Schedule_Data

part of: Submit_Purchase_Order_Schedule_Request
Element containing Purchase Order Schedule Data
 
Parameter name Type/Value Cardinality Description Validations
Purchase_Order_Schedule_ID  string  [0..1]  Purchase Order Schedule Reference ID. This is the Purchase Order Schedule unique identifier.   
Submit  boolean  [0..1]  Submit flag. The service will attempt to submit the schedule if this is on.   
Schedule_Status_Reference  Document_StatusObject  [0..*]  Reference to an existing Schedule Status   
Company_Reference  CompanyObject  [0..1]  Reference element representing the schedule company. 
Validation Description
The Company provided does not match the Supplier Contract Company from the Supplier Contract Lines provided.   
 
Supplier_Reference  Resource_ProviderObject  [0..1]  Reference element representing the schedule supplier. 
Validation Description
The Supplier provided does not match the Supplier Contract Supplier from the Supplier Contract Lines provided.   
 
Currency_Reference  CurrencyObject  [0..1]  Reference element representing the schedule currency. 
Validation Description
The Currency provided does not match the Supplier Contract Currency from the Supplier Contract Lines provided.   
 
Supplier_Contract_Reference  Supplier_ContractObject  [0..1]  Reference element representing the schedule supplier contract. 
Validation Description
The Supplier Contract provided does not match the Supplier Contract from the Supplier Contract Lines provided.   
 
Supplier_Contract_Lines_Reference  Installment_ItemObject  [0..*]  This is a reference to an existing Supplier Contract Line that isn't used by another Supplier Contract type Schedule.   
Schedule_Description  string  [0..1]  Schedule Description.   
Schedule_On_Hold  boolean  [0..1]  Schedule On Hold flag.   
Purchase_Order_Type_Reference  Order_TypeObject  [0..1]  Purchase Order Type for the Supplier Contract Purchase Order Schedule. Note that Purchase Order types that are marked Bill Only cannot be used on the Purchase Order Schedule.   
Buyer_Reference  WorkerObject  [0..1]  Reference to the named buyer for the purchase order.   
Purchase_Order_Issue_Option_Reference  Purchase_Order_Issue_OptionObject  [0..1]  Reference to an existing Purchase Order Issue Option   
Tax_Code_Reference  Tax_CodeObject  [0..1]  Default Tax Code Reference   
Payment_Terms_Reference  Payment_TermsObject  [1..1]  Reference element representing a unique instance of Payment Terms.   
Auto-submit_for_Approval  boolean  [0..1]  Auto-Submit Purchase Orders for Approval Flag.   
Override_Payment_Type_Reference  Payment_TypeObject  [0..1]  Reference to the override Supplier Invoice Payment Type.   
Procurement_Card_Reference  Worker_Credit_CardObject  [0..1]  Reference to the Procurement Card for the Purchase Order. If provided, the Payment Type reference must be set to Credit Card. If no Override Payment Type is supplied, then the Default Payment Type for the Supplier needs to be Credit Card. Additionally, the Procurement Card must be valid for the Supplier or the Buyer.   
Bill-To_Contact_Detail  string  [0..1]  Name of the Bill-To Contact for the Purchase Order.   
Bill-To_Address_Reference  Unique_IdentifierObject  [0..1]  Reference to an existing Bill-To address.   
Ship-To_Contact_Detail  string  [0..1]  Name of the Ship-To Contact for the Purchase Order.   
Ship-To_Address_Reference  Unique_IdentifierObject  [0..1]  Reference to an existing Ship-To address.   
Distribution_Method_Reference  Schedule_Distribution_MethodObject  [0..1]  Reference to the Supplier Contract type Schedule Distribution Method. Valid values are: - Custom (CUSTOM). - Defined Installment (RECURRING). - Spread Even (EVEN).   
Frequency_Reference  Frequency_BehaviorObject  [0..1]  Reference element representing the schedule Installment Frequency.   
From_Date  date  [0..1]  From date. The system generates installments based on this value.   
To_Date  date  [0..1]  To date. The system generates installments based on this value.   
Number_of_Installments  decimal (12, 0) >0   [0..1]  Number of installments. The system generates installments based on this value. 
Validation Description
Either a To Date or a Number of Installments is required if Distribution Method is not Custom.   
 
Date_Option_Reference  Procurement_Date_OptionObject  [0..1]  Reference to the Date Option used for Installment generation. Valid values are: - Contract Line Start Date (LINE_START). - Contract Signed Date (CONTRACT_SIGNED). - Contract Start Date (CONTRACT_START). - Receipt Date (RECEIPT). - Use From Date (SCHEDULE_FROM_DATE). - Use To Date (SCHEDULE_TO_DATE). 
Validation Description
None of the Contract Lines selected have a Start Date therefore you cannot select the Contract Line Start Date Option.   
 
Day_of_Month  decimal (12, 0) >0   [0..1]  Day of Month. The system generates installments based on this value.   
Automatically_Regenerate_Installments  boolean  [0..1]  Automatically Regenerate Installments Flag. Use this flag to Regenerate installments when Supplier Contract Amendments are completed.   
Automatically_Submit_Schedules  boolean  [0..1]  Automatically Submit Schedules Flag. Use this flag when automatically regenerating installments when Supplier Contract Amendments are completed to automatically submit the Supplier Contract type Schedule.   
System_Generated  boolean  [0..1]  Indicates whether the Purchase Order Schedule was System Generated. Not enterable for Submit Purchase Order Schedule web service. It is used only by Get Purchase Order Schedule web service. 
Validation Description
System Generated can't be changed. Used only for Get Web Services.   
 
Purchase_Order_Installment_Replacement_Data  Purchase_Order_Installment_Replacement_Data  [0..*]  Element containing Purchase Order Installment Data 
Validation Description
Please select "Use Installment Overrides" flag if you wish to override the Buyer, Tax Code, Purchase Order Issue Option, Payment Terms,Bill-To Contact, Bill-To Address, Ship-To Contact, Ship-To Address, Payment Type, Procurement Card or Memo.   
When creating a new Installment, please provide a unique Installment Number. If updating an existing Installment Please provide an Installment Number, an Installment ID or an Installment Reference.   
Purchase Order Installment Line Data is required.   
Cannot update an installment if its status is Canceled, Completed, or In Progress.  You may not update installments with status Canceled, Completed, or In Progress. 
 
Validation Description
Only Distribution Method of "CUSTOM" is currently allowed for Supplier Contract type Schedules.   
The Supplier Contract Lines provided are for a Supplier Contract that does not allow Purchase Order Schedules.   
Either a Date Option or a Day of Month is required if Distribution Method is not Custom.   
You may provide either the Number of Installments or the To Date but not both.   
You may provide either a Date Option Reference or a Day of the Month but not both.   
Supplier Contract Lines must be for the same Supplier Contract.   
At Least one Supplier Contract Line provided is used by a different Supplier Contract Schedule. Each Supplier Contract Line may only be used by a single Supplier Contract Schedule.   
You must submit at least one contract line.   
"Automatically regenerate installments" may only be used with Spread Even Distribution Type.   
In Order to use "Automatically submit schedules" you must also use "Automatically regenerate installments".   
Schedule Start Date can't be changed with completed installments.   
Schedule Number of Installments can't be less than the number of Installments already completed or in progress.   
Frequency Behavior can't be changed with already completed Installments.   
End Date can't be before the date of completed installments or installments in progress.   
Billing Frequency is required unless Billing Method is Custom.   
When Schedule Method is not Custom, then Schedule From Date and either Number of Installments or To Date are required.   
A To Date must be entered when the Date Option is Use To Date.   
A From Date must be entered when the Date Option is Use From Date.   
The Contract does not have a Signed Date therefore you cannot select the Contract Signed Date Option.   
The Contract Type does not allow Receipts therefore you cannot select the Receipt Date Option.   
Day of Month can only be selected with Monthly, Quarterly, or Yearly frequencies.   
You can't specify a Purchase Order Type that is marked Bill Only on the Purchase Order Schedule.   
You can't specify a Purchase Order Type that is marked Consignment on the Purchase Order Schedule.   
top
 

Document_StatusObject

part of: Purchase_Order_Installment_Replacement_Data, Purchase_Order_Schedule_Data
 
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  Document_StatusObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Document_StatusObjectID

part of: Document_StatusObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Document_Status_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
 

CompanyObject

part of: Purchase_Order_Schedule_Data
 
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
 

Resource_ProviderObject

part of: Purchase_Order_Schedule_Data
 
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
 

CurrencyObject

part of: Purchase_Order_Schedule_Data
 
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
 

Supplier_ContractObject

part of: Purchase_Order_Schedule_Data
 
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
 

Installment_ItemObject

part of: Purchase_Order_Schedule_Data
 
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  Installment_ItemObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Installment_ItemObjectID

part of: Installment_ItemObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Customer_Invoice_Line_Reference_ID, Deferred_Cost_Abstract_ID, Receivable_Contract_Line_Reference_ID, Student_Charge_Adjustment_ID, Student_Charge_Document_ID, Student_Charge_ID, Student_Sponsor_Contract_Line_ID, Supplier_Contract_Line_Number, Supplier_Invoice_Line_ID, Supplier_Invoice_Line_Split_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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, Alternate_Supplier_Contract_ID, Supplier_Contract_Amendment_ID, Supplier_Contract_History_ID, Supplier_Contract_ID  [1..1]  The unique identifier type of a parent object   
top
 

Order_TypeObject

part of: Purchase_Order_Schedule_Data
 
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  Order_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Order_TypeObjectID

part of: Order_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Order_Type_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
 

Purchase_Order_Issue_OptionObject

part of: Purchase_Order_Installment_Replacement_Data, Purchase_Order_Schedule_Data
 
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  Purchase_Order_Issue_OptionObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Purchase_Order_Issue_OptionObjectID

part of: Purchase_Order_Issue_OptionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Purchase_Order_Issue_Option_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
 

Tax_CodeObject

part of: Purchase_Order_Installment_Replacement_Data, Purchase_Order_Schedule_Data
 
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  Tax_CodeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Tax_CodeObjectID

part of: Tax_CodeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Tax_Code_ID, Withholding_Tax_Code_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
 

Payment_TermsObject

part of: Purchase_Order_Installment_Replacement_Data, Purchase_Order_Schedule_Data
 
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  Payment_TermsObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payment_TermsObjectID

part of: Payment_TermsObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payment_Terms_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
 

Payment_TypeObject

part of: Purchase_Order_Installment_Replacement_Data, Purchase_Order_Schedule_Data
 
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  Payment_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payment_TypeObjectID

part of: Payment_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payment_Type_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
 

Worker_Credit_CardObject

part of: Purchase_Order_Installment_Replacement_Data, Purchase_Order_Schedule_Data
 
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  Worker_Credit_CardObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Worker_Credit_CardObjectID

part of: Worker_Credit_CardObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Expense_Credit_Card_ID, Expense_Credit_Card_Token  [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
 

Unique_IdentifierObject

part of: Purchase_Order_Installment_Replacement_Data, Purchase_Order_Installment_Replacement_Data, Purchase_Order_Schedule_Data, Purchase_Order_Schedule_Data
 
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  Unique_IdentifierObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Unique_IdentifierObjectID

part of: Unique_IdentifierObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  IID, WID  [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
 

Schedule_Distribution_MethodObject

part of: Purchase_Order_Schedule_Data
 
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  Schedule_Distribution_MethodObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Schedule_Distribution_MethodObjectID

part of: Schedule_Distribution_MethodObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Schedule_Distribution_Method_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
 

Frequency_BehaviorObject

part of: Purchase_Order_Schedule_Data
 
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  Frequency_BehaviorObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Frequency_BehaviorObjectID

part of: Frequency_BehaviorObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Frequency_Behavior_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
 

Procurement_Date_OptionObject

part of: Purchase_Order_Schedule_Data
 
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  Procurement_Date_OptionObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Procurement_Date_OptionObjectID

part of: Procurement_Date_OptionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Procurement_Date_Option_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
 

Purchase_Order_Installment_Replacement_Data

part of: Purchase_Order_Schedule_Data
Element containing Purchase Order Installment Data
 
Parameter name Type/Value Cardinality Description Validations
Purchase_Order_Installment_ID  string  [0..1]  Purchase Order Installment Reference ID. This is the Purchase Order Installment unique identifier.   
Purchase_Order_Installment_Reference  Purchase_Order_InstallmentObject  [0..1]  Reference to an existing Purchase Order Installment   
Installment_Number  decimal (12, 0)   [0..1]  Installment Number for Schedule.   
Status_Reference  Document_StatusObject  [0..*]  Installment status   
Purchase_Order_Date  date  [1..1]  Installment Date. This will be the Purchase Order Date for the Installment.   
From_Date  date  [0..1]  Installment From date   
To_Date  date  [0..1]  Installment To date   
Purchase_Order_Reference  Purchase_OrderObject  [0..1]  A reference to the Purchase Order created from this Installment.   
On_Hold  boolean  [0..1]  Installment On Hold flag   
Use_Installment_Overrides  boolean  [0..1]  Override Line flag. Use this to specify values on the installment line instead of using values derived from either the installment, the schedule, or the contract line. This must be on to specify overrides.   
Buyer_Reference  WorkerObject  [0..1]  Reference to the named buyer for the purchase order to be used as an override.   
Tax_Code_Reference  Tax_CodeObject  [0..1]  Reference to an existing Tax Code to be use as an override.   
Purchase_Order_Issue_Option_Reference  Purchase_Order_Issue_OptionObject  [0..1]  Reference to an existing Purchase Order Issue Option to be used as an override.   
Payment_Terms_Reference  Payment_TermsObject  [0..1]  Reference to an existing Payment Terms to be use as an override.   
Bill-To_Contact  string  [0..1]  Name of the Bill-To Contact to be used as an override.   
Bill-To_Address_Reference  Unique_IdentifierObject  [0..1]  Reference to an existing Bill-To Address to be used as an override.   
Ship-To_Contact  string  [0..1]  Name of the Ship-To Contact to be used as an override.   
Ship-To_Address_Reference  Unique_IdentifierObject  [0..1]  Reference to an existing Ship-To Address to be used as an override.   
Payment_Type_Reference  Payment_TypeObject  [0..1]  Reference to an existing Payment Type to be use as an override.   
Procurement_Card_Reference  Worker_Credit_CardObject  [0..1]  Reference to an existing Procurement Card to be used as an override.   
Memo  string  [0..1]  Override Installment Memo   
Internal_Memo  string  [0..1]  Override Installment Internal Memo   
Purchase_Order_Installment_Line_Data  Supplier_Contract_Installment_Line_Data  [0..*]  Element containing Supplier Invoice Schedule Installment Line data 
Validation Description
Please Select "Use Line Overrides" if you wish to override the Unit Of Measure, Line description or Worktags.   
Supplier Contract Line may only be used once per Installment.   
 
Validation Description
Please select "Use Installment Overrides" flag if you wish to override the Buyer, Tax Code, Purchase Order Issue Option, Payment Terms,Bill-To Contact, Bill-To Address, Ship-To Contact, Ship-To Address, Payment Type, Procurement Card or Memo.   
When creating a new Installment, please provide a unique Installment Number. If updating an existing Installment Please provide an Installment Number, an Installment ID or an Installment Reference.   
Purchase Order Installment Line Data is required.   
Cannot update an installment if its status is Canceled, Completed, or In Progress.  You may not update installments with status Canceled, Completed, or In Progress. 
top
 

Purchase_Order_InstallmentObject

part of: Purchase_Order_Installment_Replacement_Data
 
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  Purchase_Order_InstallmentObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Purchase_Order_InstallmentObjectID

part of: Purchase_Order_InstallmentObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Purchase_Order_Installment_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
 

Purchase_OrderObject

part of: Purchase_Order_Installment_Replacement_Data
 
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  Purchase_OrderObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Purchase_OrderObjectID

part of: Purchase_OrderObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Document_Number, Purchase_Order_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
 

Supplier_Contract_Installment_Line_Data

part of: Purchase_Order_Installment_Replacement_Data
Element containing Supplier Invoice Schedule Installment Line data
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Contract_Line_Reference  Supplier_Contract_LineObject  [1..1]  This is a reference to an existing Supplier Contract Line that isn't used by another Supplier Contract type Schedule. 
Validation Description
Supplier Contract Line on Installment must be in the list of Supplier Contract Lines specified for the Schedule.   
Service lines are not allowed for the provided Supplier Contract Type   
 
Line_Order  string  [0..1]  Line order   
Use_Line_Overrides  boolean  [0..1]  Override Line flag. Use this to specify values on the installment line instead of using values derived from either the installment, the schedule, or the contract line. This must be on to specify overrides.   
Quantity  decimal (22, 2)   [0..1]  Quantity. If you supply this value as an override, you must also enable the Override Line flag. 
Validation Description
You may not specify a Quantity for this installment if you are not distributing Installments by Quantity.   
Quantity is required when distributing by Quantity.  Although Supplier Invoice Schedules may distribute installments by Amount or Quantity, Purchase Order Schedules always distribute by Quantity. 
Quantity distribution is not allowed for Service Lines.   
 
Unit_Cost  decimal (26, 6)   [0..1]  Installment Line Unit Cost. If you supply this value as an override, you must also enable the Override Line flag. The Unit Cost can only be entered for Supplier Invoice Schedules distributed by Amount. 
Validation Description
When distributing by Quantity, the Unit Cost is derived from the corresponding Supplier Contract Line and may not be overridden.   
Unit Cost may only be provided on Schedules using the Custom Distribution Method.   
Unit Cost is not allowed for Service Line.   
 
From_Date  date  [0..1]  From Date. If you supply this value as an override, you must also enable the Override Line flag.   
To_Date  date  [0..1]  To Date. If you supply this value as an override, you must also enable the Override Line flag.   
Payment_Amount  decimal (26, 6)   [0..1]  The total amount minus the retention amount. This field is for returning values only. Any values entered will be ignored.   
Total_Amount  decimal (26, 6)   [0..1]  Installment Line Amount 
Validation Description
You may not specify an amount when distributing by quantity.   
 
Retention_Amount  decimal (18, 3) >0   [0..1]  The amount to retain from the scheduled supplier invoice installment. 
Validation Description
Retention amount is only allowed for supplier contract lines that are subject to retention   
Retention Amount can not be more than Installment Line Amount   
 
Unit_of_Measure_Reference  Unit_of_MeasureObject  [0..1]  Reference to an existing Unit of Measure. If you supply this value as an override, you must also enable the Override Line flag. 
Validation Description
Unit of measure is not allowed for Service Line.   
 
Line_Description  string  [0..1]  Installment Line Description from Supplier Contract type Installment Line or from Supplier Contract Line.   
Spend_Category_Reference  Accounting_CategoryObject  [0..1]  Reference to an existing Spend Category   
Worktags_Reference  Accounting_WorktagObject  [0..*]  Worktags from Override or from Supplier Contract Line. 
Validation Description
The following Accounting Worktag types are invalid: [invalid].   
The following Accounting Worktags are required but have not been assigned: [missing].   
The following Accounting Worktag types are invalid: [invalid].   
The following Accounting Worktags are required but have not been assigned: [missing].   
 
Validation Description
Please Select "Use Line Overrides" if you wish to override the Unit Of Measure, Line description or Worktags.   
Supplier Contract Line may only be used once per Installment.   
top
 

Supplier_Contract_LineObject

part of: Supplier_Contract_Installment_Line_Data
 
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_Contract_LineObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Supplier_Contract_LineObjectID

part of: Supplier_Contract_LineObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Supplier_Contract_Line_Number  [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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, Alternate_Supplier_Contract_ID, Supplier_Contract_Amendment_ID, Supplier_Contract_History_ID, Supplier_Contract_ID  [1..1]  The unique identifier type of a parent object   
top
 

Unit_of_MeasureObject

part of: Supplier_Contract_Installment_Line_Data
 
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  Unit_of_MeasureObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Unit_of_MeasureObjectID

part of: Unit_of_MeasureObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, UN_CEFACT_Common_Code_ID, UOM_EDI_Code_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
 

Accounting_CategoryObject

part of: Supplier_Contract_Installment_Line_Data
 
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  Accounting_CategoryObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Accounting_CategoryObjectID

part of: Accounting_CategoryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Bank_Account_ID, Customer_Category_ID, Petty_Cash_Account_ID, Receivable_Writeoff_Reason_ID, Revenue_Category_ID, Spend_Category_ID, Supplier_Category_ID, Tax_Category_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
 

Accounting_WorktagObject

part of: Supplier_Contract_Installment_Line_Data
 
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  Accounting_WorktagObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Accounting_WorktagObjectID

part of: Accounting_WorktagObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Level_ID, Academic_Period_ID, Academic_Person_ID, Academic_Unit_ID, Ad_hoc_Payee_ID, Alternate_Supplier_Contract_ID, Applicant_ID, Asset_Adjustment_Reason_Reference_ID, Asset_Adjustment_Type_Reference_ID, Asset_Impairment_Reason_ID, Bank_Account_ID, Business_Asset_Cost_Adjustment_Reason_ID, Business_Unit_ID, Calculation_Compensation_Basis_ID, Cash_Activity_Category_ID, Catalog_Item_ID, Company_Reference_ID, Compensation_Basis_ID, Compensation_Grade_ID, Contingent_Worker_ID, Contingent_Worker_Type_ID, Corporate_Credit_Card_Account_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_06_ID, Custom_Worktag_07_ID, Custom_Worktag_08_ID, Custom_Worktag_09_ID, Custom_Worktag_1_ID, Custom_Worktag_10_ID, Custom_Worktag_11_ID, Custom_Worktag_12_ID, Custom_Worktag_13_ID, Custom_Worktag_14_ID, Custom_Worktag_15_ID, Custom_Worktag_2_ID, Custom_Worktag_3_ID, Custom_Worktag_4_ID, Custom_Worktag_5_ID, Customer_Category_ID, Customer_Contract_Alternate_Reference_ID, Customer_Contract_Reference_ID, Customer_ID, Customer_Reference_ID, Deduction_Code, Deduction_Recipient_ID, Donor_ID, Earning_Code, Employee_ID, Employee_Type_ID, Ethnicity_ID, Expense_Item_ID, External_Committee_Member_ID, Financial_Aid_Award_Year_ID, Financial_Institution_ID, Financial_Institution_Reference_ID, Fund_ID, Funding_Source_Name, Gender_Code, Gift_Reference_ID, Grant_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Investment_Pool_ID, Investment_Profile_ID, Investor_ID, Is_Manager_ID, Is_People_Manager, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, Job_Category_ID, Job_Level_ID, Job_Profile_ID, Job_Requisition_ID, Lease_Expense_Recognition_ID, Loan_ID, Location_ID, Management_Level_ID, NI_Category_Letter, Object_Class_ID, Opportunity_Reference_ID, Organization_Reference_ID, Pay_Rate_Type_ID, Payroll_Federal_Authority_Tax_Code, Payroll_Income_Code, Payroll_Local_City_Authority_Tax_Code, Payroll_Local_County_Authority_Tax_Code, Payroll_Local_Other_Authority_Tax_Code, Payroll_Local_School_District_Authority_Tax_Code, Payroll_State_Authority_Tax_Code, Petty_Cash_Account_ID, Position_ID, Position_Time_Type_ID, Program_ID, Program_of_Study_ID, Project_ID, Project_Plan_ID, Proposal_Grant_ID, Prospect_ID, Prospect_Reference_ID, Purchase_Item_ID, Receivable_Writeoff_Reason_ID, Region_Reference_ID, Revenue_Category_ID, Rubric_Value_ID, Run_Category_ID, Salary_Over_The_Cap_Type_ID, Sales_Item_ID, Spend_Category_ID, Sponsor_ID, Sponsor_Reference_ID, Student_Application_Residency_Status_ID, Student_Award_Item_ID, Student_Charge_Item_ID, Student_Course_ID, Student_Course_Section_ID, Student_ID, Student_Recruiting_Campaign_ID, Student_Recruiting_Event_ID, Student_Sponsor_Contract_ID, Student_Waiver_Item_ID, Supplier_Category_ID, Supplier_Contract_ID, Supplier_ID, Supplier_Reference_ID, Tax_Applicability_ID, Tax_Authority_ID, Tax_Authority_Reference_ID, Tax_Category_ID, Tax_Code_ID, Tax_Point_Date_Type_ID, Tax_Rate_ID, Tax_Recoverability_Object_ID, Third_Party_ID, Withholding_Order_Case_ID, Withholding_Tax_Code_ID, Withholding_Tax_Rate_ID, Work_Function_ID, Work_Shift_ID, Workday_Deduction_Code, Workday_Earning_Code, Worker_Type_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
 

Purchase_Order_ScheduleReferenceEnumeration

part of: Purchase_Order_ScheduleObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Document_StatusReferenceEnumeration

part of: Document_StatusObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Resource_ProviderReferenceEnumeration

part of: Resource_ProviderObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Supplier_ContractReferenceEnumeration

part of: Supplier_ContractObjectID
Base Type
string
top
 

Installment_ItemReferenceEnumeration

part of: Installment_ItemObjectID
Base Type
string
top
 

Base Type
string

top
 

Order_TypeReferenceEnumeration

part of: Order_TypeObjectID
Base Type
string
top
 

Purchase_Order_Issue_OptionReferenceEnumeration

part of: Purchase_Order_Issue_OptionObjectID
Base Type
string
top
 

Tax_CodeReferenceEnumeration

part of: Tax_CodeObjectID
Base Type
string
top
 

Payment_TermsReferenceEnumeration

part of: Payment_TermsObjectID
Base Type
string
top
 

Payment_TypeReferenceEnumeration

part of: Payment_TypeObjectID
Base Type
string
top
 

Worker_Credit_CardReferenceEnumeration

part of: Worker_Credit_CardObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Schedule_Distribution_MethodReferenceEnumeration

part of: Schedule_Distribution_MethodObjectID
Base Type
string
top
 

Frequency_BehaviorReferenceEnumeration

part of: Frequency_BehaviorObjectID
Base Type
string
top
 

Procurement_Date_OptionReferenceEnumeration

part of: Procurement_Date_OptionObjectID
Base Type
string
top
 

Purchase_Order_InstallmentReferenceEnumeration

part of: Purchase_Order_InstallmentObjectID
Base Type
string
top
 

Purchase_OrderReferenceEnumeration

part of: Purchase_OrderObjectID
Base Type
string
top
 

Supplier_Contract_LineReferenceEnumeration

part of: Supplier_Contract_LineObjectID
Base Type
string
top
 

Base Type
string

top
 

Unit_of_MeasureReferenceEnumeration

part of: Unit_of_MeasureObjectID
Base Type
string
top
 

Accounting_CategoryReferenceEnumeration

part of: Accounting_CategoryObjectID
Base Type
string
top
 

Accounting_WorktagReferenceEnumeration

part of: Accounting_WorktagObjectID
Base Type
string
top