Service Directory > v31.2 > Inventory > Submit_Ad_Hoc_Goods_Delivery
 

Operation: Submit_Ad_Hoc_Goods_Delivery

This service operation will create Ad Hoc Goods Delivery and it's Goods Delivery Lines and submit it to the Goods Delivery business process


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

The Request Element for Goods Delivery Ticket
 
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.   
Goods_Delivery_Ticket_Reference  Goods_DeliveryObject  [0..1]  Reference to an existing Goods Delivery Ticket for update purpose only   
Business_Process_Parameters  Financials_Business_Process_Parameters  [0..1]  Business Process Parameters provide the ability to auto-submit to the business process.   
Goods_Delivery_Ticket_Data  Ad_Hoc_Goods_Delivery_Data  [0..*]  Element containing Goods Delivery Ticket Data and all Goods Delivery Ticket Lines. 
Validation Description
At least on line is required on the Goods Delivery Ticket. Please enter at least one Goods Delivery Line  At least on line is required on the Goods Delivery Ticket. Please enter at least one Goods Delivery Line 
Ad Hoc Delivery Tickets require a Company. Please provide a Company  Ad Hoc Delivery Tickets require a Company. Please provide a Company 
The Company on a Goods Delivery Ticket cannot be updated once the Delivery Ticket is created.  The Company on a Goods Delivery Ticket cannot be updated once the Delivery Ticket is created. 
Requester for Goods Delivery Ticket cannot be updated once the Delivery Ticket is created unless the Delivery Ticket is in Draft Status and there are no Delivery Runs.  Requester for Goods Delivery Ticket cannot be updated once the Delivery Ticket is created unless the Delivery Ticket is in Draft Status and there are no Delivery Runs. 
Deliver-To for Goods Delivery Ticket cannot be updated once the Delivery Ticket is created unless the Delivery Ticket is in Draft Status and there are no Delivery Runs.  Deliver-To for Goods Delivery Ticket cannot be updated once the Delivery Ticket is created unless the Delivery Ticket is in Draft Status and there are no Delivery Runs. 
 
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. 
Updates are not allowed for Goods Delivery Tickets in Cancel or Closed status.  Updates are not allowed for Goods Delivery Tickets in Cancel or Closed status. 
top
 

Response Element: Submit_Ad_Hoc_Goods_Delivery_Response

Submit Ad Hoc Goods Delivery Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Goods_Delivery_Reference  Goods_DeliveryObject  [0..1]  Goods Delivery Ticket Request References   
Exceptions_Response_Data  Application_Instance_Related_Exceptions_Data  [0..*]  Element containing Exceptions Data   
top
 

Goods_DeliveryObject

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

Goods_DeliveryObjectID

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

Ad_Hoc_Goods_Delivery_Data

part of: Submit_Ad_Hoc_Goods_Delivery_Request
The request element containing all Ad Hoc Goods Delivery Data. An Ad Hoc Goods Delivery may have multiple lines.
 
Parameter name Type/Value Cardinality Description Validations
Goods_Delivery_ID  string  [0..1]  Goods Delivery Ticket Number   
Company_for_Goods_Delivery_Ticket_Reference  CompanyObject  [1..1]  Reference to the Company for Goods Delivery Ticket   
Requester_Reference  WorkerObject  [0..1]  Reference to the Requester of the Goods Delivery Ticket   
Delivery_To_Reference  LocationObject  [0..1]  Reference to the Delivery To location for the Goods Delivery Ticket   
Tracking_ID  string  [0..1]  Reference to Tracking ID of the Goods Delivery Ticket   
Memo  string  [0..1]  Reference to the Document Memo of the Goods Delivery Ticket   
Goods_Delivery_Ticket_Line_Data  Ad_Hoc_Goods_Delivery_Line_Data  [0..*]  Goods Delivery Ticket Line Data 
Validation Description
Ad Hoc Goods Delivery Line requires description. Please provide a valid item or description.  Ad Hoc Goods Delivery Line requires description. Please provide a valid item or description. 
Quantity for the Goods Delivery Line must be greater than zero  Quantity for the Goods Delivery Line must be greater than zero 
 
Validation Description
At least on line is required on the Goods Delivery Ticket. Please enter at least one Goods Delivery Line  At least on line is required on the Goods Delivery Ticket. Please enter at least one Goods Delivery Line 
Ad Hoc Delivery Tickets require a Company. Please provide a Company  Ad Hoc Delivery Tickets require a Company. Please provide a Company 
The Company on a Goods Delivery Ticket cannot be updated once the Delivery Ticket is created.  The Company on a Goods Delivery Ticket cannot be updated once the Delivery Ticket is created. 
Requester for Goods Delivery Ticket cannot be updated once the Delivery Ticket is created unless the Delivery Ticket is in Draft Status and there are no Delivery Runs.  Requester for Goods Delivery Ticket cannot be updated once the Delivery Ticket is created unless the Delivery Ticket is in Draft Status and there are no Delivery Runs. 
Deliver-To for Goods Delivery Ticket cannot be updated once the Delivery Ticket is created unless the Delivery Ticket is in Draft Status and there are no Delivery Runs.  Deliver-To for Goods Delivery Ticket cannot be updated once the Delivery Ticket is created unless the Delivery Ticket is in Draft Status and there are no Delivery Runs. 
top
 

