Service Directory > v31.2 > Revenue_Management > Put_Order_Fulfillment_Transaction
 

Operation: Put_Order_Fulfillment_Transaction

This service operation will add Order Fulfillment Transactions. Order Fulfillment Transaction Data includes Order Fulfillment Transaction Reference ID, Customer, Customer Contract Line, Fulfillment date, quantity fulfilled, Ship to Customer, 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: Put_Order_Fulfillment_Transaction_Request

Element containing Order Fulfillment Transaction reference for update (or empty if a new Order Fulfillment Transaction)
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that this reason should only be added. If an existing reason exists with the same ID, this will error instead of updating that reason.   
Order_Fulfillment_Transaction_Reference  Order_Fulfillment_TransactionObject  [0..1]  Reference to an existing Order Fulfillment Transaction for update purposes only.   
Order_Fulfillment_Transaction_Data  Order_Fulfillment_Transaction_Data  [1..1]  Order Fulfillment Transaction Data for the single usage based transaction being created 
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.   
 
Validation Description
A validation error occurred because this web service is Add Only and you entered an order fulfillment transaction that already exists. Enter a unique Order Fulfillment Transaction Reference.   
You cannot edit this order fulfillment transaction because it already has a customer invoice or revenue recognition installment associated with it.   
top
 

Response Element: Put_Order_Fulfillment_Transaction_Response

Element containing Put Order Fulfillment Transaction Response Data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Order_Fulfillment_Transaction_Reference  Order_Fulfillment_TransactionObject  [0..1]  Reference to the Order Fulfillment Transaction that was created by this Put operation.   
top
 

Order_Fulfillment_TransactionObject

part of: Put_Order_Fulfillment_Transaction_Request, Put_Order_Fulfillment_Transaction_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  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_Data

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

CustomerObject

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

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
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Customer_Contract_LineReferenceEnumeration

part of: Customer_Contract_LineObjectID
Base Type
string
top
 

CustomerReferenceEnumeration

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