Service Directory > v31.2 > Revenue_Management > Get_Customer_Activity
 

Operation: Get_Customer_Activity

This service operation will get Customer Activity for the specified criteria. The Customer Activity web service provides the same information as the on-line Customer Activity Detail report. The data includes Reporting Transaction, Transaction Date, Transaction Type, Transaction Number, Invoice Document Due Date, Transaction Addition (amount), Transaction Subtraction (amount), Currency, Customer, and Opportunity. The request criteria can be for a single transaction based on Reference, or all transaction can be retrieved if no criteria is specified.


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

This element is the top-level request element for all "Get" Customer Activity operations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Customer_Activity_Request_Criteria  [0..*]  Request Criteria for returning the Customer Activity details   
Response_Filter  Response_Filter  [0..*]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Customer_Activity_Response

Top-level response element for all "Get" Customers Activity operations
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Customer_Activity_Request_Criteria  [0..*]  Customer Activity Request Criteria   
Response_Filter  Response_Filter  [0..*]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..*]  Customer Activity Response Results   
Customer_Activity_Response_Data  Customer_Activity_Response_Data  [0..*]  Customer Activity Response Data   
top
 

Customer_Activity_Request_Criteria

part of: Get_Customer_Activity_Request, Get_Customer_Activity_Response
Wrapper element around a list of elements representing the specific criteria needed to search for Customer Activity instances.
 
Parameter name Type/Value Cardinality Description Validations
Event_Reference [Choice]   Transaction_LogObject  [0..1]  Event Reference   
Customer_Activity_Criteria [Choice]   Customer_Activity_Criteria  [0..1]  Element content for requesting specific Customer and Transaction Date Range 
Validation Description
Customer reference is for a customer that can be used as a basic worktag only.  Customer reference is for a customer that can be used as a basic worktag only. 
 
Company_Reference  CompanyObject  [0..*]  One or more references to a Company that will be used as an additional filter to limit which Customer Activity will be returned for the provided Transaction Log or Customer Activity Criteria.   
top
 

Transaction_LogObject

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

Transaction_LogObjectID

part of: Transaction_LogObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Absence_Case_ID, Assignable_Payroll_ID, Background_Check_ID, Background_Process_Instance_ID, Backorder_Event_ID, Budget_Amendment_ID, Change_Order_Reference_ID, Compensation_Review_Event_ID, Customer_Request_ID, Customer_Request_Reference_ID, Eligibility_Override_Event_ID, Employee_Review_ID, Employee_Severance_Worksheet_Event_ID, Goods_Delivery_Group_ID, Goods_Delivery_Run_ID, Historical_Student_Charge_ID, Invite_Committee_Candidate_Event_ID, IRS_1099_MISC_Adjustment_ID, Mass_Change_Requisition_Requester_ID, Medicare_Information_Event_ID, Position_Budget_Group_ID, Procurement_Mass_Close_ID, Procurement_Mass_ReOpen_ID, Procurement_Roll_Forward_ID, Receipt_Number, Request_Leave_of_Absence_ID, Requisition_Sourcing_Event_ID, Spend_Authorization_ID, Spend_Authorization_Mass_Close_ID, Student_Charge_Adjustment_ID, Student_Charge_Document_ID, Student_Charge_ID, Student_Dismissal_Event_ID, Student_Employment_Eligibility_Event_ID, Student_Hold_Assignment_Override_Event_ID, Student_Institutional_Withdrawal_Event_ID, Student_Leave_of_Absence_Event_ID, Supplier_Contract_Amendment_ID, Supplier_Contract_History_ID, Supplier_Contract_ID, Supplier_Invoice_Contract_ID, Workday_Project_ID, Worker_Time_Card_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
 

Customer_Activity_Criteria

part of: Customer_Activity_Request_Criteria
Element containing Customer Activity criteria for requesting a specific customer and date range for transactions
 
Parameter name Type/Value Cardinality Description Validations
Customer_Reference  CustomerObject  [1..1]  Customer Reference   
Start_Date  date  [1..1]  Start Date   
End_Date  date  [1..1]  End Date   
Validation Description
Customer reference is for a customer that can be used as a basic worktag only.  Customer reference is for a customer that can be used as a basic worktag only. 
top
 

CustomerObject

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

CustomerObjectID

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

CompanyObject

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

Response_Filter

part of: Get_Customer_Activity_Request, Get_Customer_Activity_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_Customer_Activity_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
 

Customer_Activity_Response_Data

part of: Get_Customer_Activity_Response
Wrapper Element for Customer Activity Data
 
