GetNewStandardHourlyRates
Financial service 1.4: Get blank rate templates for a new standard service
| Service | Financial 1.4 |
| Endpoint | POST https://app{server-number}.timelog.com/{account}/WebServices/Financial/V1_4/FinancialServiceSecure.svc |
| SOAPAction | http://www.timelog.com/api/tlp/v1_4/FinancialService/GetNewStandardHourlyRates |
| Content-Type | text/xml; charset=utf-8 |
| Authentication | A token from GetToken |
| Changes data | No |
| Safe to retry | Yes |
How it works
A pure READ despite the 'New' in its name: nothing is persisted. The result is one HourlyRate per price group with Details filled - the list of groups a new service needs an amount for.
Parameters
Each parameter has one label: Required, Conditional (required depending on other values) or Optional. Send them in the order shown.
Integer ID of the legal entity. Unknown or 0: empty list, no error.
The token from GetToken: Initials, Expires and Hash, sent back unchanged.
Request
POST /{account}/WebServices/Financial/V1_4/FinancialServiceSecure.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_4/FinancialService/GetNewStandardHourlyRates"
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:financial="http://www.timelog.com/api/tlp/v1_4"
xmlns:tok="http://www.timelog.com/api/tlp/v1_3">
<soapenv:Body>
<financial:GetNewStandardHourlyRates>
<financial:legalEntityId>{legalEntityId}</financial:legalEntityId>
<financial:token>
<tok:Initials>{Initials from GetToken}</tok:Initials>
<tok:Expires>{Expires from GetToken, unchanged}</tok:Expires>
<tok:Hash>{Hash from GetToken}</tok:Hash>
</financial:token>
</financial:GetNewStandardHourlyRates>
</soapenv:Body>
</soapenv:Envelope>
curl -X POST "https://app{server-number}.timelog.com/{account}/WebServices/Financial/V1_4/FinancialServiceSecure.svc" \
-H "Content-Type: text/xml; charset=utf-8" \
-H 'SOAPAction: "http://www.timelog.com/api/tlp/v1_4/FinancialService/GetNewStandardHourlyRates"' \
--data-binary @request.xml
import requests
URL = "https://app{server-number}.timelog.com/{account}/WebServices/Financial/V1_4/FinancialServiceSecure.svc"
SOAP_ACTION = '"http://www.timelog.com/api/tlp/v1_4/FinancialService/GetNewStandardHourlyRates"'
envelope = """<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:financial="http://www.timelog.com/api/tlp/v1_4"
xmlns:tok="http://www.timelog.com/api/tlp/v1_3">
<soapenv:Body>
<financial:GetNewStandardHourlyRates>
<financial:legalEntityId>{legalEntityId}</financial:legalEntityId>
<financial:token>
<tok:Initials>{Initials from GetToken}</tok:Initials>
<tok:Expires>{Expires from GetToken, unchanged}</tok:Expires>
<tok:Hash>{Hash from GetToken}</tok:Hash>
</financial:token>
</financial:GetNewStandardHourlyRates>
</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"
{…} placeholder with your own value.Response
The call returns the standard response envelope. Check ResponseState first: a failed call still returns HTTP 200.
Success, Invalid or Error.
0 on success, otherwise the error code. See Errors.
Response<HourlyRate>: one template per price group. Set: Amount, Name, ProductNo, Details {LegalEntityId, PriceGroupId, CurrencyISO, CurrencyName, ServiceId}. Not set: HourlyRateID, IsActive / IsDefault / IsSystem / IsCustomerSpecific, CustomerID. No success message. Success with an empty Return when the legal entity is unknown or has no active standard rate.
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>
<GetNewStandardHourlyRatesResponse xmlns="http://www.timelog.com/api/tlp/v1_4">
<GetNewStandardHourlyRatesResult xmlns:a="http://api.timelog.com"
xmlns:b="http://schemas.datacontract.org/2004/07/TimeLog.TLP.API.Proxy.Financial.V1_4"
xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:Return>
<b:HourlyRate>
<b:Amount>0</b:Amount>
<b:CustomerID>1001</b:CustomerID>
<b:Details>
<b:CurrencyISO>DKK</b:CurrencyISO>
<b:CurrencyName>DKK</b:CurrencyName>
<b:LegalEntityId>1001</b:LegalEntityId>
<b:PriceGroupId>1001</b:PriceGroupId>
<b:ServiceId>1001</b:ServiceId>
</b:Details>
<b:HourlyRateID>1001</b:HourlyRateID>
<b:IsActive>true</b:IsActive>
<b:IsCustomerSpecific>false</b:IsCustomerSpecific>
<b:IsDefault>false</b:IsDefault>
<b:IsSystem>false</b:IsSystem>
<b:Name>Example </b:Name>
<b:ProductNo>1001</b:ProductNo>
</b:HourlyRate>
</a:Return>
<a:ReturnTypeDescription>HourlyRate</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>
</GetNewStandardHourlyRatesResult>
</GetNewStandardHourlyRatesResponse>
</s:Body>
</s:Envelope>
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.
This operation has no errors of its own beyond the shared ones.