Service Directory > v31.2 > Resource_Management > Submit_Advanced_Ship_Notice
 

Operation: Submit_Advanced_Ship_Notice

This operation can create a Advance Shipment Notice and submit it to the business process. It can also modify an existing Advance Shipment Notice in Draft status.


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

Element containing Advanced Ship Notice reference for update, Advanced Ship Notice Business Processing Options, Flag to indicate if this operation is add only and all Advanced Ship Notice data items required to create a Advanced Ship Notice.
 
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.   
Advanced_Ship_Notice_Reference  Advanced_Ship_NoticeObject  [0..1]  Reference to an existing Advanced Ship Notice.   
Business_Process_Parameters  Financials_Business_Process_Parameters  [0..1]  Business Process Parameters provide the ability to auto-submit to the business process.   
Advanced_Ship_Notice_Data  Advanced_Ship_Notice_Data_Inbound  [0..1]  Advanced Ship Notice Data. 
Validation Description
A Purchase Order Goods line is required on Advanced Ship Notice.   
Purchase order goods line cannot be referenced more than once in a Advanced Ship Notice.   
Purchase Order is not in Issued status.   
 
Validation Description
Updates are allowed only for Advanced Ship Notice documents that are in Draft or In-Progress status.   
The Web Service is set to Add Only; documents cannot be resubmitted.   
top
 

Response Element: Submit_Advanced_Ship_Notice_Response

Submit Advanced Ship Notice Response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Advanced_Ship_Notice_Reference  Advanced_Ship_NoticeObject  [0..1]  Reference to an existing Advanced Ship Notice.   
Exceptions_Response_Data  Application_Instance_Related_Exceptions_Data  [0..1]  Element containing Exceptions Data   
top
 

Advanced_Ship_NoticeObject

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

Advanced_Ship_NoticeObjectID

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

Financials_Business_Process_Parameters

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

Advanced_Ship_Notice_Data_Inbound

part of: Submit_Advanced_Ship_Notice_Request
Advanced Ship Notice Data.
 
Parameter name Type/Value Cardinality Description Validations
Advanced_Ship_Notice_ID  string  [0..1]  Advanced Ship Notice Reference ID. This is optional and will be auto-generated if left blank on the Web Service request.   
Submit  boolean  [0..1]  Boolean flag to indicate whether the Advanced Ship Notice should be submitted to the business process.   
Auto_Submit_Receipt_for_Approval  boolean  [0..1]  Auto Submit Receipt for Approval   
Bill_Of_Lading  string  [0..1]  Bill Of Lading   
Carrier_Tracking_Number  string  [0..1]  Carrier Tracking Number   
Origin_Reference  Document_Creation_MethodObject  [0..1]  References how the how Advance Ship Notice document got created. Possible values for the reference id (Source_Name) are 'Web Service' , 'EDI', 'Manual' .   
Shipment_Contact  string  [0..1]  Shipment Contact   
Shipment_Reference  string  [0..1]  Shipment Reference   
Supplier_Order_Reference  string  [0..1]  Supplier Order Reference   
Purchase_Order_Reference  Purchase_OrderObject  [1..1]  Reference to Purchase Order for which the Advanced Ship Notice is created.   
Memo  string  [0..1]  Comment at ASN document level.   
License_Plate  string  [0..1]  License Plate Number   
Bill_of_Lading_Quantity  decimal (20, 0) >0   [0..1]  Bill of Lading Quanatity   
Shipment_Date  dateTime  [1..1]  Shipment Date   
Ship-To_Address_Reference  Unique_IdentifierObject  [0..1]  Ship-To Address for Advance Ship Notice. If value is not provided defaults to Ship-To Address of Purchase Order.   
Ship-To_Address_Global_Location_Number [Choice]   string  [0..1]  User can provide Global Location Number here; the Location assigned to it will be used to populate the Ship-to Address   
Ship-To_Address_Customer_Account_Number [Choice]   string (30)   [0..1]  User can provide EDI Customer Account Number here; the Location assigned to it will be used to populate the Ship-to Address   
Advanced_Ship_Notice_Line_Data  Advanced_Ship_Notice_Line_Data_Inbound  [0..*]  Element that captures Advanced Ship Notice Line information. An Advanced Ship Notice can have one or more Advanced Ship Notice Lines 
Validation Description
Enter a positive Shipped Quantity   
The field Quantity is required and must have a value.   
Goods line [line] does not belong to Purchase Order [po].   
Goods Line [line] is fully shipped.   
Lot Identifier cannot be referenced more than once for a given Advanced Ship Notice Line.   
Total Lot Quantity should match the Advance Ship Notice Line Shipped Quantity.   
Shipped Unit Cost cannot be negative   
Conversion Factor has to be greater than zero.   
Goods Line [line] is fully received.   
Purchase Order Line has negative unit cost.   
The Deliver-To Location is invalid for the selected Delivery Type and/or Company.   
Can't receive an advanced ship notice against a purchase order line that's Closed for Receiving   
 