Parameter name Type/Value Cardinality Description Validations
Customer_Activity  Customer_Activity  [0..*]  Wrapper element that contains the Customer Activity data elements that are included in the response as requested by the references, criteria and grouping   
top
 

Customer_Activity

part of: Customer_Activity_Response_Data
This Element contains Customer Activity attributes
 
Parameter name Type/Value Cardinality Description Validations
Reporting_Transaction_Reference  Reporting_TransactionObject  [0..1]  Reporting Transaction Instance   
Transaction_Date  date  [0..1]  Reporting Transaction Date   
Transaction_Type  string  [0..1]  Reporting Transaction Type Name   
Transaction_Number  string  [0..1]  Reporting Transaction Number   
Sequence_Number  string  [0..1]  Sequence Number if Customer Payment else Reporting Transaction Number   
Invoice_Document_Due_Date  date  [0..1]  Invoice Document Due Date   
Transaction_Additions  decimal (26, 6)   [0..1]  Reporting Transaction Increase   
Transaction_Subtractions  decimal (26, 6)   [0..1]  Transaction Decrease   
Currency_Reference  CurrencyObject  [0..1]  Reporting Transaction Currency   
Customer_Reference  Billable_EntityObject  [0..1]  Customer Reference   
Opportunity_Reference  OpportunityObject  [0..1]  Opportunity Reference   
top
 

Reporting_TransactionObject

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

Reporting_TransactionObjectID

part of: Reporting_TransactionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Ad_hoc_Payment_Reference_ID, Advanced_Ship_Notice_ID, Advanced_Ship_Notice_Number, Award_Contract_Amendment_ID, Award_Proposal_ID, Award_Reference_ID, Bank_Account_Transfer_Payment_ID, Cash_Sale_ID, Change_Order_Reference_ID, Consolidated_Invoice_ID, Customer_Contract_Alternate_Reference_ID, Customer_Contract_Amendment_Reference_ID, Customer_Contract_Intercompany_ID, Customer_Contract_Reference_ID, Customer_Invoice_Adjustment_Reference_ID, Customer_Invoice_Reference_ID, Customer_Overpayment_Reference_ID, Customer_Payment_for_Invoices_Reference_ID, Customer_Refund_Reference_ID, Document_Number, EFT_Payment_ID, Expense_Report_Reference_ID, Good_Delivery_ID, Goods_Delivery_Run_ID, Historical_Student_Charge_ID, Internal_Service_Delivery_Document_Number, Internal_Service_Delivery_ID, Inventory_Count_Sheet_Reference_ID, Inventory_Par_Count_Reference_ID, Inventory_Pick_List_Reference_ID, Inventory_Return_Reference_ID, Inventory_Ship_List_Reference_ID, Inventory_Stock_Request_Reference_ID, PO_Acknowledgement_Number, PO_Acknowledgement_Reference_ID, Procurement_Card_Transaction_Verification_ID, Purchase_Order_Reference_ID, Receipt_Number, Request_for_Quote_Award_ID, Request_for_Quote_ID, Request_for_Quote_Response_ID, Requisition_Number, Requisition_Template_ID, Return_to_Supplier_ID, Spend_Authorization_ID, Student_Application_Fee_Payment_ID, Student_Charge_Adjustment_ID, Student_Charge_Document_ID, Student_Charge_ID, Student_Credit_Memo_ID, Student_Disbursement_Payment_ID, Student_Historical_Payment_ID, Student_Payment_ID, Student_Sponsor_Contract_ID, Student_Sponsor_Payment_ID, Student_Sponsor_Refund_Payment_ID, Student_Waiver_Payment_ID, Supplier_Acknowledgement_Number, Supplier_Contract_Amendment_ID, Supplier_Contract_History_ID, Supplier_Contract_ID, Supplier_Invoice_Adjustment_Reference_ID, Supplier_Invoice_Contract_ID, Supplier_Invoice_Reference_ID, Supplier_Invoice_Request_Document_Number, Supplier_Invoice_Request_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, Document_Number, Purchase_Order_Reference_ID  [1..1]  The unique identifier type of a parent object   
top
 

CurrencyObject

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

Billable_EntityObject

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

Billable_EntityObjectID

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

OpportunityObject

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

OpportunityObjectID

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

Transaction_LogReferenceEnumeration

part of: Transaction_LogObjectID
Base Type
string
top
 

CustomerReferenceEnumeration

part of: CustomerObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Reporting_TransactionReferenceEnumeration

part of: Reporting_TransactionObjectID
Base Type
string
top
 

Base Type
string

top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Billable_EntityReferenceEnumeration

part of: Billable_EntityObjectID
Base Type
string
top
 

OpportunityReferenceEnumeration

part of: OpportunityObjectID
Base Type
string
top