Service Directory > v32.1 > Revenue_Management > Put_Subrecipient
 

Operation: Put_Subrecipient

This service operation will create or update Subrecipients. Subrecipient Data includes Subrecipient Reference ID, DUNS+4, Is SAM Registered flag, Tax Location Reference, and Attachment Data.


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

Element containing Subrecipient reference for update and all Subrecipient data.
 
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.   
Subrecipient_Reference  Subrecipient_AbstractObject  [0..1]  Reference to an existing Subrecipient for update purposes only.   
Subrecipient_Data  Subrecipient_Data  [1..1]  Element containing data for a single Subrecipient.   
Validation Description
Subrecipient must correspond with an existing Supplier ID.   
top
 

Response Element: Put_Subrecipient_Response

Element containing Put Subrecipient Response Data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Subrecipient_Reference  Subrecipient_AbstractObject  [0..1]  Reference to the Subrecipient that was created or updated by this task.   
top
 

Subrecipient_AbstractObject

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

Subrecipient_AbstractObjectID

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

Subrecipient_Data

part of: Put_Subrecipient_Request
Element containing data for a single Subrecipient.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The Reference ID of this Subrecipient.   
DUNS4  string (4)   [0..1]  The DUNS+4 value of this Subrecipient.   
Is_SAM_Registered_Reference  Is_SAM_RegisteredObject  [0..1]  Reference to the Is SAM Registered value of this Subrecipient.   
Tax_Location_Reference  Tax_LocationObject  [0..1]  Tax Location of this Subrecipient.   
Address_Reference  Address_ReferenceObject  [0..1]  Reference ID to an existing supplier address 
Validation Description
The address entered is invalid. Enter an existing address for [supplier].   
 
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.   
 
top
 

Is_SAM_RegisteredObject

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

Is_SAM_RegisteredObjectID

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

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

Tax_LocationObjectID

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

Address_ReferenceObject

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

Financials_Attachment_Data

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

Subrecipient_AbstractReferenceEnumeration

part of: Subrecipient_AbstractObjectID
Base Type
string
top
 

Is_SAM_RegisteredReferenceEnumeration

part of: Is_SAM_RegisteredObjectID
Base Type
string
top
 

Tax_LocationReferenceEnumeration

part of: Tax_LocationObjectID
Base Type
string
top
 

Address_ReferenceReferenceEnumeration

part of: Address_ReferenceObjectID
Base Type
string
top