| Description | Query Time Account Balances |
| Name | TimeAndLabourManagementTimeAccountInformationRequestingIn |
| Namespace | http://sap.com/xi/AP/TimeAndLabourManagement/Global |
| Product | SAP Business ByDesign |
| Process component | Time and Labour Management |
| Process component namespace | http://sap.com/xi/AP/TimeAndLabourManagement/Global |
| Deployment unit | Human Capital Management |
| Endpoint Activation | By Communication Arrangement | Operations |
|
| Release Status | Released |
| Technical documentation on the SAP API Business Hub | Query Time Account Balances |
| General web service documentation | A2X Web Services (SOAP) |
An interface to provide information on time accounts for an external time recording system.
This message is sent from the SAP ByDesign system to the External Time Recording System (ETRS) as synchronous response to a query triggered by the ETRS. The response contains the time accounts balances of time account types that have been configured in the SAP ByDesign system to be relevant for display at the time recording terminal.
The scheduling of the query is in the responsibility of ETRS.
Example
<n0:EmployeeTimeAccountTimeRecordingSystemCollectionByElementsQuery xmlns:n0="http://sap.com/xi/AP/TimeAndLabourManagement/Global"> <MessageHeader> <ID>00300571D06B1DED92A0C57978891967</ID> <CreationDateTime>2009-12-03T17:42:37.789+01:00</CreationDateTime> <SenderParty> <InternalID schemeID="CommunicationSystemID" schemeAgencyID="310">ETRS</InternalID> </SenderParty> <BusinessScope> <TypeCode listID="25201" listAgencyID="310">2</TypeCode> <ID schemeID="10555" schemeAgencyID="310">29</ID> </BusinessScope> <BusinessScope> <TypeCode listID="25201" listAgencyID="310">3</TypeCode> <ID schemeID="10555" schemeAgencyID="310">251</ID> </BusinessScope> </MessageHeader> <EmployeeTimeAccountCollectionByElements> <CompanyID>MC1000</CompanyID> </EmployeeTimeAccountCollectionByElements> </n0:EmployeeTimeAccountTimeRecordingSystemCollectionByElementsQuery>
You can find general information about Web services, their structure and consumption in the Web Services documentation. Please open the Web Services document in a new window.
| Description | Find time account balances |
| Name | Provide |
| Synchronous | yes |
| Release Status | Released |
To provide information on time accounts for an external time recording system.
This service is offered to retrieve current employee time account balances for display on external time recording terminals. The communication is organized as a query response messages with message types
Employee Time Account Time Recording System Collection By Elements Query
Employee Time Account Time Recording System Collection By Elements Response
Employee Time Account Time Recording System Collection By Elements Query
A query of an external time recording system about a collection of employee time accounts
Employee Time Account Time Recording System Collection By Elements Response
A response to a query of an external time recording system about a collection of employee time accounts.
| Structure Element | Description |
|---|---|
| ID | Unique GUID generated for each message, such as 00300571D06B1DDCA08F250379A2417B |
| CreationDateTime | Creation time stamp of the message, such as 2008-12-31T23:59:59.1234Z |
| EmployeeUUID | Unique GUID generated for each employee, such as 4829 |
| EmployeeID | Employee ID, such as MC1572 |
| EmployeeTimeRecordingCardID | Time recording card ID, such as 4809 |
| EmployeeTimeEventUsageCode | A usage code for employee master data for external time recording system, such as 1. The values are: <1> - Time events are used for working time determination in the SAP ByDesign system, that is, the employee is participating in time recording via terminals. <No code value> or <value other than 1> - The employee is not participating in time recording via terminals. The employee information is contained in the message as the employee has been assigned an Employee Time Recording Card ID in the SAP ByDesign system (Example, for access control usage) |
| TypeCode | Employee Time Account Type Code, such as DE0010 |
| IdentifyingPeriod-StartDate | Start Date of Identifying Period of Employee Time Account Instance, such as 2012-01-01 |
| IdentifyingPeriod-EndDate | End Date of Identifying Period of Employee Time Account Instance, such as 2018-12-31 |
| Quantity | Time account balance with unit (Day/Hour) |
| QuantityTypeCode | Type of quantity. Fixed value, TIME |
Sample Query
<n0:EmployeeTimeAccountTimeRecordingSystemCollectionByElementsQuery xmlns:n0="http://sap.com/xi/AP/TimeAndLabourManagement/Global"> <MessageHeader> <ID>00300571D06B1DED92A0C57978891967</ID> <CreationDateTime>2009-12-03T17:42:37.789+01:00</CreationDateTime> <SenderParty> <InternalID schemeID="CommunicationSystemID" schemeAgencyID="310">ETRS</InternalID> </SenderParty> <BusinessScope> <TypeCode listID="25201" listAgencyID="310">2</TypeCode> <ID schemeID="10555" schemeAgencyID="310">29</ID> </BusinessScope> <BusinessScope> <TypeCode listID="25201" listAgencyID="310">3</TypeCode> <ID schemeID="10555" schemeAgencyID="310">251</ID> </BusinessScope> </MessageHeader> <EmployeeTimeAccountCollectionByElements> <CompanyID>MC1000</CompanyID> </EmployeeTimeAccountCollectionByElements> </n0:EmployeeTimeAccountTimeRecordingSystemCollectionByElementsQuery>
Sample Response
<nm:EmployeeTimeAccountTimeRecordingSystemCollectionByElementsResponse xmlns:nm="http://sap.com/xi/AP/TimeAndLabourManagement/Global" xmlns:prx="urn:sap.com:proxy:HGM:/1SAI/TAS665D17056EA6297034E2:804"> <MessageHeader> <ID>00163E02E6641ED287B7F280D65E701C</ID> <CreationDateTime>2012-10-24T09:45:43.665793Z</CreationDateTime> </MessageHeader> <EmployeeTimeAccountCollection> <EmployeeUUID>00300571-cc0f-02db-bcaf-279e526e011a</EmployeeUUID> <EmployeeTimeAccount> <TypeCode>DE0010</TypeCode> <IdentifyingPeriod> <StartDate>2012-01-01</StartDate> <EndDate>2012-12-31</EndDate> </IdentifyingPeriod> <Quantity unitCode="DAY">27.0</Quantity> <QuantityTypeCode>TIME</QuantityTypeCode> </EmployeeTimeAccount> <EmployeeTimeAccount> <TypeCode>DE0036</TypeCode> <IdentifyingPeriod> <StartDate>2012-01-01</StartDate> <EndDate>2012-01-01</EndDate> </IdentifyingPeriod> <Quantity unitCode="DAY">27.83027777777776</Quantity> <QuantityTypeCode>TIME</QuantityTypeCode> </EmployeeTimeAccount> </EmployeeTimeAccountCollection> <EmployeeTimeAccountCollection> <EmployeeUUID>00300571-c7cc-02db-bcae-627c031cd6aa</EmployeeUUID> <EmployeeTimeAccount> <TypeCode>DE0010</TypeCode> <IdentifyingPeriod> <StartDate>2012-01-01</StartDate> <EndDate>2012-12-31</EndDate> </IdentifyingPeriod> <Quantity unitCode="DAY">23.0</Quantity> <QuantityTypeCode>TIME</QuantityTypeCode> </EmployeeTimeAccount> </EmployeeTimeAccountCollection> </nm:EmployeeTimeAccountTimeRecordingSystemCollectionByElementsResponse>
Show full documentation
Show full documentation