Service Directory > v31.2 > Revenue_Management > Get_Order_Fulfillment_Transactions
 

Operation: Get_Order_Fulfillment_Transactions

This service operation will get Order Fulfillment Transactions based on request reference or request criteria (Customer or Customer Contracts, Transaction Start Date and Transaction End Date). Order Fulfillment Transaction Data includes Order Fulfillment Transaction Reference ID, Fulfillment date, quantity fulfilled, Customer, Company, Customer Contract line, Ship to customer and Ship to address.


@ - 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_Order_Fulfillment_Transactions_Request

This element is the top-level request element for the Order Fulfillment Transaction "Get" operations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Order_Fulfillment_Transaction_Request_References  [0..1]  This element content contains the Order Fulfillment Transaction reference element used to return Order Fulfillment Transaction by reference id.   
Request_Criteria [Choice]   Order_Fulfillment_Transaction_Request_Criteria  [0..1]  This element content contains the wrapper element for the list of criteria representing the Order Fulfillment Transaction.   
Response_Filter  Response_Filter  [0..1]  Element content containing Order Fulfillment Transaction Response Filter element. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Order_Fulfillment_Transaction_Response_Group  [0..1]  Element content containing Order Fulfillment Transaction Response Group element   
top
 

Response Element: Get_Order_Fulfillment_Transactions_Response

The response for a request for Order Fulfillment Transaction data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Order_Fulfillment_Transaction_Request_References  [0..1]  Order Fulfillment Transaction Reference element contains the set of requested Order Fulfillment Transactions for which to return data.   
Request_Criteria  Order_Fulfillment_Transaction_Request_Criteria  [0..1]  This element is the wrapper around a list of elements representing the Order Fulfillment Transaction-specific criteria.   
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  Order_Fulfillment_Transaction_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Order Fulfillment Transaction response.   
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  Order_Fulfillment_Transaction_Response_Data  [0..1]  Wrapper element containing Order Fulfillment Transaction Response Data for requested references or criteria   
top
 

Order_Fulfillment_Transaction_Request_References

part of: Get_Order_Fulfillment_Transactions_Request, Get_Order_Fulfillment_Transactions_Response
Order Fulfillment Transaction Reference element contains the set of requested Order Fulfillment Transactions for which to return data.
 
Parameter name Type/Value Cardinality Description Validations
Order_Fulfillment_Transaction_Reference  Order_Fulfillment_TransactionObject  [1..*]  Reference Order Fulfillment Transaction for which data will be returned.   
top
 

Order_Fulfillment_TransactionObject

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

Order_Fulfillment_TransactionObjectID

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

Order_Fulfillment_Transaction_Request_Criteria

part of: Get_Order_Fulfillment_Transactions_Request, Get_Order_Fulfillment_Transactions_Response
This element is the wrapper around a list of elements representing the Order Fulfillment Transaction-specific criteria.
 
Parameter name Type/Value Cardinality Description Validations
Customers_Reference  CustomerObject  [0..*]  Contracts used as criteria for selecting Order Fulfillment Transactions.   
Customer_Contracts_Reference  Customer_ContractObject  [0..*]  Customers used as criteria for selecting Order Fulfillment Transactions.   
Transaction_Date_Start_Date  date  [0..1]  The start date used as criteria for selecting Order Fulfillment Transactions.   
Transaction_Date_End_Date  date  [0..1]  The end date used as criteria for selecting Order Fulfillment Transactions.   
top
 

CustomerObject

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

CustomerObjectID

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

Customer_ContractObject

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

Customer_ContractObjectID

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

Response_Filter

part of: Get_Order_Fulfillment_Transactions_Request, Get_Order_Fulfillment_Transactions_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
 

Order_Fulfillment_Transaction_Response_Group

part of: Get_Order_Fulfillment_Transactions_Request, Get_Order_Fulfillment_Transactions_Response
Wrapper element around a list of elements representing the amount of data that should be included in the Order Fulfillment Transaction response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the Order Fulfillment Transaction Reference data is to be included in the response   
top
 

Response_Results

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

Order_Fulfillment_Transaction_Response_Data

part of: Get_Order_Fulfillment_Transactions_Response
Wrapper element containing Order Fulfillment Transaction Response Data for requested references or criteria
 
Parameter name Type/Value Cardinality Description Validations
Order_Fulfillment_Transaction  Order_Fulfillment_Transaction  [0..*]  The response for a request for Order Fulfillment Transaction data.   
top
 

Order_Fulfillment_Transaction

