Overview

How to use the timecard API to import and export timecards

Use the timecard API to control the flow of timecard from and to Proactis. Depending on your requirements we have several options available.

HR-XML

Proactis timecard API uses the HR-XML message standard. We suggest you refer to the HR-XML website or SETU to learn more. Sample messages including annotation can be found on the sample messages page.

Automatically push timecards to your application

The option to push documents to a specified endpoint can be configured in the communication settings. Configuration needs to be done once for each environment (UAT and PROD).

Timecards will be send using a POST request. Upon receiving the timecard Proactis API requires a response. This response can be either successful or unsuccessful and the contents will be visible in the widgets. The response needs to be a valid HR-XML message. When no or no valid response is received, the widgets will show an error.

More information on how to configure the communication settings can be read here.

Periodically retrieve timecards from Proactis

Another option to get timecards is to have your application retrieve the timecards. To retrieve timecards Proactis API offers two endpoints, one for fetching a list of results based on filters or pagination and another for retrieving individual timecards.

More information on the process can be read here. Or check information on filtering or pagination.