GetContractPaymentsRaw

Reporting API: Returns contract payments per contract customer in an invoice-date window, with amounts.


API	Reporting API (raw extracts)
Endpoint	`POST https://app{server-number}.timelog.com/{account}/Service.asmx`
SOAPAction	`http://www.timelog.com/ws/tlp/v4_4/GetContractPaymentsRaw`
Content-Type	`text/xml; charset=utf-8`
Authentication	`siteCode`, `apiID` and `apiPassword` as the first three parameters. See Authentication
Changes data	No. Safe to retry.
Paging	No: the whole result comes in one response. Narrow it with the filters.

How it works

Filters: project, contract customer's customer, contract, plus the mandatory date window. Only payments linked to a contract customer are returned; all installment types are included. The contract is filterable but not returned - join via ProjectSubContractCustomerID to GetContractCustomersRaw. CONTRACT AMOUNTS.

Parameters

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

siteCodestring

Required

Your account's site code, from the Reporting API settings.

apiIDstring

Required

The Reporting API ID, from the Reporting API settings.

apiPasswordstring

Required

The Reporting API password, from the Reporting API settings.

projectIDinteger

Required

The payment's project. 0 = no filter.

customerIDinteger

Required

The contract customer's customer. 0 = no filter.

projectSubContractIDinteger

Required

Contract ID. 0 = no filter.

startDatedateTime

Required

InvoiceDate >= value. An invalid value -> ASMX fault.

endDatedateTime

Required

InvoiceDate <= value. Same typing as startDate - an OMITTED endDate becomes 0001-01-01 and the result is EMPTY.

Request

POST /{account}/Service.asmx HTTP/1.1
Host: app{server-number}.timelog.com
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://www.timelog.com/ws/tlp/v4_4/GetContractPaymentsRaw"

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tlp="http://www.timelog.com/ws/tlp/v4_4">
  <soap:Body>
    <tlp:GetContractPaymentsRaw>
      <tlp:siteCode>{siteCode}</tlp:siteCode>
      <tlp:apiID>{apiID}</tlp:apiID>
      <tlp:apiPassword>{apiPassword}</tlp:apiPassword>
      <tlp:projectID>0</tlp:projectID>
      <tlp:customerID>0</tlp:customerID>
      <tlp:projectSubContractID>0</tlp:projectSubContractID>
      <tlp:startDate>{startDate}</tlp:startDate>
      <tlp:endDate>{endDate}</tlp:endDate>
    </tlp:GetContractPaymentsRaw>
  </soap:Body>
</soap:Envelope>

curl -X POST "https://app{server-number}.timelog.com/{account}/Service.asmx" \
  -H "Content-Type: text/xml; charset=utf-8" \
  -H 'SOAPAction: "http://www.timelog.com/ws/tlp/v4_4/GetContractPaymentsRaw"' \
  --data-binary @request.xml

import requests

URL = "https://app{server-number}.timelog.com/{account}/Service.asmx"
SOAP_ACTION = '"http://www.timelog.com/ws/tlp/v4_4/GetContractPaymentsRaw"'

envelope = """<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tlp="http://www.timelog.com/ws/tlp/v4_4">
  <soap:Body>
    <tlp:GetContractPaymentsRaw>
      <tlp:siteCode>{siteCode}</tlp:siteCode>
      <tlp:apiID>{apiID}</tlp:apiID>
      <tlp:apiPassword>{apiPassword}</tlp:apiPassword>
      <tlp:projectID>0</tlp:projectID>
      <tlp:customerID>0</tlp:customerID>
      <tlp:projectSubContractID>0</tlp:projectSubContractID>
      <tlp:startDate>{startDate}</tlp:startDate>
      <tlp:endDate>{endDate}</tlp:endDate>
    </tlp:GetContractPaymentsRaw>
  </soap:Body>
</soap:Envelope>"""

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

Replace every {…} placeholder with your own value.

Response

The result is an XML document inside GetContractPaymentsRawResult: a tlp:ContractPayments root with one tlp:ContractPayment element per record. Check the response format first: the same slot also carries the empty result and errors.