CompanyObject

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

LocationObject

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

LocationObjectID

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

Ad_Hoc_Goods_Delivery_Line_Data

part of: Ad_Hoc_Goods_Delivery_Data
Element containing all Ad Hoc Goods Delivery Line data. An Ad Hoc Goods Delivery may have multiple lines
 
Parameter name Type/Value Cardinality Description Validations
Goods_Delivery_Line_Reference  Goods_Delivery_LineObject  [0..1]  Reference of Goods Delivery Ticket Line   
Goods_Delivery_Line_Number  decimal (4, 0) >0   [0..1]  Reference ID   
Item_Reference  Procurement_ItemObject  [0..1]  Reference of an Item on the Goods Delivery Ticket 
Validation Description
Cannot update Item on Goods Delivery ticket unless it is an Ad Hoc Delivery ticket in Draft or In Progress Status with no delivery runs.   
 
Line_Item_Description  string  [0..1]  Description for Goods Delivery Line 
Validation Description
Cannot update Item Description on Goods Delivery ticket unless it is an Ad Hoc Delivery ticket in Draft or In Progress Status with no delivery runs and Item.  Cannot update Item Description on Goods Delivery ticket unless it is an Ad Hoc Delivery ticket in Draft or In Progress Status with no delivery runs and Item. 
 
Quantity  decimal (22, 2)   [1..1]  Quantity for the Goods Delivery Ticket Line 
Validation Description
Cannot update Quantity on Goods Delivery ticket unless it is an Ad Hoc Delivery ticket in Draft or In Progress Status with no delivery runs.   
 
Unit_of_Measure_Reference  Unit_of_MeasureObject  [0..1]  Reference to the Unit of Measure for the Goods Delivery Ticket Line 
Validation Description
Cannot update Unit of Measure on Goods Delivery ticket unless it is an Ad Hoc Delivery ticket in Draft or In Progress Status with no delivery runs.   
 
Signature_Required  boolean  [0..1]  Signature or Proof Required Boolean for the Goods Delivery Ticket Line 
Validation Description
Cannot update Signature Required on Goods Delivery ticket unless it is an Ad Hoc Delivery ticket in Draft or In Progress Status with no delivery runs.   
 
Line_Memo  string  [0..1]  Memo for the Goods Delivery Ticket Line   
Validation Description
Ad Hoc Goods Delivery Line requires description. Please provide a valid item or description.  Ad Hoc Goods Delivery Line requires description. Please provide a valid item or description. 
Quantity for the Goods Delivery Line must be greater than zero  Quantity for the Goods Delivery Line must be greater than zero 
top
 

Goods_Delivery_LineObject

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

Goods_Delivery_LineObjectID

part of: Goods_Delivery_LineObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Goods_Delivery_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, Good_Delivery_ID, Goods_Delivery_Run_ID  [1..1]  The unique identifier type of a parent object   
top
 

Procurement_ItemObject

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

Procurement_ItemObjectID

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

Unit_of_MeasureObject

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

Application_Instance_Related_Exceptions_Data

part of: Submit_Ad_Hoc_Goods_Delivery_Response
Element containing Exceptions Data
 
Parameter name Type/Value Cardinality Description Validations
Exceptions_Data  Application_Instance_Exceptions_Data  [0..*]  Exceptions Data   
top
 

Application_Instance_Exceptions_Data

part of: Application_Instance_Related_Exceptions_Data
Element containing application related exceptions data
 
Parameter name Type/Value Cardinality Description Validations
Exception_Data  Exception_Data  [0..*]  Exception Data   
top
 

Exception_Data

part of: Application_Instance_Exceptions_Data
Exception (Errors and Warning) associated with the transaction.
 
Parameter name Type/Value Cardinality Description Validations
Classification  string  [0..1]  Exception Classification (Error or Warning)   
Message  string  [0..1]  Exception Detail   
top
 

Goods_DeliveryReferenceEnumeration

part of: Goods_DeliveryObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Goods_Delivery_LineReferenceEnumeration

part of: Goods_Delivery_LineObjectID
Base Type
string
top
 

Base Type
string

top
 

Procurement_ItemReferenceEnumeration

part of: Procurement_ItemObjectID
Base Type
string
top
 

Unit_of_MeasureReferenceEnumeration

part of: Unit_of_MeasureObjectID
Base Type
string
top