Depending on the account you want to obtain results from, you need to use the right method. You can use methods that return the account results day by day or summed over the requested period.
List of methods for reading results with details of results day by day over the period requested
List of methods for reading results with the sum of results over the period requested
Reading the "Staff" day by day over the period from 01/09/2024 to 03/09/2024
The identifier of the account = « -5 »
Link to : https://sandbox-ws.kelio.io/open/services/AccountTotalService?wsdl
Web service: AccountTotalService
Method: exportDailyAccountTotalsList
Mandatory data
There are two options for reading employee data:
•Either reading an employee's data via one of the employee's identifiers (personnel number, badge no, surname/first name). The is the preferred identifier because it is usually consistent over time.
•Or reading data from a list of employees using filters on and . These concepts can be configured using the Kelio manager (see online help Population and Group).
The tag is used to define this operating mode:
In this case, one of the following identifiers is mandatory:
Employee ID number:
or Badge code:
or Surname First name: and
•or Technical key: (this identifier is used during batch processing after reading employee keys via the Web Service )
In this case, the concepts of Population and Group can be used. This data is not mandatory. If they are not completed, the Web Service returns the data for all employees. On large quantities of data, this type of request can slow down the performance of the Kelio server. We therefore strongly recommend that you use them.
Population:
Group: |
There are two ways of filtering dated data by date range.
•Either by using a real date period: for example, from 14/05/2024 to 25/06/2024.
•Or by using a date range relative to the current date: e.g. -20 days to +10 days.
The tag is used to define on operating mode:
Fields to be completed:
•: start date using actual date
•: end date using actual date
Fields to be completed
•: relative start date. Number of days before or after the current date.
•: relative end date. Number of days before or after the current date. |
|
Input data
Code
|
Description
|
Class type
|
archivedEmployee
|
Archived employee
|
boolean (false / true)
|
calculationMode
|
Calculation mode
|
int
Possible values:
0Completed
1Planned
2Estimated
3Estimated with absence requests |
dateMode
|
Date entry mode
|
int
Possible values:
0Date to date
1Day
2Week
3Period
4Year |
employeeBadgeCode
|
Employee's badge code
|
String (max: 16)
|
employeeFirstName
|
Employee’s first name
|
String (max: 24)
|
employeeIdentificationCode
|
Employee ID number code
|
String (max: 80)
|
employeeIdentificationNumber
|
Employee’s ID
|
String (max: 16)
|
employeeKey
|
Employee key
|
Int
|
employeeSurname
|
Employee’s surname
|
String (max: 24)
|
endDate
|
End date
|
Date (format: yyyy-MM-dd)
|
endOffset
|
End offset
|
Int
|
errorMessage
|
Error message
|
String
|
groupFilter
|
Filter by public type group
|
String (max: 40)
|
populationEndDate
|
Population enrolment end date
|
Date (format: yyyy-MM-dd)
|
populationFilter
|
Filter by population
|
String
|
populationMode
|
Population entry mode
|
Int
Possible values:
0Population / Group
1Employee |
populationStartDate
|
Population enrolment start date
|
Date (format: yyyy-MM-dd)
|
startDate
|
Start date
|
Date (format: yyyy-MM-dd)
|
startOffset
|
Start offset
|
Int
|
technicalString
|
Technical key
|
String
|
transferEmptyAccount
|
Transfer null totals
|
boolean (false / true)
|
typeKey
|
Type key
|
Int
|
|
Output data
Code
|
Description
|
Class type
|
archivedEmployee
|
Archived employee
|
boolean (false / true)
|
days
|
Days
|
Double
|
employeeBadgeCode
|
Employee's badge code
|
String (max: 16)
|
employeeFirstName
|
Employee’s first name
|
String (max: 24)
|
employeeIdentificationCode
|
Employee ID number code
|
String (max: 80)
|
employeeIdentificationNumber
|
Employee’s ID
|
String (max: 16)
|
employeeKey
|
Employee key
|
Int
|
employeeSurname
|
Employee’s surname
|
String (max: 24)
|
endDate
|
End date
|
Date (format: yyyy-MM-dd)
|
errorMessage
|
Error message
|
String
|
hours
|
Hours
|
Double
|
number
|
Number
|
Double
|
physicalHours
|
Hours 0- 24
|
Double
|
sectionAbbreviation
|
Section abbreviation
|
String (max: 40)
|
sectionDescription
|
Section description
|
String (max: 50)
|
sectionKey
|
Section key
|
Int
|
startDate
|
Start date
|
Date (format: yyyy-MM-dd)
|
technicalString
|
Technical key
|
String
|
typeAbbreviation
|
Type abbreviation
|
String
|
typeDescription
|
Type description
|
String
|
typeKey
|
Type key
|
Int
|
|
Example of a request
Name
|
Copy
|
AccountTotalService
|
Code Sample
|
Copy Code
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ech="http://echange.service.open.bodet.com">
<soapenv:Header/>
<soapenv:Body>
<ech:exportDailyAccountTotalsList>
<!--Optional:-->
<ech:accountFilter>
<!--Zero or more repetitions:-->
<ech:AccountFilter>
<ech:employeeIdentificationNumber>00001001</ech:employeeIdentificationNumber>
<ech:startDate>2024-09-01</ech:startDate>
<ech:endDate>2024-09-03</ech:endDate>
<ech:populationMode>1</ech:populationMode>
<ech:dateMode>0</ech:dateMode>
<ech:calculationMode>2</ech:calculationMode>
<ech:typeKey>-5</ech:typeKey>
</ech:AccountFilter>
</ech:accountFilter>
</ech:exportDailyAccountTotalsList>
</soapenv:Body>
</soapenv:Envelope>
|
|
Response
Code Sample
|
Copy Code
|
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:exportDailyAccountTotalsListResponse xmlns:ns1="http://echange.service.open.bodet.com">
<ns1:exportedDailyAccountTotals>
<ns1:DailyTotal>
<ns1:number xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:physicalHours>5.70</ns1:physicalHours>
<ns1:days xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:hours>5.70</ns1:hours>
<ns1:date>2024-09-01</ns1:date>
<ns1:sectionKey>150</ns1:sectionKey>
<ns1:sectionDescription>Comptabilité</ns1:sectionDescription>
<ns1:sectionAbbreviation xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:typeKey>-5</ns1:typeKey>
<ns1:typeAbbreviation>Eff.</ns1:typeAbbreviation>
<ns1:typeDescription>Effectif</ns1:typeDescription>
<ns1:employeeKey>310</ns1:employeeKey>
<ns1:employeeSurname>ANDIVEAU</ns1:employeeSurname>
<ns1:employeeFirstName>Loïc</ns1:employeeFirstName>
<ns1:employeeIdentificationCode>GD</ns1:employeeIdentificationCode>
<ns1:archivedEmployee xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:employeeIdentificationNumber>00001001</ns1:employeeIdentificationNumber>
<ns1:employeeBadgeCode xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:technicalString xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:errorMessage xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</ns1:DailyTotal>
<ns1:DailyTotal>
<ns1:number xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:physicalHours>5.70</ns1:physicalHours>
<ns1:days xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:hours>5.70</ns1:hours>
<ns1:date>2024-09-03</ns1:date>
<ns1:sectionKey>150</ns1:sectionKey>
<ns1:sectionDescription>Comptabilité</ns1:sectionDescription>
<ns1:sectionAbbreviation xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:typeKey>-5</ns1:typeKey>
<ns1:typeAbbreviation>Eff.</ns1:typeAbbreviation>
<ns1:typeDescription>Effectif</ns1:typeDescription>
<ns1:employeeKey>310</ns1:employeeKey>
<ns1:employeeSurname>ANDIVEAU</ns1:employeeSurname>
<ns1:employeeFirstName>Loïc</ns1:employeeFirstName>
<ns1:employeeIdentificationCode>GD</ns1:employeeIdentificationCode>
<ns1:archivedEmployee xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:employeeIdentificationNumber>00001001</ns1:employeeIdentificationNumber>
<ns1:employeeBadgeCode xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:technicalString xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:errorMessage xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</ns1:DailyTotal>
</ns1:exportedDailyAccountTotals>
</ns1:exportDailyAccountTotalsListResponse>
</soap:Body>
</soap:Envelope>
|
|
Filter on the periods of data to be extracted
