GetRecurringProductSaleList

Financial service 1.4: List a project's recurring product sales in a period


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/GetRecurringProductSaleList`
Content-Type	`text/xml; charset=utf-8`
Authentication	A token from GetToken
Changes data	No
Safe to retry	Yes

How it works

For the project projectID, returns every instance of its recurring project products dated between startDate and endDate. Despite the 'future' naming the window can reach into the past: instances already turned into expenses are included with the expense's purchase date and IsInvoiced = true when invoiced. Only active recurring products are listed, except that already-billed instances of inactive products are still returned. Template projects return nothing. There is no ID of the instance, product or project in the result, and no defined order.

Parameters

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

projectIDinteger

Required

Integer ID of the project; must exist.

startDatedateTime

Required

Start of the window, inclusive.

endDatedateTime

Required

End of the window, inclusive - send the end of the last day if instance dates carry a time.

tokenSecurityToken

Required

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/GetRecurringProductSaleList"

<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:GetRecurringProductSaleList>
      <financial:projectID>{projectID}</financial:projectID>
      <financial:startDate>{startDate}</financial:startDate>
      <financial:endDate>{endDate}</financial:endDate>
      <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:GetRecurringProductSaleList>
  </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/GetRecurringProductSaleList"' \
  --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/GetRecurringProductSaleList"'

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:GetRecurringProductSaleList>
      <financial:projectID>{projectID}</financial:projectID>
      <financial:startDate>{startDate}</financial:startDate>
      <financial:endDate>{endDate}</financial:endDate>
      <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:GetRecurringProductSaleList>
  </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.

ReturnRecurringProjectProductFutureInstance[]

Response<RecurringProjectProductFutureInstance>: Return = instances dated in the window; unordered. Existing project without recurring products in the window: Return empty, ResponseState Success.

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>
    <GetRecurringProductSaleListResponse xmlns="http://www.timelog.com/api/tlp/v1_4">
      <GetRecurringProductSaleListResult 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:RecurringProjectProductFutureInstance>
            <b:CostPerUnit>0</b:CostPerUnit>
            <b:CurrencyOfCost>DKK</b:CurrencyOfCost>
            <b:CurrencyOfSalesPrice>DKK</b:CurrencyOfSalesPrice>
            <b:Discount>0</b:Discount>
            <b:InvoiceDate>2026-10-01T00:00:00</b:InvoiceDate>
            <b:IsInvoiced>false</b:IsInvoiced>
            <b:Name>Example </b:Name>
            <b:PricePerUnit>0</b:PricePerUnit>
            <b:ProductNumber>1001</b:ProductNumber>
            <b:Quantity>0</b:Quantity>
            <b:TotalCostAmount>0</b:TotalCostAmount>
            <b:TotalSalesAmount>0</b:TotalSalesAmount>
          </b:RecurringProjectProductFutureInstance>
        </a:Return>
        <a:ReturnTypeDescription>RecurringProjectProductFutureInstance</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>
      </GetRecurringProductSaleListResult>
    </GetRecurringProductSaleListResponse>
  </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
Error	40001	Error during call on TimeLog.API, Message 'Invalid project ID'	No project has this ID.	Check the project ID.

Was this page helpful?