TimeMapAPI


Click here for a complete list of operations.

getPayrollPeriods

Always use Test server for test and development. All usage restrictions on test is 200 requests. Url: https://testservice.timemap.dk/timemapapi.asmx
Description:Get Payroll Periods Bonus
Note, Fair usage limit: 2 request per payroll per hour.
Parameters:
  • apikey (string): Mandatory. The apikey is specified in the Company settings. Please see menu Settings->Company
  • apipwd (string): Mandatory. The api password must be specified in the Company settings. Please see menu Settings->Company
  • username (string): Mandatory. Specify the username/email of the user/developer calling this method. The user must exists in the EmployeeList.
  • fromdate (date): Optional. Format: yyyy.MM.dd
  • todate (date): Optional. Format: yyyy.MM.dd
Result: PayrollPeriods
  • paymentid: Internal TimeMap payment id. Used to retrieve payroll details.
  • fromdate: Payroll period start (Format: yyyy.MM.dd)
  • todate: Payroll period end (Format: yyyy.MM.dd)
  • paymenttermcode: Payroll systemet Payment Term Code
  • commet: The comment/description/ of the period
  • locked: 1 = Locked (only when using masterlock functionality)
  • createdby: Creator
  • createddate: Created date (Format: yyyy.MM.dd HH:mm)
  • modifiedby: Last modified by
  • modifieddate: Modified date (Format: yyyy.MM.dd HH:mm)

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /TimeMapApi.asmx HTTP/1.1
Host: testservice.timemap.dk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/getPayrollPeriods"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getPayrollPeriods xmlns="http://tempuri.org/">
      <apikey>string</apikey>
      <apipwd>string</apipwd>
      <username>string</username>
      <fromdate>string</fromdate>
      <todate>string</todate>
    </getPayrollPeriods>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getPayrollPeriodsResponse xmlns="http://tempuri.org/">
      <getPayrollPeriodsResult>string</getPayrollPeriodsResult>
    </getPayrollPeriodsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /TimeMapApi.asmx HTTP/1.1
Host: testservice.timemap.dk
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getPayrollPeriods xmlns="http://tempuri.org/">
      <apikey>string</apikey>
      <apipwd>string</apipwd>
      <username>string</username>
      <fromdate>string</fromdate>
      <todate>string</todate>
    </getPayrollPeriods>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getPayrollPeriodsResponse xmlns="http://tempuri.org/">
      <getPayrollPeriodsResult>string</getPayrollPeriodsResult>
    </getPayrollPeriodsResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /TimeMapApi.asmx/getPayrollPeriods?apikey=string&apipwd=string&username=string&fromdate=string&todate=string HTTP/1.1
Host: testservice.timemap.dk

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://tempuri.org/">string</string>