Service Directory > v31.2 > Cash_Management > Put_Investment_Pool_Catch-up_Payout_Criteria
 

Operation: Put_Investment_Pool_Catch-up_Payout_Criteria

Web service to submit request to initiate the Run Catch-up Payout with the information supplied in the request.


@ - 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_Investment_Pool_Catch-up_Payout_Criteria_Request

Catch-up Payout Criteria Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only   
Catch-up_Payout_Criteria_Data  Catch-up_Payout_Criteria_Data  [1..1]  Catch-up Payout Criteria Data 
Validation Description
There needs to be a valuation for period [PayoutPeriod] in order to process reinvestment purchases.   
One or more gifts is inactive. Catch-up Payout requires that gifts in payout are active.   
One or more gifts do not belong to the investment pool. Catch-up payout requires that specified gifts must belong to the Investment Pool.   
 
Validation Description
The Web Service is set to Add Only; documents cannot be resubmitted.   
top
 

Response Element: Put_Investment_Pool_Catch-up_Payout_Criteria_Response

Catch-up Payout Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Investment_Pool_Payout_Criteria_Reference  Unique_IdentifierObject  [0..1]  Catch-up Payout Criteria Response   
Investment_Pool_Payout_Criteria  Investment_Pool_Payout_Criteria_Data  [0..1]  Investment Pool Payout Criteria   
top
 

Catch-up_Payout_Criteria_Data

part of: Put_Investment_Pool_Catch-up_Payout_Criteria_Request
Catch-up Payout Criteria Data
 
Parameter name Type/Value Cardinality Description Validations
Investment_Pool_Reference  Investment_PoolObject  [1..1]  Investment Pool Reference   
Transaction_Date  date  [1..1]  Transaction Date 
Validation Description
Transaction Date cannot be greater than the current date.   
 
Gift_Reference  GiftObject  [1..*]  Gift Reference   
Fiscal_Time_Interval_Reference  Fiscal_Time_IntervalObject  [1..1]  Fiscal Time Interval   
Fiscal_Year_Reference  Fiscal_YearObject  [1..1]  Fiscal Year Reference   
Payout_per_unit  decimal (26, 6) >0   [1..1]  Payout per unit   
Administrative_fee_per_unit  decimal (26, 6) >0   [1..1]  Administrative Fee per unit   
Validation Description
There needs to be a valuation for period [PayoutPeriod] in order to process reinvestment purchases.   
One or more gifts is inactive. Catch-up Payout requires that gifts in payout are active.   
One or more gifts do not belong to the investment pool. Catch-up payout requires that specified gifts must belong to the Investment Pool.   
top
 

Investment_PoolObject

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

Investment_PoolObjectID

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

GiftObject

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

GiftObjectID

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

Fiscal_Time_IntervalObject

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

Fiscal_Time_IntervalObjectID

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

Fiscal_YearObject

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

Fiscal_YearObjectID

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

Unique_IdentifierObject

part of: Put_Investment_Pool_Catch-up_Payout_Criteria_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  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
 

Investment_Pool_Payout_Criteria_Data

part of: Put_Investment_Pool_Catch-up_Payout_Criteria_Response
Investment Pool Payout Criteria Data
 
Parameter name Type/Value Cardinality Description Validations
Payout_per_unit  decimal (26, 6) >0   [0..1]  Payout per unit   
Administrative_Fee_per_unit  decimal (26, 6) >0   [0..1]  Administrative Fee per unit   
End_Date  date  [0..1]  End Date   
Investment_Pool_Payout_Reference  Investment_Pool_PayoutObject  [0..1]  Investment Pool Reference   
top
 

Investment_Pool_PayoutObject

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

Investment_Pool_PayoutObjectID

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

Investment_PoolReferenceEnumeration

part of: Investment_PoolObjectID
Base Type
string
top
 

GiftReferenceEnumeration

part of: GiftObjectID
Base Type
string
top
 

Fiscal_Time_IntervalReferenceEnumeration

part of: Fiscal_Time_IntervalObjectID
Base Type
string
top
 

Fiscal_YearReferenceEnumeration

part of: Fiscal_YearObjectID
Base Type
string
top
 

Base Type
string

top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Investment_Pool_PayoutReferenceEnumeration

part of: Investment_Pool_PayoutObjectID
Base Type
string
top