Order: InvoiceDate; ties not ordered.

tlp:ContractPaymentContractPaymentRaw[]

One element per record. Fields without a value are left out of the element, so treat every field as optional.

Example response

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetContractPaymentsRawResponse xmlns="http://www.timelog.com/ws/tlp/v4_4">
      <GetContractPaymentsRawResult>
        <tlp:ContractPayments xmlns:tlp="http://www.timelog.com/XML/Schema/tlp/v4_4">
          <tlp:ContractPayment ID="1001" GUID="3F2504E0-4F89-41D3-9A0C-0305E82C3303">
            <tlp:InvoiceDate>2026-10-01T00:00:00</tlp:InvoiceDate>
            <tlp:Rate>950.0000</tlp:Rate>
            <tlp:RateCurrency>950.0000</tlp:RateCurrency>
            <tlp:Discount>0.0000</tlp:Discount>
            <tlp:InvoicelineID>12</tlp:InvoicelineID>
            <tlp:Quantity>0.0000</tlp:Quantity>
            <tlp:Name>Example </tlp:Name>
            <tlp:UnitType>0</tlp:UnitType>
            <tlp:Amount>950.0000</tlp:Amount>
            <tlp:AmountCurrency>950.0000</tlp:AmountCurrency>
            <tlp:InvoicedAt>2026-10-01T00:00:00</tlp:InvoicedAt>
            <tlp:IsReadyForInvoicing>0</tlp:IsReadyForInvoicing>
            <tlp:CustomerID>12</tlp:CustomerID>
            <tlp:CustomerName>Example Customer A/S</tlp:CustomerName>
            <tlp:ProjectID>12</tlp:ProjectID>
            <tlp:ProjectName>Example project</tlp:ProjectName>
            <tlp:ProjectSubContractCustomerID>12</tlp:ProjectSubContractCustomerID>
            <tlp:CreatedAt>2026-10-01T00:00:00</tlp:CreatedAt>
            <tlp:CreatedByEmployeeId>12</tlp:CreatedByEmployeeId>
            <tlp:CreatedBy>ABC</tlp:CreatedBy>
            <tlp:LastModifiedAt>2026-10-01T00:00:00</tlp:LastModifiedAt>
            <tlp:LastModifiedByEmployeeId>12</tlp:LastModifiedByEmployeeId>
            <tlp:LastModifiedBy>ABC</tlp:LastModifiedBy>
          </tlp:ContractPayment>
        </tlp:ContractPayments>
      </GetContractPaymentsRawResult>
    </GetContractPaymentsRawResponse>
  </soap:Body>
</soap:Envelope>

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetContractPaymentsRawResponse xmlns="http://www.timelog.com/ws/tlp/v4_4">
      <GetContractPaymentsRawResult>
        <tlp:ContractPayments resultEmpty="true" xmlns:tlp="http://www.timelog.com/XML/Schema/tlp/v4_4"></tlp:ContractPayments>
      </GetContractPaymentsRawResult>
    </GetContractPaymentsRawResponse>
  </soap:Body>
</soap:Envelope>

Example error

Wrong credentials, or a call over plain HTTP:

HTTP/1.1 401 Unauthorized
Content-Type: text/xml; charset=utf-8

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetContractPaymentsRawResponse xmlns="http://www.timelog.com/ws/tlp/v4_4">
      <GetContractPaymentsRawResult>
        <tlp:Errors xmlns:tlp="http://www.timelog.com/XML/Schema/tlp/v4_4">
          <tlp:Error>Access denied. Check siteCode, apiID, apiPassword and SSL settings</tlp:Error>
        </tlp:Errors>
      </GetContractPaymentsRawResult>
    </GetContractPaymentsRawResponse>
  </soap:Body>
</soap:Envelope>

Data and No rows are illustrative examples: the format follows the service's documented output, with made-up values (only one record shown). Access denied was recorded from a real call with wrong credentials (to GetCustomersShortList; every data method answers the same way).

Errors

The errors every method can return (access denied, operation failed, invalid request) are listed once in Responses and errors.

This method has no errors of its own beyond the shared ones.

Was this page helpful?