Business_Document_Attachment_Data  Financials_Attachment_Data  [0..*]  Encapsulating element containing all Business Document Attachment data. 
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
 
Validation Description
A Purchase Order Goods line is required on Advanced Ship Notice.   
Purchase order goods line cannot be referenced more than once in a Advanced Ship Notice.   
Purchase Order is not in Issued status.   
top
 

Document_Creation_MethodObject

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

Document_Creation_MethodObjectID

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

Unique_IdentifierObject

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

Advanced_Ship_Notice_Line_Data_Inbound

part of: Advanced_Ship_Notice_Data_Inbound
Element that captures Advanced Ship Notice Line information.
 
Parameter name Type/Value Cardinality Description Validations
Advanced_Ship_Notice_Line_ID  string  [0..1]  Advanced Ship Notice Line Reference ID. This is optional and will be auto-generated if left blank.   
Item_Description  string  [0..1]  Item Description   
Shipment_Line_Reference  string  [0..1]  Shipment Line Reference.   
Shipped_Quantity  decimal (22, 2)   [1..1]  Shipped Quantity on Advanced Ship Notice Line.   
Shipped_Unit_of_Measure_Reference  Unit_of_MeasureObject  [0..1]  Reference of the Unit Of Measure for the Shipped Quantity. If value is not provided, it defaults to Unit of Measure from the corresponding Purchase Order line.   
Shipped_Unit_Cost  decimal (26, 6)   [0..1]  The unit cost of the item specified in the currency associated to the Purchase Order currency. If value is not provided, defaults to unit cost of corresponding line in Purchase Order.   
Conversion_Factor  decimal (21, 9) >0   [0..1]  Positive numeric value used to calculate the Ordered Quantity that is shipped from Shipped Quantity provided at Advance Shipment Line. If Shipped Quantity is five and Conversion Factor is two , then Quantity shipped is calculated as Ten. Default value for Conversion Factor is one.   
Deliver_To_Location_Reference  LocationObject  [0..1]  The location where the items will be delivered.   
Deliver_To_Location_Global_Location_Number [Choice]   string  [0..1]  User can provide Global Location Number here; the Location assigned to it will be used to populate the Deliver-to Location   
Deliver_To_Location_Customer_Account_Number [Choice]   string (30)   [0..1]  User can provide EDI Customer Account Number here; the Location assigned to it will be used to populate the Deliver-To Location   
Memo  string  [0..1]  Line Memo   
Purchase_Order_Line_Reference  Item_Order_LineObject  [1..1]  Goods line from a Purchase Order for which the Advanced Ship Notice Line is created.   
Alternate_Item_Identifier_Data  Line_Alternate_Item_Attribute_Value_Data_Inbound  [0..*]  Alternate Item Identifiers for Item on Advance Ship Notice Line 
Validation Description
Item Identifier Type mapped to Universal Item Identifier with External Name [EN] is not defined.   
Length of Alternate Item Identifier's [AIID] value is not same as the allowed length [LEN].   
Enter a 14 digit numeric value for GTIN Alternate Item Identifier.   
Only alphanumeric values are allowed for UPN.   
Value needs to be provided for Manufacturer.   
Value needs to be provided for [ExternalName].   
Enter a valid GTIN   
Manufacturer Reference not allowed for [ExternalName]   
Can't enter duplicate External Name if Allow Multiples flag is not enabled for Item Identifier mapped to [ExternalName].   
Invalid value for External Name [ET].   
 