part of: Order_Fulfillment_Transaction_Response_Data
Wrapper Element containing a Order Fulfillment Transaction Reference and all data for the single Order Fulfillment Transaction.
 
Parameter name Type/Value Cardinality Description Validations
Order_Fulfillment_Transaction_Reference  Order_Fulfillment_TransactionObject  [0..1]  The Order Fulfillment Transaction for which data is returned.   
Order_Fulfillment_Transaction_Data  Order_Fulfillment_Transaction_Data  [0..*]  Contains all References and Attributes to represent a complete Order Fulfillment Transaction. 
Validation Description
The Company must match the company on the Contract Line.   
The Sales Item on the Customer Contract Line must be marked as Fulfillment Required.   
The Customer must be the same as the Bill-To Customer from the contract line.   
The asset you entered isn’t registered with this company.   
Enter a Quantity Fulfilled that does not cause the Quantity Available to be less than zero or to exceed the Quantity on the contract line: [quantity on contract line].   
Enter a Quantity Fulfilled that does not cause the Quantity Available to be less than zero or to exceed the Quantity on the contract line: [quantity on contract line].   
The Ship-To Customer must be one of the ship-to customers from the Connection Map on the customer profile.   
The Ship-To Address must be one of the ship-to addresses from the Connection Map on the customer profile.   
 
top
 

Order_Fulfillment_Transaction_Data

part of: Order_Fulfillment_Transaction
Contains all References and Attributes to represent a complete Order Fulfillment Transaction.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Order Fulfillment Transaction Reference ID. This is the Order Fulfillment Transaction Unique Identifier.   
Fulfillment_Date  date  [0..1]  Fulfillment Date for Record Order Fulfillment Transaction.   
Company_Reference  CompanyObject  [1..1]  Company for Record Order Fulfillment Transaction.   
Customer_Contract_Line_Reference  Customer_Contract_LineObject  [1..1]  Customer Contract Line for Record Order Fulfillment Transaction.   
Customer_Reference  CustomerObject  [0..1]  Customer for Record Order Fulfillment Transaction.   
Quantity_Fulfilled  decimal (22, 2)   [1..1]  Quantity Fulfilled for Record Order Fulfillment Transaction.   
Ship_To_Customer_Reference  CustomerObject  [0..1]  Ship To Customer for Record Order Fulfillment Transaction.   
Ship_To_Address_Reference  Address_ReferenceObject  [0..1]  Ship To Address Reference for Record Order Fulfillment Transaction.   
Tracking_ID  RichText  [0..1]  Tracking ID for tracking an order fulfillment transaction.   
Asset_Reference  Business_AssetObject  [0..1]  Asset for an order fulfillment transaction.   
Memo  RichText  [0..1]  Memo for an order fulfillment transaction.   
Validation Description
The Company must match the company on the Contract Line.   
The Sales Item on the Customer Contract Line must be marked as Fulfillment Required.   
The Customer must be the same as the Bill-To Customer from the contract line.   
The asset you entered isn’t registered with this company.   
Enter a Quantity Fulfilled that does not cause the Quantity Available to be less than zero or to exceed the Quantity on the contract line: [quantity on contract line].   
Enter a Quantity Fulfilled that does not cause the Quantity Available to be less than zero or to exceed the Quantity on the contract line: [quantity on contract line].   
The Ship-To Customer must be one of the ship-to customers from the Connection Map on the customer profile.   
The Ship-To Address must be one of the ship-to addresses from the Connection Map on the customer profile.   
top
 

CompanyObject

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

Customer_Contract_LineObject

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

Customer_Contract_LineObjectID

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

Address_ReferenceObject

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

Address_ReferenceObjectID

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

Business_AssetObject

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

Business_AssetObjectID

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

Order_Fulfillment_TransactionReferenceEnumeration

part of: Order_Fulfillment_TransactionObjectID
Base Type
string
top
 

CustomerReferenceEnumeration

part of: CustomerObjectID
Base Type
string
top
 

Customer_ContractReferenceEnumeration

part of: Customer_ContractObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Customer_Contract_LineReferenceEnumeration

part of: Customer_Contract_LineObjectID
Base Type
string
top
 

Address_ReferenceReferenceEnumeration

part of: Address_ReferenceObjectID
Base Type
string
top
 

RichText

part of: Order_Fulfillment_Transaction_Data, Order_Fulfillment_Transaction_Data
Base Type
string
top
 

Business_AssetReferenceEnumeration

part of: Business_AssetObjectID
Base Type
string
top