GetAllowances

Salary service 1.1: Returns the account's allowance legislations.


Service	Salary 1.1
Endpoint	`POST https://app{server-number}.timelog.com/{account}/WebServices/Salary/V1_1/SalaryServiceSecure.svc`
SOAPAction	`http://www.timelog.com/api/tlp/v1_1/SalaryService/GetAllowances`
Content-Type	`text/xml; charset=utf-8`
Authentication	A token from GetToken
Changes data	No
Safe to retry	Yes

How it works

Every allowance legislation of the account - the country rule set used for employees' travel allowances - as ID and name only, ordered by ID. The country code, legislation type and the allowance rates themselves are not returned. The value set for an employee's allowance legislation.

Parameters

Each parameter has one label: Required, Conditional (required depending on other values) or Optional. Send them in the order shown.

tokenSecurityToken

Required

The token from GetToken: Initials, Expires and Hash, sent back unchanged.

Request

POST /{account}/WebServices/Salary/V1_1/SalaryServiceSecure.svc HTTP/1.1
Host: app{server-number}.timelog.com
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://www.timelog.com/api/tlp/v1_1/SalaryService/GetAllowances"

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:salary="http://www.timelog.com/api/tlp/v1_1"
                  xmlns:tok="http://www.timelog.com/api/tlp/v1_3">
  <soapenv:Body>
    <salary:GetAllowances>
      <salary:token>
        <tok:Initials>{Initials from GetToken}</tok:Initials>
        <tok:Expires>{Expires from GetToken, unchanged}</tok:Expires>
        <tok:Hash>{Hash from GetToken}</tok:Hash>
      </salary:token>
    </salary:GetAllowances>
  </soapenv:Body>
</soapenv:Envelope>

curl -X POST "https://app{server-number}.timelog.com/{account}/WebServices/Salary/V1_1/SalaryServiceSecure.svc" \
  -H "Content-Type: text/xml; charset=utf-8" \
  -H 'SOAPAction: "http://www.timelog.com/api/tlp/v1_1/SalaryService/GetAllowances"' \
  --data-binary @request.xml

import requests

URL = "https://app{server-number}.timelog.com/{account}/WebServices/Salary/V1_1/SalaryServiceSecure.svc"
SOAP_ACTION = '"http://www.timelog.com/api/tlp/v1_1/SalaryService/GetAllowances"'

envelope = """<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:salary="http://www.timelog.com/api/tlp/v1_1"
                  xmlns:tok="http://www.timelog.com/api/tlp/v1_3">
  <soapenv:Body>
    <salary:GetAllowances>
      <salary:token>
        <tok:Initials>{Initials from GetToken}</tok:Initials>
        <tok:Expires>{Expires from GetToken, unchanged}</tok:Expires>
        <tok:Hash>{Hash from GetToken}</tok:Hash>
      </salary:token>
    </salary:GetAllowances>
  </soapenv:Body>
</soapenv:Envelope>"""

response = requests.post(
    URL,
    data=envelope.encode("utf-8"),
    headers={"Content-Type": "text/xml; charset=utf-8", "SOAPAction": SOAP_ACTION},
    timeout=60,
)
result = parse_result(response)  # see "Responses and errors"

Replace every {…} placeholder with your own value.

Response

The call returns the standard response envelope. Check ResponseState first: a failed call still returns HTTP 200.

ResponseStatestring

Required

Success, Invalid or Error.

ErrorCodeinteger

0 on success, otherwise the error code. See Errors.

ReturnAllowance[]

Response<Allowance>: every legislation, unpaged; 'Successfully called' message added; ResponseState Success. ResponseState Success with an empty Return when the account has no legislations.

Example response

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

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetAllowancesResponse xmlns="http://www.timelog.com/api/tlp/v1_1">
      <GetAllowancesResult xmlns:a="http://api.timelog.com"
                           xmlns:b="http://schemas.datacontract.org/2004/07/TimeLog.TLP.API.Proxy.Salary.V1_1"
                           xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <a:Return>
          <b:Allowance>
            <b:Id>1001</b:Id>
            <b:Name>Example </b:Name>
          </b:Allowance>
        </a:Return>
        <a:ReturnTypeDescription>Allowance</a:ReturnTypeDescription>
        <a:Request>…</a:Request>
        <a:ResponseState>Success</a:ResponseState>
        <a:Messages>
          <a:APIMessage>
            <a:Message>Duration of call was 0,0421337 sec.</a:Message>
            <a:Severity>Message</a:Severity>
            <a:ErrorCode>0</a:ErrorCode>
          </a:APIMessage>
        </a:Messages>
        <a:ErrorCode>0</a:ErrorCode>
        <a:IsReturnPaged>false</a:IsReturnPaged>
        <a:TotalPageCount>0</a:TotalPageCount>
      </GetAllowancesResult>
    </GetAllowancesResponse>
  </s:Body>
</s:Envelope>

Illustrative example: built from the service description (WSDL) in the same format as a real response, with made-up values. The Request block is shortened.

Errors

All errors come back with HTTP 200: check ResponseState, ErrorCode and Messages. The errors every operation can return (expired or invalid token, API not enabled, HTTPS required, general errors) are listed once in Responses and errors.

Errors specific to this operation:

ResponseState	ErrorCode	Message	What it means	What to do
Invalid	40004	V1_{n} is deprecated. Please upgrade to V1_{m} or later.	Please upgrade to V1_1 or later.').	Call the same operation on the current version.

Was this page helpful?