GetPaymentList

Financial service 1.4: Returns the payments of one contract whose invoice date lies in [startDate, endDate].


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

How it works

Lists the installments of the contract contractID with startDate <= InvoiceDate <= endDate, ordered by installment type, then invoice date. Payments of every state are returned - planned, on a draft invoice and invoiced alike; the contract cannot tell them apart. Amount is in the project's currency, which is not returned. An unknown contract ID returns an empty list with ResponseState Success. 1900-01-01 as either date means 'no bound'; an omitted date fails.

Parameters

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

contractIDinteger

Required

Integer ID of the contract. Unknown / 0 = empty list.

startDatedateTime

Required

Earliest invoice date. 1900-01-01 = no lower bound. Omitted / before 1753-01-01 = error.

endDatedateTime

Required

Latest invoice date. 1900-01-01 = no upper bound. Omitted / before 1753-01-01 = error.

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

<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:GetPaymentList>
      <financial:contractID>{contractID}</financial:contractID>
      <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:GetPaymentList>
  </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/GetPaymentList"' \
  --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/GetPaymentList"'

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:GetPaymentList>
      <financial:contractID>{contractID}</financial:contractID>
      <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:GetPaymentList>
  </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.

ReturnPayment[]

Unknown contract, or no payment in the range: 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>
    <GetPaymentListResponse xmlns="http://www.timelog.com/api/tlp/v1_4">
      <GetPaymentListResult 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:Payment>
            <b:Amount>0</b:Amount>
            <b:InvoiceDate>2026-10-01T00:00:00</b:InvoiceDate>
            <b:Name>Example </b:Name>
            <b:PaymentID>1001</b:PaymentID>
            <b:ProjectID>1001</b:ProjectID>
            <b:ProjectSubContractID>1001</b:ProjectSubContractID>
            <b:Quantity>0</b:Quantity>
          </b:Payment>
        </a:Return>
        <a:ReturnTypeDescription>Payment</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>
      </GetPaymentListResult>
    </GetPaymentListResponse>
  </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	—	startDate or endDate omitted or before 1753-01-01.	Send real dates; for GetPaymentList use 1900-01-01 as an 'open' bound.

Was this page helpful?