Service Directory > v32.1 > Cash_Management > Get_Donor_Contributions
 

Operation: Get_Donor_Contributions

This service operation will get Donor Contributions for the specified criteria.


@ - 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: Get_Donor_Contributions_Request

This element is the top-level request element for Get Donor Contribution..
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Donor_Contribution_Request_References  [0..1]  Element containing references to Donor Contributions.   
Request_Criteria [Choice]   Donor_Contribution_Request_Criteria  [0..1]  Element containing search criteria for Donor Contributions.   
Response_Filter  Response_Filter  [0..1]  Element containing Response Filter. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Donor_Contributions_Response

Element containing Donor Contribution response elements including received criteria, references, data based on criteria and grouping, results filter and result summary
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Donor_Contribution_Request_References  [0..1]  Element containing references to existing Donor Contributions.   
Request_Criteria  Donor_Contribution_Request_Criteria  [0..1]  Element containing search criteria for Donor Contributions.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Donor_Contribution_Response_Data  [0..1]  Element containing data for existing Donor Contributions.   
top
 

Donor_Contribution_Request_References

part of: Get_Donor_Contributions_Request, Get_Donor_Contributions_Response
Element containing references to existing Donor Contributions.
 
Parameter name Type/Value Cardinality Description Validations
Donor_Contribution_Reference  Donor_ContributionObject  [1..*]  References to existing Donor Contributions.   
top
 

Donor_ContributionObject

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

Donor_ContributionObjectID

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

Donor_Contribution_Request_Criteria

part of: Get_Donor_Contributions_Request, Get_Donor_Contributions_Response
Element containing search criteria for Donor Contributions.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Donor_Contributions_Request, Get_Donor_Contributions_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Response_Results

part of: Get_Donor_Contributions_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Donor_Contribution_Response_Data

part of: Get_Donor_Contributions_Response
Element containing data for existing Donor Contributions.
 
Parameter name Type/Value Cardinality Description Validations
Donor_Contribution  Donor_Contribution  [0..*]  Donor Contribution   
top
 

Donor_Contribution

part of: Donor_Contribution_Response_Data
Element containing reference to existing Donor Contribution and data.
 
Parameter name Type/Value Cardinality Description Validations
Donor_Contribution_Reference  Donor_ContributionObject  [0..1]  Reference to an existing Donor Contribution.   
Donor_Contribution_Data  Donor_Contribution_Data  [0..*]  Element containing essential Donor Contribution data   
top
 

Donor_Contribution_Data

part of: Donor_Contribution
Element containing essential Donor Contribution data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Donor Contribution ID   
Submit  boolean  [0..1]  Save and Submit   
Donor_Reference  DonorObject  [1..1]  Reference to the Donor that made the contribution   
Gift_Reference  GiftObject  [1..1]  Reference to the Gift that the contribution is for   
Date_Received  date  [1..1]  The date the Donor Contribution was received   
Date_Recorded  date  [0..1]  The date the Donor Contribution was recorded   
Amount  decimal (26, 6) >0   [1..1]  The currency value of the Donor Contribution   
Currency_Reference  CurrencyObject  [0..1]  Currency Reference   
Attachment_Data  Financials_Attachment_Data  [0..*]  Attachment Data 
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
 
top
 

DonorObject

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

DonorObjectID

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

CurrencyObject

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

CurrencyObjectID

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

Donor_ContributionReferenceEnumeration

part of: Donor_ContributionObjectID
Base Type
string
top
 

DonorReferenceEnumeration

part of: DonorObjectID
Base Type
string
top
 

GiftReferenceEnumeration

part of: GiftObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top