Lot_Information_Data  ASN_Line_Lot_Information_Data_Inbound  [0..*]  Element that contains Lot Information for Item on Advance Ship Notice Line 
Validation Description
Quantity cannot be negative   
The count of serial numbers entered does not match the quantity.   
The Lot ID is required for lot-controlled items.   
 
Validation Description
Enter a positive Shipped Quantity   
The field Quantity is required and must have a value.   
Goods line [line] does not belong to Purchase Order [po].   
Goods Line [line] is fully shipped.   
Lot Identifier cannot be referenced more than once for a given Advanced Ship Notice Line.   
Total Lot Quantity should match the Advance Ship Notice Line Shipped Quantity.   
Shipped Unit Cost cannot be negative   
Conversion Factor has to be greater than zero.   
Goods Line [line] is fully received.   
Purchase Order Line has negative unit cost.   
The Deliver-To Location is invalid for the selected Delivery Type and/or Company.   
Can't receive an advanced ship notice against a purchase order line that's Closed for Receiving   
top
 

Unit_of_MeasureObject

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

LocationObject

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

Item_Order_LineObject

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

Item_Order_LineObjectID

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

Line_Alternate_Item_Attribute_Value_Data_Inbound

part of: Advanced_Ship_Notice_Line_Data_Inbound
Element that captures Alternate Item Identifiers for a Line
 
Parameter name Type/Value Cardinality Description Validations
External_Name  string  [0..1]  External Name of Alternate Identifier   
Value  string  [0..1]  Alternate Identifier Value   
Manufacturer_Reference  ManufacturerObject  [0..1]  Reference to existing Manufacturer associated with the Item Identifier Type   
Validation Description
Item Identifier Type mapped to Universal Item Identifier with External Name [EN] is not defined.   
Length of Alternate Item Identifier's [AIID] value is not same as the allowed length [LEN].   
Enter a 14 digit numeric value for GTIN Alternate Item Identifier.   
Only alphanumeric values are allowed for UPN.   
Value needs to be provided for Manufacturer.   
Value needs to be provided for [ExternalName].   
Enter a valid GTIN   
Manufacturer Reference not allowed for [ExternalName]   
Can't enter duplicate External Name if Allow Multiples flag is not enabled for Item Identifier mapped to [ExternalName].   
Invalid value for External Name [ET].   
top
 

ManufacturerObject

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

ManufacturerObjectID

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

ASN_Line_Lot_Information_Data_Inbound

part of: Advanced_Ship_Notice_Line_Data_Inbound
Element that contains Lot Information for Item on Advance Ship Notice Line
 
Parameter name Type/Value Cardinality Description Validations
Lot_Identifier  string  [0..1]  Free form text field for Item Lot Identifier   
Manufacture_Date  date  [0..1]  Manufacturer Date for the Item Lot   
Expiration_Date  date  [0..1]  Expiration Date for the Item Lot   
Quantity  decimal (22, 2)   [1..1]  Shipped Quantity for Lot   
Serial_Identifiers  ASN_Item_Serial_Data_Inbound  [0..*]  Serial Identifier   
Memo  string  [0..1]  Free form text for Item Lot Memo   
Validation Description
Quantity cannot be negative   
The count of serial numbers entered does not match the quantity.   
The Lot ID is required for lot-controlled items.   
top
 

ASN_Item_Serial_Data_Inbound

part of: ASN_Line_Lot_Information_Data_Inbound
Serial Identifier
 
Parameter name Type/Value Cardinality Description Validations
Serial_Identifier  string  [1..1]  Serial Identifier   
top
 

Financials_Attachment_Data

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

Application_Instance_Related_Exceptions_Data

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

Advanced_Ship_NoticeReferenceEnumeration

part of: Advanced_Ship_NoticeObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Document_Creation_MethodReferenceEnumeration

part of: Document_Creation_MethodObjectID
Base Type
string
top
 

Purchase_OrderReferenceEnumeration

part of: Purchase_OrderObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Unit_of_MeasureReferenceEnumeration

part of: Unit_of_MeasureObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Item_Order_LineReferenceEnumeration

part of: Item_Order_LineObjectID
Base Type
string
top
 

Base Type
string

top
 

ManufacturerReferenceEnumeration

part of: ManufacturerObjectID
Base Type
string
top